Progress card

Category: Operations. Tags: Numbers and metrics, Charts and gauges.

Previews

Views and forms

Views: canvas, corner, chip. Canvas forms: landscape, portrait.

Card views, themes and publishing. Browse the gallery.

Data and privacy

This card uses its configured properties and live card data.

Properties

For theme, background, accent and position, see Common properties.

Set static properties in params. Bind data to a project card data key for live values; that document holds only dynamic properties. Without a data key, put the complete configuration in params. Nested rows describe the contents of their parent property.

Static properties

Name	Type	Default	Values and limits	Description
`title`	string	`""`	maxLength: `60`
`prefix`	string	`""`	maxLength: `3`	Before every amount, for example $.
`unit`	string	`""`	maxLength: `12`	After every amount, for example kg or ' meals'.
`decimals`	integer	`0`	minimum: `0`; maximum: `2`
`style`	string	`"ring"`	`"ring"`, `"bar"`, `"thermometer"`
`timeZone`	string, null	`null`

Dynamic properties

Name	Type	Default	Values and limits	Description
`value`	number		Required
`goal`	number		minimum: `1e-06`; Required
`deadline`	string, null	`null`		ISO 8601 date or instant; local dates are in the zone.
`milestones`	array	`[]`	maxItems: `8`

Canvas example

Add this item to a playlist page’s primitives. Publish the playlist and assign a screen.

{
  "id": "progress",
  "primitive": "card",
  "card": "progress",
  "major": 1,
  "params": {
    "theme": "neomustard"
  },
  "rect": {
    "x": 0,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "layer": 0,
  "content_fit": "fill",
  "data": "progress-main"
}

Write live data

Create this document before showing the card, then replace it to update the screen without republishing. Use the same project as the playlist. Supply your API authorization through the environment; see API authentication.

curl --request PUT "https://api.screenrig.ai/api/card-data/progress-main" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "ScreenRig-Project: $SCREENRIG_PROJECT" \
  --header "Content-Type: application/json" \
  --data '{"document":{"value":1,"goal":1,"deadline":null,"milestones":[]}}'