Class: D3PAutoDomain ​

Defined in: core/series.ts:266

Fits axis domains to the extent of the series feeding them. mapping[i] is the domain that receives column i of the series (0 = x, 1 = the primary value; null/undefined = ignored); columns past the end of a two-entry mapping feed the second domain, so a candlestick series linked to [time, price] fits price to its lows and highs. A record maps columns by name: { x: time, high: price, low: price }.

Extends ​

Accessors ​

active ​

Get Signature ​

ts
get active(): boolean;

Defined in: core/series.ts:278

Whether it fits the domains.

Returns ​

boolean

Set Signature ​

ts
set active(v): void;

Defined in: core/series.ts:282

Turns the fitting on or off.

Parameters ​
v ​

boolean

Returns ​

void

Constructors ​

Constructor ​

ts
new D3PAutoDomain(opts?): D3PAutoDomain;

Defined in: core/series.ts:272

Parameters ​

opts? ​

D3PAutoDomainOptions = {}

Returns ​

D3PAutoDomain

Overrides ​

D3PObject.constructor

Methods ​

apply() ​

ts
apply(domains?): void;

Defined in: core/series.ts:343

Apply the candidates now (all domains, or the given ones).

Parameters ​

domains? ​

D3PAxisDomain[]

Returns ​

void

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

linkSeries() ​

ts
linkSeries(series, spec): void;

Defined in: core/series.ts:290

Fits domains to this series. spec lists the domain of each column ([time, price]), or maps column names to domains. It replaces any link the series already had.

Parameters ​

series ​

D3PSeries

spec ​

| (D3PAxisDomain | null | undefined)[] | Record<string, D3PAxisDomain | null | undefined>

Returns ​

void

onDestroy() ​

ts
protected onDestroy(): void;

Defined in: core/series.ts:382

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

Returns ​

void

Overrides ​

D3PObject.onDestroy

unlinkAxisDomain() ​

ts
unlinkAxisDomain(domain): void;

Defined in: core/series.ts:335

Stops fitting a domain, whatever series feed it.

Parameters ​

domain ​

D3PAxisDomain

Returns ​

void

unlinkSeries() ​

ts
unlinkSeries(series): void;

Defined in: core/series.ts:324

Stops fitting domains to this series.

Parameters ​

series ​

D3PSeries

Returns ​

void

Properties ​

bus ​

ts
readonly bus: D3PBus;

Defined in: core/object.ts:27

The bus the object uses for its events.

Inherited from ​

D3PObject.bus

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

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

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