This class encapsulates the information required to route an edge with a path routing algorithm.
Default Values of Properties
| strongSourcePort | null | No strong source port location for the edge is specified. |
| strongTargetPort | null | No strong target port location for the edge is specified. |
Type Details
- yfiles module
- router-polyline
- yfiles-umd modules
- layout-area, layout-multipage, layout-orthogonal-compact, layout, router-bus, router-polyline
- Legacy UMD name
- yfiles.router.EdgeInfo
See Also
Constructors
Creates a new EdgeInfo instance.
Parameters
A map of options to pass to the method.
- edge - Edge
- the edge to create the info for
- path - EdgeRouterPath
- the path that will be used for routing the edge
- configuration - PathSearchConfiguration
- the configuration of the path search algorithm
Properties
Gets a list of EdgeCellInfos describing how the edge traverses each PartitionCell on its path.
Gets whether the path of this edge is fixed or should be routed by the path search algorithm.
Gets or sets the location of the strong source port that the edge uses.
Remarks
Default Value
null.No strong source port location for the edge is specified.
Throws
- Exception({ name: 'ArgumentError' })
- if the first segment is already fixed and the given port location contradicts the segment's fixed location
See Also
Gets or sets the location of the strong target port that the edge uses.
Remarks
Default Value
null.No strong target port location for the edge is specified.
Throws
- Exception({ name: 'ArgumentError' })
- if the last segment is already fixed and the given port location contradicts the segment's fixed location
See Also
Methods
Calculates an array of LineSegments created by the calculated path points.
Returns
- ↪LineSegment[]
- an array of LineSegments created by the calculated path points
Returns the EdgeCellInfo of the given CellEntrance in the path.
Parameters
A map of options to pass to the method.
- entrance - CellEntrance
- the entrance for which the EdgeCellInfo will be returned
Returns
- ↪EdgeCellInfo
- the EdgeCellInfo of the given CellEntrance in the path
Returns the SegmentInfo of the segment following the segment of the given SegmentInfo.
Parameters
A map of options to pass to the method.
- segment - SegmentInfo
- the segment info for which the next segment info will be returned
Returns
- ↪SegmentInfo
- the segment info of the segment following the segment of the given segment info
Returns the SegmentInfo of the segment preceding the segment of the given SegmentInfo.
Parameters
A map of options to pass to the method.
- segment - SegmentInfo
- the segment info for which the previous segment info will be returned
Returns
- ↪SegmentInfo
- the segment info of the segment preceding the segment of the given segment info
Returns the SegmentInfo of the edge segment with the given index.
Parameters
A map of options to pass to the method.
- segmentIndex - number
- the index of the edge segment for which the segment info will be returned
Returns
- ↪SegmentInfo
- the SegmentInfo of the edge segment with the given index