Skip to main content

GridLayoutParameters

Options for the GridLayout.

Extends​

Properties​

columns?​

optional columns: number

Optional fixed number of columns. By default this is set to -1 - meaning not fixed - which will result in the layout making its best effort at drawing a grid of equal width and height

height?​

optional height: number

Optional fixed height for the layout.

Inherited from​

LayoutParameters.height

horizontalAlignment?​

optional horizontalAlignment: GridLayoutHorizontalAlignment

Optional alignment for horizontal placement in cells. Defaults to center.

locationFunction?​

optional locationFunction: LocationFunction

Optional function that, given some vertex, can provide the x/y location of the vertex on the canvas

Inherited from​

LayoutParameters.locationFunction

orientation?​

optional orientation: GridLayoutOrientation

Whether to lay out items row first or column first. Additionally, this setting will determine where any extra items are placed if the dataset does not conform to a grid of equal width and height

padding?​

optional padding: PointXY

Optional padding to put around the elements.

Inherited from​

LayoutParameters.padding

rows?​

optional rows: number

Optional fixed number of rows. By default this is set to -1 - meaning not fixed - which will result in the layout making its best effort at drawing a grid of equal width and height.

sort()?​

optional sort: (a, b) => number

Optional sort function to run before layout.

Parameters​

a​

Node | Group

b​

Node | Group

Returns​

number

verticalAlignment?​

optional verticalAlignment: GridLayoutVerticalAlignment

Optional alignment for vertical placement in cells. Defaults to center.

width?​

optional width: number

Optional fixed width for the layout.

Inherited from​

LayoutParameters.width