The AssistantSubtreePlacer places nodes that are marked as assistants left and right of their parents and all other nodes below the assistant nodes.
Remarks
Layout Style
Concept
This ISubtreePlacer delegates the placement of all assistant nodes to an instance of LeftRightSubtreePlacer. The non-assistant nodes are handled by another subtree placer. To be able to do this, AssistantSubtreePlacer uses an ISubtreePlacerProcessor which prepares the graph for node placing.
Nodes can be defined as assistant nodes with assistantNodes.
Default Values of Properties
| childSubtreePlacer | SingleLayerSubtreePlacer | A |
| spacing | 20 |
Type Details
- yFiles module
- algorithms
See Also
Constructors
Creates a new AssistantSubtreePlacer instance.
Parameters
A map of options to pass to the method.
- childSubtreePlacer - ISubtreePlacer
- The ISubtreePlacer instance that places the non-assistant children. This option sets the childSubtreePlacer property on the created object.
- transformation - SubtreeTransform
- The modification matrix that defines the direction of the subtree. This option sets the transformation property on the created object.
- spacing - number
- The spacing between subtrees for the delegate ISubtreePlacer. This option sets the spacing property on the created object.
Properties
Gets or sets the ISubtreePlacer instance that places the non-assistant children.
Remarks
Default Value
A
Property Value
Throws
- Exception({ name: 'ArgumentError' })
- if the given child placer is
nullor an instance of class.
See Also
Gets or sets the spacing between subtrees for the delegate ISubtreePlacer.
Remarks
Default Value
20.Property Value
Throws
- Exception({ name: 'ArgumentError' })
- if the given spacing is negative
Sample Graphs
Gets the modification matrix that defines the direction of the subtree.
Methods
Creates an edge comparison which takes the initial coordinates of the nodes into account.
Remarks
This comparison defines the order of the outgoing edges of a node before the actual placement of the node's subtree is calculated.
The from-sketch comparison functions of the LeftRightSubtreePlacer and childSubtreePlacer are combined into a compound function.
Returns
- ↪function(LayoutEdge, LayoutEdge):number
- the comparison for the edges
Signature Details
function(x: LayoutEdge, y: LayoutEdge) : numberEncapsulates a method that compares two objects.Parameters
- x - LayoutEdge
- The first object to compare.
- y - LayoutEdge
- The second object to compare.
Returns
- number
- An integer value which is
<0ifxis less thany,0ifxis equal toy, or>0ifxis greater thany
Implements
createProcessor
(treeLayout: TreeLayout, graph: LayoutGraph, currentRoot: LayoutNode) : ISubtreePlacerProcessorCreates an optional ISubtreePlacerProcessor for pre- and post-processing.
Remarks
null.Parameters
A map of options to pass to the method.
- treeLayout - TreeLayout
- the current TreeLayout instance
- graph - LayoutGraph
- the input graph
- currentRoot - LayoutNode
- the root node handled by this ISubtreePlacer
Returns
- ↪ISubtreePlacerProcessor?
- a ISubtreePlacerProcessor instance or
null
Implements
determineChildConnectors
(localRoot: LayoutNode, connectorMap: IMapper<LayoutNode,ParentConnectorDirection>)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 - LayoutNode
- the local root node
- connectorMap - IMapper<LayoutNode,ParentConnectorDirection>
- the IMapper<K,V> that is used for storing the direction specifiers of the child nodes
Implements
placeSubtree
(nodeShapeProvider: IMapper<LayoutNode,SubtreeShape>, subtreeShapeProvider: IMapper<LayoutNode,SubtreeShape>, graph: LayoutGraph, localRoot: LayoutNode, parentConnectorDirection: ParentConnectorDirection) : SubtreeShapeArranges the SubtreeShapes of the local root and its children and routes the edges that connect them.
Remarks
This method is the main method of the tree layout algorithm. It is called by TreeLayout in each recursion step to place the local root in relation to its children. Their shapes will be merged into one SubtreeShape, which is returned by this method.
The SubtreeShape for the local root can be obtained from the nodeShapeProvider. subtreeShapeProvider contains the SubtreeShapes assigned to the child nodes.
Due to the order in which the tree nodes are processed, it is guaranteed that at the time of the invocation of this method the SubtreeShape of every descendant node has already been calculated.
Parameters
A map of options to pass to the method.
- nodeShapeProvider - IMapper<LayoutNode,SubtreeShape>
- the IMapper<K,V> for obtaining an initial shape of the root node
- subtreeShapeProvider - IMapper<LayoutNode,SubtreeShape>
- the IMapper<K,V> for accessing the pre-calculated shapes of the subtrees
- graph - LayoutGraph
- the input graph
- localRoot - LayoutNode
- 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 combined shape of the whole subtree
Implements
Constants
A data key for marking which nodes are placed as assistants.
Remarks
true to nodes that are assistants, or false otherwise.