charton

Appearance

charton API

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

Interface: IndicatorSet ​

Defined in: packages/core/src/indicators/sets.ts:22

A group of indicators with their panes, to save as a template and apply to any chart: what chart.indicators.serializeSet() returns and applySet() takes. Plain JSON.

Properties ​

appliesOn? ​

optional appliesOn?: IntervalRange[]

Defined in: packages/core/src/indicators/sets.ts:39

Intervals the set is meant for (see indicatorSetFits); missing means every interval. Unlike an indicator's visibleOn, it hides nothing.

indicators ​

indicators: IndicatorState[]

Defined in: packages/core/src/indicators/sets.ts:29

The indicators in the order they were added. pane counts the set's own panes: 0 is the price pane, 1 the set's first pane below it, and so on.

paneHeights? ​

optional paneHeights?: number[]

Defined in: packages/core/src/indicators/sets.ts:34

Height of each of the set's panes below the price pane, relative to the price pane (1 is as tall). paneHeights[0] is pane 1.

version ​

version: number

Defined in: packages/core/src/indicators/sets.ts:24

Format version, INDICATOR_SET_VERSION when written.