Interface IndicatorApi

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

interface IndicatorApi {
    id: string;
    indicatorId: string;
    name: string;
    paneIndex: number;
    dataStatus(): null | Readonly<IndicatorDataStatus>;
    legend(): null | PaneLegend;
    remove(): void;
    retryData(): void;
    series(plotKey: string): undefined | SeriesApi;
    setSettings(patch: Readonly<IndicatorSettings>): void;
    settings(): IndicatorSettings;
    setVisible(on: boolean): void;
    subscribeDataStatus(
        listener: (status: Readonly<IndicatorDataStatus>) => void,
    ): () => void;
    updateLegendValues(index?: number): void;
    values(): IndicatorValues;
    visible(): boolean;
}

Index

Properties

id indicatorId name paneIndex

Methods

dataStatus legend remove retryData series setSettings settings setVisible subscribeDataStatus updateLegendValues values visible

Properties

`Readonly`id

id: string

Unique instance id (several instances of one indicator can coexist).

`Readonly`indicatorId

indicatorId: string

The descriptor id, e.g. 'macd'.

`Readonly`name

name: string

Display name.

`Readonly`paneIndex

paneIndex: number

Pane the indicator drew into.

Methods

dataStatus

dataStatus(): null | Readonly<IndicatorDataStatus>
External data state, or null for a study without a managed lifecycle.

Returns null | Readonly<IndicatorDataStatus>
- Defined in src/model/indicator-instance.ts:210

legend

legend(): null | PaneLegend
This indicator's legend row, or null if it has none.

Returns null | PaneLegend
- Defined in src/model/indicator-instance.ts:236

remove

remove(): void
Remove every series, level, and legend row this indicator created.

Returns void
- Defined in src/model/indicator-instance.ts:240

retryData

retryData(): void
Retry external history when the descriptor supplies a retry action.

Returns void
- Defined in src/model/indicator-instance.ts:214

series

series(plotKey: string): undefined | SeriesApi
The series backing one plot key, for direct styling.
Parameters
- plotKey: string
Returns undefined | SeriesApi
- Defined in src/model/indicator-instance.ts:228

setSettings

setSettings(patch: Readonly<IndicatorSettings>): void
Merge a settings patch, recompute, and restyle.
Parameters
- patch: Readonly<IndicatorSettings>
Returns void
- Defined in src/model/indicator-instance.ts:226

settings

settings(): IndicatorSettings
Current settings (a copy).

Returns IndicatorSettings
- Defined in src/model/indicator-instance.ts:224

setVisible

setVisible(on: boolean): void
Show or hide every plot without removing the instance.
Parameters
- on: boolean
Returns void
- Defined in src/model/indicator-instance.ts:234

subscribeDataStatus

subscribeDataStatus(
listener: (status: Readonly<IndicatorDataStatus>) => void,
): () => void
Observe changes; immediately receives the current managed status, if any.
Parameters
- listener: (status: Readonly<IndicatorDataStatus>) => void
Returns () => void
- Defined in src/model/indicator-instance.ts:212

updateLegendValues

updateLegendValues(index?: number): void
Refresh the legend readings for a bar index; omit for the latest bar.
Parameters
- Optionalindex: number
Returns void
- Defined in src/model/indicator-instance.ts:238

values

values(): IndicatorValues
Latest computed values (a reference — do not mutate).

Returns IndicatorValues
- Defined in src/model/indicator-instance.ts:230

visible

visible(): boolean
Whether the plots are drawn (the legend's eye toggle).

Returns boolean
- Defined in src/model/indicator-instance.ts:232