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

    Interface YAxisIndicatorProps

    interface YAxisIndicatorProps {
        axis?: string;
        color?: string;
        format?: AxisFormat;
        line?: boolean;
        pointer?: boolean;
        side?: "left" | "right";
        source?: LiveValue;
        value?: number;
    }
    Index

    Properties

    axis?: string

    Which <YAxis> (by id) to position against; omit for the row's default axis.

    color?: string

    Pill hue — the colour of the series / value it tracks. Defaults to the axis label colour (theme.axis.label).

    format?: AxisFormat

    Value formatting: a d3 format specifier (e.g. ',.2f', '.1%') or a (value) => string. Omit to use the linked axis's own formatter, so the pill reads exactly like a tick. Pass a specifier for finer precision than the tick-calibrated default (a live price usually wants ',.2f', not the coarser tick rounding). See AxisFormat.

    An indicator always shows the axis value — there is no label override. A name/annotation belongs on a <Baseline label>'s near-line chip, not on the axis pill (an axis pill reads like a tick).

    line?: boolean

    Draw a thin dashed guide line from the pill across the plot (the ChartIQ "price line"). Default false.

    pointer?: boolean

    Add a small triangle on the pill's plot-facing edge, pointing into the plot at the value (a callout tab). Default false.

    side?: "left" | "right"

    Which edge the pill hugs. Default right — the conventional side for a live value tag. (Independent of the linked axis's side; set it to match.)

    source?: LiveValue

    A LiveValue to subscribe to — the high-frequency path. .set(v) moves and relabels the pill without re-rendering the chart. Takes precedence over value if both are given.

    value?: number

    A static value to pin the pill at. Pass this or source. Updating value re-renders with its parent — fine for an occasional change; for a high-frequency tick use source so only the pill repaints.