Interface: D3PSeriesOptions ​

Defined in: core/series.ts:128

Options of a series: its name, its data, its columns, and the columns the domains, the tooltip and the display use.

Extends ​

Properties ​

bus? ​

ts
bus?: D3PBus;

Defined in: core/series.ts:130

The bus the series uses (the global bus by default).

columns? ​

ts
columns?: readonly string[];

Defined in: core/series.ts:35

Names of the columns of the input; the first one is x. Default ['x', 'y']. A series with more columns (['x', 'open', 'high', 'low', 'close']) feeds renderers that need them.

Inherited from ​

D3PColumnSpec.columns

data? ​

ts
data?: D3PSeriesData;

Defined in: core/series.ts:134

The first rows. Anything D3PSeriesData accepts.

display? ​

ts
display?: string;

Defined in: core/series.ts:142

Column the tooltip shows as the value (default: the primary one).

displayFormat? ​

ts
displayFormat?: (value) => string;

Defined in: core/series.ts:146

Formats the display column when it is not the primary one (the axis format fits positions, not always the original values).

Parameters ​

value ​

number

Returns ​

string

domainColumns? ​

ts
domainColumns?: readonly string[];

Defined in: core/series.ts:140

Value columns that the auto domain fits when the series is linked to two domains (default: all of them, but size, value, kind, color and label, which are not positions). A stack leaves its original values out, for instance.

fields? ​

ts
fields?: Readonly<Record<string, D3PFieldAccessor>>;

Defined in: core/series.ts:39

For object rows and column-oriented data: where each column comes from (default: its own name).

Inherited from ​

D3PColumnSpec.fields

name ​

ts
name: string;

Defined in: core/series.ts:132

The name of the series, shown in tooltips and legends.

primary? ​

ts
primary?: string;

Defined in: core/series.ts:37

The column read as "the value" where a single one is expected (default: the second column).

Inherited from ​

D3PColumnSpec.primary

tooltipColumns? ​

ts
tooltipColumns?: readonly string[];

Defined in: core/series.ts:144

Columns the tooltip lists when the series has several (default: all but x).

xColumns? ​

ts
xColumns?: readonly string[];

Defined in: core/series.ts:151

Columns the auto domain fits the X domain to (default: x). A histogram lists the edges of its bins, so the axis covers the whole of the first and last bar.