Skip to content

Interface: HeatmapOptions

Defined in: layers/heatmap.ts:7

Properties

colormap?

ts
optional colormap?: ColormapSpec;

Defined in: layers/heatmap.ts:14


cols

ts
cols: number;

Defined in: layers/heatmap.ts:10


domain?

ts
optional domain?: Range;

Defined in: layers/heatmap.ts:16

Value range mapped to the colormap. Defaults to the data min/max.


extent

ts
extent: {
  x: Range;
  y: Range;
};

Defined in: layers/heatmap.ts:13

Data-space extent the grid spans.

x

ts
x: Range;

y

ts
y: Range;

name?

ts
optional name?: string;

Defined in: layers/heatmap.ts:18

Series name — used as the colorbar caption.


renderType?

ts
optional renderType?: RenderType;

Defined in: layers/heatmap.ts:22

Buffer-usage hint; set "dynamic" when streaming via setData. Default "static".


rows

ts
rows: number;

Defined in: layers/heatmap.ts:11


smooth?

ts
optional smooth?: boolean;

Defined in: layers/heatmap.ts:20

Bilinear filtering (default true) vs. hard cells.


values

ts
values: ArrayLike<number>;

Defined in: layers/heatmap.ts:9

Row-major grid values, length cols * rows (row 0 at the bottom).


yAxis?

ts
optional yAxis?: string;

Defined in: layers/heatmap.ts:23

MIT licensed. WebGL2 required.