pivotick v3.0.0

---

pivotick / GraphUI / RegisteredDockTab

Interface: RegisteredDockTab

Defined in: interfaces/GraphUI.ts:1417

A DockTab once registered: its id is resolved.

Extends

• DockTab

Properties

icon?

optional icon: string

Defined in: interfaces/GraphUI.ts:1382

A glyph drawn before the label in the strip, marking where the pane came from.

An SVG string, injected with innerHTML and not sanitised — it must be trusted, exactly like PivotDefinition.icon. Useful when several tabs are the same kind of pane: four candidate reviews and a data table read as one list of five otherwise.

Inherited from

DockTab.icon

---

id

id: string

Defined in: interfaces/GraphUI.ts:1418

Stable identity: what removeDockTab / activateDockTab take, and the data-tab written onto the strip's button.

Default

an auto-generated pvt-dock-tab-N

Overrides

DockTab.id

---

label

label: string

Defined in: interfaces/GraphUI.ts:1373

The strip's label, used verbatim (so it can be translated).

Inherited from

DockTab.label

---

onActivate()?

optional onActivate: (tab) => void

Defined in: interfaces/GraphUI.ts:1412

Called when this tab comes to the front, and when it leaves. A tab that watches live data should stop working in onDeactivate and catch up in onActivate: nothing else tells it that it is off screen.

Parameters

tab

DockTabHandle

Returns

void

Inherited from

DockTab.onActivate

---

onDeactivate()?

optional onDeactivate: (tab) => void

Defined in: interfaces/GraphUI.ts:1413

Parameters

tab

DockTabHandle

Returns

void

Inherited from

DockTab.onDeactivate

---

order?

optional order: number

Defined in: interfaces/GraphUI.ts:1406

Display order in the strip, ascending. Equal orders keep registration order — and since plugins install after the UI is built, a plugin's tabs land after the built-in ones without having to say so.

Default

0

Inherited from

DockTab.order

---

render()

render: (tab) => HTMLElement

Defined in: interfaces/GraphUI.ts:1388

Build the pane's body. Called once, lazily, the first time the tab comes to the front — a tab nobody opens costs nothing. The element is kept and re-attached on later activations, so it holds its own state (scroll position included).

Parameters

tab

DockTabHandle

Returns

HTMLElement

Inherited from

DockTab.render

---

toolbar()?

optional toolbar: (tab) => HTMLElement | HTMLElement[]

Defined in: interfaces/GraphUI.ts:1399

Build this tab's header controls, laid out as part of the dock's header row. Re-invoked on every activation, so the controls can reflect the tab's current state.

A pane with several views of its own draws the switch here. Two public classes give it the same look the built-in table has — pvt-dock-views on the strip, pvt-dock-view on each button, active on the current one — so it stays a pill group beside the dock's own tabs and follows the theme.

Parameters

tab

DockTabHandle

Returns

HTMLElement | HTMLElement[]

Inherited from

DockTab.toolbar