Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

373 lines (277 sloc) 13.609 kB

Important

Leaflet.draw 0.2.0 requires Leaflet 0.6 or higher.

Leaflet.draw

Adds support for drawing and editing vectors and markers on Leaflet maps. Check out the demo

Upgrading from Leaflet.draw 0.1

Leaflet.draw 0.2.0 changes a LOT of things from 0.1. Please see BREAKING CHANGES for how to upgrade.

Table of Contents

Using the plugin
Advanced Options
Common tasks
Thanks

Using the plugin

The default state for the control is the draw toolbar just below the zoom control. This will allow map users to draw vectors and markers. Please note the edit toolbar is not enabled by default.

Too add the draw toolbar set the option drawControl: true in the map options.

// create a map in the "map" div, set the view to a given place and zoom
var map = L.map('map', {drawControl: true}).setView([51.505, -0.09], 13);

// add an OpenStreetMap tile layer
L.tileLayer('http://{s}.tile.osm.org/{z}/{x}/{y}.png', {
    attribution: '&copy; <a href="http://osm.org/copyright">OpenStreetMap</a> contributors'
}).addTo(map);

Adding the edit toolbar

To use the edit toolbar you must initialise the Leaflet.draw control and manually add it to the map.

// create a map in the "map" div, set the view to a given place and zoom
var map = L.map('map').setView([51.505, -0.09], 13);

// add an OpenStreetMap tile layer
L.tileLayer('http://{s}.tile.osm.org/{z}/{x}/{y}.png', {
    attribution: '&copy; <a href="http://osm.org/copyright">OpenStreetMap</a> contributors'
}).addTo(map);

// Initialize the FeatureGroup to store editable layers
var drawnItems = new L.FeatureGroup();
map.addLayer(drawnItems);

// Initialize the draw control and pass it the FeatureGroup of editable layers
var drawControl = new L.Control.Draw({
    edit: {
        featureGroup: drawnItems
    }
});
map.addControl(drawControl);

The key here is the featureGroup option. This tells the plugin which FeatureGroup that contains the layers that should be editable.

Events

Once you have successfully added the Leaflet.draw plugin your map you will want to respond to the different actions users can do. The following events will be triggered on the map:

draw:created

Property Type Description
layer Polyline/Polygon/Rectangle/Circle/Marker Layer that was just created.
layerType String The type of layer this is. One of: polyline, polygon, rectangle, circle, marker

Triggered when a new vector or marker has been created.

map.on('draw:created', function (e) {
    var type = e.layerType,
        layer = e.layer;

    if (type === 'marker') {
        // Do marker specific actions
    }

    // Do whatever else you need to. (save to db, add to map etc)
    map.addLayer(layer);
});

draw:edited

Property Type Description
layers LayerGroup List of all layers just edited on the map.

Triggered when layers in the FeatureGroup, that the plugin was initialized with, have been edited and saved.

map.on('draw:edited', function (e) {
    var layers = e.layers;
    layers.eachLayer(function (layer) {
        //do whatever you want, most likely save back to db
    });
});

draw:deleted

Triggered when layers have been layers have been removed (and saved) from the FeatureGroup.

Property Type Description
layers LayerGroup List of all layers just removed from the map.

draw:drawstart

Triggered when the user has chosen to draw a particular vector or marker.

Property Type Description
layerType String The type of layer this is. One of: polyline, polygon, rectangle, circle, marker

draw:drawstop

Triggered when the user has finshed a particular vector or marker.

Property Type Description
layerType String The type of layer this is. One of: polyline, polygon, rectangle, circle, marker

Advanced options

You can configure the plugin by using the different options listed here.

Control.Draw

These options make up the root object that is used when initializing the Leaflet.draw control.

Option Type Default Description
position String 'topleft' The initial position of the control (one of the map corners). See control positions.
draw DrawOptions {} The options used to configure the draw toolbar.
edit EditOptions false The options used to configure the edit toolbar.

DrawOptions

These options will allow you to configure the draw toolbar and it's handlers.

Option Type Default Description
polyline PolylineOptions { title: 'Draw a polyline' } Polyline draw handler options.
polygon PolygonOptions { title: 'Draw a polygon' } Polygon draw handler options.
rectangle RectangleOptions { title: 'Draw a rectangle' } Rectangle draw handler options.
circle CircleOptions { title: 'Draw a circle' } Circle draw handler options.
marker MarkerOptions { title: 'Add a marker' } Marker draw handler options.

Draw handler options

The following options will allow you to configure the individual draw handlers.

PolylineOptions

Polyline and Polygon drawing handlers take the same options.

Option Type Default Description
title String 'Draw a Polyline (Polygon)' The title used for the polyline/polygon button.
allowIntersection Bool true Determines if line segements can cross.
drawError Object See code Configuration options for the error that displays if an intersection is detected.
guidelineDistance Number 20 Distance in pixels between each guide dash.
shapeOptions Leaflet Polyline options See code The options used when drawing the polyline/polygon on the map.
zIndexOffset Number 2000 This should be a high number to ensure that you can draw over all other layers on the map.

PolygonOptions

