Skip to content

Class: ParcelValueLayer

Defined in: src/layers/ParcelValueLayer.ts:22

Parcel-native data layer.

Accepts parcel-level values plus per-vertex parcel labels and expands values to vertices for rendering with the existing DataLayer compositing path.

Extends

Constructors

Constructor

ts
new ParcelValueLayer(
   id, 
   parcelData, 
   vertexLabels, 
   colorMap?, 
   config?): ParcelValueLayer;

Defined in: src/layers/ParcelValueLayer.ts:26

Parameters

id

string

parcelData

ParcelData

vertexLabels

| Uint32Array<ArrayBufferLike> | Int32Array<ArrayBufferLike> | number[]

colorMap?

string | Color[]

config?

ParcelValueLayerConfig = {}

Returns

ParcelValueLayer

Overrides

DataLayer.constructor

Properties

id

ts
id: string;

Defined in: src/layers.ts:103

Inherited from

DataLayer.id


visible

ts
visible: boolean;

Defined in: src/layers.ts:104

Inherited from

DataLayer.visible


opacity

ts
opacity: number;

Defined in: src/layers.ts:105

Inherited from

DataLayer.opacity


blendMode

ts
blendMode: BlendMode;

Defined in: src/layers.ts:106

Inherited from

DataLayer.blendMode


order

ts
order: number;

Defined in: src/layers.ts:107

Inherited from

DataLayer.order


needsUpdate

ts
needsUpdate: boolean;

Defined in: src/layers.ts:108

Inherited from

DataLayer.needsUpdate


_onChangeCallback

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

Defined in: src/layers.ts:110

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

Inherited from

DataLayer._onChangeCallback

Methods

setVisible()

ts
setVisible(visible): void;

Defined in: src/layers.ts:132

Parameters

visible

boolean

Returns

void

Inherited from

DataLayer.setVisible


setOpacity()

ts
setOpacity(opacity): void;

Defined in: src/layers.ts:139

Parameters

opacity

number

Returns

void

Inherited from

DataLayer.setOpacity


setBlendMode()

ts
setBlendMode(mode): void;

Defined in: src/layers.ts:147

Parameters

mode

BlendMode

Returns

void

Inherited from

DataLayer.setBlendMode


registerOutlineLayer()

ts
static registerOutlineLayer(ctor): void;

Defined in: src/layers.ts:183

Parameters

ctor

any

Returns

void

Inherited from

DataLayer.registerOutlineLayer


registerTemporalLayer()

ts
static registerTemporalLayer(ctor): void;

Defined in: src/layers.ts:187

Parameters

ctor

any

Returns

void

Inherited from

DataLayer.registerTemporalLayer


fromConfig()

ts
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

DataLayer.fromConfig


setData()

ts
setData(data, indices?): void;

Defined in: src/layers.ts:422

Parameters

data

Float32Array<ArrayBufferLike> | number[]

indices?

Uint32Array<ArrayBufferLike> | number[] | null

Returns

void

Inherited from

DataLayer.setData


getData()

ts
getData(): Float32Array<ArrayBufferLike> | null;

Defined in: src/layers.ts:447

Returns

Float32Array<ArrayBufferLike> | null

Inherited from

DataLayer.getData


setColorMap()

ts
setColorMap(colorMap): void;

Defined in: src/layers.ts:451

Parameters

colorMap

string | ColorMap | Color[]

Returns

void

Inherited from

DataLayer.setColorMap


setRange()

ts
setRange(range): void;

Defined in: src/layers.ts:492

Parameters

range

[number, number]

Returns

void

Inherited from

DataLayer.setRange


setThreshold()

ts
setThreshold(threshold): void;

Defined in: src/layers.ts:500

Parameters

threshold

[number, number]

Returns

void

Inherited from

DataLayer.setThreshold


getRange()

ts
getRange(): [number, number];

Defined in: src/layers.ts:508

Returns

[number, number]

Inherited from

DataLayer.getRange


getThreshold()

ts
getThreshold(): [number, number];

Defined in: src/layers.ts:512

Returns

[number, number]

Inherited from

DataLayer.getThreshold


getColorMapName()

ts
getColorMapName(): string;

Defined in: src/layers.ts:516

Returns

string

Inherited from

DataLayer.getColorMapName


getRGBAData()

ts
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

Inherited from

DataLayer.getRGBAData


dispose()

ts
dispose(): void;

Defined in: src/layers.ts:615

Returns

void

Inherited from

DataLayer.dispose


getParcelData()

ts
getParcelData(): ParcelData;

Defined in: src/layers/ParcelValueLayer.ts:43

Returns

ParcelData


getValueColumn()

ts
getValueColumn(): string;

Defined in: src/layers/ParcelValueLayer.ts:47

Returns

string


getVertexLabels()

ts
getVertexLabels(): Uint32Array;

Defined in: src/layers/ParcelValueLayer.ts:51

Returns

Uint32Array


getParcelMetadata()

ts
getParcelMetadata(parcelId): ParcelRecord | null;

Defined in: src/layers/ParcelValueLayer.ts:55

Parameters

parcelId

number

Returns

ParcelRecord | null


getParcelValue()

ts
getParcelValue(parcelId, valueColumn?): number | null;

Defined in: src/layers/ParcelValueLayer.ts:59

Parameters

parcelId

number

valueColumn?

string = ...

Returns

number | null


setParcelData()

ts
setParcelData(parcelData, valueColumn?): void;

Defined in: src/layers/ParcelValueLayer.ts:63

Parameters

parcelData

ParcelData

valueColumn?

string = ...

Returns

void


setVertexLabels()

ts
setVertexLabels(vertexLabels): void;

Defined in: src/layers/ParcelValueLayer.ts:69

Parameters

vertexLabels

| Uint32Array<ArrayBufferLike> | Int32Array<ArrayBufferLike> | number[]

Returns

void


setValueColumn()

ts
setValueColumn(valueColumn): void;

Defined in: src/layers/ParcelValueLayer.ts:74

Parameters

valueColumn

string

Returns

void


update()

ts
update(updates): void;

Defined in: src/layers/ParcelValueLayer.ts:82

Update layer data Must be implemented by subclasses

Parameters

updates

ParcelValueLayerUpdateData

Returns

void

Overrides

DataLayer.update


toStateJSON()

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

Defined in: src/layers/ParcelValueLayer.ts:119

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

Returns

Record<string, unknown>

Overrides

DataLayer.toStateJSON

Released under the MIT License.