Cartão do medidor

Uma barra ou anel que se preenche em direção a uma meta, com seu valor, unidade e rótulo opcional.

Uma barra ou anel simples preenche até sua meta, com o valor em números grandes, sua unidade ao lado e um rótulo opcional, para que a medida seja lida de relance de longe. Ela preenche a tela, fica no meio, se encaixa em um canto, corre como uma linha em um canto ou se estende como uma faixa ao longo de uma borda. Você define o valor, sua meta e um rótulo opcional, com um símbolo de moeda ou unidade ao lado do número. Você escolhe uma barra ou um anel e os níveis de aviso e perigo onde a cor do preenchimento muda, para medidas onde maior é melhor ou pior.

Cartão ao vivo

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

Categoria: Operações. Tags: Números e métricas, Gráficos e medidores.

Layouts

Este cartão principal se encaixa em qualquer layout: tela cheia, centro, largo, canto, chip, faixa ou qualquer retângulo livre.

Layouts: cheio, centro, largo, canto, chip, faixa. Formas: paisagem, retrato, quadrado, faixa.

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.

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

NomeTipoPadrãoValores e limitesDescrição
prefixstring""maxLength: 8Antes do valor, menor: um símbolo de moeda.
suffixstring""maxLength: 12Após o valor, menor: uma unidade (%, kW, GB).
stylestring"bar""bar", "ring"Uma barra atravessando a caixa ou um anel com o valor dentro.
decimalsinteger, nullnullmínimo: 0; máximo: 4Decimais a mostrar; nulo mostra apenas os necessários, até um.
groupingbooleantrueSepare milhares com vírgulas.
tonestring"cool""success", "warm", "danger", "cool", "accent", "muted"A cor de preenchimento, uma chave da paleta, quando nenhum limite é definido.
warnAtnúmero, nulonullmínimo: 0; máximo: 1000Porcentagem da meta na qual o preenchimento vira alerta: abaixo dela quando goodWhen está ativo, acima dela quando está inativo.
dangerAtnúmero, nulonullmínimo: 0; máximo: 1000Porcentagem da meta na qual o preenchimento vira perigo: abaixo dela quando goodWhen está ativo, acima dela quando está inativo.
goodWhenstring"up""up", "down"Se um valor maior é melhor (bateria, vendas) ou pior (uso de disco, tamanho da fila).
backgroundColorstring, nulonullpadrã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.
textColorstring, nulonullpadrã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

NomeTipoPadrãoValores e limitesDescrição
valuenúmero, nulonullmínimo: -1000000000000000.0; máximo: 1000000000000000.0O valor medido. null mostra um traço e uma barra vazia.
goalnumber100máximo: 1000000000000000.0; exclusiveMinimum: 0Contra o que o valor é medido: a barra ou anel completo.
previousnúmero, nulonullmínimo: -1000000000000000.0; máximo: 1000000000000000.0O valor antes da última mudança. Com changedAt, cada tela conta e preenche junto dele até o novo valor.
changedAtstring, nulonullmaxLength: 40Instante ISO 8601 em que o valor mudou.
labelstring""maxLength: 40Um nome curto para a medida, na tag do tema.

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

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