Nukem's Possible Manifestation

    leaflet-lasso
    TypeScript icon, indicating that this package has built-in type declarations

    2.2.8 • Public • Published

    leaflet-lasso

    Lasso selection plugin for Leaflet

    Demo

    Screenshot

    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
    

    or

    <script src="https://unpkg.com/leaflet-lasso@2.2.8/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.

    interface LassoControlOptionsData  {
        title?: string;
    }
    
    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 {
        originalEvent: MouseEvent;
        latLngs: L.LatLng[];
        layers: L.Layer[];
    }
    
    type LassoHandlerFinishedEvent = L.LeafletEvent & LassoHandlerFinishedEventData;
    
    map.on('lasso.finished', (event: LassoHandlerFinishedEvent) => {
        console.log(event.layers);
    });
    

    Thanks

    Icon by @Falke-Design

    Keywords

    Install

    npm i leaflet-lasso

    DownloadsWeekly Downloads

    3,441

    Version

    2.2.8

    License

    MIT

    Unpacked Size

    930 kB

    Total Files

    35

    Last publish

    Collaborators

    • zakjan