A PathRequest describes a routing request from a source obstacle to a target obstacle which is handled and considered during a PathSearch.
Inheritance Hierarchy
PathRequest
Remarks
The path that is searched for an edge is potentially split into multiple requests. The path finding algorithm finds a path for each request and, finally, the results are put together to a final, full path for the actual edge. Multiple request are introduced, for example, to model intermediate routing points.
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.PathRequest
See Also
Properties
Gets the EdgeRouterEdgeLayoutDescriptor that describes routing settings for this path request.
Remarks
When implementing PathSearchExtensions and using descriptor settings, always this descriptor belonging to the current request should be queried. It may be different from the one originally registered for the edge when there are multiple PathRequests for an edge.
Gets the path that was found for this path request.
Gets the source obstacle describing the area where this request starts.
Gets the source PortCandidates associated with this path request and describing how the path must connect to the source obstacle.
Gets the target obstacle describing the area where this request ends.
Gets the target PortCandidates associated with this path request and describing how the path must connect to the target obstacle.