Skip to content

charton API


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

Interface: IndicatorInterval ​

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

Another interval's bars an indicator reads, longer than the chart's or (with lower) shorter (see IndicatorDef.intervals).

Properties ​

interval ​

interval: Interval

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

Bar interval to load, longer than the chart's, e.g. '1d' on an intraday chart.


lookback? ​

optional lookback?: number

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

Bars of that interval needed before the chart's first bar, e.g. the length of an RSI computed on them. The chart loads that many more, so the warm-up stays off screen. Default 0.


lower? ​

optional lower?: boolean

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

A shorter interval than the chart's, e.g. '1m' on an hourly chart, for values built from the bars inside each chart bar (see groupLowerBars). The chart loads its bars over the chart's own bars, follows the data source's live bars for it, and draws nothing while the chart interval is not longer. lookback does not apply. Default false: a longer interval.


maxBars? ​

optional maxBars?: number

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

Most bars of a lower interval to load, newest first. When it cuts the chart's history short, the earliest chart bars have no lower bars and the indicator's pane says so. Default 50,000.


symbol? ​

optional symbol?: string

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

Another symbol to load the bars of, e.g. an index to compare against. Default the chart's symbol. Its bars are cached per symbol and interval, so a switch of the chart's symbol keeps them, and its newest bar follows the data source's stream when there is one (otherwise it stays as loaded). They are read as bars['<symbol>@<interval>'].