import { BandSeries } from '@wick-charts/react';
 
<BandSeries data={bandData} />

Fills the region between a low and a high edge over time — percentile bands, min/max envelopes, Bollinger bands, forecast intervals. Pass several layers for a fan chart: each band draws in order with a translucent fill, so nested bands read as one gradient of certainty. The tooltip and info bar show low – high, the Y range covers both edges, and a gap splits the band the way it splits a line. There is no stacking. introAnimation takes the same LineIntroFn styles as <LineSeries>.

Fills the region between a low and a high edge over time — percentile bands, min/max envelopes, Bollinger bands, forecast intervals. Pass several layers for a fan chart: each band draws in order with a translucent fill, so nested bands read as one gradient of certainty. The tooltip and info bar show low – high, the Y range covers both edges, and a gap splits the band the way it splits a line. There is no stacking. introAnimation takes the same LineIntroFn styles as <LineSeries>.

Props

dataBandData

Band data — one band per layer. A single band passes a flat { time, low, high }[]; several bands pass BandPoint[][]. To name/color a band, pass { label, color?, data } (or an array of them). Time accepts ms or Date.

timenumber | Date

Unix milliseconds, or a Date (converted via getTime() internally).

lownumber

Lower edge at this time. A low above high draws with the edges swapped; a missing or non-finite edge is a gap that splits the band.

highnumber

Upper edge at this time. The fill spans only between the two edges, never down to the plot floor.

options?Partial<BandSeriesOptions>

Visual options override — fill, edge stroke, curve, entrance / intro / smoothing.

id?string

Stable series ID — same value across remounts.

visible?default trueboolean

Show/hide the series without unmounting it — excludes it from the Y-range fit and tooltip/legend. Default true. Live.

scale?default the default scalestring

Named Y scale from the container's scales — autoscales on its own, sharing the time axis. Default: the default scale. Live.