Interface LassoPluginOptions

interface LassoPluginOptions {
    cssClass?: string;
    filter?: string;
    generateLassoContent?: ((origin: PointXY, e: MouseEvent) => BrowserElement);
    includeEdges?: boolean;
    invert?: boolean;
    onEnd?: Function;
    onSelect?: ((vertices: Vertex[]) => any);
    onStart?: Function;
    selectionFilter?: ((o: Edge | Vertex) => boolean);
}

Hierarchy (view full)

Properties

cssClass? filter? generateLassoContent? includeEdges? invert? onEnd? onSelect? onStart? selectionFilter?

Properties

OptionalcssClass

cssClass?: string

Extra class(es) to add to the lasso's DOM element

Optionalfilter

filter?: string

Optional CSS3 filter identifying elements you do not want to lasso.

OptionalgenerateLassoContent

generateLassoContent?: ((origin: PointXY, e: MouseEvent) => BrowserElement)

Optional 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.

OptionalincludeEdges

includeEdges?: boolean

Defaults to false. If true, edges are included in the lasso selection.

Optionalinvert

invert?: boolean

Defaults to false, meaning the lasso is drawn as a rectangle. If true, the lasso is drawn as a set of masks, with the lasso area drawn as a "hole" in the masks.

OptionalonEnd

onEnd?: Function

Optional function to call when lasso selection ends.

OptionalonSelect

onSelect?: ((vertices: Vertex[]) => any)

Optional function to call when one or more objects has been selected by the lasso.

OptionalonStart

onStart?: Function

Optional function to call when lasso selection starts.

OptionalselectionFilter

selectionFilter?: ((o: Edge | Vertex) => boolean)

Optional 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

Type declaration

    • (o): boolean

    • Parameters

      • o: Edge | Vertex

        Edge or Vertex to possibly filter.

      Returns boolean

Settings

Member Visibility

On This Page

Properties
Version :