Class: D3PSeries ​

Defined in: core/series.ts:157

A series: a list of rows, [x, value, ...other columns], that renderers draw. Assign series.data to change it: everything that draws the series follows, with an animation.

Extends ​

Accessors ​

data ​

Get Signature ​

ts
get data(): D3PPoint[];

Defined in: core/series.ts:194

The rows, as [x, value, ...other columns].

Returns ​

D3PPoint[]

Set Signature ​

ts
set data(value): void;

Defined in: core/series.ts:201

Replaces the rows. Anything D3PSeriesData accepts. Everything that draws the series follows, with an animation.

Parameters ​
value ​

D3PSeriesData

Returns ​

void

Constructors ​

Constructor ​

ts
new D3PSeries(opts): D3PSeries;

Defined in: core/series.ts:177

Parameters ​

opts ​

D3PSeriesOptions

Returns ​

D3PSeries

Overrides ​

D3PObject.constructor

Methods ​

column() ​

ts
column(name): any[];

Defined in: core/series.ts:217

The values of one column.

Parameters ​

name ​

string

Returns ​

any[]

destroy() ​

ts
destroy(): void;

Defined in: core/object.ts:51

Detaches the object from all its charts, announces destroyed and releases its subscriptions. The object cannot be used afterwards.

Returns ​

void

Inherited from ​

D3PObject.destroy

fire() ​

ts
protected fire<P>(event, ...args): void;

Defined in: core/object.ts:41

Emits one of its own events on the bus.

Type Parameters ​

P ​

P

Parameters ​

event ​

D3PEvent<P>

args ​

...P extends void ? [] : [payload: P]

Returns ​

void

Inherited from ​

D3PObject.fire

has() ​

ts
has(column): boolean;

Defined in: core/series.ts:212

Whether the series has a column of that name.

Parameters ​

column ​

string

Returns ​

boolean

index() ​

ts
index(column): number;

Defined in: core/series.ts:207

Index of a column in the points, or -1.

Parameters ​

column ​

string

Returns ​

number

onDestroy() ​

ts
protected onDestroy(): void;

Defined in: core/object.ts:46

Hook run first on destroy (detach from partners, release DOM...).

Returns ​

void

Inherited from ​

D3PObject.onDestroy

Properties ​

bus ​

ts
readonly bus: D3PBus;

Defined in: core/object.ts:27

The bus the object uses for its events.

Inherited from ​

D3PObject.bus

columns ​

ts
readonly columns: readonly string[];

Defined in: core/series.ts:161

Column names, in the order of the points: x, the primary column, then the others.

display ​

ts
readonly display: string;

Defined in: core/series.ts:173

The column the tooltip shows as the value.

displayFormat ​

ts
readonly displayFormat: ((value) => string) | undefined;

Defined in: core/series.ts:171

Formats the display column.

domainColumns ​

ts
readonly domainColumns: readonly string[];

Defined in: core/series.ts:165

The value columns that the auto domain fits.

e ​

ts
readonly e: D3PEventTable<M & object>;

Defined in: core/object.ts:29

The events of the object, by name: destroyed for all, and its own (axis.e.scaleChanged).

Inherited from ​

D3PObject.e

inputColumns ​

ts
readonly inputColumns: readonly string[];

Defined in: core/series.ts:163

Column names in the order of the input (x first), for display.

isDestroying ​

ts
isDestroying: boolean = false;

Defined in: core/object.ts:31

Set when destroy starts: the object is not drawn after that.

Inherited from ​

D3PObject.isDestroying

name ​

ts
readonly name: string;

Defined in: core/series.ts:159

The name of the series: shown by tooltips and legends, and the default name of its renderers.

subs ​

ts
protected readonly subs: D3PSubscriptions;

Defined in: core/object.ts:33

The subscriptions of the object, released when it is destroyed.

Inherited from ​

D3PObject.subs

tooltipColumns ​

ts
readonly tooltipColumns: readonly string[];

Defined in: core/series.ts:169

The columns the tooltip lists.

xColumns ​

ts
readonly xColumns: readonly string[];

Defined in: core/series.ts:167

The columns the auto domain fits to the X domain.