@finchart

Appearance

Documentation / @finchart/react / ChartPaneProps

Interface: ChartPaneProps ​

Defined in: react/src/components/chart-pane.tsx:19

Properties ​

autoScale? ​

optional autoScale?: boolean

Defined in: react/src/components/chart-pane.tsx:32

Whether the value axis follows the data. Defaults to true. A directive, not a lock: the user turning a fixed range on (an axis drag, setValueDomain) turns this off on the pane, the way a divider drag moves flex — the prop is applied when it changes, and only then.

children? ​

optional children?: ReactNode

Defined in: react/src/components/chart-pane.tsx:54

flex? ​

optional flex?: number

Defined in: react/src/components/chart-pane.tsx:21

The share of leftover vertical space this takes. Defaults to 1.

invert? ​

optional invert?: boolean

Defined in: react/src/components/chart-pane.tsx:34

Flip the value axis so larger values sit lower. Defaults to false.

minHeight? ​

optional minHeight?: number

Defined in: react/src/components/chart-pane.tsx:23

Won't shrink below this (px). Defaults to 40.

valueDomain? ​

optional valueDomain?: readonly [number, number]

Defined in: react/src/components/chart-pane.tsx:53

A fixed value range, [min, max] — an oscillator's 0..100. A directive like autoScale: applied on mount and when the two numbers change (a new array with the same values is no change), so the user's axis drag in between stays. Setting it turns autoScale off; removing it hands the axis back to autoScale.

valuePadding? ​

optional valuePadding?: number

Defined in: react/src/components/chart-pane.tsx:25

Padding that keeps the value axis from hugging the data. Defaults to 0.1

yScale? ​

optional yScale?: () => Scale

Defined in: react/src/components/chart-pane.tsx:45

The value scale, as a factory. A log toggle is a change of this prop — the pane, its series and its height stay. The factory is called on each committed update, but its scale is installed only when kind changes. An inline arrow is fine. Removing it puts back a linear scale — on the main pane, the instance this replaced, carrying whatever range the pane shows at that moment; that restore also runs when this pane goes, and overwrites a mainPane.setYScale made while this pane held it.

Returns ​

Scale