Category: Time. Tags: Clocks and calendars, Schedules, Offices and workplaces, Lobbies and reception.
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.almanac/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 |
|---|---|---|---|---|
date | string, null | null | pattern: "^\\d{4}-\\d{2}-\\d{2}$" | YYYY-MM-DD to show instead of today in the screen's zone; null is today. |
timeZone | string, null | null |
Dynamic properties
| Name | Type | Default | Values and limits | Description |
|---|---|---|---|---|
observances | array | [] | minItems: 0; maxItems: 12 | Your own observances: a company day, a closure, a birthday. They join the feed's and read first when a holiday. |
observances[].date | string | pattern: "^(\\d{4}-)?\\d{2}-\\d{2}$"; Required | MM-DD for every year, or YYYY-MM-DD for one day. | |
observances[].name | string | minLength: 1; maxLength: 60; Required | ||
observances[].kind | string | "observance" | "observance", "holiday" | A holiday leads the list and warms the page. |
Canvas example
Add this item to a playlist page’s primitives. Publish the playlist and assign a screen.
{
"id": "today",
"primitive": "card",
"card": "today",
"major": 1,
"params": {
"theme": "neomustard"
},
"rect": {
"x": 0,
"y": 0,
"width": 1920,
"height": 1080
},
"layer": 0,
"content_fit": "fill",
"data": "today-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/today-main" \
--header "Authorization: Bearer $SCREENRIG_TOKEN" \
--header "ScreenRig-Project: $SCREENRIG_PROJECT" \
--header "Content-Type: application/json" \
--data '{"document":{"observances":[]}}'