@graphty/layout / index / CommonLayoutOptions

Interface: CommonLayoutOptions

Defined in: indexed/common.ts:6

Options every index-based layout takes (graph-format design 14.3).

Extended by

• BfsLayoutOptions
• BipartiteLayoutOptions
• GridLayoutOptions
• MultipartiteLayoutOptions
• RadialLayoutOptions
• ShellLayoutOptions
• SpiralLayoutOptions

Properties

center?

readonly optional center?: ArrayLike<number>

Defined in: indexed/common.ts:12

The centre (for random, the lowest corner of its cell, as in the legacy layout); missing components are 0. Default the origin.

---

dim?

readonly optional dim?: 2 | 3

Defined in: indexed/common.ts:8

Components per row, 2 or 3; default 2.

---

scale?

readonly optional scale?: number

Defined in: indexed/common.ts:10

Size of the layout around its centre; default 1. What it measures is documented per layout.

---

seed?

readonly optional seed?: number | null

Defined in: indexed/common.ts:14

Seed of a layout that draws random numbers; a random seed when absent or null.