charton

Appearance

charton API

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

Abstract Interface: NumericSeriesBase<O> ​

Defined in: packages/core/src/numeric/chart.ts:172

What the line and histogram series of a NumericChart share: id, data, options and visibility.

Extended by ​

Type Parameters ​

O ​

O extends object

Properties ​

dirty ​

protected dirty: boolean = true

Defined in: packages/core/src/numeric/chart.ts:175

host ​

protected readonly host: SeriesHost

Defined in: packages/core/src/numeric/chart.ts:182

id ​

readonly id: string

Defined in: packages/core/src/numeric/chart.ts:173

items ​

protected items: NumericItem[] = []

Defined in: packages/core/src/numeric/chart.ts:174

options ​

options: O

Defined in: packages/core/src/numeric/chart.ts:183

xBase ​

protected xBase: number = 0

Defined in: packages/core/src/numeric/chart.ts:177

Stored x values are (x - xBase) / xUnit: small numbers, so float32 on the GPU keeps them exact enough.

xUnit ​

protected xUnit: number = 1

Defined in: packages/core/src/numeric/chart.ts:178

Accessors ​

data ​

Get Signature ​

get data(): readonly NumericItem[]

Defined in: packages/core/src/numeric/chart.ts:187

The items, sorted by x.

Returns ​

readonly NumericItem[]

visible ​

Get Signature ​

get visible(): boolean

Defined in: packages/core/src/numeric/chart.ts:191

Returns ​

boolean

Methods ​

applyOptions() ​

applyOptions(patch): void

Defined in: packages/core/src/numeric/chart.ts:225

Parameters ​

patch ​

Partial<O>

Returns ​

void

changed() ​

protected changed(): void

Defined in: packages/core/src/numeric/chart.ts:233

Items or options changed: drop what was derived from them.

Returns ​

void

color() ​

color(): string

Defined in: packages/core/src/numeric/chart.ts:246

The series colour, resolved against the theme.

Returns ​

string

draw() ​

abstract draw(r, view): void

Defined in: packages/core/src/numeric/chart.ts:272

Internal

Parameters ​

r ​

RenderBackend

view ​

DrawView

Returns ​

void

extent() ​

extent(): [number, number] | null

Defined in: packages/core/src/numeric/chart.ts:251

[lowest, highest] x of the items, or null without items.

Returns ​

[number, number] | null

release() ​

abstract release(r): void

Defined in: packages/core/src/numeric/chart.ts:274

Internal

Free GPU buffers.

Parameters ​

r ​

RenderBackend

Returns ​

void

remove() ​

remove(): void

Defined in: packages/core/src/numeric/chart.ts:241

Returns ​

void

setData() ​

setData(items): void

Defined in: packages/core/src/numeric/chart.ts:200

Replace the items. They are sorted by x (a stable sort, so items with the same x keep their order and draw a vertical jump). Items without a finite x and value are left out and reported as data:dropped.

Parameters ​

items ​

readonly NumericItem[]

Returns ​

void

setVisible() ​

setVisible(visible): void

Defined in: packages/core/src/numeric/chart.ts:235

Parameters ​

visible ​

boolean

Returns ​

void

span() ​

protected span(lo, hi): [number, number]

Defined in: packages/core/src/numeric/chart.ts:257

Item range [a, b) with x in [lo, hi].

Parameters ​

lo ​

number

hi ​

number

Returns ​

[number, number]

valueAt() ​

abstract valueAt(x): number | null

Defined in: packages/core/src/numeric/chart.ts:268

The value shown for x: the legend value under the crosshair.

Parameters ​

x ​

number

Returns ​

number | null

valueRange() ​

abstract valueRange(lo, hi): [number, number] | null

Defined in: packages/core/src/numeric/chart.ts:270

[min, max] of the values drawn over x in [lo, hi], or null when nothing is drawn there.

Parameters ​

lo ​

number

hi ​

number

Returns ​

[number, number] | null

xUniform() ​

protected xUniform(x): [number, number]

Defined in: packages/core/src/numeric/chart.ts:262

The x transform for the stored values, from the scale's.

Parameters ​

x ​

NumericScale

Returns ​

[number, number]