PositionDelegate

class

Kind: class
Source: src/delegates/PositionDelegate.js:34

Description

Abstract source for layout positions owned outside the network buffers.

Signature

export class PositionDelegate {

Returns

Subclasses provide synchronized topology and position snapshots for renderers.

Type PositionDelegate

Notes

Use position delegates when layout state lives in GPU buffers or another external system. Subclasses must implement synchronization hooks and bump version whenever positions change.

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/PositionDelegate.js:183

Configures or reads capture network version snapshot.

Parameters

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

Layout And Positions

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

`getNodePositionView(context = {})`

Source: src/delegates/PositionDelegate.js:107

Returns the current node position view value or state.

Parameters

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

`getPositionView(context = {})`

Source: src/delegates/PositionDelegate.js:112

Returns the current position view value or state.

Parameters

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

`getWebGPUPositionBuffer(context = {})`

Source: src/delegates/PositionDelegate.js:116

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/PositionDelegate.js:121

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/PositionDelegate.js:126

Returns the current gpu position resource value or state.

Parameters

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

`getPositionResource(context = {})`

Source: src/delegates/PositionDelegate.js:131

Returns the current position resource value or state.

Parameters

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

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/PositionDelegate.js:135

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

Configuration

General configuration setters and compatibility helpers.

`getVersion(context = {})`

Source: src/delegates/PositionDelegate.js:102

Returns the current version value or state.

Parameters

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

Utilities

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

`onAttach(context = {})`

Source: src/delegates/PositionDelegate.js:67

Configures or reads on attach.

Parameters

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

`onDetach(context = {})`

Source: src/delegates/PositionDelegate.js:79

Configures or reads on detach.

Parameters

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

`markTopologyDirty(reason = 'manual')`

Source: src/delegates/PositionDelegate.js:92

Configures or reads mark topology dirty.

Parameters

Name	Type	Attributes	Default	Description
`reason`	`string`	optional	`'manual'`	Reason for this operation.

`bumpVersion()`

Source: src/delegates/PositionDelegate.js:97

Configures or reads bump version.

`ensureSynchronized(context = {})`

Source: src/delegates/PositionDelegate.js:141

Configures or reads ensure synchronized.

Parameters

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

`synchronizeTopology()`

Source: src/delegates/PositionDelegate.js:202

Configures or reads synchronize topology.