pivotick - v2.0.1
    Preparing search index...

    Interface LegendGroupOptions

    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.

    UI: {
        legend: {
            position: 'bottom-left',
            sections: [
                { key: 'type',  title: 'Element' },
                { key: 'scope', title: 'Provenance' },
            ],
        },
    }
    interface LegendGroupOptions {
        enabled?: boolean;
        position?: LegendPosition;
        sections: LegendSection[];
    }
    Index

    Properties

    enabled? position? sections

    Properties

    enabled?: boolean
    true when the block is present
    position?: LegendPosition

    Which corner the whole card docks in.

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

    sections: LegendSection[]

    The sections, rendered top to bottom in declaration order.

    Settings

    Member Visibility

    On This Page

    Properties