Class: DataLayer

Defined in: layers.ts:589

Layer with data values and colormap (smart mode)

Extends

• Layer

Extended by

• TemporalDataLayer
• StatisticalMapLayer
• ParcelValueLayer

Constructors

Constructor

new DataLayer(
   id, 
   data, 
   indices, 
   colorMap, 
   config?
): DataLayer;

Defined in: layers.ts:605

Parameters

id

string

data

Float32Array<ArrayBufferLike> | number[]

indices

number[] | Uint32Array<ArrayBufferLike> | null

colorMap

string | ColorMap | Color[]

config?

DataLayerConfig = {}

Returns

DataLayer

Overrides

Layer.constructor

Properties

id

id: string;

Defined in: layers.ts:303

Inherited from

Layer.id

---

visible

visible: boolean;

Defined in: layers.ts:304

Inherited from

Layer.visible

---

opacity

opacity: number;

Defined in: layers.ts:305

Inherited from

Layer.opacity

---

blendMode

blendMode: BlendMode;

Defined in: layers.ts:306

Inherited from

Layer.blendMode

---

needsUpdate

needsUpdate: boolean;

Defined in: layers.ts:307

Inherited from

Layer.needsUpdate

---

_onChangeCallback

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

Defined in: layers.ts:309

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

Inherited from

Layer._onChangeCallback

Accessors

order

Get Signature

get order(): number;

Defined in: layers.ts:352

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:356

Parameters

order

number

Returns

void

Inherited from

ParcelConnectivityLayer.order

Methods

getOrderConstraints()

getOrderConstraints(): LayerOrderConstraints;

Defined in: layers.ts:370

Returns

LayerOrderConstraints

Inherited from

Layer.getOrderConstraints

---

getPresentation()

getPresentation(): LayerPresentation;

Defined in: layers.ts:374

Returns

LayerPresentation

Inherited from

Layer.getPresentation

---

setPresentation()

setPresentation(presentation): void;

Defined in: layers.ts:378

Parameters

presentation

Partial<LayerPresentation>

Returns

void

Inherited from

Layer.setPresentation

---

setVisible()

setVisible(visible): void;

Defined in: layers.ts:441

Parameters

visible

boolean

Returns

void

Inherited from

Layer.setVisible

---

setOpacity()

setOpacity(opacity): void;

Defined in: layers.ts:448

Parameters

opacity

number

Returns

void

Inherited from

Layer.setOpacity

---

setBlendMode()

setBlendMode(mode): void;

Defined in: layers.ts:456

Parameters

mode

BlendMode

Returns

void

Inherited from

Layer.setBlendMode

---

fromConfig()

static fromConfig(config): Layer;

Defined in: layers.ts:510

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

---

setData()

setData(data, indices?): void;

Defined in: layers.ts:628

Parameters

data

Float32Array<ArrayBufferLike> | number[]

indices?

number[] | Uint32Array<ArrayBufferLike> | null

Returns

void

---

getData()

getData(): Float32Array<ArrayBufferLike> | null;

Defined in: layers.ts:656

Returns

Float32Array<ArrayBufferLike> | null

---

getDataRevision()

getDataRevision(): number;

Defined in: layers.ts:660

Returns

number

---

sampleValueAtVertex()

sampleValueAtVertex(vertexIndex): number | null;

Defined in: layers.ts:669

Sample the scalar mapped to one surface vertex without exposing private dense or sparse storage. Unmapped, out-of-domain, non-finite, and disposed values return null.

Parameters

vertexIndex

number

Returns

number | null

---

getDataSummary()

getDataSummary(options?): LayerDataSummary;

Defined in: layers.ts:695

Scalar layers override this without exposing their underlying arrays.

Parameters

options?

LayerDataSummaryOptions = {}

Returns

LayerDataSummary

Overrides

Layer.getDataSummary

---

setColorMap()

setColorMap(colorMap): void;

Defined in: layers.ts:773

Parameters

colorMap

string | ColorMap | Color[]

Returns

void

---

setRange()

setRange(range): void;

Defined in: layers.ts:814

Parameters

range

[number, number]

Returns

void

---

setThreshold()

setThreshold(threshold): void;

Defined in: layers.ts:823

Parameters

threshold

[number, number]

Returns

void

---

getRange()

getRange(): [number, number];

Defined in: layers.ts:832

Returns

[number, number]

---

getThreshold()

getThreshold(): [number, number];

Defined in: layers.ts:836

Returns

[number, number]

---

setMagnitudeOpacity()

setMagnitudeOpacity(spec): void;

Defined in: layers.ts:841

Fade colours by |value|; null restores the colormap's own alpha.

Parameters

spec

MagnitudeOpacity | null

Returns

void

---

getMagnitudeOpacity()

getMagnitudeOpacity(): MagnitudeOpacity | null;

Defined in: layers.ts:846

Returns

MagnitudeOpacity | null

---

writeThresholdEdgeAttributes()

writeThresholdEdgeAttributes(
   vertexCount, 
   colors, 
   edges
): boolean;

Defined in: layers.ts:867

Per-vertex inputs for fragment-level threshold edges.

Writes, for every vertex, the layer colour it would take just outside the masked interval (colors, straight RGBA, alpha = 1 where data exist) and a signed distance to the mask in data units (edges: > 0 outside the mask, shown; < 0 inside or without data, hidden). Interpolating the distance across triangles lets a shader draw the threshold as a smooth isoline instead of a per-vertex staircase. Returns false when no mask is active.

Parameters

vertexCount

number

colors

Float32Array

edges

Float32Array

Returns

boolean

---

getColorMapName()

getColorMapName(): string;

Defined in: layers.ts:901

Returns

string

---

getColorKeyRange()

getColorKeyRange(): [number, number];

Defined in: layers.ts:910

The value interval a colour key for this layer spans: the display range by default. Layers that map values through more than one scale (e.g. a dual-threshold statistical map) widen it to cover every drawn value.

Returns

[number, number]

---

sampleColorMap()

sampleColorMap(count?): ColorArray[] | null;

Defined in: layers.ts:919

Colour-key stops: count colours sampled evenly from the low to the high end of getColorKeyRange() with the layer's own colour lookup, ignoring the threshold mask. Returns null without a colormap.

Parameters

count?

number = 256

Returns

ColorArray[] | null

---

toStateJSON()

toStateJSON(): Record<string, unknown>;

Defined in: layers.ts:937

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

Returns

Record<string, unknown>

Overrides

Layer.toStateJSON

---

getRGBAData()

getRGBAData(vertexCount): Float32Array;

Defined in: layers.ts:948

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()

update(updates): void;

Defined in: layers.ts:1016

Update layer data Must be implemented by subclasses

Parameters

updates

DataLayerUpdateData

Returns

void

Overrides

Layer.update

---

dispose()

dispose(): void;

Defined in: layers.ts:1054

Returns

void

Overrides

Layer.dispose