yFiles for HTML Demos Basic Features Tutorial 12 Analysis Algorithms yFiles Demos

Running Graph Analysis Algorithms

How to analyze the graph structure.

This step shows how to use the graph analysis algorithms in yFiles for HTML.

yFiles provides a wide range of graph analysis algorithms that can be used for all kinds of purposes. The result of an analysis run can be shown directly to the user, or the results can be used to drive third party systems. They can also be used as input for layout algorithm configurations. The purpose of this sample is to demonstrate how to build, configure, and execute graph analysis algorithms and how to interpret the results. For a more interactive and complete showcase of the available algorithms, please see the Graph Analysis Demo, the Clustering Algorithms Demo, the Network Flows Demo, the Critical Path Analysis (CPA) Demo, the Intersection Detection Demo, and the Transitivity Demo.

Reachability

Select one or more nodes and click 'Run Reachability' to run a reachability test. All nodes that can be reached from the currently selected nodes will be highlighted.

// use the selected nodes as start nodes
const startNodes = graphComponent.selection.selectedNodes

const reachability = new Reachability({
  startNodes: startNodes,
  directed: true // consider edge direction
})
const reachabilityResult = reachability.run(graphComponent.graph)

// highlight the reachable nodes
reachabilityResult.reachableNodes.forEach((n: INode): void => {
  graphComponent.highlightIndicatorManager.addHighlight(n)
})

Select two nodes with Ctrl+Click and click 'Run Shortest Path' to calculate the shortest path. If a path is found, the nodes on the path and the edges will be highlighted. The distance to the target node will be shown as a tooltip on the target node.

const shortestPath = new ShortestPath({
  source: sourceNode,
  sink: sinkNode,
  directed: false, // don't consider edge direction
  // calculate the cost per edge as the distance between source and target node
  costs: (edge: IEdge): number =>
    edge.sourceNode!.layout.center.subtract(edge.targetNode!.layout.center)
      .vectorLength
})
const shortestPathResult = shortestPath.run(graph)

The shortest path result contains the distance, nodes and edges of the calculated path. We use this information to highlight the respective nodes and edges and to show a tooltip with the distance.

const pathDistance = shortestPathResult.distance
const pathNodes = shortestPathResult.path?.nodes ?? []
const endNode = shortestPathResult.path?.end
const pathEdges = shortestPathResult.edges