Class: HeatmapLayer

Defined in: layers/heatmap.ts:56

A drawable data series backed by GPU buffers.

Implements

• Layer

Constructors

Constructor

new HeatmapLayer(gl, opts): HeatmapLayer;

Defined in: layers/heatmap.ts:77

Parameters

Parameter	Type
gl	WebGL2RenderingContext
opts	HeatmapOptions

Returns

HeatmapLayer

Properties

id

readonly id: string;

Defined in: layers/heatmap.ts:57

Implementation of

Layer.id

---

yAxis

readonly yAxis: string;

Defined in: layers/heatmap.ts:58

The y axis this layer is bound to.

Implementation of

Layer.yAxis

Methods

bounds()

bounds(): {
  x: Range;
  y: Range;
};

Defined in: layers/heatmap.ts:174

Data-space bounds of this layer, for autoscaling. null if empty.

Returns

{
  x: Range;
  y: Range;
}

x

x: Range;

y

y: Range;

Implementation of

Layer.bounds

---

colorInfo()

colorInfo(): ColorInfo | null;

Defined in: layers/heatmap.ts:170

Colormap + value range, when this layer maps values to colours — the plot uses it to draw a colorbar. null/absent for solid-coloured layers.

Returns

ColorInfo | null

Implementation of

Layer.colorInfo

---

dispose()

dispose(): void;

Defined in: layers/heatmap.ts:190

Returns

void

Implementation of

Layer.dispose

---

draw()

draw(state): void;

Defined in: layers/heatmap.ts:178

Parameters

Parameter	Type
state	DrawState

Returns

void

Implementation of

Layer.draw

---

setData()

setData(
   values, 
   cols?, 
   rows?): void;

Defined in: layers/heatmap.ts:164

Replace the value grid and re-bake the data texture (for streaming).

Parameters

Parameter	Type
values	ArrayLike<number>
cols	number
rows	number

Returns

void