charton

Appearance

charton API

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

Interface: PointSeriesOptions ​

Defined in: packages/core/src/points.ts:57

Options for a point series (chart.addPoints): marker shape, size and colours, an optional mapping from quantities to sizes, labels and price scale placement.

Extends ​

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/points.ts:81

Show the series title in a tag beside the last-value label.

color? ​

optional color?: string

Defined in: packages/core/src/points.ts:64

Fill colour of markers without their own. Default the theme's line colour.

format ​

format: (value) => string

Defined in: packages/core/src/points.ts:75

Parameters ​

value ​

number

Returns ​

string

lastValueLabel ​

lastValueLabel: boolean

Defined in: packages/core/src/points.ts:79

Label the newest point's value on the price axis. Default false.

legend? ​

optional legend?: boolean

Defined in: packages/core/src/points.ts:60

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

opacity ​

opacity: number

Defined in: packages/core/src/points.ts:70

Fill opacity, 0 to 1. Default 0.8.

overlay? ​

optional overlay?: OverlayMargins

Defined in: packages/core/src/points.ts:82

priceFormat? ​

optional priceFormat?: PriceFormat

Defined in: packages/core/src/points.ts:77

Overrides format for labels, and gives the pane its tick size and axis unit.

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/points.ts:84

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

shape ​

shape: PointShape

Defined in: packages/core/src/points.ts:62

Default 'circle'.

size ​

size: number

Defined in: packages/core/src/points.ts:66

Diameter of markers with no usable size, css px. Default 6.

sizeBy? ​

optional sizeBy?: PointSizeBy

Defined in: packages/core/src/points.ts:68

Size markers by the item size as a quantity; without it, item sizes are diameters in css px.

stroke? ​

optional stroke?: string

Defined in: packages/core/src/points.ts:72

Outline colour; no outline when unset.

strokeWidth? ​

optional strokeWidth?: number

Defined in: packages/core/src/points.ts:74

Outline width, css px. Default 1.

title ​

title: string

Defined in: packages/core/src/points.ts:58