Live-Karte
Kategorie: Schulen. Tags: Schulen und Campus, Bestenlisten und Ranglisten, Anerkennung.
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
Diese Karte verwendet ihre konfigurierten Eigenschaften und Live-Kartendaten.
Eine Klasse ist ein Name, niemals ein Schüler.
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 |
|---|---|---|---|---|
format | string | "number" | "number", "percent", "money" | Wie Werte angezeigt werden: eine Zahl mit ihrer Einheit, ein Prozentsatz oder ein Geldbetrag. |
unit | string | "" | maxLength: 12 | Die Einheit nach einer Zahl, zum Beispiel min oder Bücher. |
currency | string | "$" | maxLength: 3 | Das Symbol vor einem Geldbetrag. |
scaleFrom | number | 0 | Minimum: 0; Maximum: 99999999 | Wo die Balken beginnen, sodass nahe Werte (Teilnahme von 94 bis 98 Prozent) noch einen Unterschied zeigen. |
showTotal | boolean | true | Zeigen Sie die Summe aller Klassen (den Durchschnitt bei Prozentangaben) und den Countdown an. | |
timeZone | String, Null | null | ||
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 |
|---|---|---|---|---|
title | string | "Class challenge" | maxLength: 40 | Die Überschrift, zum Beispiel Leseherausforderung. |
classes | array | [] | minItems: 0; maxItems: 10 | Die Klassen und ihre Werte. Rang, Balkenlängen und der Führende stammen von den Werten. Eine Klasse ist ein Name, niemals ein Schüler. |
classes[].name | string | minLength: 1; maxLength: 48; Pflichtfeld | ||
classes[].value | number | Minimum: 0; Maximum: 99999999; Pflichtfeld | ||
classes[].color | string | Muster: "^#[0-9A-Fa-f]{6}$" | Die Klassenfarbe als #RRGGBB. Fehlt sie, erhält die Klasse eine Farbe aus dem Thema. | |
classes[].prevValue | number | Minimum: 0; Maximum: 99999999 | Der Wert der Klasse vor dem letzten Update (Primetime). Bis updatedAt zeigt das Board diese; ab dann rennen die Balken zu den neuen Werten, und ein Führungswechsel ist ein Moment. | |
goal | number | 0 | Minimum: 0; Maximum: 99999999 | Das Ziel. 0 bedeutet keines. |
goalFor | string | "each" | "each", "total" | Jede: jede Klasse kämpft einzeln um das Ziel. Gesamt: die Klassen erreichen es zusammen. |
endsAt | string | "" | maxLength: 40 | ISO-8601-Zeitpunkt, zu dem die Herausforderung endet (eine Zeit ohne Offset ist die Ortszeit des Bildschirms). Leer zeigt keinen Countdown. |
updatedAt | string | "" | maxLength: 40 | ISO-8601-Zeitpunkt der letzten Punkaktualisierung, geteilt von jedem Bildschirm (Primetime). Das Rennen und ein Führungswechsel werden davon abgespielt. Leer spielt nichts ab. |
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 class-challenge --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": "class-challenge",
"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:
{
"title": "Class challenge",
"classes": [],
"goal": 0,
"goalFor": "each",
"endsAt": "",
"updatedAt": ""
}
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":{"title":"Class challenge","classes":[],"goal":0,"goalFor":"each","endsAt":"","updatedAt":""}}'