Skip to main content

IntersectingVerticesOptions

Options for a find intersecting vertices call

Extends​

  • EnclosedOrIntersectingVerticesOptions

Properties​

dimensions​

dimensions: Size

Size of the search rectangle, in canvas coordinates

Inherited from​

EnclosedOrIntersectingVerticesOptions.dimensions

dontIncludeGroups?​

optional dontIncludeGroups: boolean

If true, ignore groups in the canvas root

Inherited from​

EnclosedOrIntersectingVerticesOptions.dontIncludeGroups

dontIncludeNestedGroups?​

optional dontIncludeNestedGroups: boolean

If true, ignore groups that are children of groups

Inherited from​

EnclosedOrIntersectingVerticesOptions.dontIncludeNestedGroups

dontIncludeNodes?​

optional dontIncludeNodes: boolean

If true, ignore nodes in the canvas root

Inherited from​

EnclosedOrIntersectingVerticesOptions.dontIncludeNodes

dontIncludeNodesInsideGroups?​

optional dontIncludeNodesInsideGroups: boolean

If true, ignore nodes that are children of groups

Inherited from​

EnclosedOrIntersectingVerticesOptions.dontIncludeNodesInsideGroups

enclosed?​

optional enclosed: boolean

If true, only vertices fully enclosed by the search rectangle will be returned

filter()?​

optional filter: (n) => boolean

Optional final filter to apply to the discovered list

Parameters​

n​

Node | Group

Returns​

boolean

Inherited from​

EnclosedOrIntersectingVerticesOptions.filter

origin​

origin: PointXY

Origin of the search rectangle, in canvas coordinates

Inherited from​

EnclosedOrIntersectingVerticesOptions.origin