Skip to main content

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

Surface.findIntersectingGroups() method#

Finds Groups (not Nodes) - that intersect a rectangle defined by the given origin and dimensions.

Signature:

findIntersectingGroups(origin: PointXY, dimensions: Size, enclosed?: boolean, dontIncludeNestedGroups?: boolean): Array<IntersectingVertex<Group>>;

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
dontIncludeNestedGroupsbooleanIf true, Nodes inside Groups are omitted from the search

Returns:

Array<IntersectingVertex<Group>>