@graphty/layout / index / ArfOptions

Interface: ArfOptions

Defined in: indexed/arf.ts:9

Options of indexed.arf.

Properties

a?

readonly optional a?: number

Defined in: indexed/arf.ts:18

The spring strength between neighbours, > 1; default 1.1 (every other pair has strength 1).

---

center?

readonly optional center?: ArrayLike<number>

Defined in: indexed/arf.ts:28

The centre the result is rescaled about (missing components are 0); see scale.

---

dim?

readonly optional dim?: 2 | 3

Defined in: indexed/arf.ts:10

---

maxIter?

readonly optional maxIter?: number

Defined in: indexed/arf.ts:20

The iteration cap; default 1000. The run also stops once the summed force falls to 1e-6.

---

pos?

readonly optional pos?: F32 | null

Defined in: indexed/arf.ts:14

Start positions, dim values per node in index order; each NaN component is drawn from the seed in [0, 1), finite ones are kept.

---

scale?

readonly optional scale?: number

Defined in: indexed/arf.ts:26

When given (or when center is), the result is rescaled so the farthest node is scale from center, as every other one-shot layout's is; default 1 then. When neither is given the result keeps the scale the forces settled at.

---

scaling?

readonly optional scaling?: number

Defined in: indexed/arf.ts:16

The repulsion scale; default 1.

---

seed?

readonly optional seed?: number | null

Defined in: indexed/arf.ts:12

The seed of the rows pos does not give (null or absent: unseeded).