Skip to content

Class: ConnectivityLayer ​

Defined in: ConnectivityLayer.ts:125

Geometry-based layer that renders connectivity edges between surface vertices as lines or instanced tubes, with optional node spheres at endpoints.

This layer does not participate in color compositing; it renders its own THREE.js objects that are attached to the surface mesh.

Extends ​

Constructors ​

Constructor ​

ts
new ConnectivityLayer(
   id, 
   edges, 
   config?
): ConnectivityLayer;

Defined in: ConnectivityLayer.ts:161

Parameters ​

id ​

string

edges ​

ConnectivityEdge[]

config? ​

ConnectivityLayerConfig = {}

Returns ​

ConnectivityLayer

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 ​

ParcelConnectivityLayer.order

Methods ​

fromMatrix() ​

ts
static fromMatrix(
   id, 
   matrix, 
   config?
): ConnectivityLayer;

Defined in: ConnectivityLayer.ts:214

Create from a symmetric NxN weight matrix. Extracts upper-triangle entries (i < j) where weight !== 0.

Parameters ​

id ​

string

matrix ​

Float32Array<ArrayBufferLike> | number[][]

config? ​

ConnectivityLayerConfig & object = {}

Returns ​

ConnectivityLayer


fromSparse() ​

ts
static fromSparse(
   id, 
   csr, 
   config?
): ConnectivityLayer;

Defined in: ConnectivityLayer.ts:271

Create from CSR (Compressed Sparse Row) data. Extracts upper-triangle entries (j > i) to avoid duplicates.

Parameters ​

id ​

string

csr ​

CSRData

config? ​

ConnectivityLayerConfig & object = {}

Returns ​

ConnectivityLayer


getRGBAData() ​

ts
getRGBAData(vertexCount): Float32Array;

Defined in: ConnectivityLayer.ts:332

Non-compositing layer — returns zeroed buffer.

Parameters ​

vertexCount ​

number

Returns ​

Float32Array

Overrides ​

Layer.getRGBAData


update() ​

ts
update(config): void;

Defined in: ConnectivityLayer.ts:336

Update layer data Must be implemented by subclasses

Parameters ​

config ​

ConnectivityLayerUpdate

Returns ​

void

Overrides ​

Layer.update


attach() ​

ts
attach(surface): void;

Defined in: ConnectivityLayer.ts:450

Parameters ​

surface ​

any

Returns ​

void


detach() ​

ts
detach(): void;

Defined in: ConnectivityLayer.ts:459

Returns ​

void


getEdgeCount() ​

ts
getEdgeCount(): number;

Defined in: ConnectivityLayer.ts:471

Returns ​

number


getFilteredEdges() ​

ts
getFilteredEdges(): ConnectivityEdge[];

Defined in: ConnectivityLayer.ts:472

Returns ​

ConnectivityEdge[]


getRenderMode() ​

ts
getRenderMode(): RenderMode;

Defined in: ConnectivityLayer.ts:473

Returns ​

RenderMode


getShowNodes() ​

ts
getShowNodes(): boolean;

Defined in: ConnectivityLayer.ts:474

Returns ​

boolean


getThreshold() ​

ts
getThreshold(): number;

Defined in: ConnectivityLayer.ts:475

Returns ​

number


getTopN() ​

ts
getTopN(): number;

Defined in: ConnectivityLayer.ts:476

Returns ​

number


getColorMapName() ​

ts
getColorMapName(): string;

Defined in: ConnectivityLayer.ts:477

Returns ​

string


getWeightRange() ​

ts
getWeightRange(): [number, number];

Defined in: ConnectivityLayer.ts:478

Returns ​

[number, number]


getGroup() ​

ts
getGroup(): Group;

Defined in: ConnectivityLayer.ts:479

Returns ​

Group


getEdgeColors() ​

ts
getEdgeColors(): Float32Array;

Defined in: ConnectivityLayer.ts:485

Retrieve edge color RGBA values (one per filtered edge). Useful for legend rendering or external visualization.

Returns ​

Float32Array


toStateJSON() ​

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

Defined in: ConnectivityLayer.ts:501

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

Returns ​

Record<string, unknown>

Overrides ​

Layer.toStateJSON


setClipPlanes() ​

ts
setClipPlanes(planes): void;

Defined in: ConnectivityLayer.ts:520

Propagate clip planes to all connectivity materials.

Parameters ​

planes ​

Plane[] | null

Returns ​

void


dispose() ​

ts
dispose(): void;

Defined in: ConnectivityLayer.ts:840

Returns ​

void

Overrides ​

Layer.dispose


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


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

Released under the MIT License.