Tarjeta en vivo
Categoría: Escuelas. Etiquetas: Escuelas y campus, Clasificaciones y posiciones, Reconocimiento.
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.
Una clase es un nombre, nunca un estudiante.
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 |
|---|---|---|---|---|
format | string | "number" | "number", "percent", "money" | Cómo se muestran los valores: un número con su unidad, un porcentaje o una cantidad de dinero. |
unit | string | "" | maxLength: 12 | La unidad después de un número, por ejemplo min o libros. |
currency | string | "$" | maxLength: 3 | El símbolo antes de una cantidad de dinero. |
scaleFrom | number | 0 | mínimo: 0; máximo: 99999999 | Dónde comienzan las barras, para que valores cercanos (asistencia del 94 al 98 por ciento) aún muestren una diferencia. |
showTotal | boolean | true | Muestre el total de todas las clases (el promedio para porcentajes) y la cuenta regresiva. | |
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 | "Class challenge" | maxLength: 40 | El encabezado, por ejemplo Desafío de lectura. |
classes | array | [] | minItems: 0; maxItems: 10 | Las clases y sus valores. El rango, la longitud de las barras y el líder provienen de los valores. Una clase es un nombre, nunca un estudiante. |
classes[].name | string | minLength: 1; maxLength: 48; Requerido | ||
classes[].value | number | mínimo: 0; máximo: 99999999; Requerido | ||
classes[].color | string | patrón: "^#[0-9A-Fa-f]{6}$" | El color de la clase como #RRGGBB. Si falta, la clase toma un color del tema. | |
classes[].prevValue | number | mínimo: 0; máximo: 99999999 | El valor de la clase antes de la última actualización (Primetime). Hasta updatedAt el tablero muestra estos; a partir de él las barras corren hacia los nuevos valores y un cambio de líder es un momento. | |
goal | number | 0 | mínimo: 0; máximo: 99999999 | El objetivo. 0 no establece ninguno. |
goalFor | string | "each" | "each", "total" | cada: cada clase corre hacia la meta. total: las clases llegan juntas. |
endsAt | string | "" | maxLength: 40 | Instante ISO 8601 en que termina el desafío (una hora sin desplazamiento es la hora local en la zona de la pantalla). Vacío no muestra cuenta regresiva. |
updatedAt | string | "" | maxLength: 40 | Instante ISO 8601 de la última actualización de puntuación, compartido por cada pantalla (Primetime). La carrera y un cambio de líder se reproducen desde este instante. Vacío no reproduce nada. |
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 class-challenge --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": "class-challenge",
"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": "Class challenge",
"classes": [],
"goal": 0,
"goalFor": "each",
"endsAt": "",
"updatedAt": ""
}
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":"Class challenge","classes":[],"goal":0,"goalFor":"each","endsAt":"","updatedAt":""}}'