Tarjeta en vivo
Categoría: Escuelas. Etiquetas: Escuelas y campus, Gráficos y medidores, Números y métricas.
Diseños
Esta tarjeta de pantalla completa llena toda la pantalla en modo horizontal o vertical y no se coloca como esquina, chip o tira.
Diseños: completo. Formularios: horizontal, vertical.
Diseños, temas y publicación de tarjetas. Explorar las tarjetas.
Datos y privacidad
Esta tarjeta usa sus propiedades configuradas y datos en vivo de la tarjeta.
Solo cuenta, nunca nombres.
Propiedades
Para tema, fondo, acento y posición, consulte Propiedades comunes.
Establezca las propiedades estáticas en los params de la tarjeta al crearla. Su documento de datos solo contiene propiedades dinámicas. Las filas anidadas describen el contenido de su propiedad principal.
Propiedades estáticas
| Nombre | Tipo | Predeterminado | Valores y límites | Descripción |
|---|---|---|---|---|
goal | integer | 95 | mínimo: 1; máximo: 100 | El porcentaje de asistencia que una clase o la escuela alcanza para contar como en camino. |
showDate | boolean | true | ||
hour12 | boolean | false | ||
timeZone | cadena, nulo | null | ||
backgroundColor | cadena, nulo | null | patrón: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | Sobrescribe el fondo y la placa de la tarjeta con un color plano ordenado por CSS. #RRGGBBAA suministra opacidad. background none tiene prioridad. |
textColor | cadena, nulo | null | patrón: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | Sobrescribe los colores de texto principal y secundario. Los colores de acento y estado semántico mantienen sus roles. |
Propiedades dinámicas
| Nombre | Tipo | Predeterminado | Valores y límites | Descripción |
|---|---|---|---|---|
title | string | "Attendance today" | maxLength: 40 | |
classes | array | [] | minItems: 0; maxItems: 16 | Asistencia de hoy por clase: cuántos están presentes de los inscritos. Una clase que no ha reportado aún no incluye presentes. Solo conteos, nunca nombres. |
classes[].name | string | minLength: 1; maxLength: 28; Requerido | ||
classes[].enrolled | integer | mínimo: 1; máximo: 9999; Requerido | ||
classes[].present | integer | mínimo: 0; máximo: 9999 | Aquí hoy. Ausente: la clase aún no ha reportado. | |
classes[].streak | integer | 0 | mínimo: 0; máximo: 999 | Días consecutivos en o por encima de la meta. |
classes[].reportedAt | string | "" | maxLength: 40 | El instante en que cambió por última vez el conteo de esta clase, ISO 8601. Primetime reproduce el momento del 100 por ciento de una clase desde él. |
classes[].prevPresent | integer | mínimo: 0; máximo: 9999 | Aquí antes del cambio; el anillo del momento se llena desde él. | |
schoolStreak | integer | 0 | mínimo: 0; máximo: 999 | Días consecutivos en que toda la escuela estuvo en o por encima de la meta. |
takenAt | string | "" | maxLength: 40 | Instante ISO 8601 en que se tomó asistencia. Vacío muestra sin hora. |
schoolMetAt | string | "" | maxLength: 40 | El instante en que toda la escuela alcanzó su meta, ISO 8601. Primetime reproduce su momento META ALCANZADA desde él, en todas las pantallas a la vez. |
Ejemplo de lienzo
Guarde las propiedades estáticas como params.json y cree la tarjeta. El resultado incluye su id crd_.
{
"theme": "neomustard"
}
screenrig card create --type attendance --major 1 --file params.json
Agregue este elemento a los primitives de una página de la lista de reproducción, con ese id en lugar del del ejemplo. Publique la lista de reproducción y asigne una pantalla.
{
"id": "attendance",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
Escribir datos en vivo
Escriba el documento en la tarjeta después de crearla y luego reemplácelo para actualizar la pantalla sin republicar. La tarjeta verifica cada escritura contra sus propiedades dinámicas y rechaza un documento que no acepta. Use el mismo proyecto que la lista de reproducción.
Guarde el documento como card-data.json. La CLI lee el documento en sí, sin envoltorio:
{
"title": "Attendance today",
"classes": [],
"schoolStreak": 0,
"takenAt": "",
"schoolMetAt": ""
}
screenrig card data put crd_01EXAMPLECARD000000000 --file card-data.json
O llame a la API directamente. La API envuelve el mismo documento en un campo document. Un token de agente ya nombra su proyecto, por lo que no se envía encabezado de proyecto; si envía ScreenRig-Project, debe coincidir con el proyecto del token. Proporcione su autorización API a través del entorno; vea Autenticación 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":""}}'