pivotick v3.0.0

---

Pivotick / GraphUI / LegendOptions

Interface: LegendOptions

Definiert in: interfaces/GraphUI.ts:668

UI.legend – die Canvas-Legende. Es ist beschreibend: Es meldet die Farben, die der Renderer bereits aufgelöst hat, und weist niemals eine zu, sodass der Verbraucher der alleinige Eigentümer der Knotenfärbung bleibt.

Einträge kommen von key (abgeleitet von den Daten, vom Renderer abgetastete Farbfelder), von entries (deklariert) oder von beiden – key stellt dann das Standardprädikat für Einträge bereit, die kein Prädikat tragen.

Mit weder geht die Legende auf render.nodeTypeAccessor (die Dimension, die Sie bereits für nodeStyleMap deklariert haben) ein – aber erst nachdem überprüft wurde, dass es sich bei dieser Dimension wirklich um die Farbdimension handelt: Jede Kategorie muss in genau eine Farbe aufgelöst werden, es müssen mindestens zwei davon vorhanden sein und nur wenige davon, um Kategorien zu sein. Dieser Scheck macht eine Legende sicher, nach der niemand gefragt hat; UI.legend: true überspringt es, false unterdrückt die Legende vollständig.

Um ein Diagramm in mehr als einer Dimension gleichzeitig zu verschlüsseln, übergeben Sie stattdessen LegendGroupOptions.

Wird nur in den Modi full und light angezeigt.

Beispiel

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

Erweitert

• LegendSection

Eigenschaften

collapsed?

optional collapsed: boolean

Definiert in: interfaces/GraphUI.ts:626

Start zusammengebrochen.

Standardwert

false

Geerbt von

LegendSection.collapsed

---

collapsible?

optional collapsible: boolean

Definiert in: interfaces/GraphUI.ts:624

Standardwert

true

Geerbt von

LegendSection.collapsible

---

enabled?

optional enabled: boolean

Definiert in: interfaces/GraphUI.ts:586

Standardwert

true when the block is present

Geerbt von

LegendSection.enabled

---

entries?

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

Definiert in: interfaces/GraphUI.ts:622

Deklarierte Einträge oder eine Funktion, die jedes Mal, wenn die Legende neu erstellt wird, anhand des Live-Diagramms neu aufgelöst wird (damit die Liste den Daten folgen kann).

Geerbt von

LegendSection.entries

---

filterable?

optional filterable: boolean

Definiert in: interfaces/GraphUI.ts:630

Durch Klicken auf einen Eintrag wird das Diagramm gefiltert. false rendert einen reinen Schlüssel.

Standardwert

true

Geerbt von

LegendSection.filterable

---

highlightOnHover?

optional highlightOnHover: boolean

Definiert in: interfaces/GraphUI.ts:637

Wenn Sie mit der Maus über einen Eintrag fahren, wird dessen Kategorie von der Arbeitsfläche abgelesen: Die Elemente, für die er steht, behalten ihr Aussehen, alles andere wird ausgeblendet, bis der Zeiger verschwindet. Funktioniert auch mit einer filterable: false-Taste – wenn Sie auf eine Kategorie zeigen, werden keine Anforderungen an das Diagramm gestellt.

Standardwert

true

Geerbt von

LegendSection.highlightOnHover

---

id?

optional id: string

Definiert in: interfaces/GraphUI.ts:605

Stabile Identität: der eigene Filterschlüssel des Abschnitts (__legend:<id>) und das section-Feld des legendToggle-Ereignisses.

Standardwert

key, sonst section-<index>

Geerbt von

LegendSection.id

---

key?

optional key: string

Definiert in: interfaces/GraphUI.ts:617

Abgeleiteter Modus: der Datenschlüssel, dessen unterschiedliche Werte zu den Einträgen werden, wobei jedes Farbfeld aus dem aufgelösten Stil des Renderers abgetastet wird. Lesen Sie Knoten oder Kanten ab, wenn scope 'edge' ist. Stellt auch das Standardprädikat bereit, wenn entries ohne eines deklariert werden.

Geerbt von

LegendSection.key

---

maxVisibleEntries?

optional maxVisibleEntries: number

Definiert in: interfaces/GraphUI.ts:639

Einträge werden angezeigt, bevor die Liste scrollt.

Standardwert

12

Geerbt von

LegendSection.maxVisibleEntries

---

position?

optional position: LegendPosition

Definiert in: interfaces/GraphUI.ts:675

In welcher Ecke es andockt. Im full-Modus ist die Standardeinstellung die rechte Spalte, die über der Minikarte gestapelt ist – die linke gehört zur Modusleiste und ihren Panels. Andere Modi behalten die untere linke Ecke.

Standardwert

'unten rechts' im full-Modus, andernfalls 'bottom-left'

---

scope?

optional scope: LegendScope

Definiert in: interfaces/GraphUI.ts:599

Auf welche Sammlung konzentriert sich dieser Abschnitt? 'edge' listet die Beziehungsarten des Diagramms mit einem Linie-Farbfeld auf – Strichfarbe, Strich und Markierung, wie sie vom Renderer aufgelöst wurden – und schaltet die Kante aus Ebenen: Die Knoten bleiben erhalten, ebenso das Layout, die Auswahl und die Kamera.

Ein edge-Abschnitt filtert, ob UI.filter.edgeFacets seinen Schlüssel deklariert oder nicht: Wenn einer vorhanden ist, steuert er diese Facette, sodass das Panel und die Legende zwei Ansichten eines Filters sind; ohne eine behält es eine eigene Facette.

Standardwert

'node'

Geerbt von

LegendSection.scope

---

showCounts?

optional showCounts: boolean

Definiert in: interfaces/GraphUI.ts:628

Zeigt die Anzahl der Elemente pro Eintrag an.

Standardwert

true

Geerbt von

LegendSection.showCounts

---

title?

optional title: string

Definiert in: interfaces/GraphUI.ts:610

Kopfzeilentext, wörtlich verwendet (damit er übersetzt werden kann).

Standardwert

ein geschöntes key, sonst 'Legend'

Geerbt von

LegendSection.title