WorkerLayout

class

Back to Helios Web API

Kind

class

Source

src/layouts/Layout.js:223

Description

Worker-backed force or jitter layout.

Signature

export class WorkerLayout extends Layout {

Parameters

Name	Type	Attributes	Default	Description
network	HeliosNetwork			Source graph.
visuals	import('../pipeline/VisualAttributes.js').VisualAttributes			Visual attribute owner.
options	Object	optional		Worker layout options such as layout kind, mode, force constants, and sampling settings.

Lifecycle

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

initialize()

Source: src/layouts/Layout.js:232

Configures or reads initialize.

Configuration

General configuration setters and compatibility helpers.

setSettings(next = {}, { reheat = false, reason = 'layout-settings' } = {}) → {this}

Source: src/layouts/Layout.js:317

Set the settings setting.

Parameters

Name	Type	Attributes	Default	Description
next		optional	{}	Value passed to setSettings.
reheat		optional	false	Value passed to setSettings.
reason	string	optional	'layout-settings' } = {}	Reason for this operation.

Returns

This instance.

Type this

getParameterBindings()

Source: src/layouts/Layout.js:338

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/Layout.js:244

Configures or reads should run.

step()

Source: src/layouts/Layout.js:248

Configures or reads step.

handleMessage(message)

Source: src/layouts/Layout.js:278

Configures or reads handle message.

Parameters

Name	Type	Attributes	Default	Description
message				Value passed to handleMessage.

dispose()

Source: src/layouts/Layout.js:310

Configures or reads dispose.

resize(size)

Source: src/layouts/Layout.js:535

Configures or reads resize.

Parameters

Name	Type	Attributes	Default	Description
size				Value passed to resize.

buildGraphPayload()

Source: src/layouts/Layout.js:547

Configures or reads build graph payload.