Skip to content

charton API


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

Interface: IndicatorSeriesOptions ​

Defined in: packages/core/src/indicators/series.ts:40

The options of an IndicatorSeries, set from its indicator's definition and inputs.

Properties ​

axisTitle? ​

optional axisTitle?: boolean

Defined in: packages/core/src/indicators/series.ts:50

Tag each label with the indicator title, or the plot title when there are several plots.


format ​

format: (value) => string

Defined in: packages/core/src/indicators/series.ts:44

Parameters ​

value ​

number

Returns ​

string


lastValueLabel? ​

optional lastValueLabel?: boolean

Defined in: packages/core/src/indicators/series.ts:48

Last-value labels on the price axis (default true); plots with lastValueLabel: false never show one.


legend? ​

optional legend?: boolean

Defined in: packages/core/src/indicators/series.ts:43

false leaves this series out of the legend. Default true.


priceScale? ​

optional priceScale?: string

Defined in: packages/core/src/indicators/series.ts:46

Price scale id in the pane (default 'right').


renderer? ​

optional renderer?: "canvas" | "gpu"

Defined in: packages/core/src/indicators/series.ts:52

Where line plots and fills are drawn (default 'gpu'); see IndicatorAddOptions.renderer.


title ​

title: string

Defined in: packages/core/src/indicators/series.ts:41