Skip to main content
LassoPluginOptions
NameTypeDescription
armTimeout?numberTimeout in ms for autoArm long press. Defaults to 500ms.
autoArm?booleanDefaults to false. If true, the lasso will arm itself after a long press.
autoExit?booleanWhen true (which is the default) the lasso exits after a selection has been made.
cssClass?stringExtra class(es) to add to the lasso's DOM element
enableInGroups?boolean | "metaKey"Optional setting for whether lasso inside groups is enabled - it is by default. Setting this to false will mean that the user cannot lasso items inside a group. Setting to "metaKey" will mean that lasso is supported inside groups if the user is holding the meta key down (ie the Window key, or Cmd on macs).
filter?string | (e:MouseEvent) => booleanOptional CSS3 filter identifying elements you do not want to lasso
generateLassoContent?(origin:PointXY, e:MouseEvent) => BrowserElementOptional function that generates the DOM element for the lasso to use. This is for advanced usage scenarios and most users will not need to supply this. Applies only to rectangular lasso; freehand and polygon use a built-in SVG path styled with the lasso CSS variables/classes.
includeEdges?booleanDefaults to false. If true, edges are included in the lasso selection.
invert?booleanDefaults to false. If true, shade outside the selected region instead of inside it.
onEnd?FunctionOptional function to call when lasso selection ends. Polygon gestures supply {shape:"polygon", cancelled:boolean} for completion or cancellation.
onSelect?(vertices:Array<Vertex>) => anyOptional function to call when one or more objects has been selected by the lasso.
onStart?FunctionOptional function to call when lasso selection starts.
selectionFilter?(o:Edge | Vertex) => booleanOptional filter that is passed every vertex/edge that the lasso would ordinarily select, and if this function returns false then the vertex/edge is not added to the selection
shape?LassoShapeSelection shape. Defaults to "rectangle". "freehand" draws continuously; "polygon" adds vertices on clicks and completes with double-click or Enter.
simplificationTolerance?numberCorner-preserving freehand simplification tolerance in screen pixels. Defaults to 1. Must be finite and non-negative; 0 disables simplification. Details smaller than this tolerance may disappear.