Cartão de desafio de classe para telas de sinalização digital

Cartão ao vivo

Este cartão é desenhado no seu navegador pelo mesmo código que os Players executam, com dados de exemplo.

Categoria: Escolas. Tags: Escolas e campi, Classificações e posições, Reconhecimento.

Layouts

Este cartão em tela cheia preenche toda a tela em paisagem ou retrato e não é colocado como canto, chip ou faixa.

Layouts: cheio. Formas: paisagem, retrato.

Layouts, temas e publicação de cartões. Veja os cartões.

Dados e privacidade

Este cartão usa suas propriedades configuradas e dados ao vivo do cartão.

Uma turma é um nome, nunca um aluno.

Propriedades

Para tema, fundo, destaque e posição, veja Propriedades comuns.

Defina as propriedades estáticas nos params do cartão ao criá-lo. O documento de dados dele contém apenas propriedades dinâmicas. Linhas aninhadas descrevem o conteúdo da propriedade pai.

Propriedades estáticas

Nome	Tipo	Padrão	Valores e limites	Descrição
`format`	string	`"number"`	`"number"`, `"percent"`, `"money"`	Como os valores aparecem: um número com sua unidade, uma porcentagem ou uma quantia em dinheiro.
`unit`	string	`""`	maxLength: `12`	A unidade após um número, por exemplo min ou livros.
`currency`	string	`"$"`	maxLength: `3`	O símbolo antes de uma quantia em dinheiro.
`scaleFrom`	number	`0`	mínimo: `0`; máximo: `99999999`	Onde as barras começam, para que valores próximos (frequência de 94 a 98 por cento) ainda mostrem uma diferença.
`showTotal`	boolean	`true`		Mostre o total de todas as classes (a média para percentuais) e a contagem regressiva.
`timeZone`	string, nulo	`null`
`backgroundColor`	string, nulo	`null`	padrão: `"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"`	Substitui o fundo e a placa do cartão por uma cor plana ordenada por CSS. #RRGGBBAA fornece opacidade. background none tem precedência.
`textColor`	string, nulo	`null`	padrão: `"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"`	Substitui as cores do texto principal e secundário. As cores de destaque e status semântico mantêm seus papéis.

Propriedades dinâmicas

Nome	Tipo	Padrão	Valores e limites	Descrição
`title`	string	`"Class challenge"`	maxLength: `40`	O cabeçalho, por exemplo Desafio de leitura.
`classes`	array	`[]`	minItems: `0`; maxItems: `10`	As classes e seus valores. Classificação, comprimento das barras e o líder vêm dos valores. Uma classe é um nome, nunca um estudante.
`classes[].name`	string		minLength: `1`; maxLength: `48`; Obrigatório
`classes[].value`	number		mínimo: `0`; máximo: `99999999`; Obrigatório
`classes[].color`	string		padrão: `"^#[0-9A-Fa-f]{6}$"`	A cor da classe como #RRGGBB. Ausente, a classe recebe uma cor do tema.
`classes[].prevValue`	number		mínimo: `0`; máximo: `99999999`	O valor da classe antes da última atualização (Primetime). Até updatedAt o quadro mostra estes; a partir dele as barras correm para os novos valores e uma mudança de líder é um momento.
`goal`	number	`0`	mínimo: `0`; máximo: `99999999`	O alvo. 0 não define nenhum.
`goalFor`	string	`"each"`	`"each"`, `"total"`	each: cada classe corre para o objetivo. total: as classes alcançam juntas.
`endsAt`	string	`""`	maxLength: `40`	Instante ISO 8601 em que o desafio termina (um horário sem deslocamento é o horário local da zona da tela). Vazio não mostra contagem regressiva.
`updatedAt`	string	`""`	maxLength: `40`	Instante ISO 8601 da última atualização da pontuação, compartilhado por todas as telas (Primetime). A corrida e a mudança de líder são reproduzidas a partir dele. Vazio não reproduz nada.

Exemplo de tela

Salve as propriedades estáticas como params.json e crie o cartão. O resultado traz o id crd_ dele.

{
  "theme": "neomustard"
}

screenrig card create --type class-challenge --major 1 --file params.json

Adicione este item aos primitives de uma página da playlist, com esse id no lugar do id do exemplo. Publique a playlist e atribua uma tela.

{
  "id": "class-challenge",
  "primitive": "card",
  "card": "crd_01EXAMPLECARD000000000",
  "layout": "full",
  "content_fit": "fill"
}

Escrever dados ao vivo

Escreva o documento no cartão depois de criá-lo e depois substitua-o para atualizar a tela sem republicar. O cartão verifica cada gravação contra suas propriedades dinâmicas e recusa um documento que ele rejeita. Use o mesmo projeto da playlist.

Salve o documento como card-data.json. O CLI lê o documento em si, sem invólucro:

{
  "title": "Class challenge",
  "classes": [],
  "goal": 0,
  "goalFor": "each",
  "endsAt": "",
  "updatedAt": ""
}

screenrig card data put crd_01EXAMPLECARD000000000 --file card-data.json

Ou chame a API diretamente. A API envolve o mesmo documento em um campo document. Um token de agente já nomeia seu projeto, então nenhum cabeçalho de projeto é enviado; se você enviar ScreenRig-Project, ele deve corresponder ao projeto do token. Forneça sua autorização de API pelo ambiente; veja Autenticação da 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":""}}'