This class is used by HierarchicLayoutCore during the various phases to provide routing details for the edges of the graph.
Remarks
An HierarchicLayoutEdgeLayoutDescriptor instance can be specified individually for single edges using a IDataProvider that returns an HierarchicLayoutEdgeLayoutDescriptor instance for each edge of the graph, or null if no HierarchicLayoutEdgeLayoutDescriptor is bound to an edge. The IDataProvider is registered with the graph using key EDGE_LAYOUT_DESCRIPTOR_DP_KEY.
This class is designed as a class to allow future additions of new getter methods.
Default Values of Properties
| minimumDistance | 10.0d | |
| minimumFirstSegmentLength | 10.0d | |
| minimumLastSegmentLength | 15.0d | |
| minimumLength | 20.0d | |
| minimumOctilinearSegmentLength | 20.0d | |
| minimumSlope | 0.2 | |
| recursiveEdgeStyle | OFF | Edges are not routed recursively. |
| sourcePortOptimization | false | Ports being placed at the side of the node which lies closest to the target of the edge in terms of layering. |
| targetPortOptimization | false | Ports being placed at the side of the node which lies closest to the source of the edge in terms of layering. |
Type Details
- yfiles module
- layout-hierarchic
- yfiles-umd modules
- layout-familytree, layout-hierarchic, layout-radial, layout
- Legacy UMD name
- yfiles.hierarchic.EdgeLayoutDescriptor
See Also
Constructors
Creates a new instance of an HierarchicLayoutEdgeLayoutDescriptor with the default values.
Parameters
A map of options to pass to the method.
- minimumFirstSegmentLength - number
The minimum length of the first segment of the edge path (at the source node). This option sets the minimumFirstSegmentLength property on the created object.
- minimumLastSegmentLength - number
The minimum length of the last segment of the edge path (at the target node). This option sets the minimumLastSegmentLength property on the created object.
- minimumLength - number
The minimum length of an edge. This option sets the minimumLength property on the created object.
- minimumDistance - number
The preferred minimum distance to obstacles. This option sets the minimumDistance property on the created object.
- minimumSlope - number
The minimum slope that the mid segments of this edge should have, if the edge is routed polyline in vertical layouts. This option sets the minimumSlope property on the created object.
- sourcePortOptimization - boolean
Whether or not source port optimization is enabled. This option sets the sourcePortOptimization property on the created object.
- targetPortOptimization - boolean
Whether or not target port optimization is enabled. This option sets the targetPortOptimization property on the created object.
- routingStyle - HierarchicLayoutRoutingStyle
The routing style for this edge. This option sets the routingStyle property on the created object.
- minimumOctilinearSegmentLength - number
The minimum length of octilinear segments for this edge. This option sets the minimumOctilinearSegmentLength property on the created object.
- recursiveEdgeStyle - RecursiveEdgeStyle
How edges in grouped graphs are routed between the content of different groups. This option sets the recursiveEdgeStyle property on the created object.
- directGroupContentEdgeRouting - boolean
Whether or not this edge is routed directly to a group node's border if it connects the group node with one of its descendants. This option sets the directGroupContentEdgeRouting property on the created object.
Properties
Gets or sets whether or not this edge is routed directly to a group node's border if it connects the group node with one of its descendants.
Remarks
Default Value
false.See Also
Sample Graphs
Gets or sets the preferred minimum distance to obstacles.
Remarks
0.Default Value
10.0d.Throws
- Exception({ name: 'ArgumentError' })
- if the minimum length is negative
See Also
Sample Graphs
Gets or sets the minimum length of the first segment of the edge path (at the source node).
Remarks
The minimum length should be greater than 0.
If the value is 0.0d the first segment does not need to be orthogonal.
Default Value
10.0d.Throws
- Exception({ name: 'ArgumentError' })
- if the minimum length of the first segment is negative
See Also
Sample Graphs
Gets or sets the minimum length of the last segment of the edge path (at the target node).
Remarks
The minimum length should be greater than 0.
If the value is 0.0d the last segment does not need to be orthogonal.
Default Value
15.0d.Throws
- Exception({ name: 'ArgumentError' })
- if the minimum length of the last segment is negative
See Also
Sample Graphs
Gets or sets the minimum length of an edge.
Remarks
If this is used for polyline routing, it describes the minimum vertical length of the mid segment. If it is used for orthogonal routing, it describes the minimum length of the whole edge (i.e., the sum of the length of all segments).
The minimum length should be greater than 0.
Default Value
20.0d.Throws
- Exception({ name: 'ArgumentError' })
- if the minimum length is negative
See Also
Sample Graphs
Gets or sets the minimum length of octilinear segments for this edge.
Default Value
20.0d.Throws
- Exception({ name: 'ArgumentError' })
- if the minimum length of the first segment is negative
See Also
Sample Graphs
Gets or sets the minimum slope that the mid segments of this edge should have, if the edge is routed polyline in vertical layouts.
Remarks
In addition, this value influences the steepness for curved edges.
The minimum slope should be greater than 0. For the curved routing style, larger values lead to steeper curves. Steeper curves generally require more height but less width (vertical layout direction).
Default Value
0.2.Throws
- Exception({ name: 'ArgumentError' })
- if the given minimum slope is negative
See Also
Sample Graphs
Gets or sets how edges in grouped graphs are routed between the content of different groups.
Default Value
Throws
- Exception({ name: 'ArgumentError' })
- if an unknown style is specified
See Also
Sample Graphs
Gets or sets the routing style for this edge.
Gets or sets whether or not source port optimization is enabled.
Remarks
null or ANY.Default Value
false.Ports being placed at the side of the node which lies closest to the target of the edge in terms of layering.
Gets or sets whether or not target port optimization is enabled.
Remarks
null or ANY.Default Value
false.Ports being placed at the side of the node which lies closest to the source of the edge in terms of layering.
Methods
Creates a copy of this HierarchicLayoutEdgeLayoutDescriptor instance.
Returns
- ↪HierarchicLayoutEdgeLayoutDescriptor
- a copy of this HierarchicLayoutEdgeLayoutDescriptor instance