Carte en direct
Catégorie : Écoles. Étiquettes : Écoles et campus, Classements et positions, Graphiques et jauges, Reconnaissance.
Mises en page
Cette carte plein écran occupe tout l’écran en mode paysage ou portrait et n’est pas placée en coin, puce ou bande.
Mises en page : pleine. Formes : paysage, portrait.
Mises en page, thèmes et publication des cartes. Parcourir les cartes.
Données et confidentialité
Cette carte utilise ses propriétés configurées et les données de carte en direct.
Un prix nomme une maison, jamais un étudiant.
Propriétés
Pour le thème, l’arrière-plan, l’accent et la position, voir Propriétés communes.
Définissez les propriétés statiques dans les params de la carte lorsque vous la créez. Son document de données ne contient que des propriétés dynamiques. Les lignes imbriquées décrivent le contenu de leur propriété parente.
Propriétés statiques
| Nom | Type | Par défaut | Valeurs et limites | Description |
|---|---|---|---|---|
title | string | "House points" | maxLength : 40 | |
awardCount | integer | 5 | minimum : 1 ; maximum : 8 | Combien de récompenses récentes la mise en page complète liste. |
hour12 | boolean | true | ||
backgroundColor | chaîne, nul | null | motif : "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | Remplace le fond et la plaque de la carte par une couleur plate ordonnée en CSS. #RRGGBBAA fournit l’opacité. background none a la priorité. |
textColor | chaîne, nul | null | motif : "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | Remplace les couleurs du texte principal et secondaire. Les couleurs d’accentuation et de statut sémantique conservent leur rôle. |
Propriétés dynamiques
| Nom | Type | Par défaut | Valeurs et limites | Description |
|---|---|---|---|---|
houses | array | [] | minItems : 0 ; maxItems : 8 | Les maisons et leurs totaux de points. Le rang, la hauteur des barres et le leader proviennent des totaux. |
houses[].name | string | minLength : 1 ; maxLength : 24 ; Obligatoire | ||
houses[].points | integer | minimum : 0 ; maximum : 999999 ; Obligatoire | ||
houses[].color | string | motif : "^#[0-9A-Fa-f]{6}$" | La couleur de la maison en #RRGGBB. Absente, la maison prend une couleur du thème. | |
awards | array | [] | minItems : 0 ; maxItems : 40 | Récompenses récentes, de la plus récente à la plus ancienne. Une récompense nomme une maison, jamais un élève. |
awards[].house | string | minLength : 1 ; maxLength : 24 ; Obligatoire | Un nom de maison parmi les maisons. | |
awards[].points | integer | minimum : 1 ; maximum : 999 ; Obligatoire | ||
awards[].reason | string | "" | maxLength : 80 | Pourquoi les points ont été donnés, par exemple Aider un nouvel ami. |
awards[].at | string | "" | maxLength : 40 | Instant ISO 8601 de la récompense. |
Exemple de canevas
Enregistrez les propriétés statiques comme params.json et créez la carte. Le résultat contient son identifiant crd_.
{
"theme": "neomustard"
}
screenrig card create --type house-points --major 1 --file params.json
Ajoutez cet élément aux primitives d’une page de liste de lecture, en remplaçant l’identifiant de l’exemple par celui de votre carte. Publiez la liste de lecture et assignez un écran.
{
"id": "house-points",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
Écrire des données en direct
Écrivez le document dans la carte après l’avoir créée, puis remplacez-le pour mettre à jour l’écran sans republier. La carte vérifie chaque écriture par rapport à ses propriétés dynamiques et refuse un document qu’elle rejette. Utilisez le même projet que la liste de lecture.
Enregistrez le document sous card-data.json. La CLI lit le document lui-même, sans enveloppe :
{
"houses": [],
"awards": []
}
screenrig card data put crd_01EXAMPLECARD000000000 --file card-data.json
Ou appelez directement l’API. L’API enveloppe le même document dans un champ document. Un jeton agent nomme déjà son projet, donc aucun en-tête de projet n’est envoyé ; si vous envoyez ScreenRig-Project, il doit correspondre au projet du jeton. Fournissez votre autorisation API via l’environnement ; voir Authentification API.
curl --request PUT "https://api.screenrig.ai/api/cards/crd_01EXAMPLECARD000000000/data" \
--header "Authorization: Bearer $SCREENRIG_TOKEN" \
--header "Content-Type: application/json" \
--data '{"document":{"houses":[],"awards":[]}}'