The MultiParentDescriptor provides style information for multi-parent structures.
Remarks
This class is used by TreeLayout to determine the desired layout of nodes that constitute a multi-parent structure. All nodes of such a structure are placed side by side and the incident edges are routed over common points for incoming edges and for outgoing edges.
Default Values of Properties
| edgeRoutingStyle | ORTHOGONAL | |
| minimumBusDistance | 10 | |
| minimumNodeDistance | 15d | |
| verticalAlignment | 0.5 |
Type Details
- yFiles module
- algorithms
See Also
Constructors
Creates a new MultiParentDescriptor instance with default settings.
Parameters
A map of options to pass to the method.
- minimumNodeDistance - number
- The minimum distance between two nodes belonging to the same multi-parent structure. This option sets the minimumNodeDistance property on the created object.
- minimumBusDistance - number
- The minimum distance between the nodes of a multi-parent structure and the bus connecting these nodes. This option sets the minimumBusDistance property on the created object.
- verticalAlignment - number
- The relative vertical alignment of nodes belonging to the same multi-parent structure. This option sets the verticalAlignment property on the created object.
- edgeRoutingStyle - MultiParentRoutingStyle
- The routing style for edges that connect to nodes which constitute a multi-parent structure. This option sets the edgeRoutingStyle property on the created object.
Properties
Gets or sets the routing style for edges that connect to nodes which constitute a multi-parent structure.
Default Value
Throws
- Exception({ name: 'ArgumentError' })
- If the given routing style is unknown
Gets or sets the minimum distance between the nodes of a multi-parent structure and the bus connecting these nodes.
Remarks
In case the edge style is not orthogonal, the bus only consists of a common point.
The minimum distance needs to be non-negative.
Default Value
10.Property Value
Throws
- Exception({ name: 'ArgumentError' })
- if the given bus distance is negative
Sample Graphs
Gets or sets the minimum distance between two nodes belonging to the same multi-parent structure.
Remarks
Default Value
15d.Property Value
Throws
- Exception({ name: 'ArgumentError' })
- if the given node distance is negative
Sample Graphs
Gets or sets the relative vertical alignment of nodes belonging to the same multi-parent structure.
Remarks
A value of 0 means that nodes are top-aligned; a value of 1 means that nodes are bottom-aligned; a value of 0.5 means that nodes are center-aligned.
Values outside the interval [0,1] will result in a compact node placement with unaligned nodes, especially when labels are considered.
Default Value
0.5.