@graphty/layout / index / ForceAtlas2Options

Interface: ForceAtlas2Options

Defined in: simulation/types.ts:23

Design 9.3 ForceAtlas2Options: the names and defaults of the positional forceatlas2Layout (design 7.14).

Extends

• CommonLayoutOptions.SimulationOptions

Properties

center?

readonly optional center?: ArrayLike<number>

Defined in: simulation/types.ts:7

Inherited from

CommonLayoutOptions.center

---

dim?

readonly optional dim?: 2 | 3

Defined in: simulation/types.ts:5

Inherited from

CommonLayoutOptions.dim

---

dissuadeHubs?

readonly optional dissuadeHubs?: boolean

Defined in: simulation/types.ts:36

---

distributedAction?

readonly optional distributedAction?: boolean

Defined in: simulation/types.ts:29

---

gravity?

readonly optional gravity?: number

Defined in: simulation/types.ts:27

---

iterationsPerStep?

readonly optional iterationsPerStep?: number

Defined in: simulation/types.ts:17

Iterations per step() call; default 1; the element passes its stepMultiplier (design 9.4 item 4).

Inherited from

SimulationOptions.iterationsPerStep

---

jitterTolerance?

readonly optional jitterTolerance?: number

Defined in: simulation/types.ts:25

---

linlog?

readonly optional linlog?: boolean

Defined in: simulation/types.ts:30

---

maxInFlight?

readonly optional maxInFlight?: number

Defined in: simulation/types.ts:19

GPU simulations only (design 7.19); default 2.

Inherited from

SimulationOptions.maxInFlight

---

maxIter?

readonly optional maxIter?: number

Defined in: simulation/types.ts:24

---

nodeMass?

readonly optional nodeMass?: string | F32 | Readonly<Record<NodeId, number>> | null

Defined in: simulation/types.ts:32

A per-node mass (n values), the name of a numeric node column, the legacy id-keyed record, or null (role-mass column, else outDegree + 1).

---

nodeSize?

readonly optional nodeSize?: string | F32 | Readonly<Record<NodeId, number>> | null

Defined in: simulation/types.ts:33

---

scale?

readonly optional scale?: number

Defined in: simulation/types.ts:6

Inherited from

CommonLayoutOptions.scale

---

scalingRatio?

readonly optional scalingRatio?: number

Defined in: simulation/types.ts:26

---

seed?

readonly optional seed?: number | null

Defined in: simulation/types.ts:8

Inherited from

CommonLayoutOptions.seed

---

settleThreshold?

readonly optional settleThreshold?: number

Defined in: simulation/types.ts:14

Settle when the mean per-node displacement stays below settleThreshold * rmsRadius for settleWindow iterations (design 7.17).

Inherited from

SimulationOptions.settleThreshold

---

settleWindow?

readonly optional settleWindow?: number

Defined in: simulation/types.ts:15

Inherited from

SimulationOptions.settleWindow

---

strongGravity?

readonly optional strongGravity?: boolean

Defined in: simulation/types.ts:28

---

weight?

readonly optional weight?: string | boolean | null

Defined in: simulation/types.ts:35

true: the snapshot's weights; a string: a numeric edge column; false / null: unweighted.