API reference
The API reference, rendered inside the site from the TypeScript
source: docstring first, centered on the primitives rather than
alphabetical declaration lists. Everything here is extracted at build
time (typedoc --json → curated model → site components), so it cannot
drift from the code — and referenced type names in the type chips carry
hover cards with their definition and doc.
pond-ts (core)
Temporal keys — Time,
TimeRange, Interval — and
Event, the key + payload pair.
Grids — Sequence,
BoundedSequence.
Batch series — TimeSeries,
PartitionedTimeSeries,
ValueSeries.
Live series — LiveSeries,
LiveView,
LivePartitionedSeries,
LivePartitionedView.
Functions — toTimeRange, top.
@pond-ts/charts
Structure — <ChartContainer>,
<ChartRow>, <Layers>,
<XAxis>, <YAxis>,
<Canvas>, <TimeAxis>,
<CategoryAxis>.
Draw layers — <LineChart>,
<AreaChart>,
<BandChart>,
<BarChart>,
<ScatterChart>,
<BoxPlot>,
<Candlestick>.
Annotations — <Baseline>,
<Marker>, <Region>,
<YAxisIndicator>.
Functions — data adapters, theming, scales & live values.
Other packages
@pond-ts/react, @pond-ts/fit, and @pond-ts/financial aren't in
the in-site reference yet — their full generated references remain
available: