Interface: WaterfallOptions

Defined in: stats/waterfall.ts:113

Properties

colormap?

optional colormap?: ColormapSpec;

Defined in: stats/waterfall.ts:127

---

cols

cols: number;

Defined in: stats/waterfall.ts:117

Cells across a row. A longer pushed column is block-maxed down to this.

---

domain?

optional domain?: Range;

Defined in: stats/waterfall.ts:126

Value range mapped to the colormap. Strongly recommended: without it the heatmap re-reads its own min/max on every push and the colours breathe.

---

extent

extent: Range;

Defined in: stats/waterfall.ts:115

Data-space extent one row spans — the frequency band, for a spectrogram.

---

fill?

optional fill?: number;

Defined in: stats/waterfall.ts:129

Value filling rows that have not streamed in yet. Default domain[0], else 0.

---

fitView?

optional fitView?: boolean;

Defined in: stats/waterfall.ts:149

Pin the view to the image (default true) — autoscale would pad around it.

---

history?

optional history?: ArrayLike<number>;

Defined in: stats/waterfall.ts:135

A history to open with, cols * rows row-major with row 0 at the bottom (the oldest). The clock then reads the top row as the newest, so a pre-computed spectrogram gets the same time axis a streaming one does.

---

name?

optional name?: string;

Defined in: stats/waterfall.ts:139

Series name — used as the colorbar caption.

---

renderType?

optional renderType?: RenderType;

Defined in: stats/waterfall.ts:152

Buffer-usage hint. Default "dynamic": a waterfall exists to stream.

---

rows

rows: number;

Defined in: stats/waterfall.ts:119

Rows of history kept on screen.

---

rowSeconds

rowSeconds: number;

Defined in: stats/waterfall.ts:121

Seconds of signal one row covers; with rows this sets the time span.

---

smooth?

optional smooth?: boolean;

Defined in: stats/waterfall.ts:137

Bilinear filtering (default true) vs. hard cells.

---

startTime?

optional startTime?: number;

Defined in: stats/waterfall.ts:141

Clock of the first pushed row, in seconds. Default 0.

---

timeFormat?

optional timeFormat?: TimeFormat | ((seconds) => string);

Defined in: stats/waterfall.ts:143

Time tick labels: a preset or your own formatter. Default "hh:mm:ss".

---

timeTicks?

optional timeTicks?: number;

Defined in: stats/waterfall.ts:145

Roughly how many time ticks to place. Default 8.

---

timeTitle?

optional timeTitle?: string;

Defined in: stats/waterfall.ts:147

Axis title for the time axis. Left alone when omitted.

---

yAxis?

optional yAxis?: string;

Defined in: stats/waterfall.ts:150