Category: Sports. Tags: Scoreboards, Team sports, Schools and campuses.
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.game.basketball/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 |
|---|---|---|---|---|
title | string | "" | maxLength: 40 | Empty uses the competition's name. |
order | string | "home-away" | "home-away", "away-home" | Which team reads first: left on the board, top in the corner, first in the chip. |
teamColors | boolean | true | Team colours on the marks and bars; off keeps the theme's colours. | |
periods | integer | 4 | minimum: 2; maximum: 4 | Regulation periods when the game omits period.of: 4 quarters or 2 halves. |
bonusAt | integer | 5 | minimum: 1; maximum: 15 | The opponent's team fouls in a period that put a team in the bonus, when the game does not say. |
doubleBonusAt | integer | 0 | minimum: 0; maximum: 20 | The opponent's team fouls that make it the double bonus; 0 has none. |
leaders | integer | 1 | minimum: 0; maximum: 3 | Top scorers shown per team. |
hour12 | boolean | false | ||
timeZone | string, null | null |
Dynamic properties
| Name | Type | Default | Values and limits | Description |
|---|---|---|---|---|
game | object, null | null | The game as a screenrig.game.basketball/v1 document, for venues and clubs: a scoreboard bridge or an agent writes it to the data store. Used when no feed is attached. |
Canvas example
Add this item to a playlist page’s primitives. Publish the playlist and assign a screen.
{
"id": "basketball-board",
"primitive": "card",
"card": "basketball-board",
"major": 1,
"params": {
"theme": "neomustard"
},
"rect": {
"x": 0,
"y": 0,
"width": 1920,
"height": 1080
},
"layer": 0,
"content_fit": "fill",
"data": "basketball-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/basketball-board-main" \
--header "Authorization: Bearer $SCREENRIG_TOKEN" \
--header "ScreenRig-Project: $SCREENRIG_PROJECT" \
--header "Content-Type: application/json" \
--data '{"document":{"game":null}}'