Leaderboard card

Category: Operations. Tags: Leaderboards and standings, Offices and workplaces, Stores.

Previews

Views and forms

Views: canvas, corner, chip. Canvas forms: landscape, portrait.

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	`"Leaderboard"`	maxLength: `60`
`unit`	string	`""`	maxLength: `12`	Shown after scores, for example pts.
`show`	integer	`10`	minimum: `3`; maximum: `20`
`highlight`	string	`""`	maxLength: `40`	An entry name to emphasise.

Dynamic properties

Name	Type	Default	Values and limits	Description
`entries`	array		minItems: `1`; maxItems: `50`; Required
`entries[].name`	string		minLength: `1`; maxLength: `40`; Required
`entries[].score`	number		Required
`entries[].previousRank`	integer, null	`null`	minimum: `1`	Last period's rank; null or absent marks the entry new.
`entries[].team`	string	`""`	maxLength: `40`

Canvas example

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

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