Interface AddSeriesOptions

interface AddSeriesOptions {
    paneIndex?: number;
    priceFormat?:
        | { minMove?: number; precision?: number; type: "price" }
        | { type: "volume" }
        | { formatter: (value: number) => string; type: "custom" };
    priceScaleId?: PriceScaleId;
    style?: SeriesStyle;
}

Properties

paneIndex? priceFormat? priceScaleId? style?

Properties

OptionalpaneIndex

paneIndex?: number

Target pane index (0 = price). Higher panes are created on demand.

OptionalpriceFormat

priceFormat?:
    | { minMove?: number; precision?: number; type: "price" }
    | { type: "volume" }
    | { formatter: (value: number) => string; type: "custom" }

Value formatting applied to this series' price scale (axis + crosshair tag): price (tick-size precision), volume (compact 1.2K / 3.4M / 5.6B), or a custom formatter (currency, percent, ...).

OptionalpriceScaleId

priceScaleId?: PriceScaleId

Which price axis this series maps to. 'right' (default) and 'left' each draw an axis and autoscale independently; '' is a hidden overlay scale (no axis) for a volume histogram inside the price pane.

Optionalstyle

style?: SeriesStyle

Style overrides merged onto the chart type's defaults.

Settings

Member Visibility

On This Page

Properties