Carte de compteur

Une barre ou un anneau qui se remplit vers un objectif, avec sa valeur, son unité et son étiquette optionnelle.

Une barre ou un anneau simple se remplit vers son objectif, avec la valeur en grands chiffres, son unité à côté et une étiquette optionnelle, pour que la mesure soit lisible d’un coup d’œil à travers une pièce. Il remplit l’écran, se place au centre, se glisse dans un coin, s’affiche en une ligne dans un coin ou s’étire en bande le long d’un bord. Vous définissez la valeur, son objectif et une étiquette optionnelle, avec un symbole monétaire ou une unité à côté du chiffre. Vous choisissez une barre ou un anneau et les niveaux d’alerte et de danger où la couleur de remplissage change, pour des mesures où plus c’est mieux ou pire.

Carte en direct

Cette carte est dessinée dans votre navigateur par le même code que les lecteurs, avec des données d’exemple.

Catégorie : Opérations. Étiquettes : Nombres et métriques, Graphiques et jauges.

Mises en page

Cette carte principale s’adapte à toute disposition : plein écran, centre, large, coin, puce, bande ou tout rectangle libre.

Mises en page : pleine, centrée, large, coin, puce, bande. Formes : paysage, portrait, carré, bande.

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.

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

NomTypePar défautValeurs et limitesDescription
prefixstring""maxLength : 8Avant la valeur, plus petit : un symbole monétaire.
suffixstring""maxLength : 12Après la valeur, en plus petit : une unité (%, kW, GB).
stylestring"bar""bar", "ring"Une barre à travers la boîte ou un anneau avec la valeur à l’intérieur.
decimalsentier, nulnullminimum : 0 ; maximum : 4Décimales à afficher ; null affiche seulement celles nécessaires à la valeur, jusqu’à une.
groupingbooleantrueSéparez les milliers par des virgules.
tonestring"cool""success", "warm", "danger", "cool", "accent", "muted"La couleur de remplissage, une clé de palette, quand aucun seuil n’est défini.
warnAtnombre, nulnullminimum : 0 ; maximum : 1000Pourcentage de l’objectif auquel le remplissage devient chaud : en dessous quand goodWhen est activé, au-dessus quand il est désactivé.
dangerAtnombre, nulnullminimum : 0 ; maximum : 1000Pourcentage de l’objectif auquel le remplissage devient dangereux : en dessous quand goodWhen est activé, au-dessus quand il est désactivé.
goodWhenstring"up""up", "down"Si une valeur plus haute est meilleure (batterie, ventes) ou pire (utilisation disque, longueur de file).
backgroundColorchaîne, nulnullmotif : "^#[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é.
textColorchaîne, nulnullmotif : "^#[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

NomTypePar défautValeurs et limitesDescription
valuenombre, nulnullminimum : -1000000000000000.0 ; maximum : 1000000000000000.0La valeur mesurée. null affiche un tiret et une barre vide.
goalnumber100maximum : 1000000000000000.0 ; exclusiveMinimum : 0Par rapport à quoi la valeur est mesurée : la barre ou l’anneau complet.
previousnombre, nulnullminimum : -1000000000000000.0 ; maximum : 1000000000000000.0La valeur avant le dernier changement. Avec changedAt, chaque écran compte et remplit ensemble de celle-ci à la nouvelle valeur.
changedAtchaîne, nulnullmaxLength : 40Instant ISO 8601 où la valeur a changé.
labelstring""maxLength : 40Un nom court pour la mesure, dans l’étiquette du thème.

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 meter --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": "meter",
  "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 :

{
  "value": null,
  "goal": 100,
  "previous": null,
  "changedAt": null,
  "label": ""
}
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":{"value":null,"goal":100,"previous":null,"changedAt":null,"label":""}}'