Skip to content

Commit

Permalink
Make canvas requirements clearer. Refs mapbox#74
Browse files Browse the repository at this point in the history
  • Loading branch information
tmcw committed May 19, 2016
1 parent fcdb1c6 commit 80c5d2c
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,16 @@ Canvas and [CORS](http://en.wikipedia.org/wiki/Cross-origin_resource_sharing).
don't, so they aren't supported.
* Your browser must support [CORS](http://caniuse.com/#feat=cors) and [Canvas](http://caniuse.com/#feat=canvas),
so `IE >= 10` with no exceptions.
* __(Leaflet < 1.0.0)__ You must set `L_PREFER_CANVAS = true;` so that vector
layers are drawn in Canvas
* __(Leaflet >= 1.0.0)__ You must set `renderer: L.canvas()` for any layer that
you want included in the generated image.
* This library **does not rasterize HTML** because **browsers cannot rasterize HTML**. Therefore,
L.divIcon and other HTML-based features of a map, like zoom controls or legends, are not
included in the output, because they are HTML.

__For Leaflet < 1.0.0__: You must set `L_PREFER_CANVAS = true;` so that vector
layers are drawn in Canvas

__For Leaflet >= 1.0.0__: You must set `renderer: L.canvas()` for any layer that
you want included in the generated image. You can also set this by setting [`preferCanvas: true`](http://leafletjs.com/reference-1.0.0.html#map-prefercanvas) in your map's options.

### Usage

browserify
Expand Down

0 comments on commit 80c5d2c

Please sign in to comment.