@finchart

Appearance

Documentation / @finchart/core / index / PaneOptions

Interface: PaneOptions ​

Defined in: packages/core/src/plot/pane-options.ts:14

Properties ​

autoScale? ​

optional autoScale?: boolean

Defined in: packages/core/src/plot/pane-options.ts:28

The value axis follows the visible range. Default true. This is the default behavior for financial charts — zoom from a year of data into the last week, and that week should fill the pane. Turn it off to fit the whole source dataset instead, after which a manually set value domain is no longer overwritten every frame.

axis? ​

optional axis?: AxisOptions

Defined in: packages/core/src/plot/pane-options.ts:30

This pane's value axis settings. Anything omitted follows the Plot's default.

flex? ​

optional flex?: number

Defined in: packages/core/src/plot/pane-options.ts:16

Share of the leftover vertical space this pane takes. Default 1.

invert? ​

optional invert?: boolean

Defined in: packages/core/src/plot/pane-options.ts:36

Inverts the value axis — larger values go toward the bottom. The right spot for values where "smaller is better," like the spread on a yield curve.

minHeight? ​

optional minHeight?: number

Defined in: packages/core/src/plot/pane-options.ts:18

Never shrinks below this (px). Default 40.

valuePadding? ​

optional valuePadding?: number

Defined in: packages/core/src/plot/pane-options.ts:20

Margin that keeps the value axis off the data. Default 0.1