pivotick v3.0.0

---

pivotick / GraphUI / LegendGroupOptions

Interface: LegendGroupOptions

Defined in: interfaces/GraphUI.ts:704

UI.legend in its multi-section form: one docked card keying the graph on several encodings at once. Sections stack top to bottom in declaration order, each with its own title, entries and collapse toggle.

Every filterable section owns its own filter, and filters and together: with attribute switched off in one section and self in another, what stays on the canvas is the nodes that are neither.

A section declaring neither key nor entries is the dimension already declared as render.nodeTypeAccessor — the one spelling for a styling dimension that isn't a plain data key. Only one section may do that.

Example

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

Properties

enabled?

optional enabled: boolean

Defined in: interfaces/GraphUI.ts:706

Default

true when the block is present

---

position?

optional position: LegendPosition

Defined in: interfaces/GraphUI.ts:711

Which corner the whole card docks in.

Default

'bottom-right' in full mode, 'bottom-left' otherwise

---

sections

sections: LegendSection[]

Defined in: interfaces/GraphUI.ts:713

The sections, rendered top to bottom in declaration order.