Polygon options include all of the Polyline options plus the option to show the approximate area.

Option Type Default Description
showArea Bool false Show the area of the drawn polygon in m², ha or km². The area is only approximate and become less accurate the larger the polygon is.

RectangleOptions

Option Type Default Description
title String 'Draw a rectangle.' The title used for the rectangle button.
shapeOptions Leaflet Path options See code The options used when drawing the rectangle on the map.

CircleOptions

Option Type Default Description
title String 'Draw a circle.' The title used for the circle button.
shapeOptions Leaflet Path options See code The options used when drawing the circle on the map.

MarkerOptions

Option Type Default Description
title String 'Add a marker.' The title used for the marker button.
icon Leaflet Icon L.Icon.Default() The icon displayed when drawing a marker.
zIndexOffset Number 2000 This should be a high number to ensure that you can draw over all other layers on the map.

EditOptions

These options will allow you to configure the draw toolbar and its handlers.

Option Type Default Description
featureGroup Leaflet FeatureGroup null This is the FeatureGroup that stores all editable shapes. THIS iS REQUIRED FOR THE EDIT TOOLBAR TO WORK
edit EditHandlerOptions { title: 'Edit layers' } Edit handler options.
remove DeleteHandlerOptions { title: 'Delete layers' } Delete handler options.

EditHandlerOptions

Option Type Default Description
title String 'Edit Layers' The title used for the edit button.
selectedPathOptions Leaflet Path options See code The path options for how the layers will look like while in edit mode. If this is set to null the editable path options will not be set.

DeleteHandlerOptions

Option Type Default Description
title String 'Remove Layers' The title used for the delete button.

Common tasks

The following examples outline some common tasks.

Example Leaflet.draw config

The following example will show you how to:

  1. Change the position of the control's toolbar.
  2. Customize the styles of a vector layer.
  3. Use a custom marker.
  4. Disable the delete functionality.
var cloudmadeUrl = 'http://{s}.tile.cloudmade.com/BC9A493B41014CAABB98F0471D759707/997/256/{z}/{x}/{y}.png',
    cloudmade = new L.TileLayer(cloudmadeUrl, {maxZoom: 18}),
    map = new L.Map('map', {layers: [cloudmade], center: new L.LatLng(-37.7772, 175.2756), zoom: 15 });

var editableLayers = new L.FeatureGroup();
map.addLayer(editableLayers);

var MyCustomMarker = L.Icon.extend({
    options: {
        shadowUrl: null,
        iconAnchor: new L.Point(12, 12),
        iconSize: new L.Point(24, 24),
        iconUrl: 'link/to/image.png'
    }
});

var options = {
    position: 'topright',
    draw: {
        polyline: {
            title: 'Draw a kick ass polyline!',
            shapeOptions: {
                color: '#f357a1',
                weight: 10
            }
        },
        polygon: {
            allowIntersection: false, // Restricts shapes to simple polygons
            drawError: {
                color: '#e1e100', // Color the shape will turn when intersects
                message: '<strong>Oh snap!<strong> you can\'t draw that!' // Message that will show when intersect
            },
            shapeOptions: {
                color: '#bada55'
            }
        },
        circle: false, // Turns off this drawing tool
        rectangle: {
            shapeOptions: {
                clickable: false
            }
        },
        marker: {
            icon: new MyCustomMarker()
        }
    },
    edit: {
        featureGroup: editableLayers, //REQUIRED!!
        remove: false
    }
};

var drawControl = new L.Control.Draw(options);
map.addControl(drawControl);

map.on('draw:created', function (e) {
    var type = e.layerType,
        layer = e.layer;

    if (type === 'marker') {
        layer.bindPopup('A popup!');
    }

    drawnItems.addLayer(layer);
});

Disabling a toolbar

If you do not want a particular toolbar in your app you can turn it off by setting the toolbar to false.

var drawControl = new L.Control.Draw({
    draw: false,
    edit: {
        featureGroup: editableLayers
    }
});

Disabling a toolbar item

If you want to turn off a particular toolbar item, set it to false. The following disables drawing polygons and markers. It also turns off the ability to edit layers.

var drawControl = new L.Control.Draw({
    draw: {
        polygon: false,
        marker: false
    },
    edit: {
        featureGroup: editableLayers,
        edit: false
    }
});

Changing a drawing handlers options

You can change a draw handlers options after initialization by using the setDrawingOptions method on the Leaflet.draw control.

E.g. to change the colour of the rectangle:

drawControl.setDrawingOptions({
    rectangle: {
        color: '#0000FF'
    }
});

Thanks

Thanks so much to @brunob, @tnightingale, and @shramov. I got a lot of ideas from their Leaflet plugins.

All the contributors and issue reporters of this plugin rock. Thanks for tidying up my mess and keeping the plugin on track.

The icons used for some of the toolbar buttons are either from http://glyphicons.com/ or inspired by them. <3 Glyphicons!

Finally, @mourner is the man! Thanks for dedicating so much of your time to create the gosh darn best JavaScript mapping library around.

Jump to Line
Something went wrong with that request. Please try again.