Gets the ITreeLayoutNodePlacer instance that will arrange the upper-left part of the graph.
DelegatingNodePlacer delegates the arrangement of the children to two different ITreeLayoutNodePlacers.
Remarks
Layout Style
This ITreeLayoutNodePlacer can, for example, be used for creating mind maps or a playing schedule of a sports competition.
Default Values of Properties
| spacing | 20 |
Type Details
- yfiles module
- layout-tree
- yfiles-umd modules
- layout-orthogonal-compact, layout-orthogonal, layout-tree, layout
- Legacy UMD name
- yfiles.tree.DelegatingNodePlacer
See Also
Constructors
DelegatingNodePlacer
(modificationMatrix: RotatableNodePlacerMatrix, primaryPlacer: ITreeLayoutNodePlacer, secondaryPlacer: ITreeLayoutNodePlacer)Creates a new DefaultNodePlacer instance with default settings using the given modification matrix and the given node placers as delegates.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- modificationMatrix - RotatableNodePlacerMatrix
- the transformation matrix
- primaryPlacer - ITreeLayoutNodePlacer
- the primary delegate ITreeLayoutNodePlacer which places the left subtrees
- secondaryPlacer - ITreeLayoutNodePlacer
- the secondary delegate ITreeLayoutNodePlacer which places the right subtrees
- 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.
Throws
- Exception({ name: 'ArgumentError' })
- if the given transformation matrix is
null
See Also
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
The default value is
false.Ports are not aligned.
Sample Graphs
Defined in
Gets the modification matrix that defines the direction of the subtree.
Gets the ITreeLayoutNodePlacer instance that will arrange the lower-right part of the graph.
Gets or sets the spacing between subtrees.
Remarks
The spacing needs to be non-negative.
Default Value
The default value is
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.
Delegates to createComparer.
Creates a IProcessor that partitions child nodes of the current root node into two subsets.
Remarks
In a pre-processing step the child nodes are divided into an upper-left and a lower-right subset. The first set is arranged using the first delegate, the second set is arranged using the second delegate. To be able to delegate to different ITreeLayoutNodePlacers this IProcessor adds dummy nodes to which it assigns the according ITreeLayoutNodePlacers.
The changes to the graph are restored in the post-processing step.
Parameters
options - Object
A map of options to pass to the method.
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
See Also
Overrides
Determines a connector direction for the given child node.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- child - YNode
- the child node
Returns
- ↪ParentConnectorDirection
- a direction specifier as defined in the ITreeLayoutNodePlacer interface
Throws
- Exception({ name: 'InvalidOperationError' })
- if this method is called
This method should not be called! Since the direction of the connectors is not used by determineChildConnectors, it does not call this method.
Implements
Does nothing.
Remarks
Since the DelegatingNodePlacer always places one part of the tree on one side and the remaining tree on the opposite side, it doesn't need to calculate the directions of the connectors.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- localRoot - YNode
- the local root node
- 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
Overrides
Returns the rotated subtree shape for the given node.
Remarks
This is a convenience method that retrieves a rotated subtree shape for a single node from the corresponding IDataProvider. This shape may be modified and returned by placeSubtreeOfNode.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- node - YNode
- the node
Returns
- ↪RotatedSubtreeShape
- the subtree shape for the given node
This method can first be called during the execution of placeSubtreeOfNode. Otherwise, the IDataProvider for querying results will not have been initialized yet.
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
options - Object
A map of options to pass to the method.
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
options - Object
A map of options to pass to the method.
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
This is a convenience method that retrieves a subtree shape of a complete subtree from the corresponding IDataProvider.
Parameters
options - Object
A map of options to pass to the method.
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
This method can first be called during the execution of placeSubtreeOfNode. Before, the IDataProvider for querying results will not have been initialized yet.
Defined in
placeSubtree
(nodeShapeProvider: IDataProvider, subtreeShapeProvider: IDataProvider, graph: LayoutGraph, localRoot: YNode, parentConnectorDirection: ParentConnectorDirection) : SubtreeShapePlaces the SubtreeShapes of the child nodes using the two delegate node placers retrieved with primaryPlacer and secondaryPlacer.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- nodeShapeProvider - IDataProvider
- the IDataProvider for obtaining an initial shape of the root node
- subtreeShapeProvider - IDataProvider
- the IDataProvider for accessing the pre-calculated shapes of the subtrees
- 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
Overrides
placeSubtreeOfNode
(localRoot: YNode, parentConnectorDirection: ParentConnectorDirection) : RotatedSubtreeShapeArranges the local root relative to the subtree shape of its children.
Parameters
options - Object
A map of options to pass to the method.
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
Throws
- Exception({ name: 'InvalidOperationError' })
- if this method is called
This method should not be called! Placing subtrees is delegated to the upper-left and the lower-right node placer placeSubtree.
Implements
Returns all upper-left children of the local root node.
Remarks
Which children belong to this list is determined using the IDataProvider registered with PRIMARY_NODES_DP_KEY. If no such IDataProvider is registered, the first half of the children is returned.
These children are placed using the ITreeLayoutNodePlacer returned by primaryPlacer.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- localRoot - YNode
- the local root node
- graph - LayoutGraph
- the input graph
Returns
See Also
Returns all lower-right children of the local root node.
Remarks
Which children belong to this list is determined using the IDataProvider registered with PRIMARY_NODES_DP_KEY. If no such IDataProvider is registered, the second half of the children is returned.
These children are placed using the ITreeLayoutNodePlacer returned by secondaryPlacer.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- localRoot - YNode
- the local root node
- graph - LayoutGraph
- the input graph
Returns
See Also
Translates the given real direction of the resulting layout to the model direction of this RotatableNodePlacerBase.
Remarks
This method is used in placeSubtreeOfNode to be able to retrieve the model direction for the connector
Parameters
options - Object
A map of options to pass to the method.
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
This method is used in determineChildConnectors to be able to return the real connector direction.
Parameters
options - Object
A map of options to pass to the method.
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
A data provider key for dividing the children into two sets.
Remarks
If there is no IDataProvider registered with this key, half of the nodes are placed left of the root and the remaining nodes are placed right of the root.
| Domain | YNode | |
| Values | boolean | true for nodes to place to the left, false otherwise |