The GridNodePlacer arranges the shapes of the children of a local root in a grid.
Remarks
Layout Style
The grid consists of a number of rows. The subtrees are assigned to the rows using a IDataProvider that is registered with the graph with ROW_INDEX_DP_KEY. If there is no row mapping provided, all subtrees are assigned to a single row. Furthermore, if property automaticRowAssignment is enabled, the row assignment is made automatically - the produced grid will be square-like with respect to the child count, ignoring actual subtree sizes. For example, if there are nine children, a grid with three rows is generated.
The edges from the children to the local root are routed in a bus-like way. The placement of the bus can be configured using the property busPlacement. The alignment of the root node can be configured using rootAlignment. To align the root node with the bus, use BUS_ALIGNED. A bus-aligned root in conjunction with CENTER produces a symmetric grid with the bus and root aligned in the middle.
Default Values of Properties
| automaticRowAssignment | false | The rows are user-specified. |
| busPlacement | LEADING | The bus is placed leading, left of the grid structure. |
| rootAlignment | BUS_ALIGNED | |
| spacing | 20 |
Type Details
- yfiles module
- layout-tree
- yfiles-umd modules
- layout-orthogonal-compact, layout-orthogonal, layout-tree, layout
- Legacy UMD name
- yfiles.tree.GridNodePlacer
See Also
Constructors
Creates a new GridNodePlacer instance with the given modification matrix and root alignment.
Parameters
A map of options to pass to the method.
- modificationMatrix - RotatableNodePlacerMatrix
- the transformation matrix for this RotatableNodePlacerBase
- rootAlignment - RootNodeAlignment
- the alignment of the local root with its subtrees
- busPlacement - BusPlacement
The placement of the bus with respect to the child node grid. This option sets the busPlacement property on the created object.
- automaticRowAssignment - boolean
Whether or not the nodes are automatically assigned to the rows of the grid. This option sets the automaticRowAssignment property on the created object.
- spacing - number
The spacing between subtrees. This option sets the spacing property on the created object.
- alignPorts - boolean
Whether or not nodes are placed so that the source and target port of an edge are aligned. This option sets the alignPorts property on the created object.
Properties
Gets or sets whether or not nodes are placed so that the source and target port of an edge are aligned.
Remarks
Dependent on the RootNodeAlignment the subtree root is moved in a way that the edge connecting the root to one of its children is straightened.
This setting only applies to the following RootNodeAlignments:
Default Value
false.Ports are not aligned.
Sample Graphs
Defined in
Gets or sets whether or not the nodes are automatically assigned to the rows of the grid.
Remarks
Default Value
false.The rows are user-specified.
See Also
Gets the modification matrix that defines the direction of the subtree.
Gets or sets the RootAlginment that defines how the root node is aligned with its children and their shapes.
Default Value
Throws
- Exception({ name: 'ArgumentError' })
- if the given root alignment is
null
Gets or sets the spacing between subtrees.
Remarks
Default Value
20.Throws
- Exception({ name: 'ArgumentError' })
- if the given spacing is negative
Sample Graphs
Defined in
Methods
Creates a IComparer<T> for outgoing edges that takes the rotation into account.
Creates a IComparer<T> that sorts the outgoing edges according to the rows and x-coordinates of their target nodes.
Remarks
Returns
- ↪IComparer<any>
- a IComparer<T> that orders edges lexicographically by row and x-coordinates of their target nodes
See Also
Overrides
Creates an optional IProcessor for pre- and post-processing.
Remarks
null. Hence, no pre- or post-processing is done.Parameters
A map of options to pass to the method.
- layouter - TreeLayout
- the current TreeLayout instance
- graph - LayoutGraph
- the input graph
- currentRoot - YNode
- the root node handled by this ITreeLayoutNodePlacer
Returns
- ↪IProcessor
null
Implements
Provides the direction of the connector to the SubtreeShape for each child node.
Remarks
Parameters
A map of options to pass to the method.
- localRoot - YNode
- the local root
- connectorMap - IDataMap
- the map that must be used for storing the direction specifiers of the child nodes
Domain YNode a child node of the local root Values number the direction specifier assigned to the child node
See Also
Implements
Returns the rotated subtree shape for the given node.
Remarks
Parameters
A map of options to pass to the method.
- node - YNode
- the node
Returns
- ↪RotatedSubtreeShape
- the subtree shape for the given node
Defined in
Returns the target PortConstraint for the local root's incoming edge.
Remarks
This method translates the PortConstraint according to the rotation described by the modification matrix. It should be used instead of getTPC.
This method may be used in placeSubtreeOfNode to route the edges to the according port. It may be overridden to provide constant PortConstraints for each node.
Parameters
A map of options to pass to the method.
- localRoot - YNode
- the local root
Returns
- ↪PortConstraint
- the PortConstraint for the incoming edge of the local root or ANY if no PortConstraint is assigned for that edge
Defined in
Returns the absolute source point of the given edge depending on the rotation of this ITreeLayoutNodePlacer.
Remarks
This method translates the source point according to the rotation described by the modification matrix. It should be used instead of getSourcePointAbs.
It can be used in an implementation of placeSubtreeOfNode.
Parameters
A map of options to pass to the method.
- edge - Edge
- the edge whose absolute source point should be calculated
Returns
- ↪YPoint
- the translated absolute source point for the given edge and current modification matrix
Defined in
Returns the rotated subtree shape for the subtree rooted at the given node.
Remarks
Parameters
A map of options to pass to the method.
- node - YNode
- the local root node
Returns
- ↪RotatedSubtreeShape
- the rotated subtree shape of the subtree rooted at the given local root node
Defined in
placeSubtree
(nodeShapeProvider: IDataProvider, subtreeShapeProvider: IDataProvider, graph: LayoutGraph, localRoot: YNode, parentConnectorDirection: ParentConnectorDirection) : SubtreeShapeInitializes the local data structures and then delegates the work to the abstract variant of this method (placeSubtreeOfNode).
Parameters
A map of options to pass to the method.
- nodeShapeProvider - IDataProvider
- the IDataProvider for obtaining an initial shape of the root node
Domain YNode Values SubtreeShape the shape of the node - subtreeShapeProvider - IDataProvider
- the IDataProvider for accessing the pre-calculated shapes of the subtrees
Domain YNode Values SubtreeShape the shape of the subtree rooted at the node - graph - LayoutGraph
- the input graph
- localRoot - YNode
- the root of the subtree that should be arranged by this method
- parentConnectorDirection - ParentConnectorDirection
- the direction specifier for the connector of the local root node to its parent node
Returns
- ↪SubtreeShape
- the merged SubtreeShape for the subtree rooted at the local root node
See Also
Implements
placeSubtreeOfNode
(localRoot: YNode, parentConnectorDirection: ParentConnectorDirection) : RotatedSubtreeShapePlaces the children of a local root node in a grid.
Parameters
A map of options to pass to the method.
- localRoot - YNode
- the local root node
- parentConnectorDirection - ParentConnectorDirection
- the direction specifier for the connector of the local root node to its parent node
Returns
- ↪RotatedSubtreeShape
- the merged subtree shape that contains the local root node and all its children
Implements
Translates the given real direction of the resulting layout to the model direction of this RotatableNodePlacerBase.
Remarks
Parameters
A map of options to pass to the method.
- realDirection - ParentConnectorDirection
- the real direction
Returns
- ↪number
- the model direction
Throws
- Exception({ name: 'ArgumentError' })
- if translation for the given real direction is not implemented
Defined in
Translates the given model direction to the real direction in the resulting layout.
Remarks
Parameters
A map of options to pass to the method.
- modelDirection - ParentConnectorDirection
- the model direction
Returns
- ↪number
- the real direction
Throws
- Exception({ name: 'ArgumentError' })
- if translation for the given model direction is not implemented
Defined in
Fields
The list containing the created children.
Defined in
The graph instance this ITreeLayoutNodePlacer is working on.
Defined in
The provider of SubtreeShapes for single nodes.
Defined in
The provider of SubtreeShapes for whole subtrees.
Defined in
Constants
Horizontal RootNodeAlignment with the bus of the grid so that the position of the root depends on the selected bus placement.
Remarks
A data provider key for assigning nodes to the rows in the grid.
Remarks
| Domain | YNode | |
| Values | number | the index of the row in the grid of siblings (starting with 0) |