Carte en direct
Catégorie : Écoles. Étiquettes : Écoles et campus, Graphiques et jauges, Nombres et mesures.
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.
Comptages seulement, jamais de noms.
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 |
|---|---|---|---|---|
goal | integer | 95 | minimum : 1 ; maximum : 100 | Le pourcentage de présence qu’une classe ou l’école doit atteindre pour être considéré comme sur la bonne voie. |
showDate | boolean | true | ||
hour12 | boolean | false | ||
timeZone | chaîne, nul | null | ||
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 |
|---|---|---|---|---|
title | string | "Attendance today" | maxLength : 40 | |
classes | array | [] | minItems : 0 ; maxItems : 16 | Présence d’aujourd’hui par classe : combien sont présents sur le nombre d’inscrits. Une classe qui n’a pas encore rapporté ne compte pas les présents. Comptages seulement, jamais de noms. |
classes[].name | string | minLength : 1 ; maxLength : 28 ; Obligatoire | ||
classes[].enrolled | integer | minimum : 1 ; maximum : 9999 ; Obligatoire | ||
classes[].present | integer | minimum : 0 ; maximum : 9999 | Présent aujourd’hui. Absent : la classe n’a pas encore rapporté. | |
classes[].streak | integer | 0 | minimum : 0 ; maximum : 999 | Jours consécutifs au-dessus ou à l’objectif. |
classes[].reportedAt | string | "" | maxLength : 40 | L’instant où le compte de cette classe a changé pour la dernière fois, ISO 8601. Primetime joue un moment de 100 % pour une classe à partir de celui-ci. |
classes[].prevPresent | integer | minimum : 0 ; maximum : 9999 | Ici avant le changement ; l’anneau du moment se remplit à partir de là. | |
schoolStreak | integer | 0 | minimum : 0 ; maximum : 999 | Jours consécutifs où toute l’école était au-dessus ou à l’objectif. |
takenAt | string | "" | maxLength : 40 | Instant ISO 8601 où la présence a été prise. Vide affiche aucune heure. |
schoolMetAt | string | "" | maxLength : 40 | L’instant où toute l’école a atteint son objectif, ISO 8601. Primetime joue son moment OBJECTIF ATTEINT à partir de celui-ci, sur tous les écrans simultanément. |
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 attendance --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": "attendance",
"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 :
{
"title": "Attendance today",
"classes": [],
"schoolStreak": 0,
"takenAt": "",
"schoolMetAt": ""
}
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":{"title":"Attendance today","classes":[],"schoolStreak":0,"takenAt":"","schoolMetAt":""}}'