Determines the nodes that are reachable from one or more startNodes.
Examples
const reachableNodes = new Reachability({
directed: true,
startNodes: { item: selectedNode },
}).run(graph).reachableNodes
reachableNodes.forEach((reachableNode) =>
graph.setStyle(reachableNode, reachableStyle),
)Type Details
- yFiles module
- view-layout-bridge
Constructors
Parameters
A map of options to pass to the method.
- startNodes - ItemCollection<INode>
- A collection of nodes from which to determine reachability. This option either sets the value directly or recursively sets properties to the instance of the startNodes property on the created object.
- subgraphNodes - ItemCollection<INode>
- The collection of nodes which define a subset of the graph for the algorithms to work on. This option either sets the value directly or recursively sets properties to the instance of the subgraphNodes property on the created object.
- subgraphEdges - ItemCollection<IEdge>
- The collection of edges which define a subset of the graph for the algorithms to work on. This option either sets the value directly or recursively sets properties to the instance of the subgraphEdges property on the created object.
- directed - boolean
- A value indicating whether edge direction should be considered. This option sets the directed property on the created object.
Properties
Gets or sets a collection of nodes from which to determine reachability.
Gets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
Remarks
If nothing is set, all edges of the graph will be processed.
If only the excludes are set, all edges in the graph except those provided in the excludes are processed.
Note that edges which start or end at nodes which are not in the subgraphNodes are automatically not considered by the algorithm.
ItemCollection<T> instances may be shared among algorithm instances and will be (re-)evaluated upon (re-)execution of the algorithm.
Examples
const reachability = new Reachability({ directed: true })
reachability.startNodes = (node) => node.labels.size == 1
reachability.subgraphEdges.source = graph.edges.filter(
(edge) =>
edge.style instanceof PolylineEdgeStyle &&
edge.style.targetArrow === IArrow.NONE,
)
const result = reachability.run(graph)
result.reachableNodes.forEach((reachableNode) =>
graph.setStyle(reachableNode, reachableStyle),
)Gets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
Remarks
If nothing is set, all nodes of the graph will be processed.
If only the excludes are set, all nodes in the graph except those provided in the excludes are processed.
ItemCollection<T> instances may be shared among algorithm instances and will be (re-)evaluated upon (re-)execution of the algorithm.
Examples
const reachability = new Reachability({ directed: true })
reachability.startNodes.item = selectedNode
reachability.subgraphNodes.excludes = (node) =>
node.labels.some((label) => label.text == 'forbidden')
const result = reachability.run(graph)
result.reachableNodes.forEach((reachableNode) =>
graph.setStyle(reachableNode, reachableStyle),
)Methods
Determines the set of nodes that are reachable from the startNodes.
Complexity
O(|V| + |E|)
Parameters
A map of options to pass to the method.
- graph - IGraph
- The input graph to run the algorithm on.
Returns
- ↪ReachabilityResult
- A ReachabilityResult containing the nodes reachable from startNodes.
Throws
- Exception({ name: 'InvalidOperationError' })
- If the algorithm can't create a valid result due to an invalid graph structure or wrongly configured properties.