leaflet-plugins icon indicating copy to clipboard operation
leaflet-plugins copied to clipboard

better documentation please ?

Open brunob opened this issue 11 years ago • 4 comments

Help needed ! It would be great to see a pull request for that :)

brunob avatar Apr 03 '14 18:04 brunob

How about jsdoc? I saw some comments in code which should describe data structure, it's a job for jsdoc.

fiskus avatar Aug 27 '14 09:08 fiskus

If anyone else finds this issue looking for just a simple example of adding a Google layer, see this example:

https://github.com/shramov/leaflet-plugins/blob/master/examples/google.html

The gist of the code there is basically this (differences are just small clarifications):

<script src="path-to-shramov-leaflet-plugins/layer/tile/Google.js"></script>
<script type='text/javascript'>
var map = new L.Map('map', {center: new L.LatLng(53.9618, 58.4277), zoom: 13});
var osm = new L.TileLayer('http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png');
var ggl = new L.Google(); //defaults to SATELLITE
var ggl2 = new L.Google('TERRAIN');
map.addLayer(ggl);
map.addControl(new L.Control.Layers({'Open Street Map': osm, 
                                     'Google Satellite': ggl, 
                                     'Google Terrain': ggl2}, {}));
</script>

And note that the full set of Google tile types are given in /layer/tile/Google.js: SATELLITE, ROADMAP, HYBRID, or TERRAIN.

techieshark avatar Apr 07 '15 06:04 techieshark

Documentation for L.BingLayer and L.Yandex can be extracted from my recent commits messages. It'd easy to compile README.md Edit: Done, see Yandex.md and Bing.md.

johnd0e avatar Jun 18 '19 19:06 johnd0e

What about documentation for the permalink script?

pangoSE avatar Feb 07 '20 16:02 pangoSE