Skip to content

charton API


charton API / @chart-on/core / index / IndicatorState

Interface: IndicatorState ​

Defined in: packages/core/src/indicators/types.ts:526

Serializable indicator state.

Properties ​

folded? ​

optional folded?: boolean

Defined in: packages/core/src/indicators/types.ts:548

The legend row shows only the title (see chart.setLegendFolded); missing means unfolded.


id? ​

optional id?: string

Defined in: packages/core/src/indicators/types.ts:532

The indicator's id on its chart (see Indicator.id); missing in sets made by serializeSet and in layouts saved before ids, where loading gives a new one.


inputs ​

inputs: Record<string, InputValue>

Defined in: packages/core/src/indicators/types.ts:537


pane ​

pane: number

Defined in: packages/core/src/indicators/types.ts:539

Pane index at the time of saving.


plotStyles? ​

optional plotStyles?: Record<string, PlotStyle>

Defined in: packages/core/src/indicators/types.ts:546

Plot styles set over the definition's, by plot id (see Indicator.plotStyles); missing means none.


priceScale? ​

optional priceScale?: string

Defined in: packages/core/src/indicators/types.ts:542

Price scale id given to add, when it overrode the definition's priceScale.


type ​

type: string

Defined in: packages/core/src/indicators/types.ts:534

Definition id.


version? ​

optional version?: number

Defined in: packages/core/src/indicators/types.ts:536

The definition's version when saved; missing means 1.


visible ​

visible: boolean

Defined in: packages/core/src/indicators/types.ts:540


visibleOn? ​

optional visibleOn?: IntervalRange[]

Defined in: packages/core/src/indicators/types.ts:544

Intervals it shows on (see Indicator.visibleOn); missing means every interval.