Skip to content

charton API


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

Interface: PlotBase ​

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

The fields every plot type of PlotDef has: its output id, title, colour and labels.

Properties ​

color? ​

optional color?: string

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


colorInput? ​

optional colorInput?: string

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

Id of a color input that overrides color.


id ​

id: string

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

Key of the output array in compute results.


lastValueLabel? ​

optional lastValueLabel?: boolean

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

Price-axis label for the last value (default true).


priceLine? ​

optional priceLine?: boolean | SeriesPriceLineOptions

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

Price line across the pane at the plot's newest value, as the series priceLine option: true for the default style (dotted, 1 px, the plot's colour), an object to style it. Default off. Line, histogram and OHLC plots only (OHLC at the close).


title? ​

optional title?: string

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

Legend label; omitted plots show only their value.