OptionalasOptionalaxisWhich <YAxis> (by its id) this candle scales against — the scale, where
as picks the style. Omitted ⇒ the row's default axis.
OptionalcloseClosing-price column. Omitted ⇒ 'close'.
OptionalcolorWhat drives the colour — 'direction' (default; rising / falling / doji off
open vs close, the market convention) or 'series' (one colour off the as
role, no green/red). See ColorBy.
OptionalgapTotal horizontal inset between adjacent candles in px (half each side), so
they breathe — see barSpanPx. Omitted ⇒ 0 (the body already insets to
style.bodyWidth of the slot). A candle narrower than 1px after the inset
collapses to a 1px mark, so a thin slot stays visible.
OptionalhighSession-high column. Omitted ⇒ 'high'.
Optional InternalindexDeclaration position among the <Layers> children, injected by
Layers so z-order follows JSX order. Do not set.
OptionallowSession-low column. Omitted ⇒ 'low'.
OptionalopenOpening-price column. Omitted ⇒ 'open'.
The source series. Point-keyed (time) raw OHLCV feeds straight in —
each candle's slot is derived from neighbour spacing (see
ohlcFromTimeSeries), no aggregate pass needed. An interval /
timeRange-keyed series (an aggregate rollup — weekly / monthly bars) uses
the key's own [begin, end) as the slot. The chart infers the x-kind from
the data; there's no axis-type prop.
OptionalshowFan the full O/H/L/C to the tracker readout (four value pills) instead of
the default single close pill. Omitted ⇒ false — close is "the price"
for a compact legend; the full quote is opt-in for a dense hover readout.
OptionalvariantHow each mark renders — 'candle' (default; filled body + wick), 'bar'
(OHLC tick bar), or 'hollow' (rising hollow / falling filled). See
CandleVariant.
The series' semantic identifier — what the data is (e.g. a ticker). The theme maps it to a CandleStyle (
theme.candle[as] ?? theme.candle.default). Omitted ⇒ thedefaultcandle style. It's also the tracker/readout label for the series (the primaryclosepill keys onas, not the raw column name).