charton

Appearance

charton API

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

Interface: CustomSeriesBaseOptions<D> ​

Defined in: packages/core/src/series.ts:3658

Options every custom series has, next to its own.

Extends ​

Type Parameters ​

D ​

D extends object = { time: Time; }

Properties ​

autoscale? ​

optional autoscale?: boolean | AutoscaleProvider

Defined in: packages/core/src/series.ts:272

How the series takes part in its price scale's autoscale. true (the default) fits its visible values, false leaves it out (it still draws, possibly off the pane), and a function adjusts the range it adds. Primitives attached to the series still add their own ranges.

Inherited from ​

PriceLineSeriesOptions.autoscale

axisTitle? ​

optional axisTitle?: boolean

Defined in: packages/core/src/series.ts:3671

Show the series title (e.g. the symbol) in a tag beside the last-value label.

follow? ​

optional follow?: FollowMapper<D>

Defined in: packages/core/src/series.ts:3668

Derive the series from the main series: called with each main bar, the one before it and the theme; return a point, or null for none. The chart keeps it in step on loads, history pages, symbol switches, live bars and theme changes. See volumeOf.

format ​

format: (value) => string

Defined in: packages/core/src/series.ts:3672

Parameters ​

value ​

number

Returns ​

string

lastValueLabel ​

lastValueLabel: boolean

Defined in: packages/core/src/series.ts:3669

legend? ​

optional legend?: boolean

Defined in: packages/core/src/series.ts:3661

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

offscreenLastPrice? ​

optional offscreenLastPrice?: "hidden" | "hollow"

Defined in: packages/core/src/series.ts:283

The last-value label when the newest bar is panned off screen: 'hollow' draws it as an outline, 'hidden' leaves it out. Unset keeps it as is.

Inherited from ​

PriceLineSeriesOptions.offscreenLastPrice

overlay? ​

optional overlay?: OverlayMargins

Defined in: packages/core/src/series.ts:3675

priceFormat? ​

optional priceFormat?: PriceFormat

Defined in: packages/core/src/series.ts:3674

Overrides format, and gives the pane its tick size and axis unit when no candle series is on it.

priceLine? ​

optional priceLine?: boolean | SeriesPriceLineOptions

Defined in: packages/core/src/series.ts:278

Price line across the plot: true for the default style, an object to style it, false for none. Separate from lastValueLabel. Default: on for the main candle series, off for the others.

Inherited from ​

PriceLineSeriesOptions.priceLine

priceScale? ​

optional priceScale?: string

Defined in: packages/core/src/series.ts:3680

Price scale id in the pane (default 'right'). 'left' shows a left axis; other ids are overlays until given a side. Ignored with overlay.

title ​

title: string

Defined in: packages/core/src/series.ts:3659