@pond-ts/charts API Reference
    Preparing search index...

    Interface BandChartProps<S, VS>

    interface BandChartProps<
        S extends SeriesSchema = SeriesSchema,
        VS extends ValueSeriesSchema = ValueSeriesSchema,
    > {
        as?: string;
        axis?: string;
        curve?: Curve;
        index?: number;
        lower: string;
        series: TimeSeries<S> | ValueSeries<VS>;
        upper: string;
    }

    Type Parameters

    • S extends SeriesSchema = SeriesSchema
    • VS extends ValueSeriesSchema = ValueSeriesSchema
    Index

    Properties

    as?: string

    The band's semantic identifier — what the spread is (e.g. outer for a p5/p95 envelope, inner for p25/p75). The theme maps it to a BandStyle (theme.band[as] ?? theme.band.default). Omitted ⇒ the default band style — no per-component fill/opacity override (restyle via the theme, the single styling channel).

    axis?: string

    Which <YAxis> (by its id) this band scales against — the scale, where as picks the style. Omitted ⇒ the row's default axis.

    curve?: Curve

    Render-time edge interpolation — both edges drawn with this curve. Omitted ⇒ 'linear'. Prefer a symmetric curve ('natural'/'basis') to smooth a sparse aggregated envelope (RTC's interpolation) — 'monotone' assumes increasing x and smooths the right→left lower edge asymmetrically. Denoise the underlying values with smooth(), not this.

    index?: number

    Declaration position among the <Layers> children, injected by Layers so z-order follows JSX order. Do not set.

    lower: string

    Name of the numeric column for the band's lower edge (e.g. p25).

    series: TimeSeries<S> | ValueSeries<VS>

    The source series. A TimeSeries fills the envelope against the time axis; a ValueSeries (series.byValue('dist')) against its value axis — the container infers which from the data, no axis-type prop (mirrors <LineChart> / <AreaChart>). Either way lower/upper name the numeric edge columns.

    Live charts: series.byValue(…) mints a fresh projection each call, so an inline series={s.byValue('dist')} re-registers this layer every render — on a frequently re-rendering chart, memoize the projection (useMemo).

    upper: string

    Name of the numeric column for the band's upper edge (e.g. p75).