Class: DataLayer

Defined in: src/layers.ts:391

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: src/layers.ts:400

Parameters

id

string

data

Float32Array<ArrayBufferLike> | number[]

indices

Uint32Array<ArrayBufferLike> | number[] | null

colorMap

string | ColorMap | Color[]

config?

DataLayerConfig = {}

Returns

DataLayer

Overrides

Layer.constructor

Properties

id

id: string;

Defined in: src/layers.ts:103

Inherited from

Layer.id

---

visible

visible: boolean;

Defined in: src/layers.ts:104

Inherited from

Layer.visible

---

opacity

opacity: number;

Defined in: src/layers.ts:105

Inherited from

Layer.opacity

---

blendMode

blendMode: BlendMode;

Defined in: src/layers.ts:106

Inherited from

Layer.blendMode

---

order

order: number;

Defined in: src/layers.ts:107

Inherited from

Layer.order

---

needsUpdate

needsUpdate: boolean;

Defined in: src/layers.ts:108

Inherited from

Layer.needsUpdate

---

_onChangeCallback

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

Defined in: src/layers.ts:110

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

Inherited from

Layer._onChangeCallback

Methods

setVisible()

setVisible(visible): void;

Defined in: src/layers.ts:132

Parameters

visible

boolean

Returns

void

Inherited from

Layer.setVisible

---

setOpacity()

setOpacity(opacity): void;

Defined in: src/layers.ts:139

Parameters

opacity

number

Returns

void

Inherited from

Layer.setOpacity

---

setBlendMode()

setBlendMode(mode): void;

Defined in: src/layers.ts:147

Parameters

mode

BlendMode

Returns

void

Inherited from

Layer.setBlendMode

---

registerOutlineLayer()

static registerOutlineLayer(ctor): void;

Defined in: src/layers.ts:183

Parameters

ctor

any

Returns

void

Inherited from

Layer.registerOutlineLayer

---

registerTemporalLayer()

static registerTemporalLayer(ctor): void;

Defined in: src/layers.ts:187

Parameters

ctor

any

Returns

void

Inherited from

Layer.registerTemporalLayer

---

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

Inherited from

Layer.fromConfig

---

setData()

setData(data, indices?): void;

Defined in: src/layers.ts:422

Parameters

data

Float32Array<ArrayBufferLike> | number[]

indices?

Uint32Array<ArrayBufferLike> | number[] | null

Returns

void

---

getData()

getData(): Float32Array<ArrayBufferLike> | null;

Defined in: src/layers.ts:447

Returns

Float32Array<ArrayBufferLike> | null

---

setColorMap()

setColorMap(colorMap): void;

Defined in: src/layers.ts:451

Parameters

colorMap

string | ColorMap | Color[]

Returns

void

---

setRange()

setRange(range): void;

Defined in: src/layers.ts:492

Parameters

range

[number, number]

Returns

void

---

setThreshold()

setThreshold(threshold): void;

Defined in: src/layers.ts:500

Parameters

threshold

[number, number]

Returns

void

---

getRange()

getRange(): [number, number];

Defined in: src/layers.ts:508

Returns

[number, number]

---

getThreshold()

getThreshold(): [number, number];

Defined in: src/layers.ts:512

Returns

[number, number]

---

getColorMapName()

getColorMapName(): string;

Defined in: src/layers.ts:516

Returns

string

---

toStateJSON()

toStateJSON(): Record<string, unknown>;

Defined in: src/layers.ts:520

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

Returns

Record<string, unknown>

Overrides

Layer.toStateJSON

---

getRGBAData()

getRGBAData(vertexCount): Float32Array;

Defined in: src/layers.ts:530

Get RGBA values for this layer Must be implemented by subclasses

Parameters

vertexCount

number

Returns

Float32Array

Overrides

Layer.getRGBAData

---

update()

update(updates): void;

Defined in: src/layers.ts:591

Update layer data Must be implemented by subclasses

Parameters

updates

DataLayerUpdateData

Returns

void

Overrides

Layer.update

---

dispose()

dispose(): void;

Defined in: src/layers.ts:615

Returns

void

Overrides

Layer.dispose