leaflet-js 0.7.9 → 0.8.dev2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 066a15b8341261a0eafccc4462e01a10b6225533
-  data.tar.gz: 35ab648ae7d950937f02e23122dc432318df24c7
+  metadata.gz: 56cc24d0e40ab7e60ebc73a750e4121ada45d272
+  data.tar.gz: 521f6389747be4f293e13dc7fbd6f1921bea5ee1
 SHA512:
-  metadata.gz: 6a1149a1a414bfbd396bf579eafe701cdc2522b9f1de506ecebed52884f26458921ae04f57dd020268ed327d2d4053383771eb775bccc59ab687d227a95979d1
-  data.tar.gz: c24097a2ed7d7f3614451097bd5d5cd64b05c19d0eb366e4d934c1f730be99ca24450945d9e0ad65948d56401ac3728dea1567176d2847781cffd8f51ed4a885
+  metadata.gz: 711e6d7d99d3b93608fa04b1eda04851500bede52262753697655aba163c439608d8bd311ad0099f631554bac59627c46c562e08348674a6bdccc043b2612508
+  data.tar.gz: 001b1951fea827978b885e6f6395a3d4c5a275858bd23cb2d9ff5df581aed055c488bce509573232b2e6226a18a0c442067cdbbe8885247c9d706fa7d6bb79a9

data/CHANGELOG.rdoc

@@ -1,15 +1,5 @@
 = leaflet-js Changelog
 
-=== 0.7.9 (December 10, 2015)
-* Create images directory to work with asset pipeline
-
-=== 0.7.8 (December 10, 2015)
-* Fix case sensitivity issue
-
-=== 0.7.7 (December 6, 2015)
-* Update to leaflet 0.7.7
-* Revamp how assets are setup to work with newer versions of spockets
-
 === 0.8.dev2 (January 30, 2014)
 * Update to latest version of leaflet (0.8 master)
 

data/Rakefile

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 
-require 'rubygems'
-require 'rubygems/package_task'
+require "rubygems"
+require "rubygems/package_task"
 
-GEM_NAME = 'leaflet-js'
+GEM_NAME = "leaflet-js"
 
 # Read the spec file
 spec = Gem::Specification.load("#{GEM_NAME}.gemspec")

data/leaflet-js.gemspec

@@ -1,9 +1,7 @@
 # encoding: utf-8
-require_relative 'lib/leaflet-js/version'
-
 Gem::Specification.new do |spec|
   spec.name        = 'leaflet-js'
-  spec.version     = Leaflet::VERSION
+  spec.version     = '0.8.dev2'
   spec.homepage    = 'https://github.com/cfis/leaflet-js'
   spec.summary     = <<-EOS
 Wraps the Leaflet Javascript Mapping Library in a Rails asset gem. Also include Leaflet.Label
@@ -18,16 +16,12 @@ EOS
                          'Rakefile',
                          'README.rdoc',
                          'lib/leaflet-js.rb',
-                         'lib/leaflet-js/version.rb',
-                         'lib/leaflet-js/engine.rb',
-                         'vendor/assets/Leaflet/src/**/*',
-                         'vendor/assets/Leaflet/dist/images/*',
-                         'vendor/assets/Leaflet.draw/src/**/*',
-                         'vendor/assets/Leaflet.draw/dist/images/*',
-                         'vendor/assets/Leaflet.label/src/**/*',
-                         'vendor/assets/*.js',
-                         'vendor/assets/*.css',
-                         'vendor/assets/*.erb'])
+                         'lib/leaflet/**/*',
+                         'lib/leaflet.draw/**/*',
+                         'lib/leaflet.label/**/*',
+                         'vendor/assets/javascripts/*',
+                         'vendor/assets/stylesheets/*',
+                         'vendor/assets/images/*'])
   spec.required_ruby_version = '>= 1.9.3'
   spec.license = 'MIT'
   spec.date = Time.now

data/lib/leaflet-js.rb

