@finchart

Appearance

Documentation / @finchart/core / index / LineDataAccessor

Class: LineDataAccessor ​

Defined in: packages/core/src/data/accessors.ts:28

Pulls display x/y coordinates out of a point.

Implements ​

Constructors ​

Constructor ​

new LineDataAccessor(): LineDataAccessor

Returns ​

LineDataAccessor

Methods ​

assertFinite() ​

assertFinite(point, index, label?): void

Defined in: packages/core/src/data/accessors.ts:41

null is a gap; any other non-finite value is a rejection. y: null meaning whitespace is a contract the README teaches, so that stays, but y: "102" or NaN is a wrong value, not a gap.

Doesn't throw on undefined here — assertReadableValue catches that and gives a better message that also teaches the way out.

Parameters ​

point ​

LineDataPoint

index ​

number

label? ​

string = "data"

Returns ​

void

Implementation of ​

CoordinateAccessor.assertFinite

getX() ​

getX(point): number

Defined in: packages/core/src/data/accessors.ts:29

Where to place it. Can't be absent.

A point with no x isn't whitespace — it's a point that must be dropped. If you don't know where to put it, you can't even draw a gap for it.

Parameters ​

point ​

LineDataPoint

Returns ​

number

Implementation of ​

CoordinateAccessor.getX

getY() ​

getY(point): number | null

Defined in: packages/core/src/data/accessors.ts:46

null passes straight through — having no value is data too.

Parameters ​

point ​

LineDataPoint

Returns ​

number | null

Implementation of ​

CoordinateAccessor.getY