GridifyParameters
Defined in: gridify.ts:41
Parameters accepted by gridify, by method.
Properties
Section titled “Properties”alpha?
Section titled “alpha?”optional alpha?: number;Defined in: gridify.ts:63
cmds: weight of the boundary constraint. Defaults to 0.1.
aspect_ratio?
Section titled “aspect_ratio?”optional aspect_ratio?: number;Defined in: gridify.ts:51
dgrid: cell aspect ratio. Defaults to 1.
optional BB?: Bounds | null;Defined in: gridify.ts:71
nmap: region to fill. Defaults to the data’s bounding box.
optional cols?: number;Defined in: gridify.ts:56
gilbert, dgrid: explicit grid dimensions in cells. Both must be given.
For dgrid they override aspect_ratio; for gilbert, whitespace.
Gamma?
Section titled “Gamma?”optional Gamma?: Bounds;Defined in: gridify.ts:59
cmds: boundary the layout is confined to. Defaults to the data’s square bounds.
inner_iterations?
Section titled “inner_iterations?”optional inner_iterations?: number;Defined in: gridify.ts:69
cmds: inner iterations per round, N in Algorithm 1. Defaults to 20.
keep_aspect_ratio?
Section titled “keep_aspect_ratio?”optional keep_aspect_ratio?: boolean;Defined in: gridify.ts:47
hilbert: preserves the data’s aspect ratio.
max_iter?
Section titled “max_iter?”optional max_iter?: number;Defined in: gridify.ts:65
cmds: rounds of Algorithm 1 before the grid is grown.
max_rescales?
Section titled “max_rescales?”optional max_rescales?: number;Defined in: gridify.ts:67
cmds: how many times the grid may grow before giving up.
orientation?
Section titled “orientation?”optional orientation?: HexOrientation;Defined in: gridify.ts:49
gosper: which way up the hexagons sit. Defaults to "flat".
pluslevel?
Section titled “pluslevel?”optional pluslevel?: number;Defined in: gridify.ts:43
hilbert, gosper: extra curve levels beyond the fitted minimum.
optional rows?: number;Defined in: gridify.ts:57
optional size?: number;Defined in: gridify.ts:61
cmds: starting node size. Defaults to a cell of the fitted grid, and shrinks if needed.
squared?
Section titled “squared?”optional squared?: boolean;Defined in: gridify.ts:73
nmap: pads the input so it fills a square grid.
whitespace?
Section titled “whitespace?”optional whitespace?: number;Defined in: gridify.ts:45
hilbert, gilbert: inflates the grid so cells outnumber points.