charton API

---

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

Class: NumericLineSeries

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

A line, step line or area on a NumericChart, from addLine.

Extends

• NumericSeriesBase<NumericLineOptions>

Constructors

Constructor

new NumericLineSeries(host, options): NumericLineSeries

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

Parameters

host

SeriesHost

options

NumericLineOptions

Returns

NumericLineSeries

Inherited from

NumericSeriesBase<NumericLineOptions>.constructor

Properties

dirty

protected dirty: boolean = true

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

Inherited from

NumericSeriesBase.dirty

---

host

protected readonly host: SeriesHost

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

Inherited from

NumericSeriesBase.host

---

id

readonly id: string

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

Inherited from

NumericSeriesBase.id

---

items

protected items: NumericItem[] = []

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

Inherited from

NumericSeriesBase.items

---

options

options: NumericLineOptions

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

Inherited from

NumericSeriesBase.options

---

type

readonly type: "line" = 'line'

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

---

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.

Inherited from

NumericSeriesBase.xBase

---

xUnit

protected xUnit: number = 1

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

Inherited from

NumericSeriesBase.xUnit

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[]

Inherited from

NumericSeriesBase.data

---

visible

Get Signature

get visible(): boolean

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

Returns

boolean

Inherited from

NumericSeriesBase.visible

Methods

applyOptions()

applyOptions(patch): void

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

Parameters

patch

Partial<O>

Returns

void

Inherited from

NumericSeriesBase.applyOptions

---

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

Inherited from

NumericSeriesBase.changed

---

color()

color(): string

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

The series colour, resolved against the theme.

Returns

string

Inherited from

NumericSeriesBase.color

---

draw()

draw(r, view): void

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

Internal

Parameters

r

RenderBackend

view

DrawView

Returns

void

Overrides

NumericSeriesBase.draw

---

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

Inherited from

NumericSeriesBase.extent

---

release()

release(r): void

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

Internal

Free GPU buffers.

Parameters

r

RenderBackend

Returns

void

Overrides

NumericSeriesBase.release

---

remove()

remove(): void

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

Returns

void

Inherited from

NumericSeriesBase.remove

---

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

Inherited from

NumericSeriesBase.setData

---

setVisible()

setVisible(visible): void

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

Parameters

visible

boolean

Returns

void

Inherited from

NumericSeriesBase.setVisible

---

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]

Inherited from

NumericSeriesBase.span

---

valueAt()

valueAt(x): number | null

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

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

Parameters

x

number

Returns

number | null

Overrides

NumericSeriesBase.valueAt

---

valueRange()

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

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

[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

Overrides

NumericSeriesBase.valueRange

---

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]

Inherited from

NumericSeriesBase.xUniform