Skip to content

Documentation / @finchart/core / index / paneMaximize

Function: paneMaximize() ​

paneMaximize(options?): Plugin<PaneHost & InputHost, PaneMaximizeApi>

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

Picks one pane and grows it to fill the view — the rest collapse to minHeight.

ts
const max = plot.use(paneMaximize());
max.maximize(rsiPane);   // keep only RSI, collapse the rest
max.maximize(rsiPane);   // call it again to restore (toggle)
// Esc comes built in. Toggling via pane double-click is opt-in:
plot.use(paneMaximize({ gestures: true }));

dispose() takes the toggle and the gestures away and leaves the layout as it is — plot.maximizePane(null) gives the split back.

Esc and double-click reach it only after every consumer at the default priority passed on them, so a drawing in progress or under the cursor answers first wherever the tools were installed.

Parameters ​

options? ​

PaneMaximizeOptions = {}

Returns ​

Plugin<PaneHost & InputHost, PaneMaximizeApi>