2011-04-27 06:26:03 +08:00
<!DOCTYPE html>
< html >
< head >
< title > Leaflet - a modern, lightweight JavaScript library for interactive maps by CloudMade - Quick Start Guide< / title >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< meta charset = "utf-8" / >
2012-02-14 23:02:29 +08:00
< meta property = "og:title" content = "Leaflet — an open-source JavaScript library for interactive maps" / >
2011-04-27 06:26:03 +08:00
< meta property = "og:description" content = "Leaflet is a modern, lightweight BSD-licensed JavaScript library for making tile-based interactive maps for both desktop and mobile web browsers, developed by CloudMade to form the core of its next generation JavaScript API." / >
2012-02-14 23:02:29 +08:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2011-04-27 06:26:03 +08:00
< link rel = "icon" type = "image/png" href = "../docs/images/favicon.png" / >
<!-- Blueprint -->
< link rel = "stylesheet" href = "../docs/css/blueprint/screen.css" media = "screen, projection" >
< link rel = "stylesheet" href = "../docs/css/blueprint/print.css" media = "print" >
<!-- [if lt IE 8]><link rel="stylesheet" href="../docs/css/blueprint/ie.css" media="screen, projection"><![endif] -->
< link rel = "stylesheet" href = "../docs/css/screen.css" media = "screen, projection" / >
< script src = "../docs/highlight/highlight.pack.js" > < / script >
< link rel = "stylesheet" href = "../docs/highlight/styles/github.css" / >
<!-- Leaflet -->
< link rel = "stylesheet" href = "../dist/leaflet.css" / >
<!-- [if lte IE 8]><link rel="stylesheet" href="../dist/leaflet.ie.css" /><![endif] -->
< script src = "../dist/leaflet.js" > < / script >
< / head >
< body >
< div class = "container" >
< h1 > Leaflet< / h1 >
< h3 class = "alt" > A Modern, Lightweight Open-Source JavaScript Library for Interactive Maps by < a href = "http://cloudmade.com" > CloudMade< / a > < / h3 >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< ul class = "nav clearfix" >
< li > < a href = "../index.html" > Overview< / a > < / li >
2012-02-14 23:02:29 +08:00
< li > < a href = "../features.html" > Features< / a > < / li >
< li > < a href = "../examples.html" > Examples< / a > < / li >
< li > < a href = "../reference.html" > Documentation< / a > < / li >
< li > < a href = "../download.html" > Download< / a > < / li >
2011-04-27 06:26:03 +08:00
< li > < a class = "twitter-link" href = "http://twitter.com/LeafletJS" > @LeafletJS< / a > < / li >
2012-02-14 23:02:29 +08:00
< li > < a class = "github-link" href = "http://github.com/CloudMade/Leaflet" > GitHub Repo< / a > < / li >
2011-04-27 06:26:03 +08:00
< / ul >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< p > < a href = "../examples.html" > ← Back to the list of examples< / a > < / p >
< h3 > Leaflet Quick Start Guide< / h3 >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< p > This step-by-step guide will quickly get you started on Leaflet basics, including setting up a Leaflet map, working with markers, polylines and popups, and dealing with events.< / p >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< div id = "map" style = "height: 180px; margin-bottom: 18px" > < / div >
< script >
var cloudmadeUrl = 'http://{s}.tile.cloudmade.com/BC9A493B41014CAABB98F0471D759707/997/256/{z}/{x}/{y}.png',
2012-02-25 19:03:29 +08:00
cloudmadeAttribution = 'Map data © < a href = "http://openstreetmap.org" > OpenStreetMap< / a > contributors, < a href = "http://creativecommons.org/licenses/by-sa/2.0/" > CC-BY-SA< / a > , Imagery © < a href = "http://cloudmade.com" > CloudMade< / a > ',
2011-04-27 06:26:03 +08:00
cloudmade = new L.TileLayer(cloudmadeUrl, {maxZoom: 18, attribution: cloudmadeAttribution});
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
var map = new L.Map('map');
map.setView(new L.LatLng(51.505, -0.09), 13).addLayer(cloudmade);
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
var markerLocation = new L.LatLng(51.5, -0.09),
marker = new L.Marker(markerLocation);
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
map.addLayer(marker);
marker.bindPopup("< b > Hello world!< / b > < br / > I am a popup.").openPopup();
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
var circleLocation = new L.LatLng(51.508, -0.11),
circleOptions = {color: '#f03', opacity: 0.7},
2011-05-19 21:41:16 +08:00
circle = new L.Circle(circleLocation, 500, circleOptions);
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
circle.bindPopup("I am a circle.");
map.addLayer(circle);
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
var p1 = new L.LatLng(51.509, -0.08),
p2 = new L.LatLng(51.503, -0.06),
p3 = new L.LatLng(51.51, -0.047),
polygonPoints = [p1, p2, p3],
polygon = new L.Polygon(polygonPoints);
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
polygon.bindPopup("I am a polygon.");
map.addLayer(polygon);
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
map.on('click', onMapClick);
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
var popup = new L.Popup();
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
function onMapClick(e) {
var latlngStr = '(' + e.latlng.lat.toFixed(3) + ', ' + e.latlng.lng.toFixed(3) + ')';
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
popup.setLatLng(e.latlng);
popup.setContent("You clicked the map at " + latlngStr);
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
map.openPopup(popup);
}
< / script >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< p > < a target = "_blank" href = "quick-start-example.html" > View example on a separate page → < / a > < / p >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< h3 > Preparing your page< / h3 >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< p > Before writing any code for the map, you need to do the following preparation steps on your page:< / p >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< ol >
< li > Include Leaflet CSS files in the head section of your document:
2012-02-25 19:03:29 +08:00
< pre > < code class = "html" > < link rel="stylesheet" href="http://code.leafletjs.com/leaflet-0.3.1/leaflet.css" />
< !--[if lte IE 8]>
< link rel="stylesheet" href="http://code.leafletjs.com/leaflet-0.3.1/leaflet.ie.css" />
< ![endif]--> < / code > < / pre >
2011-04-27 06:26:03 +08:00
< / li >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< li > Include Leaflet JavaScript file somewhere on the page (preferably before < code > body< / code > close tag):
2012-02-25 19:03:29 +08:00
< pre > < code class = "html" > < script src="http://code.leafletjs.com/leaflet-0.3.1/leaflet.js"> < /script> < / code > < / li >
2012-02-14 23:02:29 +08:00
2012-02-25 19:03:29 +08:00
< li > Put a < code > div< / code > element with a certain < code > id< / code > where you want your map to be (making sure it has defined height):
< pre > < code class = "html" > < div id="map" style="height: 200px"> < /div> < / code > < / pre > < / li >
2011-04-27 06:26:03 +08:00
< / ol >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< p > Now you're ready to initialize the map and do some stuff with it.< / p >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< h3 > Setting up the map< / h3 >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< div id = "map1" style = "height: 180px" > < / div >
< script >
var cloudmade1 = new L.TileLayer(cloudmadeUrl, {maxZoom: 18, attribution: cloudmadeAttribution});
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
var map1 = new L.Map('map1');
map1.setView(new L.LatLng(51.505, -0.09), 13).addLayer(cloudmade1);
< / script >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< p > Let's create a map instance, set its view to the center of London and add a pretty CloudMade tile layer to it. First we'll initialize the map:< / p >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< pre > < code class = "javascript" > var map = new L.Map('map');< / code > < / pre >
< p > By default (as we didn't pass any options when creating the map instance), all mouse and touch interactions on the map are enabled, and it has zoom and attribution controls.< / p >
2011-04-27 23:18:20 +08:00
< p > Next we'll create a tile layer to add to our map, in this case it's a CloudMade tile layer with Fresh style. Creating a tile layer usually involves setting the URL template for the tile images (get yours at < a href = "http://cloudmade.com/register" > CloudMade< / a > ), the attribution text and the maximum zoom level of the layer:< / p >
2011-04-27 06:26:03 +08:00
2012-02-25 19:03:29 +08:00
< pre > < code class = "javascript" > var cloudmade = new L.TileLayer('http://{s}.tile.cloudmade.com/< span class = "text-cut" data-cut = "[your-API-key]" > YOUR-API-KEY< / span > /997/256/{z}/{x}/{y}.png', {
attribution: 'Map data & copy; < span class = "text-cut" data-cut = "[…]" > < a href="http://openstreetmap.org"> OpenStreetMap< /a> contributors, < a href="http://creativecommons.org/licenses/by-sa/2.0/"> CC-BY-SA< /a> , Imagery © < a href="http://cloudmade.com"> CloudMade< /a> < / span > ',
maxZoom: 18
});< / code > < / pre >
< p > It's worth noting that Leaflet is provider-agnostic, meaning that it doesn't enforce a particular choice of providers for tiles, and it doesn't even contain a single provider-specific line of code, so you're free to use other providers if you need to (we'd recommend CloudMade though, it looks beautiful).< / p >
2011-04-27 06:26:03 +08:00
< p > Finally we'll set the map view to the center of London at 13th zoom level and add our tile layer (see the resulting map above):< / p >
< pre > < code class = "javascript" > var london = new L.LatLng(51.505, -0.09); // geographical point (longitude and latitude)
map.setView(london, 13).addLayer(cloudmade);< / code > < / pre >
< p > Make sure this code is below both the map < code > div< / code > and < code > leaflet.js< / code > inclusion, or in a < code > window.load< / code > or < code > document.ready< / code > event handler.< / p >
< h3 > Markers, circles and polygons< / h3 >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< div id = "map2" style = "height: 180px; margin-bottom: 18px" > < / div >
< script >
var cloudmade2 = new L.TileLayer(cloudmadeUrl, {maxZoom: 18, attribution: cloudmadeAttribution});
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
var map2 = new L.Map('map2');
map2.setView(new L.LatLng(51.505, -0.09), 13).addLayer(cloudmade2);
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
var marker2 = new L.Marker(markerLocation);
map2.addLayer(marker2);
2012-02-14 23:02:29 +08:00
var circle2 = new L.Circle(circleLocation, 500, circleOptions);
2011-04-27 06:26:03 +08:00
map2.addLayer(circle2);
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
var polygon2 = new L.Polygon(polygonPoints);
map2.addLayer(polygon2);
< / script >
< p > Besides tile layers, you can easily add other things to your map, including markers, polylines, polygons, circles, and popups. Let's add a marker:< / p >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< pre > < code class = "javascript" > var markerLocation = new L.LatLng(51.5, -0.09);
var marker = new L.Marker(markerLocation);
map.addLayer(marker);< / code > < / pre >
2011-05-19 21:41:16 +08:00
< p > Adding a circle is the same (except for specifying the radius in meters), but lets configure it by passing options as a third argument when creating the object (the second argument is the radius in pixels):< / p >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< pre > < code class = "javascript" > var circleLocation = new L.LatLng(51.508, -0.11),
circleOptions = {
2012-02-14 23:02:29 +08:00
color: 'red',
fillColor: '#f03',
2011-04-27 06:26:03 +08:00
fillOpacity: 0.5
};
2012-02-14 23:02:29 +08:00
2011-05-19 21:41:16 +08:00
var circle = new L.Circle(circleLocation, 500, circleOptions);
2011-04-27 06:26:03 +08:00
map.addLayer(circle);< / code > < / pre >
< p > Add a polygon is easy too:< / p >
< pre > < code class = "javascript" > var p1 = new L.LatLng(51.509, -0.08),
p2 = new L.LatLng(51.503, -0.06),
p3 = new L.LatLng(51.51, -0.047),
polygonPoints = [p1, p2, p3];
var polygon = new L.Polygon(polygonPoints);
map.addLayer(polygon);< / code > < / pre >
< h3 > Working with popups< / h3 >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< div id = "map3" style = "height: 180px; margin-bottom: 18px" > < / div >
< script >
var cloudmade3 = new L.TileLayer(cloudmadeUrl, {maxZoom: 18, attribution: cloudmadeAttribution});
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
var map3 = new L.Map('map3');
map3.setView(new L.LatLng(51.505, -0.09), 13).addLayer(cloudmade3);
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
var marker3 = new L.Marker(markerLocation);
map3.addLayer(marker3);
marker3.bindPopup("< b > Hello world!< / b > < br / > I am a popup.").openPopup();
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
/*marker3.dragging.enable();
marker3.on('dragend', function() {
marker2._popup.setContent('Marker dragged.');
marker2._popup._updateContent();
marker2.openPopup();
});*/
2012-02-14 23:02:29 +08:00
2011-05-19 21:41:16 +08:00
var circle3 = new L.Circle(circleLocation, 500, circleOptions);
2011-04-27 06:26:03 +08:00
circle3.bindPopup("I am a circle.");
map3.addLayer(circle3);
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
var polygon3 = new L.Polygon(polygonPoints);
polygon3.bindPopup("I am a polygon.");
map3.addLayer(polygon3);
< / script >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< p > Popups are usually used when you want to attach some information to a particular object on a map. Leaflet has a very handy shortcut for this:< / p >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< pre > < code class = "javascript" > marker.bindPopup("< b> Hello world!< /b> < br /> I am a popup.").openPopup();
circle.bindPopup("I am a circle.");
polygon.bindPopup("I am a polygon.");< / code > < / pre >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< p > Try clicking on our objects. The < code > bindPopup< / code > method attaches a popup with the specified HTML content to your marker so the popup appears when you click on the object, and the < code > openPopup< / code > method (for markers only) immediately opens the attached popup.< / p >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< p > You can also use popups as layers (when you need something more than attching a popup to an object):< / p >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< pre > < code class = "javascript" > var popup = new L.Popup();
popup.setLatLng(new L.LatLng(51.5, -0.09));
popup.setContent("I am a standalone popup.");
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
map.openPopup(popup);< / code > < / pre >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< p > Here we use < code > openPopup< / code > instead of < code > addLayer< / code > because it handles automatic closing of a previously opened popup when opening a new one which is good for usability.< / p >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< h3 > Dealing with events< / h3 >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< p > Every time something happens in Leaflet, e.g. user clicks on a marker or map zoom changes, the corresponding object sends an event which you can subscribe to with a function. It allows you to react to user interaction:< / p >
< pre > < code class = "javascript" > map.on('click', onMapClick);
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
function onMapClick(e) {
alert("You clicked the map at " + e.latlng);
}< / code > < / pre >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< p > Each object has its own set of events — see < a href = "../reference.html" > documentation< / a > for details. The first argument of the listener function is an event object — it contains useful information about the event that happened. For example, map click event object (< code > e< / code > in the example above) has < code > latlng< / code > property which is a location at which the click occured.< / p >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< p > Lets improve our example by using a popup instead of an alert and formatting the location string:< / p >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< pre > < code class = "javascript" > map.on('click', onMapClick);
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
var popup = new L.Popup();
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
function onMapClick(e) {
var latlngStr = '(' + e.latlng.lat.toFixed(3) + ', ' + e.latlng.lng.toFixed(3) + ')';
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
popup.setLatLng(e.latlng);
popup.setContent("You clicked the map at " + latlngStr);
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
map.openPopup(popup);
}< / code > < / pre >
2011-04-27 23:18:20 +08:00
< p > Try clicking on the map and you will see the coordinates in a popup. < a target = "_blank" href = "quick-start-example.html" > View the full example → < / a > < / p >
2011-04-27 19:41:58 +08:00
< p > Now you've learned Leaflet basics and can start building map apps straight away! Don't forget to take a look at the detailed < a href = "../reference.html" > documentation< / a > or < a href = "../examples.html" > other examples< / a > .< / p >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< hr / >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< p class = "quiet" > © 2011 < a href = "http://cloudmade.com" > CloudMade< / a > . Map data © 2011 < a href = "http://openstreetmap.org" > OpenStreetMap< / a > contributors, < a href = "http://creativecommons.org/licenses/by-sa/2.0/" > CC-BY-SA< / a > .< / p >
< / div >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< a href = "http://github.com/CloudMade/Leaflet" > < img id = "forkme" src = "http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt = "Fork me on GitHub" / > < / a >
2012-02-14 23:02:29 +08:00
2011-04-27 06:26:03 +08:00
< script >
hljs.tabReplace = ' ';
hljs.initHighlightingOnLoad();
2012-02-14 23:02:29 +08:00
< / script >
2011-06-17 06:56:11 +08:00
< script type = "text/javascript" >
var _gaq = _gaq || [];
_gaq.push([ '_setAccount', 'UA-4147697-4' ]);
_gaq.push([ '_trackPageview' ]);
(function() {
var ga = document.createElement('script');
ga.type = 'text/javascript';
ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl'
: 'http://www')
+ '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(ga, s);
})();
< / script >
2012-02-21 23:14:40 +08:00
< script type = "text/javascript" >
var uvOptions = {};
(function() {
var uv = document.createElement('script'); uv.type = 'text/javascript'; uv.async = true;
uv.src = ('https:' == document.location.protocol ? 'https://' : 'http://') + 'widget.uservoice.com/ygv5CFpu3yBQFTFPOAdFg.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(uv, s);
})();
< / script >
2011-04-27 06:26:03 +08:00
< / body >
2012-02-14 23:02:29 +08:00
< / html >
