Skip to content

Contrato do componente ​

Tipo
Referência
Para
Desenvolvedor
Liberação
Em beta

O contrato (manifest) de um componente paramétrico declara os campos que quem monta o Dashboard preenche e a aparência fixa do componente. O código lê cada valor em config.<key>. No editor, ele fica em Componente › Campos, campo a campo ou em Editar como JSON.

json
{
  "fields": [
    { "key": "titulo", "type": "text", "label": "Título", "default": "Meta do mês" },
    { "key": "cor", "type": "color", "label": "Cor principal", "group": "Aparência" },
    { "key": "valor", "type": "column-binding", "label": "Coluna de valor", "filter": "Measure" },
    { "key": "meta", "type": "number", "label": "Meta", "min": 0, "step": 100, "expression": true },
    { "key": "modo", "type": "select", "label": "Modo", "options": [
      { "value": "compacto", "label": "Compacto" },
      { "value": "detalhado", "label": "Detalhado" }
    ] }
  ],
  "display": { "transparentBackground": false, "autoGrow": false }
}

Propriedades de todo campo ​

PropriedadeObrigatóriaO que é
keySimA chave em config. Única no contrato
typeSimUm dos tipos abaixo
labelSimO nome que quem configura vê
defaultNãoO valor quando ninguém preenche
helpNãoTexto de ajuda abaixo do campo
groupNãoJunta campos do mesmo grupo na tela

Contrato sem fields, com campo sem key, chave repetida, sem label ou com tipo desconhecido é recusado ("Manifest inválido").

Um column-binding entra direto numa consulta: app.query('valor', { title: 'Valor', columns: { valor: config.valor } }).

Tipos de campo ​

typeO valor em configPropriedades própriasPadrão sem default
column-bindingTexto de coluna, como '[Vendas]."VALOR":SUM'. Lista, com multiplemultiple, filter (Measure, Dimension, Date ou All)"" ou []
textTexto""
textareaTexto longo""
numberNúmeromin, max, stepmin ou 0
rangeNúmero, num controle deslizantemin, max, stepmin ou 0
colorCor em hex, como #4F46E5#000000
booleantrue ou falsefalse
selectO value da opção escolhidaoptions ([{ value, label }]), forceKind (segmented ou list)A primeira opção
dateData""
iconNome Iconify, como fa:star""
number-formatUm formato de número do Lumo, para app.formatValue"default"
svelte_modalO objeto que a tela do autor devolveeditorComponent (o arquivo da tela), buttonLabel{}

O componente nunca recebe undefined num campo do contrato: vale o que foi preenchido, senão o default, senão o padrão da tabela.

Fórmula por campo ​

Os tipos color, number, text, textarea, range e number-format aceitam "expression": true (no editor, Aceita fórmula). Quem configura ganha Usar fórmula e escreve uma expressão em JavaScript no lugar do valor fixo.

O componente recebe a fórmula sem avaliar, em duas chaves a mais por campo, <key>Expression (o texto) e <key>UsesExpression, e avalia ele mesmo:

javascript
const meta = config.metaUsesExpression
  ? (await app.evalExpression(config.metaExpression, { config })) ?? config.meta
  : config.meta;

A fórmula é o corpo de uma função assíncrona, como a regra em código: usa return, e o segundo argumento chega em this. Em erro, app.evalExpression devolve undefined e o ?? cai no valor fixo.

Aparência ​

display vale para todas as instâncias, e quem configura não muda. No editor, é Componente › Aparência do widget.

PropriedadeEfeito
transparentBackgroundGráfico com fundo transparente: tira o fundo e a borda do cartão
autoGrowCrescer com o conteúdo. Trava a mesma opção da instância

Relacionado ​