Skip to content

pivotick v3.0.0


pivotick / GraphUI / RegisteredExtraPanel

Interface: RegisteredExtraPanel ​

Defined in: interfaces/GraphUI.ts:1030

An ExtraPanel once registered: its id is always resolved.

Extends ​

Properties ​

alwaysVisible? ​

optional alwaysVisible: boolean

Defined in: interfaces/GraphUI.ts:1011

should the panel be always visible

Default ​

ts
false

Inherited from ​

ExtraPanel.alwaysVisible


id ​

id: string

Defined in: interfaces/GraphUI.ts:1031

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

Overrides ​

ExtraPanel.id


order? ​

optional order: number

Defined in: interfaces/GraphUI.ts:1018

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.

Default ​

ts
0

Inherited from ​

ExtraPanel.order


reactive? ​

optional reactive: boolean

Defined in: interfaces/GraphUI.ts:1026

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.

Default ​

ts
true

Inherited from ​

ExtraPanel.reactive


render ​

render: ExtraPanelContent

Defined in: interfaces/GraphUI.ts:1006

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

Inherited from ​

ExtraPanel.render


title? ​

optional title: ExtraPanelContent

Defined in: interfaces/GraphUI.ts:1004

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.

Inherited from ​

ExtraPanel.title