Skip to content

Class: ParcelConnectivityLayer ​

Defined in: layers/ParcelConnectivityLayer.ts:124

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: layers/ParcelConnectivityLayer.ts:142

Parameters ​

id ​

string

matrix ​

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

parcelData ​

ParcelData

vertexLabels ​

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

colorMap? ​

string | ColorMap | Color[]

config? ​

ParcelConnectivityLayerConfig = {}

Returns ​

ParcelConnectivityLayer

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 ​

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


getParcelData() ​

ts
getParcelData(): ParcelData;

Defined in: layers/ParcelConnectivityLayer.ts:179

Returns ​

ParcelData


getVertexLabels() ​

ts
getVertexLabels(): Uint32Array;

Defined in: layers/ParcelConnectivityLayer.ts:183

Returns ​

Uint32Array


getSeedParcelId() ​

ts
getSeedParcelId(): number | null;

Defined in: layers/ParcelConnectivityLayer.ts:187

Returns ​

number | null


getParcelIds() ​

ts
getParcelIds(): Uint32Array;

Defined in: layers/ParcelConnectivityLayer.ts:191

Returns ​

Uint32Array


getRange() ​

ts
getRange(): [number, number];

Defined in: layers/ParcelConnectivityLayer.ts:195

Returns ​

[number, number]


getThreshold() ​

ts
getThreshold(): number | null;

Defined in: layers/ParcelConnectivityLayer.ts:199

Returns ​

number | null


getColorMapName() ​

ts
getColorMapName(): string;

Defined in: layers/ParcelConnectivityLayer.ts:203

Returns ​

string


setSeedParcel() ​

ts
setSeedParcel(parcelId): void;

Defined in: layers/ParcelConnectivityLayer.ts:207

Parameters ​

parcelId ​

number | null

Returns ​

void


setSeedFromVertex() ​

ts
setSeedFromVertex(vertexIndex): void;

Defined in: layers/ParcelConnectivityLayer.ts:212

Parameters ​

vertexIndex ​

number

Returns ​

void


getConnectivityValue() ​

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

Defined in: layers/ParcelConnectivityLayer.ts:221

Parameters ​

parcelId ​

number

seedParcelId? ​

number | null

Returns ​

number | null


setMatrix() ​

ts
setMatrix(matrix, parcelIds?): void;

Defined in: layers/ParcelConnectivityLayer.ts:236

Parameters ​

matrix ​

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

parcelIds? ​

ArrayLike<number>

Returns ​

void


setParcelData() ​

ts
setParcelData(parcelData): void;

Defined in: layers/ParcelConnectivityLayer.ts:254

Parameters ​

parcelData ​

ParcelData

Returns ​

void


setVertexLabels() ​

ts
setVertexLabels(vertexLabels): void;

Defined in: layers/ParcelConnectivityLayer.ts:266

Parameters ​

vertexLabels ​

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

Returns ​

void


setColorMap() ​

ts
setColorMap(colorMap): void;

Defined in: layers/ParcelConnectivityLayer.ts:271

Parameters ​

colorMap ​

string | ColorMap | Color[]

Returns ​

void


setRange() ​

ts
setRange(range): void;

Defined in: layers/ParcelConnectivityLayer.ts:279

Parameters ​

range ​

[number, number]

Returns ​

void


setThreshold() ​

ts
setThreshold(threshold): void;

Defined in: layers/ParcelConnectivityLayer.ts:286

Parameters ​

threshold ​

number | null

Returns ​

void


setAlphaMode() ​

ts
setAlphaMode(alphaMode): void;

Defined in: layers/ParcelConnectivityLayer.ts:291

Parameters ​

alphaMode ​

ParcelConnectivityAlphaMode

Returns ​

void


setAlphaRange() ​

ts
setAlphaRange(alphaRange): void;

Defined in: layers/ParcelConnectivityLayer.ts:296

Parameters ​

alphaRange ​

[number, number]

Returns ​

void


getRGBAData() ​

ts
getRGBAData(vertexCount): Float32Array;

Defined in: layers/ParcelConnectivityLayer.ts:301

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(updates): void;

Defined in: layers/ParcelConnectivityLayer.ts:349

Update layer data Must be implemented by subclasses

Parameters ​

updates ​

ParcelConnectivityLayerUpdate

Returns ​

void

Overrides ​

Layer.update


toStateJSON() ​

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

Defined in: layers/ParcelConnectivityLayer.ts:434

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

Returns ​

Record<string, unknown>

Overrides ​

Layer.toStateJSON

Released under the MIT License.