Interface SeriesApi

Public handle returned by chart.addSeries(...).

interface SeriesApi {
    applyOptions(style: Partial<SeriesStyle>): void;
    createMarkers(): SeriesMarkers;
    getData(): Bar[];
    prependData(bars: readonly SeriesDataItem[]): void;
    priceScale(): PriceScale;
    remove(): void;
    setData(bars: readonly SeriesDataItem[]): void;
    update(bar: SeriesDataItem): void;
}

Index

Methods

applyOptions createMarkers getData prependData priceScale remove setData update

Methods

applyOptions

applyOptions(style: Partial<SeriesStyle>): void
Merge a partial style into the series and repaint (recolor, { visible:false } to hide, ...).
Parameters
- style: Partial<SeriesStyle>
Returns void
- Defined in src/model/series.ts:42

createMarkers

createMarkers(): SeriesMarkers
Create a markers layer (buy/sell signals, shapes) bound to this series.

Returns SeriesMarkers
- Defined in src/model/series.ts:48

getData

getData(): Bar[]
Current bars for this series (sorted old -> new, normalized to OHLC). Handy for computing the next live update.

Returns Bar[]
- Defined in src/model/series.ts:40

prependData

prependData(bars: readonly SeriesDataItem[]): void
Merge older data (history paging); same item shapes as setData.
Parameters
- bars: readonly SeriesDataItem[]
Returns void
- Defined in src/model/series.ts:36

priceScale

priceScale(): PriceScale
The price scale this series maps to (call .setOptions({ marginTop, marginBottom }) on it).

Returns PriceScale
- Defined in src/model/series.ts:46

remove

remove(): void
Remove the series from its pane and free its data rows.

Returns void
- Defined in src/model/series.ts:44

setData

setData(bars: readonly SeriesDataItem[]): void
Replace all data. Accepts OHLC bars, { time, value } points, or { time } gaps.
Parameters
- bars: readonly SeriesDataItem[]
Returns void
- Defined in src/model/series.ts:34

update

update(bar: SeriesDataItem): void
Live update: update the last item or append. Same item shapes as setData.
Parameters
- bar: SeriesDataItem
Returns void
- Defined in src/model/series.ts:38