Skip to content

charton API


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

Interface: CustomSeriesView<D, O> ​

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

What a custom series' draw hook gets. Sizes in css px, pane-local.

Type Parameters ​

D ​

D

O ​

O

Properties ​

barSpacing ​

barSpacing: number

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


height ​

height: number

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


items ​

items: CustomItem<D>[]

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

Visible items, plus one either side so shapes can run off the edges.


options ​

options: O

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


pixelRatio ​

pixelRatio: number

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


theme ​

theme: ChartTheme

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


width ​

width: number

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

Methods ​

indexToX() ​

indexToX(index): number

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

Parameters ​

index ​

number

Returns ​

number


priceToY() ​

priceToY(price): number

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

Parameters ​

price ​

number

Returns ​

number


yToPrice() ​

yToPrice(y): number

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

Parameters ​

y ​

number

Returns ​

number