Skip to main content

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

Surface.findIntersectingVertices() method#

Finds vertices - Nodes or Groups - that intersect a rectangle defined by the given origin and dimensions.

Signature:

findIntersectingVertices<T extends Node>(origin: PointXY, dimensions: Size, enclosed?: boolean, dontIncludeGroups?: boolean, dontIncludeNodes?: boolean, dontIncludeNodesInsideGroups?: boolean, dontIncludeNestedGroups?: boolean): Array<IntersectingVertex<T>>;

Parameters#

ParameterTypeDescription
originPointXYOrigin of the rectangle to test
dimensionsSizeWidth and height of the rectangle to test
enclosedbooleanIf true, vertices must be fully enclosed by the rectangle
dontIncludeGroupsbooleanIf true, Groups are omitted from the search
dontIncludeNodesbooleanIf true, Nodes are omitted from the search
dontIncludeNodesInsideGroupsbooleanIf true, Nodes inside Groups are omitted from the search
dontIncludeNestedGroupsbooleanIf true, Groups that are nested inside other Groups are omitted from the search

Returns:

Array<IntersectingVertex<T>>