@finchart

Appearance

Documentation / @finchart/core / index / PaneHost

Interface: PaneHost ​

Defined in: packages/core/src/plot/capabilities.ts:99

Can get, create, and remove panes.

Indicators are the flagship consumer here — MACD has a different price range and digit count, so it needs its own pane, and has to clean up what it created when removed.

Consumers: legend, @finchart/indicators, @finchart/tools

Properties ​

mainPane ​

readonly mainPane: Pane

Defined in: packages/core/src/plot/capabilities.ts:101

The default pane holding series. Always present.

maximizedPane ​

readonly maximizedPane: Pane | null

Defined in: packages/core/src/plot/capabilities.ts:107

The pane that fills the chart, or null → Plot.maximizePane.

panes ​

readonly panes: readonly Pane[]

Defined in: packages/core/src/plot/capabilities.ts:103

Stacking order from the top.

Methods ​

addPane() ​

addPane(options?): Pane

Defined in: packages/core/src/plot/capabilities.ts:104

Parameters ​

options? ​

PaneOptions & object

Returns ​

Pane

maximizePane() ​

maximizePane(pane): void

Defined in: packages/core/src/plot/capabilities.ts:109

Lets one pane fill the chart without touching any flex; null gives the split back.

Parameters ​

pane ​

Pane | null

Returns ​

void

removePane() ​

removePane(pane): void

Defined in: packages/core/src/plot/capabilities.ts:105

Parameters ​

pane ​

Pane

Returns ​

void