Skip to content

@graphty/layout / index / forceAtlas2

Function: forceAtlas2() ​

forceAtlas2(g, options?): LayoutResult

Defined in: indexed/force.ts:49

ForceAtlas2 run for maxIter iterations (default 100; a fractional count runs its ceiling, and 0, a negative or a non-finite count runs none), then rescaled to scale (default 1) about center (default the origin). nodeMass and nodeSize take a Float32Array, a node column name or an id-keyed record; with none, a role-mass node column, else outDegree + 1. weight is true for the snapshot's weights or an edge column name.

Parameters ​

g ​

GraphSnapshot

the graph; a directed snapshot is laid out as its undirected copy

options? ​

IndexedForceAtlas2Options = {}

the options

Returns ​

LayoutResult

dim values per node