GridLayout class

This simple layout places all of the Parts in a grid-like arrangement, ordered, spaced apart, and wrapping as needed. It ignores any Links connecting the Nodes being laid out. There are many samples that use GridLayout. Every Palette uses a GridLayout by default.

If you want to experiment interactively with most of the properties, try the Grid Layout sample. See samples that make use of GridLayout in the samples index.

By default this layout will sort all of the Parts alphabetically (comparing Part#text values, respecting case) and position them left-to-right, separated by #spacing.width, until they do not fit in the current row. At that time it starts a new row, separated from the previous row by #spacing.height. There is a uniform cell size equal to the maximum Part width (plus spacing width) and the maximum part height (plus spacing height). At least one part is placed in each row, even if the part by itself is wider than the wrapping width.

You can specify values for the #cellSize width and height. If a part is wider than the cell size, it spans more than one cell in the row. You can also specify a value for the #wrappingWidth, which will be used instead of the diagram's viewport width, to control when each row is considered "full". The value of Layout#isViewportSized will be true when the value of #wrappingWidth is NaN. This causes the layout to be performed again automatically as the viewport changes size.

You can also set #wrappingColumn to limit the number of items in each row. Both the #wrappingWidth and the #wrappingColumn are respected when deciding when to wrap to the next row.

This layout is sufficiently simple that it does not use a LayoutNetwork.

Implemented types

Layout

Available extensions

Annotations

@JS()
@staticInterop

Constructors

GridLayout([dynamic init]): factory

Properties

alignment ↔ EnumValue: Available on GridLayout, provided by the GridLayout$Typings extension
Gets or sets whether the Part#location or the position should be used to arrange each part.
getter/setter pair
arrangement ↔ EnumValue: Available on GridLayout, provided by the GridLayout$Typings extension
Gets or sets how to arrange the parts. Must be GridLayout.LeftToRight or GridLayout.RightToLeft.
getter/setter pair
arrangementOrigin ↔ Point: Available on Layout, provided by the Layout$Typings extension
Gets or sets the top-left point for where the graph should be positioned when laid out. The default value for this property is the Point(0, 0). Setting this property to a new value invalidates this layout. This property is likely to be set by many Layouts that belong to a Group when the layout is performed.
getter/setter pair
boundsComputation ↔ Rect Function(Part, Layout, Rect)?: Available on Layout, provided by the Layout$Typings extension
Gets or sets a function that determines the initial size and position in document coordinates of a LayoutVertex corresponding to a Node. This function is called by #getLayoutBounds. The default value for this property is null, in which case the GraphObject#actualBounds of the Node is used. Setting this property to a new value invalidates this layout.
getter/setter pair
cellSize ↔ Size: Available on GridLayout, provided by the GridLayout$Typings extension
Gets or sets the minimum part size by which each part is positioned in the grid.
getter/setter pair
comparer ↔ num Function(Part, Part): Available on GridLayout, provided by the GridLayout$Typings extension
Gets or sets the comparison function used to sort the parts.
getter/setter pair
diagram ↔ Diagram?: Available on Layout, provided by the Layout$Typings extension
Gets the Diagram that owns this layout, if it is the value of Diagram#layout.
getter/setter pair
group ↔ Group?: Available on Layout, provided by the Layout$Typings extension
Gets the Group that uses this layout, if it is the value of a group's Group#layout.
getter/setter pair
hashCode → int: The hash code for this object.
no setterinherited
isInitial ↔ bool: Available on Layout, provided by the Layout$Typings extension
Gets or sets whether this layout is performed on an initial layout. The default value is true. Setting this property to false causes #isValidLayout to be set to true so that the diagram does not perform this layout.
getter/setter pair
isOngoing ↔ bool: Available on Layout, provided by the Layout$Typings extension
Gets or sets whether this layout can be invalidated by #invalidateLayout. Set this to false to prevent actions such as adding or removing Parts from invalidating this layout. The default value is true. Setting this property does not invalidate this layout.
getter/setter pair
isRealtime ↔ bool?: Available on Layout, provided by the Layout$Typings extension
Gets or sets whether this layout be performed in real-time, before the end of a transaction. All layouts that are invalidated will be performed at the end of a transaction. The default value is null. A null value is treated as true for a Diagram#layout but false for a Group#layout. Setting this property does not invalidate this layout.
getter/setter pair
isRouting ↔ bool: Available on Layout, provided by the Layout$Typings extension
Gets or sets whether this layout routes Links. The default value is true. When false, this layout will not explicitly set the Link#points, and the default routing of each individual Link will take place after the Nodes are moved by #commitLayout. Setting this property does not invalidate this layout.
getter/setter pair
isValidLayout ↔ bool: Available on Layout, provided by the Layout$Typings extension
Gets or sets whether this layout needs to be performed again (if false). Instead of setting this property directly, it is normal to set it to false by calling #invalidateLayout, since that also requests performing a layout in the near future.
getter/setter pair
isViewportSized ↔ bool: Available on Layout, provided by the Layout$Typings extension
Gets or sets whether this layout depends on the Diagram#viewportBounds's size. If set to true, the layout will invalidate when the Diagram's viewport changes size. This only applies to diagram layouts, not to group layouts, and only when Diagram#autoScale is set to Diagram.None.
getter/setter pair
network ↔ LayoutNetwork?: Available on Layout, provided by the Layout$Typings extension
Gets or sets the LayoutNetwork used by this Layout, if any. The default value is null. Setting this property does not invalidate this layout. Not all kinds of layout make use of a LayoutNetwork. Call #createNetwork or #makeNetwork to create a network.
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
sorting ↔ EnumValue: Available on GridLayout, provided by the GridLayout$Typings extension
Gets or sets what order to place the parts. Must be GridLayout.Forward, GridLayout.Reverse, GridLayout.Ascending, or GridLayout.Descending.
getter/setter pair
spacing ↔ Size: Available on GridLayout, provided by the GridLayout$Typings extension
Gets or sets the minimum horizontal and vertical space between parts.
getter/setter pair
wrappingColumn ↔ num: Available on GridLayout, provided by the GridLayout$Typings extension
Gets or sets the maximum number of columns.
getter/setter pair
wrappingWidth ↔ num: Available on GridLayout, provided by the GridLayout$Typings extension
Gets or sets the wrapping width.
getter/setter pair

Methods

cloneProtected(Layout copy) → void: Available on Layout, provided by the Layout$Typings extension
Copies properties from this object to the given object, which is of the same class. This is called by #copy and should be overridden for each class that adds properties. There are examples of such overrides in the samples. Please read the Introduction page on Extensions for how to override methods and how to call this base method.
collectParts(Object coll) → Set<Part>: Available on Layout, provided by the Layout$Typings extension
A convenient way of converting the Diagram|Group|Iterable argument to doLayout to an actual collection of eligible Parts. The resulting Set will not include any Nodes or Links for which Part#canLayout is false. If the argument includes a Group for which Group#layout is null, the resulting Set will include the member parts of that group rather than that group itself. You will not need to call collectParts if you call #makeNetwork, because that method does effectively the same thing when building the LayoutNetwork.
commitLayout() → void: Available on Layout, provided by the Layout$Typings extension
When using a LayoutNetwork, commit changes to the diagram by setting Node positions and by routing the Links. This is called by #updateParts within a transaction.
copy() → Layout: Available on Layout, provided by the Layout$Typings extension
Creates a copy of this Layout and returns it. When a Group is copied that has a Group#layout, the Layout must also be copied. This calls #cloneProtected on a newly constructed Layout. @expose @return {Layout}
createNetwork() → LayoutNetwork: Available on Layout, provided by the Layout$Typings extension
Create a new LayoutNetwork of LayoutVertexes and LayoutEdges. This may be overridden in Layout subclasses to create instances of subclasses of LayoutNetwork. Please read the Introduction page on Extensions for how to override methods and how to call this base method. @expose @return {LayoutNetwork} a new LayoutNetwork.
doLayout(Object coll) → void: Available on GridLayout, provided by the GridLayout$Typings extension
Assign the positions of the parts, ignoring any links. @param {Diagram|Group|Iterable.
doLayout(Object coll) → void: Available on Layout, provided by the Layout$Typings extension
Position all of the nodes that do not have an assigned Part#location in the manner of a simple rectangular array. The default implementation ignores all Groups and Links; many subclasses of Layout ignore all instances of Parts that are not Nodes or Links.
getLayoutBounds(Part part, [Rect? rect]) → Rect: Available on Layout, provided by the Layout$Typings extension
This method is called by layouts to determine the size and initial position of the nodes that it is laying out. Normally this just returns the part's GraphObject#actualBounds. However, if #boundsComputation has been set to a function, that function will be called in order to return the bounds of the given Part in document coordinates that the layout should pretend it has. @param {Part} part the Part being laid out @param {Rect=} rect an optional Rect that will be modified and returned @return {Rect} a Rect in document coordinates @since 2.0
initialOrigin(Point origin) → Point: Available on Layout, provided by the Layout$Typings extension
Compute the desired value of #arrangementOrigin if this Layout is being performed for a Group. This is typically called near the beginning of the implementation of #doLayout: this.arrangementOrigin = this.initialOrigin(this.arrangementOrigin); if the layout wants to respect the pre-layout location of the Group when deciding where to position its member nodes.
invalidateLayout() → void: Available on Layout, provided by the Layout$Typings extension
If #isOngoing is true and if an initial layout has not yet been performed, set the #isValidLayout property to false, and ask to perform another layout in the near future. If #isInitial is true, this layout is invalidated only when the Diagram#model is replaced, not under the normal circumstances such as when parts are added or removed or due to other calls to Layout#invalidateLayout.
makeNetwork(Object coll) → LayoutNetwork: Available on Layout, provided by the Layout$Typings extension
Create and initialize a LayoutNetwork with the given nodes and links. This should be called by #doLayout when this layout uses a #network. This method calls #createNetwork to allocate the network. This may be overridden in Layout subclasses to customize the initialization. Please read the Introduction page on Extensions for how to override methods and how to call this base method. @expose @param {Diagram|Group|Iterable.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited
updateParts() → void: Available on Layout, provided by the Layout$Typings extension
When using a LayoutNetwork, update the "physical" node positionings and link routings. This should be called by #doLayout when this layout uses a #network. This calls #commitLayout to actually set Node positions and route Links. This performs the changes within a transaction. Please read the Introduction page on Extensions for how to override methods and how to call this base method. @expose

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Properties

ascending ↔ EnumValue: Lay out each child according to the sort order given by GridLayout#comparer This value is used for GridLayout#sorting.
getter/setter pair
descending ↔ EnumValue: Lay out each child in reverse sort order given by GridLayout#comparer This value is used for GridLayout#sorting.
getter/setter pair
forward ↔ EnumValue: Lay out each child in the order in which they were found; This value is used for GridLayout#sorting.
getter/setter pair
leftToRight ↔ EnumValue: Fill each row from left to right; This value is used for GridLayout#arrangement.
getter/setter pair
location ↔ EnumValue: Position the part's Part#location at a grid point; This value is used for GridLayout#alignment.
getter/setter pair
position ↔ EnumValue: Position the top-left corner of each part at a grid point; This value is used for GridLayout#alignment.
getter/setter pair
reverse ↔ EnumValue: Lay out each child in reverse order from which they were found; This value is used for GridLayout#sorting.
getter/setter pair
rightToLeft ↔ EnumValue: Fill each row from right to left; This value is used for GridLayout#arrangement.
getter/setter pair