Represents all paths between two sets of nodes as computed by paths.
Inheritance Hierarchy
PathsResult
Remarks
When querying this result for a path or enumerating it, the paths are found on the fly. Enumerating all paths can be slow if the graph is large and startNodes or endNodes contain many nodes. Generally this should be used to find paths satisfying certain criteria and only enumerating until a suitable path is found to avoid walking the whole graph.
Type Details
- yfiles module
- view-layout-bridge
- yfiles-umd modules
- view-layout-bridge
- Legacy UMD name
- yfiles.analysis.PathsResult
Properties
Gets a collection of all paths between the startNodes and endNodes.
Remarks
This collection's enumerator calculates paths only when needed. This also means that accessing the size or via an index will cause all paths to be calculated immediately which can be slow.
Methods
Gets a collection of all paths between the given start and end node.
Remarks
This collection's enumerator calculates paths only when needed. This also means that accessing the size or via an index will cause all paths to be calculated immediately which can be slow.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
Returns
- ↪ResultItemCollection<Path>
- All paths between
startandend.
Returns a path between the given start and end node if one exists.