Category: Events. Tags: Lobbies and reception, Stores, News and announcements, Events and venues.
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 |
|---|---|---|---|---|
calendars | array | ["world"] | maxItems: 11; uniqueItems: true | Which sets of occasions the card draws from: world (New Year, Valentine's Day, Easter, Halloween, Christmas), christian, orthodox, us, canada, uk, australia, lunar, jewish, islamic and south-asian. |
occasion | string | "auto" | "auto", "new-years-day", "valentines-day", "st-patricks-day", "easter", "earth-day", "halloween", "christmas-eve", "christmas", "new-years-eve", "good-friday", "orthodox-christmas", "orthodox-easter", "mlk-day", "presidents-day", "mothers-day", "memorial-day", "juneteenth", "fathers-day", "independence-day", "labor-day", "veterans-day", "thanksgiving", "canada-day", "victoria-day", "thanksgiving-ca", "remembrance-day", "boxing-day", "mothering-sunday", "bonfire-night", "remembrance-sunday", "australia-day", "anzac-day", "fathers-day-au", "lunar-new-year", "lantern-festival", "dragon-boat", "mid-autumn", "rosh-hashanah", "passover", "hanukkah", "ramadan", "eid-al-fitr", "eid-al-adha", "islamic-new-year", "diwali", "vaisakhi" | auto picks the occasion in season, or the next one. An id shows that occasion's greeting on every day. |
showUpcoming | boolean | true | When nothing is in season, show the next occasion with its countdown. Off shows the plain message. | |
leadDays | integer, null | null | minimum: 0; maximum: 60 | How many days before an occasion its greeting appears. Empty uses each occasion's own lead-in. |
moonOffset | integer | 0 | minimum: -2; maximum: 2 | Days added to Ramadan and Eid dates, to follow a local moon sighting. |
timeZone | string, null | null |
Dynamic properties
| Name | Type | Default | Values and limits | Description |
|---|---|---|---|---|
message | string | "" | maxLength: 120 | Replaces the occasion's greeting. With no occasion in view it is the card's message (Welcome when empty). |
note | string | "" | maxLength: 160 | Replaces the line under the greeting. |
signoff | string | "" | maxLength: 100 | Replaces the sign-off (With warm wishes). |
Canvas example
Add this item to a playlist page’s primitives. Publish the playlist and assign a screen.
{
"id": "greeting",
"primitive": "card",
"card": "greeting",
"major": 1,
"params": {
"theme": "neomustard"
},
"rect": {
"x": 0,
"y": 0,
"width": 1920,
"height": 1080
},
"layer": 0,
"content_fit": "fill",
"data": "greeting-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/greeting-main" \
--header "Authorization: Bearer $SCREENRIG_TOKEN" \
--header "ScreenRig-Project: $SCREENRIG_PROJECT" \
--header "Content-Type: application/json" \
--data '{"document":{"message":"","note":"","signoff":""}}'