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

    Function boxFromTimeSeries

    • Build a BoxSeries from a pond TimeSeries. lower/upper (the whisker reach) are required; q1/q3 (the box body) and median (the centre line) are optional — omit them for a range-only box (a bid→ask segment). The quantile columns are typically rolling/aggregate percentiles; a key with any present quantile missing reads as a gap (the box draws nothing).

      Key-shape aware, like ohlcFromTimeSeries. An interval / timeRange-keyed series uses the key's own [begin, end) as the box span; a point-keyed (time) series synthesizes the span from neighbour spacing (each box centred on its timestamp, halfway to each neighbour), so a raw percentile-per-timestamp feed renders as contiguous boxes instead of collapsing to the 1px floor.

      Type Parameters

      • S extends SeriesSchema

      Parameters

      Returns BoxSeries

      RangeError if any named quantile column does not exist, or if exactly one of q1/q3 is given.

      TypeError if any named quantile column is not a numeric column.