Heatmap card

Compare activity across weekdays and hours, teams and periods, or a dated calendar. Colours share one scale across every page. Missing readings stay distinct from zero; compact views show the strongest reading and its labels.

Live card

This card is drawn in your browser by the same code the Players run, with sample data.

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

Layouts

This fullscreen card fills the whole screen in landscape or portrait and is not placed as a corner, chip, or strip.

Layouts: full. Forms: landscape, portrait.

Card layouts, themes and publishing. Browse the cards.

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
`mode`	string	`"matrix"`	`"matrix"`, `"calendar"`
`weeks`	integer	`13`	minimum: `1`; maximum: `53`
`columnsPerPage`	integer	`12`	minimum: `4`; maximum: `24`
`pageSeconds`	integer	`12`	minimum: `8`; maximum: `120`
`decimals`	integer	`0`	minimum: `0`; maximum: `2`
`showValues`	boolean	`true`

Dynamic properties

Name	Type	Default	Values and limits
`title`	string	`"Activity heatmap"`	maxLength: `80`
`subtitle`	string	`""`	maxLength: `160`
`footnote`	string	`""`	maxLength: `240`
`updatedAt`	string	`""`	maxLength: `40`
`startDate`	string	`""`	maxLength: `10`
`unit`	string	`""`	maxLength: `20`
`scaleMin`	number, null	`null`
`scaleMax`	number, null	`null`
`watchAt`	number, null	`null`
`columns`	array	`[]`	maxItems: `53`
`rows`	array	`[]`	maxItems: `12`
`rows[].label`	string		minLength: `1`; maxLength: `48`; Required
`rows[].values`	array		maxItems: `53`; Required
`days`	array	`[]`	maxItems: `371`
`days[].date`	string		maxLength: `10`; Required
`days[].value`	number, null		Required

Canvas example

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

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

Write live data

The canvas example binds its data field to example-key. That value is a data key: a name this canvas item chooses, not the name of the card. Give each canvas item its own key when items should show different data, or share one key when they should show the same data. Keys are scoped to the project, follow the K/V key grammar, and cannot start with feed:.

Create this document before showing the card, then replace it to update the screen without republishing. Writes to a key that live canvas items bind are checked against each bound card’s dynamic properties. Use the same project as the playlist.

Save the document as card-data.json. The CLI reads the document itself, with no wrapper:

{
  "title": "Activity heatmap",
  "subtitle": "",
  "footnote": "",
  "updatedAt": "",
  "startDate": "",
  "unit": "",
  "scaleMin": null,
  "scaleMax": null,
  "watchAt": null,
  "columns": [],
  "rows": [],
  "days": []
}

screenrig card-data put example-key --file card-data.json

Or call the API directly. The API wraps the same document in a document field. An agent token already names its project, so no project header is sent; if you send ScreenRig-Project, it must match the token’s project. Supply your API authorization through the environment; see API authentication.

curl --request PUT "https://api.screenrig.ai/api/card-data/example-key" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"document":{"title":"Activity heatmap","subtitle":"","footnote":"","updatedAt":"","startDate":"","unit":"","scaleMin":null,"scaleMax":null,"watchAt":null,"columns":[],"rows":[],"days":[]}}'