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

    Interface LineChartProps<S, VS>

    interface LineChartProps<
        S extends SeriesSchema = SeriesSchema,
        VS extends ValueSeriesSchema = ValueSeriesSchema,
    > {
        as?: string;
        axis?: string;
        column: string;
        curve?: Curve;
        gaps?: GapMode;
        index?: number;
        series: TimeSeries<S> | ValueSeries<VS>;
        sessionBreaks?: boolean;
    }

    Type Parameters

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

    Properties

    as?: string

    The series' semantic identifier — what the data is / how it should read (e.g. heartrate, power, or a role name like foam). The theme maps it to a LineStyle (theme.line[as] ?? theme.line.default). Omitted ⇒ the default stylecolumn is the data, as is the identity, and there's no per-component colour/width override (that second styling channel is what bred react-timeseries-charts' styling bugs; restyle via the theme).

    axis?: string

    Which <YAxis> (by its id) this line scales against — picks the scale, where as picks the style (separate concerns). Omitted ⇒ the row's default axis (the first declared, or the implicit auto-domain axis).

    column: string

    Name of the numeric value column to plot.

    curve?: Curve

    Render-time path interpolation between points — a view concern (denoise the data with pond's smooth() upstream). Omitted ⇒ 'linear' (straight segments). 'monotone' is a smooth line that still passes through points.

    gaps?: GapMode

    How a gap (a coast / dropout — a run of NaN in column) is rendered (a GapMode). Omitted ⇒ 'empty': the line breaks at the gap and leaves a hole (the honest default). 'none' bridges straight across; 'dashed' adds a faint dashed bridge over the break; 'step' adds a faint flat dashed line at the average of the two edge values; 'fade' is estela's fade-to-baseline at each gap edge. Shared with <AreaChart> — one concept. (The 'dashed' / 'step' connector faintness is the theme's gap.connectorOpacity.)

    index?: number

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

    series: TimeSeries<S> | ValueSeries<VS>

    The source series. A TimeSeries plots against the time axis; a ValueSeries (series.byValue('cumDist')) against its value axis — the container infers which from the data, no axis-type prop. Either way the key / axis column supplies x and column supplies y.

    Live charts: series.byValue(…) mints a fresh projection each call, so passing series={s.byValue('dist')} inline re-registers this layer every render — on a frequently re-rendering (e.g. scrub-driven) chart, memoize the projection (useMemo) so the layer isn't rebuilt each frame.

    sessionBreaks?: boolean

    Break the line at each trading-axis discontinuity (a session / day / lunch close→open) when the container renders on a trading-time axis (a discontinuities / calendar provider). Omitted ⇒ false: the line connects the last pre-close point straight to the next open across the collapsed gap (the near-vertical connector). true ends the line at the close and re-starts it at the open — the intraday look, where a session's price shouldn't visually flow into the next.

    This is a scale break (driven by the axis's collapsed gaps), orthogonal to gaps (a data break, a NaN run) — set both independently. A no-op on a continuous axis (no provider) or a provider without boundaries.