@graphty/layout / index / ShellLayoutOptions

Interface: ShellLayoutOptions

Defined in: indexed/shell.ts:9

Options of the index-based shell layout.

Extends

• CommonLayoutOptions

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.

Inherited from

CommonLayoutOptions.center

---

dim?

readonly optional dim?: 2 | 3

Defined in: indexed/common.ts:8

Components per row, 2 or 3; default 2.

Inherited from

CommonLayoutOptions.dim

---

nlist?

readonly optional nlist?: string | readonly NodeSet[]

Defined in: indexed/shell.ts:16

The shells, innermost first: either node sets (index arrays, { mask } or { ids }), or the name of a u32 or dict node column whose equal values form one shell, in ascending value (for dict, dictionary) order. A node in no shell, or with an unset value, is not placed: its row is NaN. Default one shell of every node.

---

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.

Inherited from

CommonLayoutOptions.scale

---

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.

Inherited from

CommonLayoutOptions.seed