Skip to content

Class: ParcelConnectivityLayer

Defined in: src/layers/ParcelConnectivityLayer.ts:98

Parcel-native connectivity overlay.

Given a parcel x parcel matrix plus a seed parcel id, this layer paints the surface by the seed parcel's connectivity to every other parcel.

Extends

Constructors

Constructor

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

Defined in: src/layers/ParcelConnectivityLayer.ts:116

Parameters

id

string

matrix

Float32Array<ArrayBufferLike> | number[] | number[][]

parcelData

ParcelData

vertexLabels

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

colorMap?

string | ColorMap | Color[]

config?

ParcelConnectivityLayerConfig = {}

Returns

ParcelConnectivityLayer

Overrides

Layer.constructor

Properties

id

ts
id: string;

Defined in: src/layers.ts:103

Inherited from

Layer.id


visible

ts
visible: boolean;

Defined in: src/layers.ts:104

Inherited from

Layer.visible


opacity

ts
opacity: number;

Defined in: src/layers.ts:105

Inherited from

Layer.opacity


blendMode

ts
blendMode: BlendMode;

Defined in: src/layers.ts:106

Inherited from

Layer.blendMode


order

ts
order: number;

Defined in: src/layers.ts:107

Inherited from

Layer.order


needsUpdate

ts
needsUpdate: boolean;

Defined in: src/layers.ts:108

Inherited from

Layer.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

Layer._onChangeCallback

Methods

setVisible()

ts
setVisible(visible): void;

Defined in: src/layers.ts:132

Parameters

visible

boolean

Returns

void

Inherited from

Layer.setVisible


setOpacity()

ts
setOpacity(opacity): void;

Defined in: src/layers.ts:139

Parameters

opacity

number

Returns

void

Inherited from

Layer.setOpacity


setBlendMode()

ts
setBlendMode(mode): void;

Defined in: src/layers.ts:147

Parameters

mode

BlendMode

Returns

void

Inherited from

Layer.setBlendMode


dispose()

ts
dispose(): void;

Defined in: src/layers.ts:167

Returns

void

Inherited from

Layer.dispose


registerOutlineLayer()

ts
static registerOutlineLayer(ctor): void;

Defined in: src/layers.ts:183

Parameters

ctor

any

Returns

void

Inherited from

Layer.registerOutlineLayer


registerTemporalLayer()

ts
static registerTemporalLayer(ctor): void;

Defined in: src/layers.ts:187

Parameters

ctor

any

Returns

void

Inherited from

Layer.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

Layer.fromConfig


getParcelData()

ts
getParcelData(): ParcelData;

Defined in: src/layers/ParcelConnectivityLayer.ts:146

Returns

ParcelData


getVertexLabels()

ts
getVertexLabels(): Uint32Array;

Defined in: src/layers/ParcelConnectivityLayer.ts:150

Returns

Uint32Array


getSeedParcelId()

ts
getSeedParcelId(): number | null;

Defined in: src/layers/ParcelConnectivityLayer.ts:154

Returns

number | null


getParcelIds()

ts
getParcelIds(): Uint32Array;

Defined in: src/layers/ParcelConnectivityLayer.ts:158

Returns

Uint32Array


getRange()

ts
getRange(): [number, number];

Defined in: src/layers/ParcelConnectivityLayer.ts:162

Returns

[number, number]


getThreshold()

ts
getThreshold(): number | null;

Defined in: src/layers/ParcelConnectivityLayer.ts:166

Returns

number | null


getColorMapName()

ts
getColorMapName(): string;

Defined in: src/layers/ParcelConnectivityLayer.ts:170

Returns

string


setSeedParcel()

ts
setSeedParcel(parcelId): void;

Defined in: src/layers/ParcelConnectivityLayer.ts:174

Parameters

parcelId

number | null

Returns

void


setSeedFromVertex()

ts
setSeedFromVertex(vertexIndex): void;

Defined in: src/layers/ParcelConnectivityLayer.ts:182

Parameters

vertexIndex

number

Returns

void


getConnectivityValue()

ts
getConnectivityValue(parcelId, seedParcelId?): number | null;

Defined in: src/layers/ParcelConnectivityLayer.ts:186

Parameters

parcelId

number

seedParcelId?

number | null

Returns

number | null


setMatrix()

ts
setMatrix(matrix, parcelIds?): void;

Defined in: src/layers/ParcelConnectivityLayer.ts:201

Parameters

matrix

Float32Array<ArrayBufferLike> | number[] | number[][]

parcelIds?

ArrayLike<number>

Returns

void


setParcelData()

ts
setParcelData(parcelData): void;

Defined in: src/layers/ParcelConnectivityLayer.ts:214

Parameters

parcelData

ParcelData

Returns

void


setVertexLabels()

ts
setVertexLabels(vertexLabels): void;

Defined in: src/layers/ParcelConnectivityLayer.ts:226

Parameters

vertexLabels

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

Returns

void


setColorMap()

ts
setColorMap(colorMap): void;

Defined in: src/layers/ParcelConnectivityLayer.ts:231

Parameters

colorMap

string | ColorMap | Color[]

Returns

void


setRange()

ts
setRange(range): void;

Defined in: src/layers/ParcelConnectivityLayer.ts:239

Parameters

range

[number, number]

Returns

void


setThreshold()

ts
setThreshold(threshold): void;

Defined in: src/layers/ParcelConnectivityLayer.ts:245

Parameters

threshold

number | null

Returns

void


setAlphaMode()

ts
setAlphaMode(alphaMode): void;

Defined in: src/layers/ParcelConnectivityLayer.ts:250

Parameters

alphaMode

ParcelConnectivityAlphaMode

Returns

void


setAlphaRange()

ts
setAlphaRange(alphaRange): void;

Defined in: src/layers/ParcelConnectivityLayer.ts:255

Parameters

alphaRange

[number, number]

Returns

void


getRGBAData()

ts
getRGBAData(vertexCount): Float32Array;

Defined in: src/layers/ParcelConnectivityLayer.ts:260

Get RGBA values for this layer Must be implemented by subclasses

Parameters

vertexCount

number

Returns

Float32Array

Overrides

Layer.getRGBAData


update()

ts
update(updates): void;

Defined in: src/layers/ParcelConnectivityLayer.ts:308

Update layer data Must be implemented by subclasses

Parameters

updates

ParcelConnectivityLayerUpdate

Returns

void

Overrides

Layer.update


toStateJSON()

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

Defined in: src/layers/ParcelConnectivityLayer.ts:363

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

Returns

Record<string, unknown>

Overrides

Layer.toStateJSON

Released under the MIT License.