Rich annotation plugin (drawing, text, and more) for Leaflet. Designed to help people tell the story behind their maps.
JavaScript CSS
Latest commit f49ee69 Mar 4, 2016 @justinmanley Fix links in README.

README.md

Leaflet.Illustrate

Build Status Coverage Status

Rich annotation plugin (drawing, text, and more) for Leaflet extending Leaflet.draw. Designed to help people tell the story behind the maps that they create.

Created for MapKnitter, a free and open-source tool for stitching (or orthorectifying, in geographer-speak) grassroots aerial imagery into a composite "satellite" map. This Leaflet plugin is designed to address the needs of the MapKnitter community, in particular, but is useful in any applications where rich map annotation is desired.

Learn more about MapKnitter at http://publiclab.org/wiki/mapknitter.

MapKnitter is open-source software created and run by the Public Lab for Open Technology and Science, and this project is sponsored by Google as part of Google Summer of Code 2014.

Check it out

The latest demo is live at Leaflet.Illustrate/examples/0.0.2/simple/. Give it a try!

Usage

Leaflet.Illustrate defines two new types of annotations: textboxes, and pointers.

Users can create and edit textbox and pointer annotations using a Leaflet.draw-style toolbar. Leaflet.Illustrate is built on top of Leaflet.draw, so it also easy to use Leaflet.Illustrate annotations alongside Leaflet.draw geometric annotations.

This plugin is documented more fully in the wiki.

Contributing

I will gladly accept contributions. Please follow the Leaflet contribution guide.

To set up, install Node.js. If you don't have it already, you'll also need the Grunt CLI: npm install -g grunt-cli. Then, clone this repository and run npm install in the project root to install dependencies.

You can have Grunt watch the repository and continuously rebuild the project as you make changes by running grunt before you start working.

Tests are run with the command grunt test. Please ensure that your contributions pass all tests before you submit a pull request.

License

Released under the MIT license. See the LICENSE.