GpuForcePositionDelegate

class

Back to Helios Web API

Kind

class

Source

src/delegates/GpuForcePositionDelegate.js:4708

Description

Position delegate used by GPU force layouts.

Signature

export class GpuForcePositionDelegate extends PositionDelegate {

Parameters

Name	Type	Attributes	Default	Description
options	Object	optional		GPU force layout delegate options and resource handles.

Returns

Delegate that synchronizes graph topology to GPU buffers and exposes position snapshots to Helios renderers.

Type GpuForcePositionDelegate

Notes

This is a low-level extension point. Most applications configure it indirectly through GpuForceLayout or LayoutBehavior.

Filtering And State

Graph filtering and interaction state. When active, FilterBehavior and SelectionBehavior coordinate this area.

resetDynamicStateFromNetwork(context = {}) → {this}

Source: src/delegates/GpuForcePositionDelegate.js:4840

Updates the dynamic state from network state on the current instance.

Parameters

Name	Type	Attributes	Default	Description
context		optional	{}	Value passed to resetDynamicStateFromNetwork.

Returns

This instance.

Type this

Network And Persistence

Network replacement, serialization, and visualization state persistence. ExporterBehavior and InterfaceBehavior can surface parts of this flow in the UI.

captureNetworkVersionSnapshot(network)

Source: src/delegates/GpuForcePositionDelegate.js:4899

Configures or reads capture network version snapshot.

Parameters

Name	Type	Attributes	Default	Description
network	HeliosNetwork			Network instance to read from or mutate.

synchronizeNodePositionsToNetwork(context = {})

Source: src/delegates/GpuForcePositionDelegate.js:5446

Configures or reads synchronize node positions to network.

Parameters

Name	Type	Attributes	Default	Description
context		optional	{}	Value passed to synchronizeNodePositionsToNetwork.

Layout And Positions

Layout selection, position sources, interpolation, and position snapshots. LayoutBehavior handles the built-in layout UI.

getNodePositionView(context = {})

Source: src/delegates/GpuForcePositionDelegate.js:5305

Returns the current node position view value or state.

Parameters

Name	Type	Attributes	Default	Description
context		optional	{}	Value passed to getNodePositionView.

getWebGPUPositionBuffer(context = {})

Source: src/delegates/GpuForcePositionDelegate.js:5318

Returns the current web gpuposition buffer value or state.

Parameters

Name	Type	Attributes	Default	Description
context		optional	{}	Value passed to getWebGPUPositionBuffer.

getWebGLPositionTexture(context = {})

Source: src/delegates/GpuForcePositionDelegate.js:5330

Returns the current web glposition texture value or state.

Parameters

Name	Type	Attributes	Default	Description
context		optional	{}	Value passed to getWebGLPositionTexture.

getGpuPositionResource(context = {})

Source: src/delegates/GpuForcePositionDelegate.js:5343

Returns the current gpu position resource value or state.

Parameters

Name	Type	Attributes	Default	Description
context		optional	{}	Value passed to getGpuPositionResource.

snapshotNodePositions(context = {})

Source: src/delegates/GpuForcePositionDelegate.js:5356

Configures or reads snapshot node positions.

Parameters

Name	Type	Attributes	Default	Description
context		optional	{}	Value passed to snapshotNodePositions.

snapshotNodePositionsById(context = {}, nodeIds = [], options = {})

Source: src/delegates/GpuForcePositionDelegate.js:5370

Configures or reads snapshot node positions by id.

Parameters

Name	Type	Attributes	Default	Description
context		optional	{}	Value passed to snapshotNodePositionsById.
nodeIds	Array<number>|TypedArray	optional	[]	Node or edge identifiers/indices used by the operation.
options	Object	optional	{}	Options object for this operation.

writePositionSnapshot(snapshot, options = {})

Source: src/delegates/GpuForcePositionDelegate.js:5430

Configures or reads write position snapshot.

Parameters

Name	Type	Attributes	Default	Description
snapshot				Value passed to writePositionSnapshot.
options	Object	optional	{}	Options object for this operation.

Appearance

Visual rendering settings for nodes, edges, labels, legends, density, shading, and background. AppearanceBehavior, LabelsBehavior, and LegendsBehavior cover the built-in controls.

flattenNodeDepthToPlane(context = {}, zValue = 0)

Source: src/delegates/GpuForcePositionDelegate.js:5471

Configures or reads flatten node depth to plane.

Parameters

Name	Type	Attributes	Default	Description
context		optional	{}	Value passed to flattenNodeDepthToPlane.
zValue		optional	0	Value passed to flattenNodeDepthToPlane.

injectPlanarDepthJitter(context = {}, amplitude = 0)

Source: src/delegates/GpuForcePositionDelegate.js:5512

Configures or reads inject planar depth jitter.

Parameters

Name	Type	Attributes	Default	Description
context		optional	{}	Value passed to injectPlanarDepthJitter.
amplitude		optional	0	Value passed to injectPlanarDepthJitter.

Configuration

General configuration setters and compatibility helpers.

resetAnnealing() → {this}

Source: src/delegates/GpuForcePositionDelegate.js:4849

Updates the annealing state on the current instance.

Returns

This instance.

Type this

getCompletedEpochs()

Source: src/delegates/GpuForcePositionDelegate.js:4860

Returns the current completed epochs value or state.

Example

const value = helios.getCompletedEpochs();

Utilities

Additional public helpers that do not belong to a narrower API area.

didDetach()

Source: src/delegates/GpuForcePositionDelegate.js:4756

Configures or reads did detach.

updateOptions(next = {})

Source: src/delegates/GpuForcePositionDelegate.js:4760

Configures or reads update options.

Parameters

Name	Type	Attributes	Default	Description
next		optional	{}	Value passed to updateOptions.

dispose()

Source: src/delegates/GpuForcePositionDelegate.js:4815

Configures or reads dispose.

synchronizeTopology(context = {})

Source: src/delegates/GpuForcePositionDelegate.js:4963

Configures or reads synchronize topology.

Parameters

Name	Type	Attributes	Default	Description
context		optional	{}	Value passed to synchronizeTopology.

step(context = {})

Source: src/delegates/GpuForcePositionDelegate.js:5095

Configures or reads step.

Parameters

Name	Type	Attributes	Default	Description
context		optional	{}	Value passed to step.

snapshotNodeCentroidById(context = {}, nodeIds = [], options = {})

Source: src/delegates/GpuForcePositionDelegate.js:5393

Configures or reads snapshot node centroid by id.

Parameters

Name	Type	Attributes	Default	Description
context		optional	{}	Value passed to snapshotNodeCentroidById.
nodeIds	Array<number>|TypedArray	optional	[]	Node or edge identifiers/indices used by the operation.
options	Object	optional	{}	Options object for this operation.