charton

Appearance

charton API

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

Interface: CustomSeriesDef<D, O> ​

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

Plugin contract for a user-defined chart type. Use with chart.addCustomSeries.

Type Parameters ​

D ​

D extends object

O ​

O extends object = object

Properties ​

defaultOptions? ​

optional defaultOptions?: O

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

type ​

type: string

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

Id for debugging and saved layouts.

Methods ​

draw() ​

draw(ctx, view): void

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

Parameters ​

ctx ​

CanvasRenderingContext2D

view ​

CustomSeriesView<D, O & CustomSeriesBaseOptions<{ time: number; }>>

Returns ​

void

group()? ​

optional group(items, options): D

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

One item standing for items (consecutive, oldest first) while the chart groups bars (the grouping option); give it the first item's time. Without it a group shows its last item.

Parameters ​

items ​

readonly D[]

options ​

O & CustomSeriesBaseOptions<{ time: number; }>

Returns ​

D

lastValue()? ​

optional lastValue(item, options): { color?: string; value: number; } | null

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

Value and color of the price-axis label for the newest item.

Parameters ​

item ​

D

options ​

O & CustomSeriesBaseOptions<{ time: number; }>

Returns ​

{ color?: string; value: number; } | null

legend()? ​

optional legend(item, options): LegendPart[]

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

Legend values for the item under the crosshair (undefined when there is none).

Parameters ​

item ​

D | undefined

options ​

O & CustomSeriesBaseOptions<{ time: number; }>

Returns ​

LegendPart[]

priceRange() ​

priceRange(item, options): [number, number] | null

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

Price span of one item for autoscale, or null to ignore it.

Parameters ​

item ​

D

options ​

O

Returns ​

[number, number] | null

step()? ​

optional step(dt, data, options): boolean

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

Advance animations by dt ms; return true while still animating.

Parameters ​

dt ​

number

data ​

readonly D[]

options ​

O & CustomSeriesBaseOptions<{ time: number; }>

Returns ​

boolean