Skip to content

@graphty/layout / index / LayoutSimulation

Interface: LayoutSimulation ​

Defined in: simulation/types.ts:68

graph-format design 14.3 LayoutSimulation, verbatim: steppable layouts over the owner's stride-3 scene-unit array.

Properties ​

settled ​

readonly settled: boolean

Defined in: simulation/types.ts:73

Methods ​

dispose() ​

dispose(): void

Defined in: simulation/types.ts:78

Returns ​

void


load() ​

load(snapshot, positions): void

Defined in: simulation/types.ts:70

positions: the owner's stride-3 scene-unit array, read AND written in place.

Parameters ​

snapshot ​

GraphSnapshot

positions ​

F32

Returns ​

void


setFixed() ​

setFixed(mask): void

Defined in: simulation/types.ts:75

The same bitmap layout as a bool column with role "fixed".

Parameters ​

mask ​

U32

Returns ​

void


setPosition() ​

setPosition(index, x, y, z): void

Defined in: simulation/types.ts:77

A drag during the simulation: one node's scene-unit position.

Parameters ​

index ​

number

x ​

number

y ​

number

z ​

number

Returns ​

void


step() ​

step(iterations?): void | Promise<void>

Defined in: simulation/types.ts:72

GPU implementations are async (the readback); CPU implementations return void.

Parameters ​

iterations? ​

number

Returns ​

void | Promise<void>