This class manages the best EdgeRouterPaths found for each edge and provides according EdgeInfos.
Inheritance Hierarchy
PathSearchResult
Remarks
These are used by the ChannelBasedPathRouting algorithm to calculate the final segment locations for the segments of an edge path.
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.PathSearchResult
Constructors
Creates a new instance of PathSearchResult.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- configuration - PathSearchConfiguration
- the configuration used for the path search
Methods
Returns an EdgeInfo for the given edge.
Remarks
If the given edge shall be routed but no path has been set for it, yet,
null is returned. If no EdgeInfo has been created for the path by this context before, a new one is instantiated, otherwise the stored one is returned.Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
Returns
See Also
Returns the previously registered path found for the edge.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- edge - Edge
- the edge for which the path is provided
Returns
- ↪EdgeRouterPath
- the previously registered path found for the edge or
nullif no path has been registered, yet
Specifies a found path for an edge.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- edge - Edge
- the edge for which the path is set
- path - EdgeRouterPath
- the found path