pivotick - v2.0.1
    Preparing search index...

    Interface RegisteredExtraPanel

    An ExtraPanel once registered: its id is always resolved.

    interface RegisteredExtraPanel {
        alwaysVisible?: boolean;
        id: string;
        order?: number;
        reactive?: boolean;
        render: ExtraPanelContent;
        title?: ExtraPanelContent;
    }

    Hierarchy (View Summary)

    Index

    Properties

    alwaysVisible? id order? reactive? render title?

    Properties

    alwaysVisible?: boolean

    should the panel be always visible

    false
    id: string

    Stable identifier, used to address the panel in removePanel / refreshPanel. Auto-generated when omitted.

    order?: number

    Display order in the sidebar, ascending. Panels sharing an order keep their registration order, so UI.extraPanels reads top-to-bottom and runtime panels append after them.

    0
    reactive?: boolean

    Re-resolve title and render whenever the selection changes. Set false for a panel that is expensive to build and doesn't describe the selection: it then renders once, and only an explicit refreshPanel() rebuilds it.

    true
    render: ExtraPanelContent

    A string renders as plain text; pass an HTMLElement to render HTML.

    title?: ExtraPanelContent

    The panel's header row. A string renders as plain text; pass an HTMLElement to render HTML. Omit it (or resolve to blank) for a panel with no header at all.

    Settings

    Member Visibility

    On This Page

    Properties