Class: D3PWaterfall ​

Defined in: core/transforms.ts:165

A waterfall of running sums. waterfall.series has the columns x, y (end of the step), y0 (its start), value (the change, or the running sum for a total) and kind (up, down or total, to color bars with style.colorBy).

Extends ​

  • D3PTransform

Constructors ​

Constructor ​

ts
new D3PWaterfall(opts): D3PWaterfall;

Defined in: core/transforms.ts:170

Parameters ​

opts ​

D3PWaterfallOptions

Returns ​

D3PWaterfall

Overrides ​

D3PTransform.constructor

Methods ​

compute() ​

ts
protected compute(): void;

Defined in: core/transforms.ts:180

Computes the running sums, with a total where the rows say so.

Returns ​

void

Overrides ​

D3PTransform.compute

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 ​

D3PTransform.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 ​

D3PTransform.fire

onDestroy() ​

ts
protected onDestroy(): void;

Defined in: core/transforms.ts:191

Stops listening to the input and destroys the series it made.

Returns ​

void

Overrides ​

D3PTransform.onDestroy

refresh() ​

ts
protected refresh(): void;

Defined in: core/transforms.ts:32

Computes again, and announces changed.

Returns ​

void

Inherited from ​

D3PTransform.refresh

watch() ​

ts
protected watch(): void;

Defined in: core/transforms.ts:21

Recompute whenever an input changes, and when it is destroyed.

Returns ​

void

Inherited from ​

D3PTransform.watch

Properties ​

bus ​

ts
readonly bus: D3PBus;

Defined in: core/object.ts:27

The bus the object uses for its events.

Inherited from ​

D3PTransform.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 ​

D3PTransform.e

inputs ​

ts
protected readonly inputs: D3PSeries[];

Defined in: core/transforms.ts:16

Inherited from ​

D3PTransform.inputs

isDestroying ​

ts
isDestroying: boolean = false;

Defined in: core/object.ts:31

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

Inherited from ​

D3PTransform.isDestroying

series ​

ts
readonly series: D3PSeries;

Defined in: core/transforms.ts:167

The series the waterfall makes.

subs ​

ts
protected readonly subs: D3PSubscriptions;

Defined in: core/object.ts:33

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

Inherited from ​

D3PTransform.subs