pivotick v3.0.0

---

pivotick / GraphUI / LegendOptions

Interface: LegendOptions

Défini dans : interfaces/GraphUI.ts:668

UI.legend — la légende de la toile. Il est descriptif : il rapporte les couleurs que le moteur de rendu a déjà résolues et n'en attribue jamais, de sorte que le consommateur reste le seul propriétaire de la coloration des nœuds.

Les entrées proviennent de key (dérivées des données, échantillons échantillonnés à partir du moteur de rendu), de entries (déclaré) ou des deux — key fournit ensuite le prédicat par défaut pour les entrées qui n'en portent pas.

Avec ni, la légende se clède sur render.nodeTypeAccessor (la dimension que vous avez déjà déclarée pour nodeStyleMap) — mais seulement après avoir vérifié que cette dimension est bien la dimension de couleur : chaque catégorie doit se résoudre à exactement une couleur, il doit y en avoir au moins deux, et suffisamment d'entre elles pour être des catégories. Ce contrôle est ce qui rend une légende dont personne n’a demandé la sécurité ; UI.legend: true l'ignore, false supprime entièrement la légende.

Pour saisir un graphique sur plusieurs dimensions à la fois, transmettez plutôt LegendGroupOptions.

Affiché dans les modes full et light uniquement.

Exemple

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

Prolonge

• LegendSection

Propriétés

collapsed?

optional collapsed: boolean

Défini dans : interfaces/GraphUI.ts:626

Début effondré.

Valeur par défaut

false

Hérité de

LegendSection.collapsed

---

collapsible?

optional collapsible: boolean

Défini dans : interfaces/GraphUI.ts:624

Valeur par défaut

true

Hérité de

LegendSection.collapsible

---

enabled?

optional enabled: boolean

Défini dans : interfaces/GraphUI.ts:586

Valeur par défaut

true when the block is present

Hérité de

LegendSection.enabled

---

entries?

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

Défini dans : interfaces/GraphUI.ts:622

Entrées déclarées, ou fonction re-résolue par rapport au graphique en direct à chaque fois que la légende est reconstruite (afin que la liste puisse suivre les données).

Hérité de

LegendSection.entries

---

filterable?

optional filterable: boolean

Défini dans : interfaces/GraphUI.ts:630

Cliquer sur une entrée filtre le graphique. false restitue une clé pure.

Valeur par défaut

true

Hérité de

LegendSection.filterable

---

highlightOnHover?

optional highlightOnHover: boolean

Défini dans : interfaces/GraphUI.ts:637

Le survol d'une entrée lit sa catégorie hors du canevas : les éléments qu'elle représente conservent leur apparence, tout le reste s'assombrit jusqu'à ce que le pointeur parte. Fonctionne également sur une touche filterable: false — pointer sur une catégorie ne demande rien au graphique.

Valeur par défaut

true

Hérité de

LegendSection.highlightOnHover

---

id?

optional id: string

Défini dans : interfaces/GraphUI.ts:605

Identité stable : la propre clé de filtre de la section (__legend:<id>) et le champ section de l'événement legendToggle.

Valeur par défaut

key, sinon section-<index>

Hérité de

LegendSection.id

---

key?

optional key: string

Défini dans : interfaces/GraphUI.ts:617

Mode dérivé : la clé de données dont les valeurs distinctes deviennent les entrées, chaque échantillon étant échantillonné à partir du style résolu du moteur de rendu. Lisez les nœuds ou les bords lorsque scope est 'edge'. Fournit également le prédicat par défaut lorsque entries sont déclarés sans un.

Hérité de

LegendSection.key

---

maxVisibleEntries?

optional maxVisibleEntries: number

Défini dans : interfaces/GraphUI.ts:639

Entrées affichées avant le défilement de la liste.

Valeur par défaut

12

Hérité de

LegendSection.maxVisibleEntries

---

position?

optional position: LegendPosition

Défini dans : interfaces/GraphUI.ts:675

Dans quel coin il s'ancre. En mode full, la colonne par défaut est la colonne de droite, empilée au-dessus de la mini-carte — celle de gauche appartient au rail de mode et à ses panneaux. Les autres modes conservent le coin inférieur gauche.

Valeur par défaut

'en bas à droite' en mode full, 'bottom-left' sinon

---

scope?

optional scope: LegendScope

Défini dans : interfaces/GraphUI.ts:599

Sur quelle collection cette section porte-t-elle. 'edge' répertorie les types de relations du graphique avec un échantillon line — couleur du trait, tiret et marqueur tels que le moteur de rendu les a résolus — et ses bascules masquent le bord layers : les nœuds restent en place, tout comme la mise en page, la sélection et la caméra.

Une section edge filtre si UI.filter.edgeFacets déclare ou non sa clé : étant donné celle-ci, elle pilote cette facette, donc le panneau et la légende sont deux vues d'un même filtre ; sans cela, il réserve une facette qui lui est propre.

Valeur par défaut

'node'

Hérité de

LegendSection.scope

---

showCounts?

optional showCounts: boolean

Défini dans : interfaces/GraphUI.ts:628

Afficher un nombre d'éléments par entrée.

Valeur par défaut

true

Hérité de

LegendSection.showCounts

---

title?

optional title: string

Défini dans : interfaces/GraphUI.ts:610

Texte d'en-tête, utilisé textuellement (afin qu'il puisse être traduit).

Valeur par défaut

un key joli, sinon 'Legend'

Hérité de

LegendSection.title