Skip to content

Interface: WaterfallHandle

Defined in: stats/waterfall.ts:155

Properties

heatmap

ts
heatmap: HeatmapLayer;

Defined in: stats/waterfall.ts:156


rowSeconds

ts
rowSeconds: number;

Defined in: stats/waterfall.ts:160

Seconds one row covers.


span

ts
span: number;

Defined in: stats/waterfall.ts:162

Seconds of history the axis spans.


values

ts
values: Float64Array;

Defined in: stats/waterfall.ts:158

The history grid, cols * rows, row 0 at the bottom (the oldest row).

Methods

now()

ts
now(): number;

Defined in: stats/waterfall.ts:164

Clock of the newest row — the top of the time axis.

Returns

number


push()

ts
push(column): void;

Defined in: stats/waterfall.ts:166

Newest column in: the history ages one row down and the clock advances one.

Parameters

ParameterType
columnArrayLike<number>

Returns

void


reset()

ts
reset(): void;

Defined in: stats/waterfall.ts:170

Wipe the history back to fill and restart the clock at startTime.

Returns

void


setTimeAxis()

ts
setTimeAxis(opts): void;

Defined in: stats/waterfall.ts:168

Re-label the time axis — swap the format, the tick count or the title.

Parameters

ParameterType
opts{ count?: number; format?: TimeFormat | ((seconds) => string); title?: string; }
opts.count?number
opts.format?TimeFormat | ((seconds) => string)
opts.title?string

Returns

void

MIT licensed. WebGL2 required.