@@ -1,2 +1,10 @@
-require 'leaflet-js/version'
-require 'leaflet-js/engine'
+module Leaflet
+  class Engine < Rails::Engine
+    initializer :append_assets_path do |app|
+      # Javascripts
+      app.config.assets.paths << File.join(config.root, 'lib', 'leaflet', 'src')
+      app.config.assets.paths << File.join(config.root, 'lib', 'leaflet.draw', 'src')
+      app.config.assets.paths << File.join(config.root, 'lib', 'leaflet.label', 'src')
+    end
+  end
+end

data/lib/leaflet.draw/BREAKINGCHANGES.md

@@ -0,0 +1,54 @@
+# How to upgrade from 0.1 to 0.2
+
+There are a number of changes to the plugin in 0.2 that may break peoples implementations of Leaflet.draw 0.1. If you  I will try my best to list any changes here.
+
+## Event consolidation
+
+Leaflet.draw 0.1 had a created event for each different shape that was created. 0.2 now consolitates these into a single created shape.
+
+The vector or marker is accessed by the `layer` property of the event arguments, the type of layer by the `layerType`.
+
+#### New way
+
+````js
+map.on('draw:created', function (e) {
+	var type = e.layerType,
+		layer = e.layer;
+
+	if (type === 'marker') {
+		// Do any marker specific logic here
+	}
+
+	map.addLayer(layer);
+});
+````
+
+#### Old way
+
+````js
+map.on('draw:poly-created', function (e) {
+	map.addLayer(e.poly);
+});
+map.on('draw:rectangle-created', function (e) {
+	map.addLayer(e.rect);
+});
+map.on('draw:circle-created', function (e) {
+	map.addLayer(e.circ);
+});
+map.on('draw:marker-created', function (e) {
+	e.marker.bindPopup('A popup!');
+	map.addLayer(e.marker);
+});
+````
+
+## Draw handler started/stopped event change
+
+Renamed the drawing started and stopped events to be the same as the created standard.
+
+`drawing` -> `draw:drawstart` and `drawing-disabled` -> `draw:drawstop`.
+
+The event argument has also changed from `drawingType` -> `layerType`.
+
+## CSS changes
+
+There has been a whole bunch of CSS changes, if you have customized any of these plese see [leaflet.draw.css](https://github.com/Leaflet/Leaflet.draw/blob/master/dist/leaflet.draw.css).

data/lib/leaflet.draw/CHANGELOG.md

@@ -0,0 +1,130 @@
+Leaflet.draw Changelog
+======================
+
+## master
+
+An in-progress version being developed on the master branch.
+
+## 0.2.3 (January 14, 2014)
+
+### Improvements
+
+ * Restrict editing polygons so that at least 3 points are present. (by [@Zverik](https://github.com/Zverik)). [#200](https://github.com/Leaflet/Leaflet.draw/pull/200)
+ * Tooltips initially start hidden until the mouse has been moved. (by [@Zverik](https://github.com/Zverik)). [#210](https://github.com/Leaflet/Leaflet.draw/pull/210)
+ * Fixup spelling errors. (by [@nexushoratio](https://github.com/nexushoratio)). [#223](https://github.com/Leaflet/Leaflet.draw/pull/223)
+ * Combine ie specific style within leaflet.draw.css stylesheet. (by [@frankrowe](https://github.com/frankrowe)). [#221](https://github.com/Leaflet/Leaflet.draw/pull/221)
+ * Improve my terrible engrish. (by [@erictheise](https://github.com/erictheise)). [#237](https://github.com/Leaflet/Leaflet.draw/pull/237)
+ * Fire `editstart` events when a poly or simple shape is initially edited. (by [@atombender](https://github.com/atombender)). [#245](https://github.com/Leaflet/Leaflet.draw/pull/245)
+ * Add ability to add a new vertex to a polyline or polygon hander.
+ * Added ability to remove/undo the last placed point for polyline or polygons. (by [@Zverik](https://github.com/Zverik)). [#242](https://github.com/Leaflet/Leaflet.draw/pull/242)
+ * Dynamically position the action toolbars. (by [@DevinClark](https://github.com/DevinClark)). [#240](https://github.com/Leaflet/Leaflet.draw/pull/240)
+ * Improve polyline/polygon drawing by accepting some motion on click. (by [@atombender](https://github.com/atombender)). [#249](https://github.com/Leaflet/Leaflet.draw/pull/249)
+ * Only draw a limited number of guide dashes to improve performance in some rare cases. [#254](https://github.com/Leaflet/Leaflet.draw/pull/254)
+
+### Bugfixes
+
+ * Fix edit toolbar so diabled state is represented correctly. (by [@joeybaker](https://github.com/joeybaker)). [#203](https://github.com/Leaflet/Leaflet.draw/pull/203)
+ * Fixed path middle marker positions. (by [@Zverik](https://github.com/Zverik)). [#208](https://github.com/Leaflet/Leaflet.draw/pull/208)
+ * Fix issue where toolbar buttons would have focus after clicked so couldn't use escape to cancel until clicked map at least once.
+ * Fix toolbar icons for retina displays. (by [@dwnoble](https://github.com/dwnoble)). [#217](https://github.com/Leaflet/Leaflet.draw/pull/217)
+ * Ensure that options are not shared between draw handler classes. (by [@yohanboniface](https://github.com/yohanboniface)). [#219](https://github.com/Leaflet/Leaflet.draw/pull/219)
+ * Fix bug where multiple handlers could be active. (by [@manubb](https://github.com/manubb)). [#247](https://github.com/Leaflet/Leaflet.draw/pull/247)
+
+## 0.2.2 (October 4, 2013)
+
+### Improvements
+
+ * Refactored the `L.drawLocal' object to be better structured and use this object whereever text is used. *NOTE: THIS IS A NEW FORMAT, SO WILL BRESK ANY EXISTING CUSTOM `L.drawLocal` SETTINGS*.
+ * Added Imperial measurements to compliment the existing Metric measurements when drawing a polyline or polygon.
+ * Added `draw:editstart` and `draw:editstop` events. (by [@bhell](https://github.com/bhell)). [#175](https://github.com/Leaflet/Leaflet.draw/pull/175)
+ * Added `repeatMode` option that will allow repeated drawing of features. (by [@jayhogan](https://github.com/jayhogan) and [@cscheid](https://github.com/cscheid)). [#178](https://github.com/Leaflet/Leaflet.draw/pull/178)
+ * Added abilit to set circle radius measurement to imperial units.
+ * Added disabled state for edit/delete buttons when no layers present. (inspired by [@snkashis](https://github.com/snkashis)). [#136](https://github.com/Leaflet/Leaflet.draw/pull/136)
+ * Add `showLength` and `showRadius` options to circle and polyline. (by [@Zverik](https://github.com/Zverik)). [#195](https://github.com/Leaflet/Leaflet.draw/pull/195)
+ * Add option to disable tooltips. (by [@Zverik](https://github.com/Zverik)). [#196](https://github.com/Leaflet/Leaflet.draw/pull/196)
+
+### Bugfixes
+
+ * Fixed bug where edit handlers could not be disabled.
+ * Added support for displaying the toolbar on the right hand side of the map. (by [@paulcpederson](https://github.com/paulcpederson)). [#164](https://github.com/Leaflet/Leaflet.draw/pull/164)
+ * Add flexible width action buttons. (by [@Grsmto](https://github.com/Grsmto)). [#181](https://github.com/Leaflet/Leaflet.draw/pull/181)
+ * Check for icon existence before disabling edit state. (by [@tmcw](https://github.com/tmcw)). [#182](https://github.com/Leaflet/Leaflet.draw/pull/182)
+ * Only update guideslines when guidelines are present. (by [@jayhogan](https://github.com/jayhogan)). [#188](https://github.com/Leaflet/Leaflet.draw/pull/188)
+ * Fixes to localization code so it can be correctly set after files have been loaded.
+ * Fix for firing `draw:edit` twice for Draw.SimpleShape. (by [@cazacugmihai](https://github.com/cazacugmihai)). [#192](https://github.com/Leaflet/Leaflet.draw/pull/192)
+ * Fix last edit menu buttons from wrapping. (by [@moiarcsan](https://github.com/moiarcsan)). [#198](https://github.com/Leaflet/Leaflet.draw/pull/198)
+
+## 0.2.1 (July 5, 2013)
+
+### Improvements
+
+ * `draw:edited` now returns a `FeatureGroup` of features edited. (by [@jmkelly](https://github.com/jmkelly)). [#95](https://github.com/Leaflet/Leaflet.draw/pull/95)
+ * Circle tooltip shows the radius (in m) while drawing.
+ * Added Leaflet version check to inform developers that Leaflet 0.6+ is required.
+ * Added ability to finish drawing polygons by double clicking. (inspired by [@snkashis](https://github.com/snkashis)). [#121](https://github.com/Leaflet/Leaflet.label/pull/121)
+ * Added test environment. (by [@iirvine](https://github.com/iirvine)). [#123](https://github.com/Leaflet/Leaflet.draw/pull/123)
+ * Added `L.drawLocal` object to allow users to customize the text used in the plugin. Addresses localization issues. (by [@Starefossen](https://github.com/Starefossen)). [#87](https://github.com/Leaflet/Leaflet.draw/pull/87)
+ * Added ability to disable edit mode path and marker styles. (inspired by [@markgibbons25](https://github.com/markgibbons25)). [#121](https://github.com/Leaflet/Leaflet.label/pull/137)
+ * Added area calculation when drawing a polygon.
+ * Polyline and Polygon tooltips update on click as well as mouse move.
+
+### Bugfixes
+
+ * Fixed issue where removing a vertex or adding a new one via midpoints would not update the edited state for polylines and polygons.
+ * Fixed issue where not passing in the context to `off()` would result in the event from not being unbound.(by [@koppelbakje](https://github.com/koppelbakje)). [#95](https://github.com/Leaflet/Leaflet.draw/pull/112)
+ * Fixed issue where removing the draw control from the map would result in an error.
+ * Fixed bug where removing points created by dragging midpoints would cause the polyline to not reflect any newly created points.
+ * Fixed regression where handlers were not able to be disabled.(by [@yohanboniface](https://github.com/yohanboniface)). [#139](https://github.com/Leaflet/Leaflet.draw/pull/139)
+ * Fixed bug where L.Draw.Polyline would try to remove a non-existant handler if the user cancelled and the polyline only had a single point.
+
+## 0.2.0 (February 20, 2013)
+
+Major new version. Added Edit toolbar which allows editing and deleting shapes.
+
+### Features
+
+ * Consistant event for shape creation. (by [@krikrou](https://github.com/krikrou)). [#58](https://github.com/Leaflet/Leaflet.draw/pull/58)
+
+### Bugfixes
+
+ * Fixed adding markers over vector layers. (by [@Starefossen](https://github.com/Starefossen)). [#82](https://github.com/Leaflet/Leaflet.draw/pull/82)
+
+## 0.1.7 (February 11, 2013)
+
+ * Add sanity check for toolbar buttons when adding top and bottom classes. (by [@yohanboniface](https://github.com/yohanboniface)). [#60](https://github.com/Leaflet/Leaflet.draw/pull/60)
+
+## 0.1.6 (January 17, 2013)
+
+* Updated toolbar styles to be in line with the new Leaflet zoom in/out styles.
+
+## 0.1.5 (December 10, 2012)
+
+### Features
+
+ * Added 'drawing-disabled' event fired on the map when a draw handler is disabled. (by [@ajbeaven](https://github.com/thegreat)). [#35](https://github.com/jacobtoye/Leaflet.draw/pull/35)
+ * Added 'drawing' event fired on the map when a draw handler is actived. (by [@ajbeaven](https://github.com/thegreat)). [#30](https://github.com/jacobtoye/Leaflet.draw/pull/30)
+
+### Bugfixes
+ 
+ * Stopped L.Control.Draw from storing handlers in it's prototype. (by [@thegreat](https://github.com/thegreat)). [#37](https://github.com/jacobtoye/Leaflet.draw/pull/37)
+
+## 0.1.4 (October 8, 2012)
+
+### Bugfixes
+
+ * Fixed a bug that would cause an error when creating rectangles/circles withought moving the mouse. (by [@inpursuit](https://github.com/inpursuit)). [#25](https://github.com/jacobtoye/Leaflet.draw/pull/25)
+ * Fixed a bug that would cause an error when clicking a different drawing tool while another mode enabled. (by [@thegreat](https://github.com/thegreat)). [#27](https://github.com/jacobtoye/Leaflet.draw/pull/27)
+ * Fixed control buttons breaking plugin in oldIE.
+ * Fixed drawing polylines and polygons in oldIE.
+
+## 0.1.3 (October 3, 2012)
+
+### Bugfixes
+
+ * Tip label will now show over vertex markers.
+ * Added ability to draw on top of existing markers and vector layers.
+ * Clicking on a map object that has a click handler no longer triggers the click event when in drawing mode.
+
+## Pre-0.1.3
+
+Check the commit history for changes previous to 0.1.3.

data/lib/leaflet.draw/Jakefile.js

@@ -0,0 +1,48 @@
+/*
+Leaflet.draw building and linting scripts.
+
+To use, install Node, then run the following commands in the project root:
+
+    npm install -g jake
+    npm install
+
+To check the code for errors and build Leaflet from source, run "jake".
+To run the tests, run "jake test".
+
+For a custom build, open build/build.html in the browser and follow the instructions.
+*/
+
+var build = require('./build/build.js');
+
+function hint(msg, paths) {
+    return function () {
+        console.log(msg);
+        jake.exec('node node_modules/jshint/bin/jshint -c ' + paths,
+                    {printStdout: true}, function () {
+            console.log('\tCheck passed.\n');
+            complete();
+        });
+    };
+}
+
+desc('Check Leaflet.draw source for errors with JSHint');
+task('lint', {async: true}, hint('Checking for JS errors...', 'build/hintrc.js src'));
+
+desc('Check Leaflet.draw specs source for errors with JSHint');
+task('lintspec', {async: true}, hint('Checking for specs JS errors...', 'spec/spec.hintrc.js spec/suites'));
+
+desc('Combine and compress Leaflet.draw source files');
+task('build', {async: true}, function () {
+    build.build(complete);
+});
+
+desc('Run PhantomJS tests');
+task('test', ['lint', 'lintspec'], {async: true}, function () {
+    build.test(complete);
+});
+
+task('default', ['test', 'build']);
+
+jake.addListener('complete', function () {
+    process.exit();
+});

data/lib/leaflet.draw/MIT-LICENCE.txt

@@ -0,0 +1,20 @@
+Copyright 2012 Jacob Toye
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/leaflet.draw/README.md

@@ -0,0 +1,427 @@
+# Important
+Leaflet.draw 0.2.3+ requires [Leaflet 0.7](https://github.com/Leaflet/Leaflet/archive/v0.7.zip) or higher.
+
+#Leaflet.draw
+Adds support for drawing and editing vectors and markers on [Leaflet maps](https://github.com/Leaflet/Leaflet). Check out the [demo](http://leaflet.github.com/Leaflet.draw/).
+
+#### Upgrading from Leaflet.draw 0.1
+
+Leaflet.draw 0.2.0 changes a LOT of things from 0.1. Please see [BREAKING CHANGES](https://github.com/Leaflet/Leaflet.draw/blob/master/BREAKINGCHANGES.md) for how to upgrade.
+
+## Table of Contents
+[Using the plugin](#using)  
+[Advanced Options](#options)  
+[Common tasks](#commontasks)  
+[Thanks](#thanks)  
+
+<a name="using" />
+## 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.**
+
+To add the draw toolbar set the option `drawControl: true` in the map options.
+
+````js
+// 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.
+
+````js
+// 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);
+
+// Initialise the FeatureGroup to store editable layers
+var drawnItems = new L.FeatureGroup();
+map.addLayer(drawnItems);
+
+// Initialise 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` contains the layers that should be editable.
+
+### Events
+
+Once you have successfully added the Leaflet.draw plugin to your map you will want to respond to the different actions users can initiate. The following events will be triggered on the map:
+
+#### draw:created
+
+| Property | Type | Description
+| --- | --- | ---
+| layer | [Polyline](http://leafletjs.com/reference.html#polyline)/[Polygon](http://leafletjs.com/reference.html#polygon)/[Rectangle](http://leafletjs.com/reference.html#rectangle)/[Circle](http://leafletjs.com/reference.html#circle)/[Marker](http://leafletjs.com/reference.html#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.
+
+````js
+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](http://leafletjs.com/reference.html#layergroup) | List of all layers just edited on the map.
+
+Triggered when layers in the FeatureGroup, initialised with the plugin, have been edited and saved.
+
+````js
+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 removed (and saved) from the FeatureGroup.
+
+| Property | Type | Description
+| --- | --- | ---
+| layers | [LayerGroup](http://leafletjs.com/reference.html#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 finished a particular vector or marker.
+
+| Property | Type | Description
+| --- | --- | ---
+| layerType | String | The type of layer this is. One of: `polyline`, `polygon`, `rectangle`, `circle`, `marker`
+
+#### draw:editstart
+
+Triggered when the user starts edit mode by clicking the edit tool button.
+
+| Property | Type | Description
+| --- | --- | ---
+| handler | String | The type of edit this is. One of: `edit`
+
+#### draw:editstop
+
+Triggered when the user has finshed editing (edit mode) and saves edits.
+
+| Property | Type | Description
+| --- | --- | ---
+| handler | String | The type of edit this is. One of: `edit`
+
+#### draw:deletestart
+
+Triggered when the user starts remove mode by clicking the remove tool button.
+
+| Property | Type | Description
+| --- | --- | ---
+| handler | String | The type of edit this is. One of: `remove`
+
+#### draw:deletestop
+
+Triggered when the user has finished removing shapes (remove mode) and saves.
+
+| Property | Type | Description
+| --- | --- | ---
+| handler | String | The type of edit this is. One of: `remove`
+
+<a name="options" />
+## 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 initialising 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](http://leafletjs.com/reference.html#control-positions).
+| draw | [DrawOptions](#drawoptions) | `{}` | The options used to configure the draw toolbar.
+| edit | [EditOptions](#editoptions) | `false` | The options used to configure the edit toolbar.
+
+<a name="drawoptions" />
+### DrawOptions
+
+These options will allow you to configure the draw toolbar and its handlers.
+
+| Option | Type | Default | Description
+| --- | --- | --- | ---
+| polyline | [PolylineOptions](#polylineoptions) | `{ }` | Polyline draw handler options. Set to `false` to disable handler.
+| polygon | [PolygonOptions](#polygonoptions) | `{ }` | Polygon draw handler options. Set to `false` to disable handler.
+| rectangle | [RectangleOptions](#rectangleoptions) | `{ }` | Rectangle draw handler options. Set to `false` to disable handler.
+| circle | [CircleOptions](#circleoptions) | `{ }` | Circle draw handler options. Set to `false` to disable handler.
+| marker | [MarkerOptions](#markeroptions) | `{ }` | Marker draw handler options. Set to `false` to disable handler.
+
+### Draw handler options
+
+The following options will allow you to configure the individual draw handlers.
+
+<a name="polylineoptions" />
+#### PolylineOptions
+
+Polyline and Polygon drawing handlers take the same options.
+
+| Option | Type | Default | Description
+| --- | --- | --- | ---
+| allowIntersection | Bool | `true` | Determines if line segments can cross.
+| drawError | Object | [See code](https://github.com/Leaflet/Leaflet.draw/blob/master/src/draw/handler/Draw.Polyline.js#L10) | 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](http://leafletjs.com/reference.html#polyline-options) | [See code](https://github.com/Leaflet/Leaflet.draw/blob/master/src/draw/handler/Draw.Polyline.js#L20) | The options used when drawing the polyline/polygon on the map.
+| metric | Bool | `true` | Determines which measurement system (metric or imperial) is used.
+| zIndexOffset | Number | `2000` | This should be a high number to ensure that you can draw over all other layers on the map.
+| repeatMode | Bool | `false` | Determines if the draw tool remains enabled after drawing a shape.
+
+<a name="polygonoptions" />
+#### 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.**
+
+<a name="rectangleoptions" />
+#### RectangleOptions
+
+| Option | Type | Default | Description
+| --- | --- | --- | ---
+| shapeOptions | [Leaflet Path options](http://leafletjs.com/reference.html#path-options) | [See code](https://github.com/Leaflet/Leaflet.draw/blob/master/src/draw/handler/Draw.Rectangle.js#L7) | The options used when drawing the rectangle on the map.
+| repeatMode | Bool | `false` | Determines if the draw tool remains enabled after drawing a shape.
+
+<a name="circleoptions" />
+#### CircleOptions
+
+| Option | Type | Default | Description
+| --- | --- | --- | ---
+| shapeOptions | [Leaflet Path options](http://leafletjs.com/reference.html#path-options) | [See code](https://github.com/Leaflet/Leaflet.draw/blob/master/src/draw/handler/Draw.Circle.js#L7) | The options used when drawing the circle on the map. 
+| repeatMode | Bool | `false` | Determines if the draw tool remains enabled after drawing a shape.
+
+<a name="markeroptions" />
+#### MarkerOptions
+
+| Option | Type | Default | Description
+| --- | --- | --- | ---
+| icon | [Leaflet Icon](http://leafletjs.com/reference.html#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.
+| repeatMode | Bool | `false` | Determines if the draw tool remains enabled after drawing a shape.
+
+<a name="editoptions" />
+### EditOptions
+
+These options will allow you to configure the draw toolbar and its handlers.
+
+| Option | Type | Default | Description
+| --- | --- | --- | ---
+| featureGroup | [Leaflet FeatureGroup](http://leafletjs.com/reference.html#featuregroup) | `null` | This is the FeatureGroup that stores all editable shapes. **THIS IS REQUIRED FOR THE EDIT TOOLBAR TO WORK**
+| edit | [EditHandlerOptions](#edithandleroptions) | `{ }` | Edit handler options. Set to `false` to disable handler.
+| remove | [DeleteHandlerOptions](#deletehandleroptions) | `{ }` | Delete handler options. Set to `false` to disable handler.
+
+<a name="edithandleroptions" />
+#### EditHandlerOptions
+
+| Option | Type | Default | Description
+| --- | --- | --- | ---
+| selectedPathOptions | [Leaflet Path options](http://leafletjs.com/reference.html#path-options) | [See code](https://github.com/Leaflet/Leaflet.draw/blob/master/src/edit/handler/EditToolbar.Edit.js#L9) | The path options for how the layers will look while in edit mode. If this is set to null the editable path options will not be set.
+
+<a name="deletehandleroptions" />
+#### DeleteHandlerOptions
+
+| Option | Type | Default | Description
+| --- | --- | --- | ---
+
+<a name="drawlocal" />
+#### Customizing language and text in Leaflet.draw
+
+Leaflet.draw uses the `L.drawLocal` configuration object to set any text used in the plugin. Customizing this will allow support for changing the text or supporting another language.
+
+See [Leaflet.draw.js](https://github.com/Leaflet/Leaflet.draw/blob/master/src/Leaflet.draw.js) for the default strings.
+
+E.g.
+
+````js
+// Set the button title text for the polygon button
+L.drawLocal.draw.toolbar.buttons.polygon = 'Draw a sexy polygon!';
+
+// Set the tooltip start text for the rectangle
+L.drawLocal.draw.handlers.rectangle.tooltip.start = 'Not telling...';
+````
+
+<a name="commontasks" />
+## 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.
+
+````js
+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: {
+			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.
+
+````js
+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.
+
+````js
+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 initialisation by using the `setDrawingOptions` method on the Leaflet.draw control.
+
+E.g. to change the colour of the rectangle:
+
+````js
+drawControl.setDrawingOptions({
+    rectangle: {
+    	shapeOptions: {
+        	color: '#0000FF'
+        }
+    }
+});
+````
+
+### Creating a custom build
+
+If you only require certain handlers (and not the UI), you may wish to create a custom build. You can generate the relevant jake command using the [build html file](https://github.com/Leaflet/Leaflet.draw/blob/master/build/build.html). 
+
+See [edit handlers example](https://github.com/Leaflet/Leaflet.draw/blob/master/examples/edithandlers.html) which uses only the edit handlers.
+
+<a name="thanks" />
+## Thanks
+
+Thanks so much to [@brunob](https://github.com/brunob), [@tnightingale](https://github.com/tnightingale), and [@shramov](https://github.com/shramov). I got a lot of ideas from their Leaflet plugins.
+
+All the [contributors](https://github.com/Leaflet/Leaflet.draw/graphs/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](https://github.com/mourner) is the man! Thanks for dedicating so much of your time to create the gosh darn best JavaScript mapping library around.