Skip to content

Class: AreaLayer

Defined in: layers/area.ts:40

A drawable data series backed by GPU buffers.

Implements

Constructors

Constructor

ts
new AreaLayer(gl, opts): AreaLayer;

Defined in: layers/area.ts:58

Parameters

ParameterType
glWebGL2RenderingContext
optsAreaOptions

Returns

AreaLayer

Properties

colorCss

ts
readonly colorCss: string;

Defined in: layers/area.ts:43


id

ts
readonly id: string;

Defined in: layers/area.ts:41

Implementation of

Layer.id


name

ts
readonly name: string;

Defined in: layers/area.ts:42


yAxis

ts
readonly yAxis: string;

Defined in: layers/area.ts:44

The y axis this layer is bound to.

Implementation of

Layer.yAxis

Methods

bounds()

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

Defined in: layers/area.ts:126

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

Returns

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

Implementation of

Layer.bounds


dispose()

ts
dispose(): void;

Defined in: layers/area.ts:142

Returns

void

Implementation of

Layer.dispose


draw()

ts
draw(state): void;

Defined in: layers/area.ts:131

Parameters

ParameterType
stateDrawState

Returns

void

Implementation of

Layer.draw


setData()

ts
setData(
   x, 
   y, 
   base?): void;

Defined in: layers/area.ts:105

Replace the area data and re-upload (for streaming).

Parameters

ParameterType
xArrayLike<number>
yArrayLike<number>
base?number | ArrayLike<number>

Returns

void

MIT licensed. WebGL2 required.