Welcome board card

Category: People. Tags: Lobbies and reception, Offices and workplaces, Recognition.

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
`title`	string	`"Today's guests"`	maxLength: `40`
`greeting`	string	`""`	maxLength: `40`	The big words. Empty greets by the time of day: Good morning, Good afternoon or Good evening.
`organization`	string	`""`	maxLength: `60`	Your name; reads "Welcome to <organization>" above the greeting. Empty hides the line.
`order`	string	`"listed"`	`"listed"`, `"time"`, `"name"`	listed: as given. time: earliest first, untimed last. name: A to Z.
`showDate`	boolean	`true`

Dynamic properties

Name	Type	Default	Values and limits	Description
`visitors`	array	`[]`	minItems: `0`; maxItems: `40`
`visitors[].name`	string		minLength: `1`; maxLength: `60`; Required
`visitors[].company`	string	`""`	maxLength: `60`
`visitors[].note`	string	`""`	maxLength: `60`	After the company: who they are meeting, or a room.
`visitors[].time`	string	`""`	maxLength: `12`	When they are expected, as written ("9:30 AM", "14:00"). It also orders the list when order is time.
`footnote`	string	`""`	maxLength: `120`

Canvas example

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

{
  "id": "welcome",
  "primitive": "card",
  "card": "welcome",
  "major": 1,
  "params": {
    "theme": "neomustard"
  },
  "rect": {
    "x": 0,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "layer": 0,
  "content_fit": "fill",
  "data": "welcome-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/welcome-main" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "ScreenRig-Project: $SCREENRIG_PROJECT" \
  --header "Content-Type: application/json" \
  --data '{"document":{"visitors":[],"footnote":""}}'