Home > @jsplumbtoolkit/browser-ui > Surface > getPath
Surface.getPath() method
Gets a Path from some source Vertex to some target Vertex. This method is a wrapper around the Toolkit's getPath method, adding a few ui specific functions to the result.
Signature:
getPath(params: PathOptions): UIPath;
Parameters
| Parameter | Type | Description |
|---|---|---|
| params | PathOptions | Path spec params |
Returns:
A Path object. Even if no path exists you will get a return value - but it will just be empty.