Documentation / @finchart/core / index / PaneMaximizeApi

Interface: PaneMaximizeApi

Defined in: packages/core/src/extensions/pane-maximize.ts:24

The toggle and the gestures for a maximized pane. The state itself is the chart's (plot.maximizePane / plot.maximizedPane): a layout mode the height split reads, not a rewrite of any pane's flex — so there is no snapshot to keep in step with the panes, and a divider drag, a removed pane or a pane added meanwhile are handled where the layout is.

Restoring via Esc is built in; toggling via a pane double-click is opt-in — double-click already belongs to doubleClickReset (default true), so consuming it here would silently kill that reset on every pane click. That's why it only turns on with an explicit gestures: true. Esc has no such owner, so when there's nothing to restore it returns false and the chain continues.

Extends

• PluginApi

Properties

disposed

readonly disposed: boolean

Defined in: packages/core/src/primitives/plugin.ts:30

Inherited from

PluginApi.disposed

---

maximizedPane

readonly maximizedPane: Pane | null

Defined in: packages/core/src/extensions/pane-maximize.ts:37

The currently maximized pane, null if none — the chart's maximizedPane. A change rings panesChange, a lone pane included.

Methods

dispose()

dispose(): void

Defined in: packages/core/src/primitives/plugin.ts:29

Returns

void

Inherited from

PluginApi.dispose

---

maximize()

maximize(pane): void

Defined in: packages/core/src/extensions/pane-maximize.ts:30

Lets pane fill the chart — the rest are laid out at their minHeight. Given the pane already maximized, this is restore() (a toggle); given another, the target moves.

Parameters

pane

Pane

Returns

void

---

restore()

restore(): void

Defined in: packages/core/src/extensions/pane-maximize.ts:32

Gives the panes back their own split. Does nothing if not maximized.

Returns

void