ForceLayout
Defined in: network/force.ts:72
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ForceLayout(
graph,params?):ForceLayout
Defined in: network/force.ts:91
Parameters
Section titled “Parameters”params?
Section titled “params?”Partial<ForceParams> = {}
Returns
Section titled “Returns”ForceLayout
Methods
Section titled “Methods”run(
iterations):void
Defined in: network/force.ts:193
Run iterations ticks.
Parameters
Section titled “Parameters”iterations
Section titled “iterations”number
Returns
Section titled “Returns”void
setPinned()
Section titled “setPinned()”setPinned(
ids):void
Defined in: network/force.ts:110
Set the held (pinned) node set for an interactive drag (#140), replacing any previous one. Pinned
nodes are left where the caller put them — tick won’t move them — so the drag session can
hold them exactly under the cursor while the rest of the layout reheats around them. Pass null
(or an empty iterable) to release every pin. Allocates the flag array lazily on first use.
Parameters
Section titled “Parameters”Iterable<number, any, any> | null
Returns
Section titled “Returns”void
tick()
Section titled “tick()”tick():
void
Defined in: network/force.ts:118
Advance the simulation one step, mutating graph.positions.
Returns
Section titled “Returns”void