Skip to main content

Home > @jsplumbtoolkit/browser-ui > Surface > selectEdges

Surface.selectEdges() method

Selects a set of edges. If you supply a DOM element for any of the arguments here, the underlying graph object - a Node or a Port - will be determined, and the edges for that object will be retrieved. Note that for a Port this method does the same thing as selectAllEdges, but for a Node, which may have Ports registered on it, this method will retrieve only the Edges directly registered on the Node itself. You may need to use selectAllEdges if you want everything from some Node.

Signature:

selectEdges(params: {
source?: string | Element | Vertex;
target?: string | Element | Vertex;
element?: string | Element | Vertex;
}): ConnectionSelection;

Parameters

ParameterTypeDescription
params{ source?: string | Element | Vertex; target?: string | Element | Vertex; element?: string | Element | Vertex; }Selection parameters

Returns:

ConnectionSelection