D3Force3DLayout

class

Back to Helios Web API

Kind

class

Source

src/layouts/d3force3dLayoutWorker.js:99

Description

Worker-backed layout adapter for the D3 Force 3D engine.

Signature

export class D3Force3DLayout extends Layout {

Parameters

Name	Type	Attributes	Default	Description
network	HeliosNetwork			Source graph.
visuals	import('../pipeline/VisualAttributes.js').VisualAttributes			Visual attribute owner.
options	Object	optional		D3 force settings and worker options.

Notes

Use this when CPU worker force layout behavior is preferred over GPU force layout, especially for compatibility testing.

Lifecycle

Creation, initialization, prewarming, cleanup, and renderer lifetime.

initialize()

Source: src/layouts/d3force3dLayoutWorker.js:165

Configures or reads initialize.

Filtering And State

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

adoptHandoffState(state = {})

Source: src/layouts/d3force3dLayoutWorker.js:382

Configures or reads adopt handoff state.

Parameters

Name	Type	Attributes	Default	Description
state		optional	{}	Value passed to adoptHandoffState.

Network And Persistence

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

seedFromNetworkPositions()

Source: src/layouts/d3force3dLayoutWorker.js:364

Configures or reads seed from network positions.

Layout And Positions

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

completePositionHandoff(snapshot = null, options = {})

Source: src/layouts/d3force3dLayoutWorker.js:373

Configures or reads complete position handoff.

Parameters

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

Configuration

General configuration setters and compatibility helpers.

setSettings(next = {}, { reheat = false } = {}) → {this}

Source: src/layouts/d3force3dLayoutWorker.js:304

Set the settings setting.

Parameters

Name	Type	Attributes	Default	Description
next		optional	{}	Value passed to setSettings.
reheat		optional	false } = {}	Value passed to setSettings.

Returns

This instance.

Type this

getParameterBindings()

Source: src/layouts/d3force3dLayoutWorker.js:408

Returns the current parameter bindings value or state.

Example

const value = helios.getParameterBindings();

Utilities

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

shouldRun()

Source: src/layouts/d3force3dLayoutWorker.js:178

Configures or reads should run.

step()

Source: src/layouts/d3force3dLayoutWorker.js:182

Configures or reads step.

handleMessage(message)

Source: src/layouts/d3force3dLayoutWorker.js:225

Configures or reads handle message.

Parameters

Name	Type	Attributes	Default	Description
message				Value passed to handleMessage.

dispose()

Source: src/layouts/d3force3dLayoutWorker.js:271

Configures or reads dispose.

reheat(reason = 'layout')

Source: src/layouts/d3force3dLayoutWorker.js:357

Configures or reads reheat.

Parameters

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

buildGraphPayload()

Source: src/layouts/d3force3dLayoutWorker.js:572

Configures or reads build graph payload.