Category: Health. Tags: Healthcare, Charts and gauges, Numbers and metrics.
Previews



Views and forms
Views: canvas, corner, chip. Canvas forms: landscape, portrait, square, strip.
Card views, themes and publishing. Browse the gallery.
Data and privacy
Feed: screenrig.respiratory/v1.
Feed documents carry source attribution. The Player supplies the feed to the card.
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 | "Respiratory activity" | maxLength: 40 | |
staleMinutes | integer | 2880 | minimum: 1; maximum: 20160 | A feed older than this shows how long ago it updated. |
timeZone | string, null | null | IANA zone; null uses the screen's zone. |
Dynamic properties
| Name | Type | Default | Values and limits | Description |
|---|---|---|---|---|
region | string | "" | maxLength: 48 | Place the levels describe; the feed's region wins. |
weekEnding | string | "" | maxLength: 32 | Date the levels run to; the feed's wins. |
viruses | array | [] | minItems: 0; maxItems: 6 | Viruses, the same document as the screenrig.respiratory/v1 feed's viruses. The feed wins when present. |
viruses[].kind | string | minLength: 1; maxLength: 24; Required | flu, covid or rsv; any other value shows as its own name. | |
viruses[].name | string | "" | maxLength: 24 | Shown instead of the standard name. |
viruses[].level | string, integer | "" | very low, low, moderate, high or very high (or 1 to 5). | |
viruses[].trend | string | "" | "rising", "steady", "falling", "" | |
viruses[].series | array | [] | maxItems: 26 | Weekly values, oldest first. |
footnote | string | "" | maxLength: 140 | Advice under the board; the feed's advice shows when this is empty. |
Canvas example
Add this item to a playlist page’s primitives. Publish the playlist and assign a screen.
{
"id": "respiratory-activity",
"primitive": "card",
"card": "respiratory-activity",
"major": 1,
"params": {
"theme": "neomustard"
},
"rect": {
"x": 0,
"y": 0,
"width": 1920,
"height": 1080
},
"layer": 0,
"content_fit": "fill",
"data": "respiratory-activity-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/respiratory-activity-main" \
--header "Authorization: Bearer $SCREENRIG_TOKEN" \
--header "ScreenRig-Project: $SCREENRIG_PROJECT" \
--header "Content-Type: application/json" \
--data '{"document":{"region":"","weekEnding":"","viruses":[],"footnote":""}}'