Skip to content

@graphty/layout / index / GridLayoutOptions

Interface: GridLayoutOptions ​

Defined in: indexed/grid.ts:7

Options of the index-based grid layout.

Extends ​

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


columns? ​

readonly optional columns?: number | null

Defined in: indexed/grid.ts:9

Number of columns, a positive integer; default ceil(sqrt(n)), a square grid.


dim? ​

readonly optional dim?: 2 | 3

Defined in: indexed/common.ts:8

Components per row, 2 or 3; default 2.

Inherited from ​

CommonLayoutOptions.dim


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