Skip to content

pivotick v3.0.0


pivotick / Flyout

Abstract Class: Flyout ​

Defined in: ui/elements/Flyout/Flyout.ts:22

Shared scaffolding for the settings flyouts — the overlays opened by the mode rail's flyout modes: ViewFlyout (grid + canvas behaviour) and PhysicsFlyout (layout + simulation). The base owns the panel element, the shared pvt-flyout-* chrome (header, section labels, switch rows) and the binding to ModeStore — a panel is open exactly while its own mode is the active one, so the flyouts exclude each other for free.

A subclass declares the mode it answers to, renders its controls in template and wires them in wire. The template's words are text: the helpers below escape what they are given, and elements marked with i18nText / i18nAttr are filled from the graph's catalogue. A subclass overriding onGraphReady must call super.onGraphReady(): that's where switch rows get their initial state (graph.simulation only exists by then).

Extends ​

Constructors ​

Constructor ​

new Flyout(uiManager): Flyout

Defined in: ui/UIComponent.ts:32

Parameters ​

uiManager ​

UIManager

Returns ​

Flyout

Inherited from ​

UIComponent.constructor

Methods ​

afterMount() ​

afterMount(): void

Defined in: ui/UIComponent.ts:54

Returns ​

void

Inherited from ​

UIComponent.afterMount


destroy() ​

destroy(): void

Defined in: ui/UIComponent.ts:64

Returns ​

void

Inherited from ​

UIComponent.destroy


getMode() ​

getMode(): string

Defined in: ui/elements/Flyout/Flyout.ts:38

The rail mode this panel answers to. Public so the rail-mode registry can check a registered flyout against the id its definition declared.

Returns ​

string


graphReady() ​

graphReady(): void

Defined in: ui/UIComponent.ts:59

Returns ​

void

Inherited from ​

UIComponent.graphReady


mount() ​

mount(container?): void

Defined in: ui/UIComponent.ts:50

Parameters ​

container? ​

HTMLElement

Returns ​

void

Inherited from ​

UIComponent.mount