Category: Messages. Tags: Schedules, Lobbies and reception, Transit and travel, News and announcements.
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
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 |
|---|---|---|---|---|
pageSeconds | integer | 8 | minimum: 3; maximum: 120 | How long each page stays. |
columns | integer | 0 | minimum: 0; maximum: 24 | Tiles across; 0 takes the longest line (6 to 24). |
rows | integer | 0 | minimum: 0; maximum: 8 | Tiles down; 0 takes the page with the most lines (1 to 8). |
align | string | "center" | "start", "center", "end" | Where a line without a | sits in its row. |
Dynamic properties
| Name | Type | Default | Values and limits | Description |
|---|---|---|---|---|
title | string | "" | maxLength: 60 | A label above the board; empty shows none. |
lines | array | ["WELCOME"] | maxItems: 8 | One page of lines. A line is upper-cased; LEFT|RIGHT puts the right part at the far end of the row; a leading ! highlights the row. |
pages | array | [] | maxItems: 12 | Several pages of lines, shown in turn every pageSeconds. When present they replace lines. |
Canvas example
Add this item to a playlist page’s primitives. Publish the playlist and assign a screen.
{
"id": "flap-board",
"primitive": "card",
"card": "flap-board",
"major": 1,
"params": {
"theme": "neomustard"
},
"rect": {
"x": 0,
"y": 0,
"width": 1920,
"height": 1080
},
"layer": 0,
"content_fit": "fill",
"data": "flap-board-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/flap-board-main" \
--header "Authorization: Bearer $SCREENRIG_TOKEN" \
--header "ScreenRig-Project: $SCREENRIG_PROJECT" \
--header "Content-Type: application/json" \
--data '{"document":{"title":"","lines":["WELCOME"],"pages":[]}}'