Live-Karte
Kategorie: Betrieb. Tags: Zahlen und Kennzahlen, Diagramme und Anzeigen, Geschäfte.
Layouts
Diese Vollbildkarte füllt den gesamten Bildschirm im Quer- oder Hochformat und wird nicht als Ecke, Chip oder Streifen platziert.
Layouts: voll. Formulare: Querformat, Hochformat.
Kartenlayouts, Designs und Veröffentlichung. Karten durchsuchen.
Daten und Datenschutz
Feed: screenrig.sales/v1.
Feed-Dokumente tragen Quellenangaben. Der Player liefert den Feed an die Karte.
Zeigt nur Umsatz, Bestellmengen und die Stadt jeder Bestellung; niemals Kundennamen, Adresse oder Zahlungsdetails.
Eigenschaften
Für Thema, Hintergrund, Akzent und Position siehe Gemeinsame Eigenschaften.
Legen Sie statische Eigenschaften in den params der Karte fest, wenn Sie sie erstellen. Ihr Datendokument enthält nur dynamische Eigenschaften. Verschachtelte Zeilen beschreiben den Inhalt ihrer übergeordneten Eigenschaft.
Statische Eigenschaften
| Name | Typ | Standard | Werte und Grenzwerte | Beschreibung |
|---|---|---|---|---|
title | string | "Sales pulse" | maxLength: 40 | |
currency | string | "USD" | maxLength: 3 | ISO 4217-Code; der Feed hat Vorrang. |
rows | integer | 5 | Minimum: 1; Maximum: 8 | Zeilen in jeder Liste. |
staleMinutes | integer | 15 | Minimum: 1; Maximum: 1440 | Ein Feed, der älter ist als dieser Wert, zeigt an, wie lange die letzte Aktualisierung zurückliegt. |
backgroundColor | String, Null | null | Muster: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | Überschreibt den Kartenhintergrund und die Platte mit einer flachen, CSS-geordneten Farbe. #RRGGBBAA gibt die Deckkraft an. Hintergrund none hat Vorrang. |
textColor | String, Null | null | Muster: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | Überschreibt die Haupt- und Sekundärtextfarben. Akzent- und semantische Statusfarben behalten ihre Funktion. |
Dynamische Eigenschaften
| Name | Typ | Standard | Werte und Grenzwerte | Beschreibung |
|---|---|---|---|---|
store | string | "" | maxLength: 60 | Das Geschäft, das die Zahlen beschreibt; die Gewinne des Feeds. |
revenue | Zahl, Null | null | Minimum: 0; Maximum: 1000000000000 | Bisheriger Umsatz heute. |
orders | Integer, null | null | Minimum: 0; Maximum: 100000000 | Bestellungen bisher heute. |
goal | Zahl, Null | null | Minimum: 0; Maximum: 1000000000000 | Umsatzziel für heute; leer zeigt kein Ziel. |
yesterdayRevenue | Zahl, Null | null | Minimum: 0; Maximum: 1000000000000 | Umsatz zum gleichen Zeitpunkt gestern; leer zeigt keinen Vergleich. |
hourly | array | [] | maxItems: 24 | Umsatz für jede Stunde des heutigen Tages in der Zone des Bildschirms, Mitternacht zuerst. |
cities | array | [] | maxItems: 20 | Umsatz nach Stadt, dasselbe Dokument wie der screenrig.sales/v1-Feed cities. |
cities[].name | string | minLength: 1; maxLength: 60; Pflichtfeld | Eine Stadt oder Region. | |
cities[].revenue | number | Minimum: 0; Maximum: 1000000000; Pflichtfeld | Umsatz heute aus der Stadt. | |
recent | array | [] | maxItems: 20 | Die neuesten Bestellungen, dasselbe Dokument wie der Feed recent. |
recent[].at | string | minLength: 1; maxLength: 40; Pflichtfeld | Wann die Bestellung aufgegeben wurde, ein ISO-8601-Zeitpunkt. | |
recent[].amount | number | Minimum: 0; Maximum: 1000000000; Pflichtfeld | Die Gesamtsumme der Bestellung. | |
recent[].city | string | "" | maxLength: 60 | Wohin es geliefert oder platziert wurde; niemals ein Kunde. |
Canvas-Beispiel
Speichern Sie die statischen Eigenschaften als params.json und erstellen Sie die Karte. Das Ergebnis enthält ihre crd_ ID.
{
"theme": "neomustard"
}
screenrig card create --type sales-pulse --major 1 --file params.json
Fügen Sie diesen Eintrag den primitives einer Playlist-Seite hinzu, mit dieser ID anstelle der Beispiel-ID. Veröffentlichen Sie die Playlist und weisen Sie einen Bildschirm zu.
{
"id": "sales-pulse",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
Live-Daten schreiben
Schreiben Sie das Dokument nach dem Erstellen in die Karte und ersetzen Sie es dann, um den Bildschirm ohne erneute Veröffentlichung zu aktualisieren. Die Karte prüft jeden Schreibvorgang gegen ihre dynamischen Eigenschaften und lehnt ein Dokument ab, das sie nicht akzeptiert. Verwenden Sie dasselbe Projekt wie die Playlist.
Speichern Sie das Dokument als card-data.json. Die CLI liest das Dokument selbst, ohne Wrapper:
{
"store": "",
"revenue": null,
"orders": null,
"goal": null,
"yesterdayRevenue": null,
"hourly": [],
"cities": [],
"recent": []
}
screenrig card data put crd_01EXAMPLECARD000000000 --file card-data.json
Oder rufen Sie die API direkt auf. Die API verpackt dasselbe Dokument in ein document-Feld. Ein Agent-Token benennt bereits sein Projekt, daher wird kein Projekt-Header gesendet; wenn Sie ScreenRig-Project senden, muss es zum Token-Projekt passen. Stellen Sie Ihre API-Autorisierung über die Umgebung bereit; siehe API-Authentifizierung.
curl --request PUT "https://api.screenrig.ai/api/cards/crd_01EXAMPLECARD000000000/data" \
--header "Authorization: Bearer $SCREENRIG_TOKEN" \
--header "Content-Type: application/json" \
--data '{"document":{"store":"","revenue":null,"orders":null,"goal":null,"yesterdayRevenue":null,"hourly":[],"cities":[],"recent":[]}}'