Zum Inhalt springen

pivotick v3.0.0


Pivotick / GraphUI / LegendGroupOptions

Interface: LegendGroupOptions ​

Definiert in: interfaces/GraphUI.ts:704

UI.legend in seiner mehrteiligen-Form: eine angedockte Karte, die den Graphen mit mehreren Kodierungen gleichzeitig verschlüsselt. Die Abschnitte werden in der Deklarationsreihenfolge von oben nach unten gestapelt, jeder mit eigenem Titel, Einträgen und Ein-/Aus-Schalter.

Jeder filterbare Abschnitt besitzt seinen eigenen Filter und filtert und zusammen: Wenn attribute in einem Abschnitt und self in einem anderen ausgeschaltet ist, bleiben auf der Arbeitsfläche die Knoten, die keines von beiden sind.

Ein Abschnitt, der weder key noch entries deklariert, ist die Dimension, die bereits als render.nodeTypeAccessor deklariert ist – die einzige Schreibweise für eine Stildimension, die kein einfacher Datenschlüssel ist. Das darf nur ein Abschnitt tun.

Beispiel ​

js
UI: {
    legend: {
        position: 'bottom-left',
        sections: [
            { key: 'type',  title: 'Element' },
            { key: 'scope', title: 'Provenance' },
        ],
    },
}

Eigenschaften ​

enabled? ​

optional enabled: boolean

Definiert in: interfaces/GraphUI.ts:706

Standardwert ​

ts
true when the block is present

position? ​

optional position: LegendPosition

Definiert in: interfaces/GraphUI.ts:711

In welcher Ecke die ganze Karte andockt.

Standardwert ​

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


sections ​

sections: LegendSection[]

Definiert in: interfaces/GraphUI.ts:713

Die Abschnitte, von oben nach unten in Deklarationsreihenfolge gerendert.