This class provides context information that is useful for the path search algorithm of EdgeRouter.
Remarks
Most notably, the context provides access to the edge that is currently being routed (see currentEdge).
This class cannot be instantiated
Type Details
- yFiles module
- algorithms
Properties
Gets an artificial PartitionCell with the size of the bounds of all source cells of the current path request.
Property Value
See Also
Gets an artificial PartitionCell with the size of the bounds of all target cells of the current path request.
Property Value
See Also
Gets the configuration used for the path search phase.
Property Value
Gets or sets the edge that is currently routed.
Gets the EdgeRouterEdgeDescriptor for the currentEdge containing edge-specific settings for the path search.
Property Value
Gets or sets the PathSearchRequest that is currently routed.
Remarks
Property Value
Gets the ICursor<T> of LayoutEdge to iterate over the edges that are routed.
Property Value
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