README

leaflet-lasso

Lasso selection plugin for Leaflet

Demo

Supports all Leaflet vector layers:

Marker
CircleMarker
Circle
Polyline
Polyline with multiple segments
Rectangle
Polygon
Polygon with hole
Polygon with multiple segments
Polygon with multiple segments and holes

Selection modes:

contain - entire shape must be in lasso polygon (default)
intersect - any part of shape can be in lasso polygon

Install

npm install leaflet-lasso

<script src="https://unpkg.com/leaflet-lasso@2.2.6/dist/leaflet-lasso.umd.min.js"></script>

Usage

import "leaflet-lasso";

For detailed API, please see exported TypeScript typings.

Handler

Use for custom activation.

interface LassoHandlerOptions {
    polygon?: L.PolylineOptions,
    intersect?: boolean;
}

const lasso = L.lasso(map, options);
yourCustomButton.addEventListener('click', () => {
    lasso.enable();
});

Control

Use for default control.

export interface LassoControlOptionsData  {
    title?: string;
}

export type LassoControlOptions = L.ControlOptions & LassoControlOptionsData & LassoHandlerOptions;

L.control.lasso(options).addTo(map);

Finished event

Listen for this event to receive matching Leaflet layers.

interface LassoHandlerFinishedEventData {
    latLngs: L.LatLng[];
    layers: L.Layer[];
}

map.on('lasso.finished', (event: LassoHandlerFinishedEventData) => {
    console.log(event.layers);
});

Thanks

Icon by @Falke-Design

Usage no npm install needed!