Carte de progression pour écrans d’affichage numérique

Un grand montant ou pourcentage s’affiche à côté d’un anneau, d’une barre ou d’un thermomètre de collecte de fonds, avec ce qui reste et les jours restants clairement visibles d’un coup d’œil. Il remplit tout l’écran, s’adapte à n’importe quel rectangle, 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 le titre, la valeur actuelle et l’objectif, ajoutez une date limite et des étapes, et choisissez un anneau, une barre ou un thermomètre pour un plein écran.

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, libre, centrée, large, coin, puce, bande. 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.

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	`""`	maxLength : `60`
`prefix`	string	`""`	maxLength : `3`	Avant chaque montant, par exemple $.
`unit`	string	`""`	maxLength : `12`	Après chaque quantité, par exemple kg ou « repas ».
`decimals`	integer	`0`	minimum : `0` ; maximum : `2`
`style`	string		`"ring"`, `"bar"`, `"thermometer"`	Le graphique d’un écran complet : un anneau (lorsqu’il n’est pas défini), une barre ou un thermomètre. Le centre, la bande et la puce dessinent toujours une barre. Un coin dessine le pourcentage au-dessus d’une barre, ou un anneau lorsque c’est un anneau.
`timeZone`	chaîne, nul	`null`
`hero`	string	`"amount"`	`"amount"`, `"percent"`	Le grand chiffre : le montant recueilli ou le pourcentage. L’autre est le petit.
`presence`	string	`"always"`	`"always"`, `"milestone"`, `"deadline-soon"`	jalon : la carte s’affiche pendant presenceWindow minutes après un changement qui atteint un jalon ou l’objectif. échéance-proche : seulement lorsque l’échéance est à soonDays jours ou moins.
`presenceWindow`	integer	`10`	minimum : `1` ; maximum : `1440`	Minutes pendant lesquelles la carte reste affichée après qu’un jalon ou un objectif est dépassé (jalon de présence).
`soonDays`	integer	`3`	minimum : `0` ; maximum : `60`	Jours avant la date limite à laquelle la carte apparaît (présence date limite prochaine).
`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
`value`	number		Requis
`goal`	number		minimum : `1e-06` ; Obligatoire
`deadline`	chaîne, nul	`null`		Date ou instant ISO 8601 ; les dates locales sont dans la zone.
`milestones`	array	`[]`	maxItems : `8`
`previous`	nombre, nul	`null`		La valeur avant qu’elle ne change à `changedAt` ; le remplissage va de celle-ci à la valeur actuelle.
`changedAt`	chaîne, nul	`null`		Instant ISO 8601 où la valeur a changé. En quelques secondes, la carte joue son moment : le remplissage s’exécute depuis `previous`, les jalons franchis clignotent et un objectif atteint déclenche une explosion.

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 progress --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": "progress",
  "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": 1,
  "goal": 1,
  "deadline": null,
  "milestones": [],
  "previous": null,
  "changedAt": null
}

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":1,"goal":1,"deadline":null,"milestones":[],"previous":null,"changedAt":null}}'