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
new ConnectivityLayer(
id,
edges,
config?
): ConnectivityLayer;Defined in: ConnectivityLayer.ts:161
Parameters
id
string
edges
config?
Returns
ConnectivityLayer
Overrides
Properties
id
id: string;Defined in: layers.ts:294
Inherited from
visible
visible: boolean;Defined in: layers.ts:295
Inherited from
opacity
opacity: number;Defined in: layers.ts:296
Inherited from
blendMode
blendMode: BlendMode;Defined in: layers.ts:297
Inherited from
needsUpdate
needsUpdate: boolean;Defined in: layers.ts:298
Inherited from
_onChangeCallback
_onChangeCallback: ((changes) => void) | null;Defined in: layers.ts:300
Callback set by the parent surface to propagate observable layer changes.
Inherited from
Accessors
order
Get Signature
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
set order(order): void;Defined in: layers.ts:347
Parameters
order
number
Returns
void
Inherited from
Methods
fromMatrix()
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()
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
config?
ConnectivityLayerConfig & object = {}
Returns
ConnectivityLayer
getRGBAData()
getRGBAData(vertexCount): Float32Array;Defined in: ConnectivityLayer.ts:332
Non-compositing layer — returns zeroed buffer.
Parameters
vertexCount
number
Returns
Float32Array
Overrides
update()
update(config): void;Defined in: ConnectivityLayer.ts:336
Update layer data Must be implemented by subclasses
Parameters
config
Returns
void
Overrides
attach()
attach(surface): void;Defined in: ConnectivityLayer.ts:450
Parameters
surface
any
Returns
void
detach()
detach(): void;Defined in: ConnectivityLayer.ts:459
Returns
void
getEdgeCount()
getEdgeCount(): number;Defined in: ConnectivityLayer.ts:471
Returns
number
getFilteredEdges()
getFilteredEdges(): ConnectivityEdge[];Defined in: ConnectivityLayer.ts:472
Returns
getRenderMode()
getRenderMode(): RenderMode;Defined in: ConnectivityLayer.ts:473
Returns
getShowNodes()
getShowNodes(): boolean;Defined in: ConnectivityLayer.ts:474
Returns
boolean
getThreshold()
getThreshold(): number;Defined in: ConnectivityLayer.ts:475
Returns
number
getTopN()
getTopN(): number;Defined in: ConnectivityLayer.ts:476
Returns
number
getColorMapName()
getColorMapName(): string;Defined in: ConnectivityLayer.ts:477
Returns
string
getWeightRange()
getWeightRange(): [number, number];Defined in: ConnectivityLayer.ts:478
Returns
[number, number]
getGroup()
getGroup(): Group;Defined in: ConnectivityLayer.ts:479
Returns
Group
getEdgeColors()
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()
toStateJSON(): Record<string, unknown>;Defined in: ConnectivityLayer.ts:501
Serialize common layer state for state persistence. Override in subclasses.
Returns
Record<string, unknown>
Overrides
setClipPlanes()
setClipPlanes(planes): void;Defined in: ConnectivityLayer.ts:520
Propagate clip planes to all connectivity materials.
Parameters
planes
Plane[] | null
Returns
void
dispose()
dispose(): void;Defined in: ConnectivityLayer.ts:840
Returns
void
Overrides
getOrderConstraints()
getOrderConstraints(): LayerOrderConstraints;Defined in: layers.ts:361
Returns
Inherited from
getPresentation()
getPresentation(): LayerPresentation;Defined in: layers.ts:365
Returns
Inherited from
setPresentation()
setPresentation(presentation): void;Defined in: layers.ts:369
Parameters
presentation
Partial<LayerPresentation>
Returns
void
Inherited from
getDataSummary()
getDataSummary(_options?): LayerDataSummary | null;Defined in: layers.ts:377
Scalar layers override this without exposing their underlying arrays.
Parameters
_options?
Returns
LayerDataSummary | null
Inherited from
setVisible()
setVisible(visible): void;Defined in: layers.ts:432
Parameters
visible
boolean
Returns
void
Inherited from
setOpacity()
setOpacity(opacity): void;Defined in: layers.ts:439
Parameters
opacity
number
Returns
void
Inherited from
setBlendMode()
setBlendMode(mode): void;Defined in: layers.ts:447
Parameters
mode
Returns
void
Inherited from
fromConfig()
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