@finchart

Appearance

Documentation / @finchart/react / ChartCandlesProps

Interface: ChartCandlesProps ​

Defined in: react/src/components/chart-candles.tsx:5

Properties ​

data? ​

optional data?: OHLC[]

Defined in: react/src/components/chart-candles.tsx:7

The data this candle draws. Falls back to what's passed down from above when omitted.

name? ​

optional name?: string

Defined in: react/src/components/chart-candles.tsx:9

Display name — the legend and tooltip refer to it by this.

readout? ​

optional readout?: boolean

Defined in: react/src/components/chart-candles.tsx:15

false for a series drawn for the eye rather than read out (a band fill, a marker row) — the tooltip and legend leave it out. Like name, fixed at registration: change the React key to change it.

style? ​

optional style?: StyleOverridesOf<{ bodyRatio: { css: "--chart-candle-body-ratio"; fallback: 0.6; range: readonly [0, 1]; }; down: { css: "--chart-candle-down"; fallback: "#dc2626"; }; up: { css: "--chart-candle-up"; fallback: "#16a34a"; }; wickWidth: { css: "--chart-candle-wick-width"; fallback: 1; }; }>

Defined in: react/src/components/chart-candles.tsx:22

The candles' look, in the imperative lane's override shape — the same CandleSeriesStyleOverrides that candleSeries(style) takes: { up, down, wickWidth, bodyRatio }. Omitted fields fall back to the CSS variables (--chart-candle-up, --chart-candle-down, …).