Abstract Class: Layer

Defined in: layers.ts:293

Base class for all layer types

Extended by

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

Constructors

Constructor

new Layer(
   id, 
   config?, 
   orderConstraints?
): Layer;

Defined in: layers.ts:311

Parameters

id

string

config?

LayerConfig = {}

orderConstraints?

Partial<LayerOrderConstraints> & object = {}

Returns

Layer

Properties

id

id: string;

Defined in: layers.ts:294

---

visible

visible: boolean;

Defined in: layers.ts:295

---

opacity

opacity: number;

Defined in: layers.ts:296

---

blendMode

blendMode: BlendMode;

Defined in: layers.ts:297

---

needsUpdate

needsUpdate: boolean;

Defined in: layers.ts:298

---

_onChangeCallback

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

Defined in: layers.ts:300

Callback set by the parent surface to propagate observable layer changes.

Accessors

order

Get Signature

get order(): number;

Defined in: layers.ts:343

Numeric initialization hint used when this layer first enters a stack. Runtime ordering is owned exclusively by LayerStack.

Deprecated

Use LayerStack.setLayerOrder() or LayerStack.moveLayer() after the layer has been added. Runtime writes are ignored.

Returns

number

Set Signature

set order(order): void;

Defined in: layers.ts:347

Parameters

order

number

Returns

void

Methods

getOrderConstraints()

getOrderConstraints(): LayerOrderConstraints;

Defined in: layers.ts:361

Returns

LayerOrderConstraints

---

getPresentation()

getPresentation(): LayerPresentation;

Defined in: layers.ts:365

Returns

LayerPresentation

---

setPresentation()

setPresentation(presentation): void;

Defined in: layers.ts:369

Parameters

presentation

Partial<LayerPresentation>

Returns

void

---

getDataSummary()

getDataSummary(_options?): LayerDataSummary | null;

Defined in: layers.ts:377

Scalar layers override this without exposing their underlying arrays.

Parameters

_options?

LayerDataSummaryOptions = {}

Returns

LayerDataSummary | null

---

setVisible()

setVisible(visible): void;

Defined in: layers.ts:432

Parameters

visible

boolean

Returns

void

---

setOpacity()

setOpacity(opacity): void;

Defined in: layers.ts:439

Parameters

opacity

number

Returns

void

---

setBlendMode()

setBlendMode(mode): void;

Defined in: layers.ts:447

Parameters

mode

BlendMode

Returns

void

---

getRGBAData()

abstract getRGBAData(vertexCount): Float32Array;

Defined in: layers.ts:461

Get straight RGBA values for this layer.

Alpha here is intrinsic data/colormap coverage only. Layer.opacity is applied exactly once by the CPU or GPU compositor.

Parameters

vertexCount

number

Returns

Float32Array

---

update()

abstract update(data): void;

Defined in: layers.ts:467

Update layer data Must be implemented by subclasses

Parameters

data

LayerUpdateData

Returns

void

---

dispose()

dispose(): void;

Defined in: layers.ts:469

Returns

void

---

toStateJSON()

toStateJSON(): Record<string, unknown>;

Defined in: layers.ts:474

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

Returns

Record<string, unknown>

---

fromConfig()

static fromConfig(config): Layer;

Defined in: layers.ts:501

Backward-compatible throwing factory. The package entry point installs the same explicit registry exposed by createLayerFromConfig.

Parameters

config

unknown

Returns

Layer