Abstract base class for ITreeLayoutNodePlacers that support rotations of the subtrees.
Remarks
The direction specified in this RotatableNodePlacerBase (defined by a transformation matrix) rotates the subtree that is placed. This is the final direction of this subtree. Rotations are not accumulated.
ITreeLayoutNodePlacers of this type will only implement the default direction (i.e. top-to-bottom). The other directions are calculated using the specified modification RotatableNodePlacerMatrix. The direction used by the implementing ITreeLayoutNodePlacers is called the model direction while the actual direction in the graph is the real direction.
Note that using rotatable ITreeLayoutNodePlacers has some pitfalls. Calculations must be aware of the rotations. Especially operations on BorderLines should not be called directly (e.g. mergeWithMin, mergeWithMax). The corresponding methods of RotatableNodePlacerBase already support the different directions.
Subclasses just need to override the following two abstract methods: placeSubtreeOfNode and determineChildConnectors.
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.RotatableNodePlacerBase
See Also
Constructors
Creates a new instance of RotatableNodePlacerBase whose direction is specified by the given transformation matrix.
Parameters
A map of options to pass to the method.
- modificationMatrix - RotatableNodePlacerMatrix
- the transformation matrix for the ITreeLayoutNodePlacer
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
false.Ports are not aligned.
Sample Graphs
Gets the modification matrix that defines the direction of the subtree.
See Also
Gets or sets the spacing between subtrees.
Remarks
Default Value
20.Throws
- Exception({ name: 'ArgumentError' })
- if the given spacing is negative
Sample Graphs
Methods
Creates a IComparer<T> for outgoing edges that takes the rotation into account.
Returns
- ↪IComparer<any>
- the IComparer<T> that considers the rotation
Delegates to createComparer.
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
Determines a connector direction for the given child node.
Remarks
Parameters
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
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
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
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
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
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) : RotatedSubtreeShapeArranges the local root relative to the rotated subtree shapes of its children.
Remarks
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
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
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
Fields
The list containing the created children.
The graph instance this ITreeLayoutNodePlacer is working on.
The provider of SubtreeShapes for single nodes.
The provider of SubtreeShapes for whole subtrees.
Static Methods
Translates a point from the real layout direction to the model direction using the given modification matrix.
Parameters
A map of options to pass to the method.
- modificationMatrix - RotatableNodePlacerMatrix
- the modification matrix to use for the translation
- realWorldPoint - YPoint
- the point with coordinates from the real world
Returns
- ↪YPoint
- the translated point with coordinates from the model