pivotick v3.0.0

---

pivotick / GraphUI / LegendOptions

Interface: LegendOptions

Definido em: interfaces/GraphUI.ts:668

UI.legend — a legenda da tela. É descritivo: relata as cores que o renderizador já resolveu e nunca atribui uma, então o consumidor continua sendo o único proprietário da coloração do nó.

As entradas vêm de key (derivado dos dados, amostras amostradas do renderizador), de entries (declarado) ou de ambos — key então fornece o predicado padrão para entradas que não carregam um.

Com nem, a legenda se fixa em render.nodeTypeAccessor (a dimensão que você já declarou para nodeStyleMap) - mas somente depois de verificar se esta dimensão é realmente a dimensão da cor: cada categoria deve resolver exatamente uma cor, deve haver pelo menos duas delas, e poucas delas o suficiente para serem categorias. Essa verificação é o que torna segura uma lenda que ninguém pediu; UI.legend: true ignora, false suprime totalmente a legenda.

Para codificar um gráfico em mais de uma dimensão por vez, passe LegendGroupOptions.

Mostrado apenas nos modos full e light.

Exemplo

UI: { legend: { key: 'type', title: 'Node type' } }

Estende

• LegendSection

Propriedades

collapsed?

optional collapsed: boolean

Definido em: interfaces/GraphUI.ts:626

Comece recolhido.

Padrão

false

Herdado de

LegendSection.collapsed

---

collapsible?

optional collapsible: boolean

Definido em: interfaces/GraphUI.ts:624

Padrão

true

Herdado de

LegendSection.collapsible

---

enabled?

optional enabled: boolean

Definido em: interfaces/GraphUI.ts:586

Padrão

true when the block is present

Herdado de

LegendSection.enabled

---

entries?

optional entries: LegendEntry[] | (graph) => LegendEntry[]

Definido em: interfaces/GraphUI.ts:622

Entradas declaradas ou uma função resolvida novamente no gráfico ativo sempre que a legenda é reconstruída (para que a lista possa seguir os dados).

Herdado de

LegendSection.entries

---

filterable?

optional filterable: boolean

Definido em: interfaces/GraphUI.ts:630

Clicar em uma entrada filtra o gráfico. false renderiza uma chave pura.

Padrão

true

Herdado de

LegendSection.filterable

---

highlightOnHover?

optional highlightOnHover: boolean

Definido em: interfaces/GraphUI.ts:637

Passar o mouse sobre uma entrada lê sua categoria na tela: os elementos que ela representa mantêm sua aparência, todo o resto escurece até que o ponteiro saia. Também funciona com a tecla filterable: false - apontar para uma categoria não exige nada do gráfico.

Padrão

true

Herdado de

LegendSection.highlightOnHover

---

id?

optional id: string

Definido em: interfaces/GraphUI.ts:605

Identidade estável: a chave de filtro da própria seção (__legend:<id>) e o campo section do evento legendToggle.

Padrão

key, senão section-<index>

Herdado de

LegendSection.id

---

key?

optional key: string

Definido em: interfaces/GraphUI.ts:617

Modo derivado: a chave de dados cujos valores distintos se tornam as entradas, cada amostra amostrada do estilo resolvido do renderizador. Leia os nós ou as bordas quando scope for 'edge'. Também fornece o predicado padrão quando entries é declarado sem um.

Herdado de

LegendSection.key

---

maxVisibleEntries?

optional maxVisibleEntries: number

Definido em: interfaces/GraphUI.ts:639

Entradas mostradas antes da rolagem da lista.

Padrão

12

Herdado de

LegendSection.maxVisibleEntries

---

position?

optional position: LegendPosition

Definido em: interfaces/GraphUI.ts:675

Em qual canto ele se encaixa. No modo full o padrão é a coluna direita, empilhada acima do minimapa — a esquerda pertence ao modo rail e seus painéis. Outros modos mantêm o canto inferior esquerdo.

Padrão

'canto inferior direito' no modo full, 'bottom-left' caso contrário

---

scope?

optional scope: LegendScope

Definido em: interfaces/GraphUI.ts:599

Em qual coleção esta seção se baseia. 'edge' lista os tipos de relação do gráfico com uma amostra line - cor do traço, traço e marcador conforme o renderizador os resolveu - e seus botões ocultam a borda layers: os nós permanecem no lugar, assim como o layout, a seleção e a câmera.

Uma seção edge filtra independentemente de UI.filter.edgeFacets declarar ou não sua chave: dada uma, ela direciona essa faceta, então o painel e a legenda são duas visualizações de um filtro; sem ele, reserva uma faceta própria.

Padrão

'node'

Herdado de

LegendSection.scope

---

showCounts?

optional showCounts: boolean

Definido em: interfaces/GraphUI.ts:628

Mostrar uma contagem de elementos por entrada.

Padrão

true

Herdado de

LegendSection.showCounts

---

title?

optional title: string

Definido em: interfaces/GraphUI.ts:610

Texto do cabeçalho, usado literalmente (para que possa ser traduzido).

Padrão

um key embelezado, senão 'Legend'

Herdado de

LegendSection.title