Skip to content

Class: ConnectivityLayer

Defined in: src/ConnectivityLayer.ts:52

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: src/ConnectivityLayer.ts:88

Parameters

id

string

edges

ConnectivityEdge[]

config?

ConnectivityLayerConfig = {}

Returns

ConnectivityLayer

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

fromMatrix()

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

Defined in: src/ConnectivityLayer.ts:142

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: src/ConnectivityLayer.ts:194

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: src/ConnectivityLayer.ts:229

Non-compositing layer — returns zeroed buffer.

Parameters

vertexCount

number

Returns

Float32Array

Overrides

Layer.getRGBAData


update()

ts
update(config): void;

Defined in: src/ConnectivityLayer.ts:233

Update layer data Must be implemented by subclasses

Parameters

config

ConnectivityLayerUpdate

Returns

void

Overrides

Layer.update


attach()

ts
attach(surface): void;

Defined in: src/ConnectivityLayer.ts:313

Parameters

surface

any

Returns

void


detach()

ts
detach(): void;

Defined in: src/ConnectivityLayer.ts:321

Returns

void


getEdgeCount()

ts
getEdgeCount(): number;

Defined in: src/ConnectivityLayer.ts:333

Returns

number


getFilteredEdges()

ts
getFilteredEdges(): ConnectivityEdge[];

Defined in: src/ConnectivityLayer.ts:334

Returns

ConnectivityEdge[]


getRenderMode()

ts
getRenderMode(): RenderMode;

Defined in: src/ConnectivityLayer.ts:335

Returns

RenderMode


getShowNodes()

ts
getShowNodes(): boolean;

Defined in: src/ConnectivityLayer.ts:336

Returns

boolean


getThreshold()

ts
getThreshold(): number;

Defined in: src/ConnectivityLayer.ts:337

Returns

number


getTopN()

ts
getTopN(): number;

Defined in: src/ConnectivityLayer.ts:338

Returns

number


getColorMapName()

ts
getColorMapName(): string;

Defined in: src/ConnectivityLayer.ts:339

Returns

string


getWeightRange()

ts
getWeightRange(): [number, number];

Defined in: src/ConnectivityLayer.ts:340

Returns

[number, number]


getGroup()

ts
getGroup(): Group;

Defined in: src/ConnectivityLayer.ts:341

Returns

Group


getEdgeColors()

ts
getEdgeColors(): Float32Array;

Defined in: src/ConnectivityLayer.ts:347

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: src/ConnectivityLayer.ts:363

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

Returns

Record<string, unknown>

Overrides

Layer.toStateJSON


setClipPlanes()

ts
setClipPlanes(planes): void;

Defined in: src/ConnectivityLayer.ts:382

Propagate clip planes to all connectivity materials.

Parameters

planes

Plane[] | null

Returns

void


dispose()

ts
dispose(): void;

Defined in: src/ConnectivityLayer.ts:681

Returns

void

Overrides

Layer.dispose


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


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

Released under the MIT License.