This class provides context information that is useful for the PathSearch algorithm.
Remarks
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.PathSearchContext
Constructors
Creates a new instance of PathSearchContext.
Parameters
A map of options to pass to the method.
- pathSearch - PathSearch
- the path search that uses this context
- configuration - PathSearchConfiguration
- the configuration used for the path search
Properties
Gets an artificial partition cell with the size of the bounding box of all source cells of the current path request.
See Also
Gets an artificial partition cell with the size of the bounding box of all target cells of the current path request.
See Also
Gets the configuration used for the PathSearch.
Gets the EdgeRouterEdgeLayoutDescriptor for the current edge containing edge specific settings for the path search.
Gets or sets the PathRequest that is currently routed.
Remarks
Gets the IEdgeCursor to iterate over the edges that are routed.
Gets the PathSearch that uses this context.
Gets the results of the PathSearch.
Methods
Adds an additional source cell of the current path request if it is not already contained in the list of source cells.
Parameters
A map of options to pass to the method.
- cell - PartitionCell
- the new source cell to add
See Also
Adds an additional target cell of the current path request if it is not already contained in the list of target cells.
Parameters
A map of options to pass to the method.
- cell - PartitionCell
- the new target cell to add
See Also
Returns the source cell with the given index in the list of all cells that are covered by the source of the current path request.
Parameters
A map of options to pass to the method.
- index - number
- the index of the source cell
Returns
- ↪PartitionCell
- the source cell with the given index in the list of all source cells
Returns the target cell with the given index in the list of all cells that are covered by the target of the current path request.
Parameters
A map of options to pass to the method.
- index - number
- the index of the target cell
Returns
- ↪PartitionCell
- the target cell with the given index in the list of all cells that are covered by the target of the current path request
Determines whether or not the given cell is a source cell of the current path request.
Parameters
A map of options to pass to the method.
- cell - PartitionCell
- the cell
Returns
- ↪boolean
trueif the given cell is in the list of source cells,falseotherwise
See Also
Determines whether or not the given cell is a target cell of the current path request.
Parameters
A map of options to pass to the method.
- cell - PartitionCell
- the cell
Returns
- ↪boolean
trueif the given cell is in the list of target cells,falseotherwise
See Also
Returns the number of all cells that are covered by the source of the current path request.
Returns
- ↪number
- the number of all cells that are covered by the source
Returns the number of all cells that are covered by the target of the current path request.
Returns
- ↪number
- the number of all cells that are covered by the target