A SeriesParallelLayoutEdgeDescriptor provides routing details for an edge that are considered by SeriesParallelLayout.
Inheritance Hierarchy
SeriesParallelLayoutEdgeDescriptor
Remarks
Such a SeriesParallelLayoutEdgeDescriptor can either be specified for a single edge or shared by several edges with edgeDescriptors. If no SeriesParallelLayoutEdgeDescriptor is specified, the defaultEdgeDescriptor is used.
Default Values of Properties
| minimumFirstSegmentLength | 15 | |
| minimumLastSegmentLength | 15 | |
| minimumLength | 0 |
Type Details
- yFiles module
- algorithms
See Also
SeriesParallelLayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>.edgeDescriptors,
SeriesParallelLayout.defaultEdgeDescriptor
Constructors
Creates a new instance of SeriesParallelLayoutEdgeDescriptor with default settings.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- minimumLength - number
- The minimum length for the associated edge. This option sets the minimumLength property on the created object.
- minimumFirstSegmentLength - number
- The minimum length for the first segment of the associated edge. This option sets the minimumFirstSegmentLength property on the created object.
- minimumLastSegmentLength - number
- The minimum length for the last segment of the associated edge. This option sets the minimumLastSegmentLength property on the created object.
Properties
Gets or sets the minimum length for the first segment of the associated edge.
Remarks
The minimum first segment length needs to be non-negative.
Default Value
The default value is
15.Property Value
the minimum first segment length
Throws
- Exception({ name: 'ArgumentError' })
- for negative minimum segment lengths
Sample Graphs
Gets or sets the minimum length for the last segment of the associated edge.
Remarks
The minimum last segment length needs to be non-negative.
Default Value
The default value is
15.Property Value
the minimum last segment length
Throws
- Exception({ name: 'ArgumentError' })
- for negative minimum segment lengths
Sample Graphs
Gets or sets the minimum length for the associated edge.
Remarks
The minimum length needs to be non-negative.
Default Value
The default value is
0.Property Value
the minimum edge length
Throws
- Exception({ name: 'ArgumentError' })
- for negative edge lengths
Sample Graphs
Methods
Creates a copy of this SeriesParallelLayoutEdgeDescriptor instance.
Returns
- ↪SeriesParallelLayoutEdgeDescriptor
- a copy of this SeriesParallelLayoutEdgeDescriptor instance