A PathSearchResult represents the result of a path search as a list of consecutive CellEntrances.
Inheritance Hierarchy
PathSearchResult
Remarks
A path starts with a CellEntrance for a PartitionCell of the source node and ends with one for a PartitionCell of the target node.
Type Details
- yFiles module
- algorithms
Constructors
Creates a new instance of PathSearchResult for the given edge, CellEntrances, and cost.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- entrances - IList<CellEntrance>
- the list of CellEntrance objects describing the edge path from source node to target node
- cost - number
- the overall cost of this path
Properties
Returns the number of CellEntrance objects in this path.
Methods
Returns the CellEntrance at the given position of this path.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- position - number
- the position of the CellEntrance to return
Returns
- ↪CellEntrance
- the CellEntrance at the given position of this path
See Also
Returns the position of the first occurrence of the given CellEntrance in this path, or -1 if this path does not contain this CellEntrance.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- entrance - CellEntrance
- the CellEntrance for which the position is retrieved
Returns
- ↪number
- the position of the first occurrence of the given CellEntrance in this path, or
-1if this path does not contain this CellEntrance
Replaces the CellEntrance at the given position of this path with the given CellEntrance.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- position - number
- the position of the CellEntrance to replace
- entrance - CellEntrance
- the CellEntrance to be stored at the given position