Skip to content

Class: RGBALayer ​

Defined in: layers.ts:514

Layer with pre-computed RGBA values (dumb mode)

Extends ​

Constructors ​

Constructor ​

ts
new RGBALayer(
   id, 
   rgbaData, 
   config?
): RGBALayer;

Defined in: layers.ts:517

Parameters ​

id ​

string

rgbaData ​

Float32Array<ArrayBufferLike> | number[]

config? ​

LayerConfig = {}

Returns ​

RGBALayer

Overrides ​

Layer.constructor

Properties ​

id ​

ts
id: string;

Defined in: layers.ts:294

Inherited from ​

Layer.id


visible ​

ts
visible: boolean;

Defined in: layers.ts:295

Inherited from ​

Layer.visible


opacity ​

ts
opacity: number;

Defined in: layers.ts:296

Inherited from ​

Layer.opacity


blendMode ​

ts
blendMode: BlendMode;

Defined in: layers.ts:297

Inherited from ​

Layer.blendMode


needsUpdate ​

ts
needsUpdate: boolean;

Defined in: layers.ts:298

Inherited from ​

Layer.needsUpdate


_onChangeCallback ​

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

Defined in: layers.ts:300

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

Inherited from ​

Layer._onChangeCallback

Accessors ​

order ​

Get Signature ​

ts
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 ​

ts
set order(order): void;

Defined in: layers.ts:347

Parameters ​
order ​

number

Returns ​

void

Inherited from ​

ParcelConnectivityLayer.order

Methods ​

getOrderConstraints() ​

ts
getOrderConstraints(): LayerOrderConstraints;

Defined in: layers.ts:361

Returns ​

LayerOrderConstraints

Inherited from ​

Layer.getOrderConstraints


getPresentation() ​

ts
getPresentation(): LayerPresentation;

Defined in: layers.ts:365

Returns ​

LayerPresentation

Inherited from ​

Layer.getPresentation


setPresentation() ​

ts
setPresentation(presentation): void;

Defined in: layers.ts:369

Parameters ​

presentation ​

Partial<LayerPresentation>

Returns ​

void

Inherited from ​

Layer.setPresentation


getDataSummary() ​

ts
getDataSummary(_options?): LayerDataSummary | null;

Defined in: layers.ts:377

Scalar layers override this without exposing their underlying arrays.

Parameters ​

_options? ​

LayerDataSummaryOptions = {}

Returns ​

LayerDataSummary | null

Inherited from ​

Layer.getDataSummary


setVisible() ​

ts
setVisible(visible): void;

Defined in: layers.ts:432

Parameters ​

visible ​

boolean

Returns ​

void

Inherited from ​

Layer.setVisible


setOpacity() ​

ts
setOpacity(opacity): void;

Defined in: layers.ts:439

Parameters ​

opacity ​

number

Returns ​

void

Inherited from ​

Layer.setOpacity


setBlendMode() ​

ts
setBlendMode(mode): void;

Defined in: layers.ts:447

Parameters ​

mode ​

BlendMode

Returns ​

void

Inherited from ​

Layer.setBlendMode


dispose() ​

ts
dispose(): void;

Defined in: layers.ts:469

Returns ​

void

Inherited from ​

Layer.dispose


fromConfig() ​

ts
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

Inherited from ​

Layer.fromConfig


setRGBAData() ​

ts
setRGBAData(rgbaData): void;

Defined in: layers.ts:522

Parameters ​

rgbaData ​

Float32Array<ArrayBufferLike> | number[]

Returns ​

void


getRGBAData() ​

ts
getRGBAData(vertexCount): Float32Array;

Defined in: layers.ts:542

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

Overrides ​

Layer.getRGBAData


update() ​

ts
update(data): void;

Defined in: layers.ts:555

Update layer data Must be implemented by subclasses

Parameters ​

data ​

RGBALayerUpdateData

Returns ​

void

Overrides ​

Layer.update


toStateJSON() ​

ts
toStateJSON(): Record<string, unknown>;

Defined in: layers.ts:572

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

Returns ​

Record<string, unknown>

Overrides ​

Layer.toStateJSON

Released under the MIT License.