Skip to main content

Function: shortestPath()

function shortestPath(
model,
fromTableId,
toTableId,
options?
): Subgraph & object | null;

Shortest path by number of refs (undirected BFS). Ties: the path whose sequence of table indexes in model order is lexicographically smallest. null when unconnected or unknown ids.

tableIds and refIds are in model order (walk refIds from fromTableId for path order); between two consecutive path tables the first connecting ref in model order is used.

Parameters​

model​

DiagramModel

fromTableId​

string

toTableId​

string

options?​

GraphOptions = {}

Returns​

Subgraph & object | null