This class provides routing settings for edges routed by the OrthogonalLayout.
Inheritance Hierarchy
OrthogonalLayoutEdgeDescriptor
Remarks
OrthogonalLayoutEdgeDescriptor is used by OrthogonalLayout to determine the routing details for the edges (e.g. the segment length).
An OrthogonalLayoutEdgeDescriptor can be specified individually for each edge with edgeDescriptors.
Default Values of Properties
| minimumFirstSegmentLength | 15.0 | |
| minimumLastSegmentLength | 15.0 | |
| minimumSegmentLength | 15.0 |
Type Details
- yFiles module
- algorithms
See Also
Constructors
Creates a new instance of OrthogonalLayoutEdgeDescriptor with the default settings.
Parameters
options - Object
A map of options to pass to the method.
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.
- minimumSegmentLength - number
- The minimum segment length of an edge. This option sets the minimumSegmentLength property on the created object.
Properties
Gets or sets the minimum length of the first segment of the edge path (at the source node).
Remarks
The minimum length must be greater than or equal to
0.Default Value
The default value is
15.0.Property Value
the minimum length of the first segment
Throws
- Exception({ name: 'ArgumentError' })
- if the minimum length of the first segment is negative
Sample Graphs
The final segment length also depends on the used grid size (see gridSpacing). If the grid is larger than the specified minimum length, then the grid size defines the actual minimum.
Gets or sets the minimum length of the last segment of the edge path (at the target node).
Remarks
The minimum length must be greater than or equal to
0.Default Value
The default value is
15.0.Property Value
the minimum length of the last segment
Throws
- Exception({ name: 'ArgumentError' })
- if the minimum length of the last segment is negative
Sample Graphs
The final segment length also depends on the used grid size (see gridSpacing). If the grid is larger than the specified minimum length, then the grid size defines the actual minimum.
Gets or sets the minimum segment length of an edge.
Remarks
The minimum length must be greater than or equal to
0.Default Value
The default value is
15.0.Property Value
the minimum segment length
Throws
- Exception({ name: 'ArgumentError' })
- if the minimum length is negative
Sample Graphs
The final segment length also depends on the used grid size (see gridSpacing). If the grid is larger than the specified minimum length, then the grid size defines the actual minimum.
Methods
Creates a copy of this OrthogonalLayoutEdgeDescriptor instance.
Returns
- ↪OrthogonalLayoutEdgeDescriptor
- a copy of this OrthogonalLayoutEdgeDescriptor instance