This class provides layout information for the edges of the graph.
Remarks
OrthogonalLayoutEdgeLayoutDescriptor is used by OrthogonalLayout to determine the routing details for the edges (e.g. the segment length).
An OrthogonalLayoutEdgeLayoutDescriptor can be specified individually for each edge by using a IDataProvider which maps from an Edge to an OrthogonalLayoutEdgeLayoutDescriptor instance. The IDataProvider is registered with the graph with key EDGE_LAYOUT_DESCRIPTOR_DP_KEY.
Default Values of Properties
| minimumFirstSegmentLength | 15.0 | |
| minimumLastSegmentLength | 15.0 | |
| minimumSegmentLength | 15.0 |
Type Details
- yfiles module
- layout-orthogonal
- yfiles-umd modules
- layout-orthogonal-compact, layout-orthogonal, layout
- Legacy UMD name
- yfiles.orthogonal.EdgeLayoutDescriptor
See Also
Constructors
Creates a new instance of OrthogonalLayoutEdgeLayoutDescriptor with the default settings.
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.
- 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
0.Default Value
15.0.Throws
- Exception({ name: 'ArgumentError' })
- if the minimum length of the first segment is negative
Sample Graphs
Gets or sets the minimum length of the last segment of the edge path (at the target node).
Remarks
0.Default Value
15.0.Throws
- Exception({ name: 'ArgumentError' })
- if the minimum length of the last segment is negative
Sample Graphs
Gets or sets the minimum segment length of an edge.
Remarks
0.Default Value
15.0.Throws
- Exception({ name: 'ArgumentError' })
- if the minimum length is negative
Sample Graphs
Methods
Creates a copy of this OrthogonalLayoutEdgeLayoutDescriptor instance.
Returns
- ↪OrthogonalLayoutEdgeLayoutDescriptor
- a copy of this OrthogonalLayoutEdgeLayoutDescriptor instance