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

    Interface BoxSeries

    A chart-ready view of a box-and-whisker series (BoxPlot): a horizontal span (x/xEnd) per key plus its quantile edges — the required lower/upper (whisker reach) and the optional q1/median/q3 (box body + centre line). The quantiles are pre-computed columns (a rolling/aggregate percentile pass upstream); the chart only reads them.

    A key is drawn only where the quantiles it carries are all finite (a full box needs all five; a range-only box just lower/upper); any present one NaN is a gap (the box draws nothing — same gap contract as BandSeries).

    x and xEnd are the box's horizontal span. An interval-keyed TimeSeries uses the key's own [begin, end); a point-keyed TimeSeries (or a ValueSeries, always point-keyed on its value axis) synthesizes the span from neighbour spacing (each box centred on its key, reaching halfway to each neighbour — the same rule as bars / candles), so a point series still gets real box width instead of collapsing to the 1px floor.

    Range-only boxes. q1/median/q3 are optional at the source (a bid→ask IV segment is a degenerate box — whiskers only, no body). hasBox is false when q1/q3 were omitted (no box body; the whisker runs the full lower→upper), and hasMedian is false when median was omitted (no centre line). Absent quantile buffers are all-NaN; the flags — not the buffers — decide what draws, so an absent quantile isn't confused with a per-row gap. Both default to true (a full five-number box) when unset.

    interface BoxSeries {
        hasBox?: boolean;
        hasMedian?: boolean;
        length: number;
        lower: Float64Array;
        median: Float64Array;
        q1: Float64Array;
        q3: Float64Array;
        upper: Float64Array;
        x: Float64Array;
        xEnd: Float64Array;
    }
    Index

    Properties

    hasBox?: boolean

    falseq1/q3 absent (range-only box, no body). Default true.

    hasMedian?: boolean

    falsemedian absent (no centre line). Default true.

    length: number
    lower: Float64Array
    median: Float64Array
    q1: Float64Array
    q3: Float64Array
    upper: Float64Array
    x: Float64Array
    xEnd: Float64Array