Leaflet

一个开源并且对移动端友好的
交互式地图 JavaScript 库

← 教程

Leaflet 快速入门指南

这个循序渐进的入门指南将会帮助你快速了解 Leaflet 基础知识,包括设置 Leaflet 地图、使用标记、折线和弹出窗口,以及处理事件。

查看单独示例。

准备一个新的页面

在为地图编写代码之前,你需要在你的页面上完成以下准备步骤:

现在您已准备好初始化地图并使用它做一些事情。

设置地图

查看单独示例。

让我们用漂亮的 Mapbox Streets 瓦片(Tile)底图创建一张伦敦市中心的地图。首先,我们将初始化地图并将其视图设置为我们选择的地理坐标和缩放级别:

var mymap = L.map('mapid').setView([51.505, -0.09], 13); 

默认情况下(因为我们在创建地图实例时没有传递任何选项),地图上的所有鼠标和触摸交互都处于启用状态,并且具有缩放和属性控制。

请注意,setView 调用还会返回地图对象——大多数 Leaflet 方法在不返回显式值时的行为都是这样的,这允许你可以很方便的进行类似 jQuery 的链式调用。

接下来我们将添加一个瓦片(Tile)图层到地图中, 在当前示例中它是一个 Mapbox 街道的瓦片(Tile)图层。创建一个瓦片(Tile)图层通常会涉及为瓦片(Tile)图像设置 URL 模板 、属性文本和图层的最大缩放等级。在这个例子中,我们将使用 mapbox/streets-v11 中的 Mapbox’s Static Tiles API(从 Mapbox 中使用 瓦片(Tile),还必须申请一个访问令牌)。由于此 API 默认返回 512x512 图块(而不是 256x256),因此我们还必须明确指定这一点并将缩放值偏移 -1。

L.tileLayer('https://api.mapbox.com/styles/v1/{id}/tiles/{z}/{x}/{y}?access_token={accessToken}', {
	attribution: 'Map data &copy; <a href="https://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, Imagery © <a href="https://www.mapbox.com/">Mapbox</a>',
	maxZoom: 18,
	id: 'mapbox/streets-v11',
	tileSize: 512,
	zoomOffset: -1,
	accessToken: 'your.mapbox.access.token'
}).addTo(mymap);

确保引入 leaflet.js 文件并配置好 div 后运行所有代码。就是这样,你现在拥有一个运行正常的 Leaflet 地图。

值得注意的是,Leaflet 是与供应商无关的,也就是说,它不会为瓦片(Tile)强制选择一个特定的提供方。你可以试着把 mapbox/streets-v11 替换成 mapbox/satellite-v9,然后看看会发生什么。另外,Leaflet 甚至不包含任何一行特定的提供者的代码,所以如果你需要,你可以自由地使用其他提供者(我们建议使用Mapbox,它看起来很美)。

根据版权声明,无论任何时候使用任何基于OpenStreetMap 的东西,署名都是必须的。大多数其他瓦片供应商(如Mapbox, StamenThunderforest)也需要署名,请确保给予他们应有的荣誉。

标记、圆和多边形

查看单独示例。

除了瓦片(Tile)图层,您还可以轻松地向地图添加其他内容,包括标记、折线、多边形、圆形和弹出窗口。让我们添加一个标记:

var marker = L.marker([51.5, -0.09]).addTo(mymap);

可以使用同样的方式添加一个圆(除了指定以米为单位的半径作为第二个参数),但允许您通过在创建对象时将选项作为最后一个参数传递来控制它的外观:

var circle = L.circle([51.508, -0.11], {
	color: 'red',
	fillColor: '#f03',
	fillOpacity: 0.5,
	radius: 500
}).addTo(mymap);

添加多边形同样简单:

var polygon = L.polygon([
	[51.509, -0.08],
	[51.503, -0.06],
	[51.51, -0.047]
]).addTo(mymap);

使用弹出窗口

查看单独示例。

当您想将某些信息附加到地图上的特定对象时,通常会使用弹出窗口。Leaflet 有一个非常方便的快捷方式:

marker.bindPopup("<b>Hello world!</b><br>I am a popup.").openPopup();
circle.bindPopup("I am a circle.");
polygon.bindPopup("I am a polygon.");

尝试点击我们的对象。该 bindPopup 方法将带有指定 HTML 内容的弹出窗口附加到您的标记,以便在您单击对象时显示弹出窗口,并且该 openPopup 方法(仅适用于标记)立即打开附加的弹出窗口。

您还可以将弹出窗口用作图层(当您需要的不仅仅是将弹出窗口附加到对象时):

var popup = L.popup()
	.setLatLng([51.5, -0.09])
	.setContent("I am a standalone popup.")
	.openOn(mymap);

这里我们使用 openOn 而不是 addTo 因为它在打开一个新窗口时,先前打开的弹出窗口会自动关闭。

处理事件

每次在 Leaflet 中触发某些事件时,例如用户单击标记或地图缩放更改,相应的对象都会发送一个事件,您可以使用函数订阅该事件。它允许您对用户交互做出反应:

function onMapClick(e) {
	alert("You clicked the map at " + e.latlng);
}

mymap.on('click', onMapClick);

每个对象都有属于自己的一组事件——详情请参阅文档。监听器、函数的第一个参数是一个事件对象——它包含关于发生的事件的有用信息。例如,地图点击事件对象(在上面的例子中的e)有一个 latlng 属性,它是点击发生的位置。

让我们通过使用 popup 而不是 alert 来改进我们的示例:

var popup = L.popup();

function onMapClick(e) {
	popup
		.setLatLng(e.latlng)
		.setContent("You clicked the map at " + e.latlng.toString())
		.openOn(mymap);
}

mymap.on('click', onMapClick);

尝试单击地图,您将在弹出窗口中看到坐标。 查看完整示例 →

现在您已经学习了 Leaflet 的基础知识,可以立即开始构建地图应用程序了! 不要忘记查看详细 文档其它示例