Abstract Class: Layer

Defined in: src/layers.ts:102

Base class for all layer types

Extended by

• RGBALayer
• DataLayer
• TwoDataLayer
• BaseLayer
• LabelLayer
• VolumeProjectionLayer
• OutlineLayer
• CurvatureLayer
• ParcelConnectivityLayer
• ConnectivityLayer

Constructors

Constructor

new Layer(id, config?): Layer;

Defined in: src/layers.ts:114

Parameters

id

string

config?

LayerConfig = {}

Returns

Layer

Properties

id

id: string;

Defined in: src/layers.ts:103

---

visible

visible: boolean;

Defined in: src/layers.ts:104

---

opacity

opacity: number;

Defined in: src/layers.ts:105

---

blendMode

blendMode: BlendMode;

Defined in: src/layers.ts:106

---

order

order: number;

Defined in: src/layers.ts:107

---

needsUpdate

needsUpdate: boolean;

Defined in: src/layers.ts:108

---

_onChangeCallback

_onChangeCallback: (() => void) | null;

Defined in: src/layers.ts:110

Callback set by the parent surface to trigger re-compositing on change.

Methods

setVisible()

setVisible(visible): void;

Defined in: src/layers.ts:132

Parameters

visible

boolean

Returns

void

---

setOpacity()

setOpacity(opacity): void;

Defined in: src/layers.ts:139

Parameters

opacity

number

Returns

void

---

setBlendMode()

setBlendMode(mode): void;

Defined in: src/layers.ts:147

Parameters

mode

BlendMode

Returns

void

---

getRGBAData()

abstract getRGBAData(vertexCount): Float32Array;

Defined in: src/layers.ts:159

Get RGBA values for this layer Must be implemented by subclasses

Parameters

vertexCount

number

Returns

Float32Array

---

update()

abstract update(data): void;

Defined in: src/layers.ts:165

Update layer data Must be implemented by subclasses

Parameters

data

LayerUpdateData

Returns

void

---

dispose()

dispose(): void;

Defined in: src/layers.ts:167

Returns

void

---

toStateJSON()

toStateJSON(): Record<string, unknown>;

Defined in: src/layers.ts:172

Serialize common layer state for state persistence. Override in subclasses.

Returns

Record<string, unknown>

---

registerOutlineLayer()

static registerOutlineLayer(ctor): void;

Defined in: src/layers.ts:183

Parameters

ctor

any

Returns

void

---

registerTemporalLayer()

static registerTemporalLayer(ctor): void;

Defined in: src/layers.ts:187

Parameters

ctor

any

Returns

void

---

fromConfig()

static fromConfig(config): Layer;

Defined in: src/layers.ts:199

Create a concrete Layer instance from a plain object configuration. Supports: base, rgba, data, outline.

Parameters

config

Record<string, any>

Returns

Layer