Chart

Candlestick

Web supportediOS supportedAndroid supported

Show open, high, low and close for each session, with optional volume.

ECharts candlestick series · View source

When to use

Use for OHLC price data. For a single measure over time reach for Line or Time series instead — a candlestick spends four values of ink on one.

Props

The chart's own props first, then the shared ones this form reads.

PropTypeDefaultDescription
data*ChartCandlestickDatum[]One entry per session, in chronological order.
formatChartNumberFormatNumber formatting shared by axes, labels and tooltips.
showVolumebooleanfalseAdds a volume histogram beneath the price plot. Needs `volume` on each datum.
styleChartCandlestickStyleCandle body, wick and volume colors, plus hollow-up rendering.
axisChartAxes{ x: true, y: true }Horizontal and vertical axis visibility.
animationChartAnimationMark entrance and data-update animation.
annotationsChartAnnotation[]Reference lines, highlighted ranges, points and text anchored to the plot.
interactionChartInteractionHover, crosshair, tooltip, selection, pan and zoom behaviour.
onInteraction(event: ChartInteractionEvent) => voidReceives normalized pointer and selection data. Needs a client component.
plotChartPlotStyleThe plot area alone — its own background, border, clipping and padding, inside the surface.
xAxisChartAxisOptionsScale, domain, ticks, grid and label for the horizontal axis — everything axis cannot say.
yAxisChartAxisOptionsThe same for the vertical axis.
texturebooleanfalseDraws decal patterns over fills — a second encoding on top of hue, for full colour-vision deficiency, print and forced-colors.
classNamestringCSS class applied to the chart root.
heightnumber240Plot height in px. A chart never measures its own content, so this is what reserves the space.
isLoadingbooleanfalseHeld true while the data is in flight. Shows the matching skeleton, then cross-fades into the plot.
skeletonReactNodeReplaces the built-in placeholder while isLoading is true. Takes a rendered element.
surfaceChartSurfaceThe container the plot sits in — background, border, corner radius, padding. Merges over Chart.Provider, key by key.