Class: BoxLayer

Defined in: layers/box.ts:78

A drawable data series backed by GPU buffers.

Implements

• Layer

Constructors

Constructor

new BoxLayer(gl, opts): BoxLayer;

Defined in: layers/box.ts:101

Parameters

Parameter	Type
gl	WebGL2RenderingContext
opts	BoxOptions

Returns

BoxLayer

Properties

id

readonly id: string;

Defined in: layers/box.ts:79

Implementation of

Layer.id

---

yAxis

readonly yAxis: string;

Defined in: layers/box.ts:80

The y axis this layer is bound to.

Implementation of

Layer.yAxis

Methods

bounds()

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

Defined in: layers/box.ts:231

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

Returns

| { x: Range; y: Range; } | null

Implementation of

Layer.bounds

---

dispose()

dispose(): void;

Defined in: layers/box.ts:257

Returns

void

Implementation of

Layer.dispose

---

draw()

draw(state): void;

Defined in: layers/box.ts:236

Parameters

Parameter	Type
state	DrawState

Returns

void

Implementation of

Layer.draw

---

setData()

setData(groups, width?): void;

Defined in: layers/box.ts:224

Replace the box groups and rebuild the geometry (for streaming).

Parameters

Parameter	Type
groups	BoxGroup[]
width?	number

Returns

void