Leaflet/examples/quick-start.md

220 lines
7.9 KiB
Markdown
Raw Normal View History

2012-07-17 01:21:00 +08:00
---
2012-07-23 15:20:49 +08:00
layout: tutorial
2012-07-17 01:21:00 +08:00
title: Quick Start Guide
---
2012-07-24 18:57:31 +08:00
## Leaflet Quick Start Guide
2012-07-17 01:21:00 +08:00
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.
2012-07-26 21:12:20 +08:00
<div id="map" class="map" style="height: 180px"></div>
2012-07-17 01:21:00 +08:00
[View example on a separate page &rarr;](quick-start-example.html)
### Preparing your page
Before writing any code for the map, you need to do the following preparation steps on your page:
* Include Leaflet CSS file in the head section of your document:
2012-07-17 01:21:00 +08:00
2015-05-28 17:08:28 +08:00
<link rel="stylesheet" href="http://cdnjs.cloudflare.com/ajax/libs/leaflet/0.7.3/leaflet.css" />
2012-07-17 01:21:00 +08:00
2012-07-24 18:57:31 +08:00
* Include Leaflet JavaScript file:
2012-07-17 01:21:00 +08:00
2015-05-28 17:08:28 +08:00
<script src="http://cdnjs.cloudflare.com/ajax/libs/leaflet/0.7.3/leaflet.js"></script>
2012-07-17 01:21:00 +08:00
2012-07-24 18:57:31 +08:00
* Put a `div` element with a certain `id` where you want your map to be:
2012-07-17 01:21:00 +08:00
2012-07-24 18:57:31 +08:00
<div id="map"></div>
* Make sure the map container has a defined height, for example by setting it in CSS:
<pre><code class="css">#map { height: 180px; }</code></pre>
2012-07-17 01:21:00 +08:00
Now you're ready to initialize the map and do some stuff with it.
### Setting up the map
2012-07-26 21:12:20 +08:00
<div id="map1" class="map" style="height: 180px"></div>
2012-07-17 01:21:00 +08:00
2014-04-28 18:51:17 +08:00
Let's create a map of the center of London with pretty Mapbox Streets tiles. First we'll initialize the map and set its view to our chosen geographical coordinates and a zoom level:
2012-07-17 01:21:00 +08:00
2012-07-24 18:57:31 +08:00
var map = L.map('map').setView([51.505, -0.09], 13);
2012-07-17 01:21:00 +08:00
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.
2012-07-24 18:57:31 +08:00
Note that `setView` call also returns the map object --- most Leaflet methods act like this when they don't return an explicit value, which allows convenient jQuery-like method chaining.
Next we'll add a tile layer to add to our map, in this case it's a Mapbox Streets tile layer. Creating a tile layer usually involves setting the [URL template](http://leafletjs.com/reference.html#url-template) for the tile images (get yours at [Mapbox](http://mapbox.com)), the attribution text and the maximum zoom level of the layer:
2012-07-17 01:21:00 +08:00
<pre><code class="javascript">L.tileLayer('https://api.tiles.mapbox.com/v4/{id}/{z}/{x}/{y}.png?access_token={accessToken}', {
2014-04-28 18:41:40 +08:00
attribution: 'Map data &amp;copy; <span class="text-cut" data-cut="[&hellip;]">&lt;a href="http://openstreetmap.org"&gt;OpenStreetMap&lt;/a&gt; contributors, &lt;a href="http://creativecommons.org/licenses/by-sa/2.0/"&gt;CC-BY-SA&lt;/a&gt;, Imagery &copy; &lt;a href="http://mapbox.com"&gt;Mapbox&lt;/a&gt;</span>',
maxZoom: 18,
id: '<a href="https://www.mapbox.com/projects/">your.mapbox.project.id</a>',
accessToken: '<a href="https://www.mapbox.com/account/apps/">your.mapbox.public.access.token</a>'
2012-07-24 18:57:31 +08:00
}).addTo(map);</code></pre>
2012-07-17 01:21:00 +08:00
2012-07-24 18:57:31 +08:00
Make sure all the code is called after the `div` and `leaflet.js` inclusion. That's it! You have a working Leaflet map now.
2012-07-17 01:21:00 +08:00
2014-04-28 19:16:15 +08:00
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 Mapbox though, it looks beautiful).
2012-07-17 01:21:00 +08:00
### Markers, circles and polygons
2012-07-26 21:12:20 +08:00
<div id="map2" class="map" style="height: 180px"></div>
2012-07-17 01:21:00 +08:00
Besides tile layers, you can easily add other things to your map, including markers, polylines, polygons, circles, and popups. Let's add a marker:
2012-07-24 18:57:31 +08:00
var marker = L.marker([51.5, -0.09]).addTo(map);
2012-07-17 01:21:00 +08:00
2012-07-24 18:57:31 +08:00
Adding a circle is the same (except for specifying the radius in meters as a second argument), but lets you control how it looks by passing options as the last argument when creating the object:
2012-07-17 01:21:00 +08:00
2012-07-24 18:57:31 +08:00
var circle = L.circle([51.508, -0.11], 500, {
color: 'red',
fillColor: '#f03',
fillOpacity: 0.5
}).addTo(map);
2012-07-17 01:21:00 +08:00
2012-07-24 18:57:31 +08:00
Adding a polygon is as easy:
2012-07-17 01:21:00 +08:00
2012-07-24 19:07:28 +08:00
var polygon = L.polygon([
[51.509, -0.08],
[51.503, -0.06],
[51.51, -0.047]
]).addTo(map);
2012-07-17 01:21:00 +08:00
### Working with popups
2012-07-26 21:12:20 +08:00
<div id="map3" class="map" style="height: 180px"></div>
2012-07-17 01:21:00 +08:00
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:
marker.bindPopup("<b>Hello world!</b><br>I am a popup.").openPopup();
circle.bindPopup("I am a circle.");
polygon.bindPopup("I am a polygon.");
2012-07-24 18:57:31 +08:00
Try clicking on our objects. The `bindPopup` method attaches a popup with the specified HTML content to your marker so the popup appears when you click on the object, and the `openPopup` method (for markers only) immediately opens the attached popup.
2012-07-17 01:21:00 +08:00
2013-12-12 06:51:56 +08:00
You can also use popups as layers (when you need something more than attaching a popup to an object):
2012-07-17 01:21:00 +08:00
2012-07-24 18:57:31 +08:00
var popup = L.popup()
.setLatLng([51.5, -0.09])
.setContent("I am a standalone popup.")
.openOn(map);
2012-07-17 01:21:00 +08:00
2012-07-24 18:57:31 +08:00
Here we use `openOn` instead of `addTo` because it handles automatic closing of a previously opened popup when opening a new one which is good for usability.
2012-07-17 01:21:00 +08:00
### Dealing with events
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:
function onMapClick(e) {
alert("You clicked the map at " + e.latlng);
}
map.on('click', onMapClick);
2012-07-24 18:57:31 +08:00
Each object has its own set of events --- see [documentation](../reference.html) 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 (`e` in the example above) has `latlng` property which is a location at which the click occured.
2012-07-17 01:21:00 +08:00
2015-07-01 23:34:29 +08:00
Let's improve our example by using a popup instead of an alert:
2012-07-17 01:21:00 +08:00
2012-07-24 18:57:31 +08:00
var popup = L.popup();
2012-07-17 01:21:00 +08:00
2012-07-24 18:57:31 +08:00
function onMapClick(e) {
popup
2012-07-24 23:37:33 +08:00
.setLatLng(e.latlng)
.setContent("You clicked the map at " + e.latlng.toString())
2012-07-24 18:57:31 +08:00
.openOn(map);
2012-07-17 01:21:00 +08:00
}
2012-07-24 18:57:31 +08:00
map.on('click', onMapClick);
2012-07-17 01:21:00 +08:00
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 &rarr;</a>
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>.
<script>
2012-07-24 23:37:33 +08:00
var map = L.map('map').setView([51.505, -0.09], 13);
2012-07-17 01:21:00 +08:00
2014-09-18 09:05:29 +08:00
L.tileLayer(MB_URL, {attribution: MB_ATTR, id: 'examples.map-i875mjb7'}).addTo(map);
2012-07-17 01:21:00 +08:00
2012-07-24 23:37:33 +08:00
L.marker([51.5, -0.09]).addTo(map)
.bindPopup("<b>Hello world!</b><br />I am a popup.").openPopup();
2012-07-17 01:21:00 +08:00
2012-07-24 23:37:33 +08:00
L.circle([51.508, -0.11], 500, {
color: 'red',
fillColor: '#f03',
fillOpacity: 0.5
}).addTo(map).bindPopup("I am a circle.");
2012-07-17 01:21:00 +08:00
2012-07-24 23:37:33 +08:00
L.polygon([
[51.509, -0.08],
[51.503, -0.06],
[51.51, -0.047]
]).addTo(map).bindPopup("I am a polygon.");
2012-07-17 01:21:00 +08:00
2012-07-24 23:37:33 +08:00
/*var popup = L.popup();
2012-07-17 01:21:00 +08:00
function onMapClick(e) {
2012-07-24 23:37:33 +08:00
popup
.setLatLng(e.latlng)
.setContent("You clicked the map at " + e.latlng.toString())
.openOn(map);
}
2012-07-17 01:21:00 +08:00
2012-07-24 23:37:33 +08:00
map.on('click', onMapClick);*/
2012-07-17 01:21:00 +08:00
2012-07-24 23:37:33 +08:00
var map1 = L.map('map1').setView([51.505, -0.09], 13);
2014-09-18 09:05:29 +08:00
L.tileLayer(MB_URL, {attribution: MB_ATTR, id: 'examples.map-i875mjb7'}).addTo(map1);
2012-07-17 01:21:00 +08:00
2012-07-24 23:37:33 +08:00
var map2 = L.map('map2').setView([51.505, -0.09], 13);
2014-09-18 09:05:29 +08:00
L.tileLayer(MB_URL, {attribution: MB_ATTR, id: 'examples.map-i875mjb7'}).addTo(map2);
2012-07-17 01:21:00 +08:00
2012-07-24 23:37:33 +08:00
L.marker([51.5, -0.09]).addTo(map2);
2012-07-17 01:21:00 +08:00
2012-07-24 23:37:33 +08:00
L.circle([51.508, -0.11], 500, {
color: 'red',
fillColor: '#f03',
fillOpacity: 0.5
}).addTo(map2);
L.polygon([
[51.509, -0.08],
[51.503, -0.06],
[51.51, -0.047]
]).addTo(map2);
2012-07-17 01:21:00 +08:00
2012-07-24 23:37:33 +08:00
var map3 = L.map('map3').setView([51.505, -0.09], 13);
2014-09-18 09:05:29 +08:00
L.tileLayer(MB_URL, {attribution: MB_ATTR, id: 'examples.map-i875mjb7'}).addTo(map3);
2012-07-17 01:21:00 +08:00
2012-07-24 23:37:33 +08:00
L.marker([51.5, -0.09]).addTo(map3)
.bindPopup("<b>Hello world!</b><br />I am a popup.").openPopup();
L.circle([51.508, -0.11], 500, {
color: 'red',
fillColor: '#f03',
fillOpacity: 0.5
}).addTo(map3).bindPopup("I am a circle.");
L.polygon([
[51.509, -0.08],
[51.503, -0.06],
[51.51, -0.047]
]).addTo(map3).bindPopup("I am a polygon.");
2012-07-17 01:21:00 +08:00
2012-07-23 15:20:49 +08:00
</script>