leaflet Api中文文档
L.Map
API各种类中的核心部分,用来在页面中创建地图并操纵地图.
使用 example
// initialize the map on the "map" div with a given center and zoom
var map = L.map('map', {
center: [51.505, -0.09],
zoom: 13
});
构造器
构造器 | 使用 | 描述 |
---|---|---|
L.Map( <HTMLElement|String> id, <Map options> options? )
|
new L.Map(…) L.map(…)
|
通过div元素和带有地图选项的描述的文字对象来实例化一个地图对象,其中文字对象是可选的。 |
Options
Map State Options
选项 | 类型 | 默认值 | 描述 |
---|---|---|---|
center
|
LatLng
|
null
|
初始化地图的地理中心. |
zoom
|
Number
|
null
|
初始化地图的缩放. |
layers
|
ILayer[]
|
null
|
初始化后加载到地图上的图层. |
minZoom
|
Number
|
null
|
地图的最小视图。可以重写地图图层的minZoom.
|
maxZoom
|
Number
|
null
|
地图的最大视图。可以重写地图图层的maxZoom .
|
maxBounds
|
LatLngBounds
|
null
|
当这个选项被设置后,地图被限制在给定的地理边界内,当用户平移将地图拖动到视图以外的范围时会出现弹回的效果, 并且也不允许缩小视图到给定范围以外的区域(这取决于地图的尺寸)。 使用setMaxBounds方法可以动态地设置这种约束. |
crs
|
CRS
|
L.CRS.
|
使用的坐标系,当你不确定坐标系是什么时请不要更改. |
Interaction Options
选项 | 类型 | 默认值 | 描述 |
---|---|---|---|
dragging
|
Boolean
|
true
|
决定地图是否可被鼠标或触摸拖动. |
touchZoom
|
Boolean
|
true
|
决定地图是否可被两只手指触摸拖拽缩放. |
scrollWheelZoom
|
Boolean
|
true
|
决定地图是否被被鼠标滚轮滚动缩放. |
doubleClickZoom
|
Boolean
|
true
|
决定地图是否可被双击缩放. |
boxZoom
|
Boolean
|
true
|
决定地图是否可被缩放到鼠标拖拽出的矩形的视图,鼠标拖拽时需要同时按住shift键. |
tap
|
Boolean
|
true
|
Enables mobile hacks for supporting instant taps (fixing 200ms click delay on iOS/Android) and touch holds (fired as contextmenu events).
|
tapTolerance
|
Number
|
15
|
The max number of pixels a user can shift his finger during touch for it to be considered a valid tap. |
trackResize
|
Boolean
|
true
|
确定地图在窗口尺寸改变时是否可以自动处理浏览器以更新视图. |
worldCopyJump
|
Boolean
|
false
|
当这个选项可用时,当你平移地图到其另一个领域时会被地图捕获到,并无缝地跳转到原始的领域以保证所有标注、矢量图层之类的覆盖物仍然可见. |
closePopupOnClick
|
Boolean
|
true
|
当你不想用户点击地图关闭消息弹出框时,请将其设置为false .
|
Keyboard Navigation Options
选项 | 类型 | 默认值 | 描述 |
---|---|---|---|
keyboard
|
Boolean
|
true
|
聚焦到地图且允许用户通过键盘的方向键和+ /- 键来漫游地图.
|
keyboardPanOffset
|
Number
|
80
|
确定按键盘方向键时地图平移的像素. |
keyboardZoomOffset
|
Number
|
1
|
确定键盘+ or - 键对于的缩放级数.
|
Panning Inertia Options
选项 | 类型 | 默认值 | 描述 |
---|---|---|---|
inertia
|
Boolean
|
true
|
如果该选项可用,在拖动和在某一时间段内持续朝同一方向移动建有动力的地图时,会有惯性的效果. |
inertiaDeceleration
|
Number
|
3000
|
确定惯性移动减速的速率,单位是像素每秒的二次方2. |
inertiaMaxSpeed
|
Number
|
1500
|
惯性移动的最大速度,单位是像素每秒. |
inertiaThreshold
|
Number
|
depends
|
放开鼠标或是触摸来停止惯性移动与移动停止之间的毫秒数. |
Control options
选项 | 类型 | 默认值 | 描述 |
---|---|---|---|
zoomControl
|
Boolean
|
true
|
确定zoom control是否默认加载在地图上 . |
attributionControl
|
Boolean
|
true
|
确定attribution control是否默认加载在地图上. |
Animation options
选项 | 类型 | 默认值 | 描述 |
---|---|---|---|
fadeAnimation
|
Boolean
|
depends | 确定瓦片淡出动画是否可用。通常默认在所有浏览器中都支持CSS3转场,android例外. |
zoomAnimation
|
Boolean
|
depends | 确定瓦片缩放动画是否可用。通常默认在所有浏览器中都支持CSS3转场,android例外. |
zoomAnimationThreshold
|
Number
|
4 | Won't animate zoom if the zoom difference exceeds this value. |
markerZoomAnimation
|
Boolean
|
depends | 确定注记的缩放是否随地图缩放动画而播放,如果被禁用,注记在动画中拉长时会消失。通常默认在所有浏览器中都支持CSS3转场,android例外. |
Events
You can subscribe to the following events using these methods.
Event | Data | 描述 |
---|---|---|
click
|
MouseEvent
|
用户点击或触摸地图时触发. |
dblclick
|
MouseEvent
|
用户双击或连续两次触摸地图时触发. |
mousedown
|
MouseEvent
|
用户按下鼠标按键时触发. |
mouseup
|
MouseEvent
|
用户按下鼠标按键时触发. |
mouseover
|
MouseEvent
|
鼠标进入地图时触发. |
mouseout
|
MouseEvent
|
鼠标离开地图时触发. |
mousemove
|
MouseEvent
|
鼠标在地图上移动时触发. |
contextmenu
|
MouseEvent
|
当用户在地图上按下鼠标右键时触发,如果有监听器在监听这个时间,则浏览器默认的情景菜单被禁用. |
focus
|
Event
|
当用户在地图上进行标引、点击或移动时进行聚焦. |
blur
|
Event
|
当地图失去焦点时触发. |
preclick
|
MouseEvent
|
当鼠标在地图上点击之前触发。有时会在点击鼠标时,并在已存在的点击事件开始处理之前想要某件事情发生时用得到. |
load
|
Event
|
当地图初始化时触发。(当地图的中心点和缩放初次设置时). |
unload
|
Event
|
Fired when the map is destroyed with remove method. |
viewreset
|
Event
|
当地图需要重绘内容时触发。(通常在地图缩放和载入时发生)这对于创建用户自定义的叠置图层非常有用. |
movestart
|
Event
|
地图视图开始改变时触发。(比如用户开始拖动地图). |
move
|
Event
|
所有的地图视图移动时触发. |
moveend
|
Event
|
当地图视图结束改变时触发。(比如用户停止拖动地图). |
dragstart
|
Event
|
用户开始拖动地图时触发. |
drag
|
Event
|
用户拖动地图时不断重复地触发. |
dragend
|
Event
|
用户停止拖动时触发. |
zoomstart
|
Event
|
当地图缩放即将发生时触发。(比如缩放动作开始前). |
zoomend
|
Event
|
当地图缩放时触发. |
zoomlevelschange
|
Event
|
Fired when the number of zoomlevels on the map is changed due to adding or removing a layer. |
resize
|
ResizeEvent
|
Fired when the map is resized. |
autopanstart
|
Event
|
打开弹出窗口时地图开始自动平移时触发. |
layeradd
|
LayerEvent
|
当一个新的图层添加到地图上时触发. |
layerremove
|
LayerEvent
|
当一些图层从地图上移除时触发. |
baselayerchange
|
LayerEvent
|
当通过layer control改变基础图层时触发. |
overlayadd
|
LayerEvent
|
Fired when an overlay is selected through the layer control. |
overlayremove
|
LayerEvent
|
Fired when an overlay is deselected through the layer control. |
locationfound
|
LocationEvent
|
当地理寻址成功时触发(使用locate方法) |
locationerror
|
ErrorEvent
|
当地理寻址错误时触发(使用locate方法) |
popupopen
|
PopupEvent
|
当弹出框打开时触发(使用openPopup 方法)
|
popupclose
|
PopupEvent
|
当弹出框关闭时触发(使用closePopup 方法)
|
地图状态修改
方法 | 返回值 | 描述 |
---|---|---|
setView( <LatLng> center, <Number> zoom, <zoom/pan options> options? )
|
this
|
设定地图(设定其地理中心和缩放). |
setZoom( <Number> zoom, <zoom options> options? )
|
this
|
设定地图的缩放. |
zoomIn( <Number> delta?, <zoom options> options? )
|
this
|
通过delta变量放大地图的级别,1是delta的默认值. |
zoomOut( <Number> delta?, <zoom options> options?)
|
this
|
通过delta变量缩小地图的级别,1是delta的默认值. |
setZoomAround( <LatLng> latlng, <Number> zoom, <zoom options> options? )
|
this
|
Zooms the map while keeping a specified point on the map stationary (e.g. used internally for scroll zoom and double-click zoom). |
fitBounds( <LatLngBounds> bounds, <fitBounds options> options? )
|
this
|
将地图视图尽可能大地设定在给定的地理边界内. |
fitWorld( <fitBounds options> options? )
|
this
|
将地图视图尽可能大地设定在包含全部地域的级别上. |
panTo( <LatLng> latlng, <pan options> options? )
|
this
|
将地图平移到给定的中心。如果新的中心点在屏幕内与现有的中心点不同则产生平移动作. |
panInsideBounds( <LatLngBounds> bounds )
|
this
|
平移地图到坐落于给定边界最接近的视图内. |
panBy( <Point> point, <pan options> options? )
|
this
|
通过给定的像素值对地图进行平移. |
invalidateSize( <Boolean> options?, <zoom/pan options> options? )
|
this
|
检查地图容器的大小是否改变并更新地图,如果是这样的话,在动态改变地图大小后调用,如果animate是true的话,对地图进行更新. |
setMaxBounds( <LatLngBounds> bounds, <zoom/pan options> options? )
|
this
|
将地图限定在给定的边界内 (map maxBounds). |
locate( <Locate options> options? )
|
this
|
用地理定位接口Geolocation API获取用户位置信息,在成功定位或定位出错产生locationerror后解除location-found事件与定位数据,且将地图视图设定到检测的确切的用户的位置(如果定位失败则回到地域视图)。在Locate options中有更多详细内容。 |
stopLocate()
|
this
|
停止观看以前由map.locate({.:true})发起的位置,如果使用{setView:true}调用map.locate,则中止重置地图视图。 |
remove()
|
this
|
销毁地图并清除所有相关事件侦听器。 |
获取地图状态
方法 | 返回值 | 描述 |
---|---|---|
getCenter()
|
LatLng
|
返回地图视图的地理中心. |
getZoom()
|
Number
|
获取地图视图现在所处的缩放级别. |
getMinZoom()
|
Number
|
返回地图最小的缩放级别. |
getMaxZoom()
|
Number
|
返回地图最大的缩放级别. |
getBounds()
|
LatLngBounds
|
返回地图视图的经纬度边界. |
getBoundsZoom( <LatLngBounds> bounds, <Boolean> inside? )
|
Number
|
返回适应整个地图视图边界的最大缩放级别。如果inside的设置时true,这个方法返回适应整个地图视图边界的最小缩放级别. |
getSize()
|
Point
|
返回现有地图容器的大小. |
getPixelBounds()
|
Bounds
|
返回地图视图在像素投影坐标系下的边界。(很多时候对用户自定义图层和叠加很有用). |
getPixelOrigin()
|
Point
|
返回地图图层像素投影坐标系下的左上角的点。(很多时候对用户自定义图层和叠加很有用). |
图层控制/h3>
方法 | 返回值 | 描述 |
---|---|---|
addLayer( <ILayer> layer, <Boolean> insertAtTheBottom? )
|
this
|
将图层添加到地图上。如果insertAtTheBottom的选项为true,图层添加时在所以图层之下。(在切换基底图时比较有用). |
removeLayer( <ILayer> layer )
|
this
|
将图层在地图上移除. |
hasLayer( <ILayer> layer )
|
Boolean
|
如果添加的图层是当前图层则返回true. |
openPopup( <Popup> popup )
|
this
|
当关闭前一个弹出框时弹出指定的对话框。(确定在同一时间只有一个打开并可用). |
openPopup( <String> html | <HTMLElement> el, <LatLng> latlng, <Popup options> options? )
|
this
|
创建带有指定选项的弹出窗口,并在地图上的给定点打开弹出窗口。 |
closePopup( <Popup> popup? )
|
this
|
关闭openPopup打开的弹出框. |
addControl( <IControl> control )
|
this
|
在地图上添加控制选项. |
removeControl( <IControl> control )
|
this
|
在地图上移除控制选项. |
转换方法
方法 | 返回值 | 描述 |
---|---|---|
latLngToLayerPoint( <LatLng> latlng )
|
Point
|
返回地图图层上与地理坐标相一致的点。(在地图上进行位置叠加时比较有用). |
layerPointToLatLng( <Point> point )
|
LatLng
|
返回给定地图上点的地理坐标系. |
containerPointToLayerPoint( <Point> point )
|
Point
|
将于地图容器相关的点转换为地图图层相关的点. |
layerPointToContainerPoint( <Point> point )
|
Point
|
将地图图层相关的点转换为地图容器相关的点. |
latLngToContainerPoint( <LatLng> latlng )
|
Point
|
返回与给定地理坐标系相符的地图容器的点. |
containerPointToLatLng( <Point> point )
|
LatLng
|
返回给定地理容器点的地理坐标. |
project( <LatLng> latlng, <Number> zoom? )
|
Point
|
将地理坐标投影到指定缩放级别的像素坐标系中. |
unproject( <Point> point, <Number> zoom? )
|
LatLng
|
将像素坐标系投影到指定缩放级别的地理坐标系中。(默认为当前的缩放级别). |
mouseEventToContainerPoint( <MouseEvent> event )
|
Point
|
返回鼠标点击事件对象的像素坐标(与地图左上角相关). |
mouseEventToLayerPoint( <MouseEvent> event )
|
Point
|
返回鼠标点击事件对象的像素坐标(与地图图层相关). |
mouseEventToLatLng( <MouseEvent> event )
|
LatLng
|
返回鼠标点击事件对象的地理坐标. |
其他方法
方法 | 返回值 | 描述 |
---|---|---|
getContainer()
|
HTMLElement
|
返回地图容器对象. |
getPanes()
|
MapPanes
|
返回不同地图对象的边框(叠加渲染). |
whenReady( <Function> fn, <Object> context? )
|
this
|
当地图的位置和缩放初始化好或是时间发生之后,运行给定的回调方法,通常传递一个函数内容. |
位置选项
选项 | 类型 | 默认值 | 描述 |
---|---|---|---|
watch
|
Boolean
|
false
|
如果该值为真,则开始利用W3C的watchPosition方法监听位置变化情况(而不是指监听一次)。你可以通过map.stoplocate()方法来停止监听. |
setView
|
Boolean
|
false
|
如果该值为真,则通过自动将地图视图定位到用户一定精度范围内的位置,如果地理定位失败则显示全部地图. |
maxZoom
|
Number
|
Infinity
|
在使用setView选项时视图缩放的最大级别. |
timeout
|
Number
|
10000
|
在触发locationerror事件之前等待地理定位的毫秒为单位的时间. |
maximumAge
|
Number
|
0
|
位置监听的最大生命周期。如果比最后定位回复后毫秒用时短,则locate返回一个缓存位置. |
enableHighAccuracy
|
Boolean
|
false
|
开启高精度,参加 W3C SPEC的描述. |
Zoom/pan options
选项 | 类型 | 默认值 | 描述 |
---|---|---|---|
reset
|
Boolean
|
false
|
如果是真的,地图视图将被完全重置(没有任何动画)。 |
pan
|
pan options
|
-
|
设置平移选项(如果没有缩放变化),如果发生。 |
zoom
|
zoom options
|
-
|
设置缩放变焦的选项。 |
animate
|
Boolean
|
-
|
一个相当于将动画赋予缩放和平移选项的方法(见下文)。 |
Pan options
选项 | 类型 | 默认值 | 描述 |
---|---|---|---|
animate
|
Boolean
|
-
|
如果真的话,如果可能的话,平移总是会被动画化。如果为false,则它不会进行动画摇摄,或者如果摇摄超过屏幕,则重置地图视图,或者只是为地图窗格设置新的偏移量(除了“pan.”总是执行后者)。 |
duration
|
Number
|
0.25
|
动画平移的持续时间。 |
easeLinearity
|
Number
|
0.25
|
平移动画缓和的曲率因子(三次Bezier曲线的第三参数)。1.0表示线性动画,曲线越弯曲越少。 |
noMoveStart
|
Boolean
|
false
|
如果是真的,平移不会在启动时开火(在内部用于平移惯性)。 |
Zoom options
选项 | 类型 | 默认值 | 描述 |
---|---|---|---|
animate
|
Boolean
|
-
|
如果未指定,如果缩放原点在当前视图内,则会发生缩放动画。如果是真的,地图将尝试动画缩放不管放在何处是变焦原点。设置“假”将使其始终完全重置视图而无动画 |
fitBounds options
The same as zoom/pan options and additionally:
选项 | 类型 | 默认值 | 描述 |
---|---|---|---|
paddingTopLeft
|
Point
|
[0,0]
|
设置地图容器左上角的填充量,在将视图设置为适合边界时不应该考虑这些填充量。有用的,如果你有一些控件覆盖在地图上,就像侧边栏,你不想让它们模糊你正在缩放的对象。 |
paddingBottomRight
|
Point
|
[0,0]
|
同样的地图右下角。 |
padding
|
Point
|
[0,0]
|
相当于将左上和右下填充设置为相同的值。 |
Properties
M地图属性包括互动操作,允许你在运行环境中互动地控制地图行为,比如通过拖拽和点击缩放级别显示和不显示某要素. Example:
map.doubleClickZoom.disable();
You can also access default map controls like attribution control through map properties:
map.attributionControl.addAttribution("Earthquake data © GeoNames");
Property | 类型 | 描述 |
---|---|---|
dragging
|
IHandler
|
地图拖拽处理程序,可以通过鼠标和触摸的形式. |
touchZoom
|
IHandler
|
触摸地图缩放处理程序. |
doubleClickZoom
|
IHandler
|
双击缩放处理程序. |
scrollWheelZoom
|
IHandler
|
滚动缩放处理程序. |
boxZoom
|
IHandler
|
矩形框(利用鼠标拖动)缩放处理程序. |
keyboard
|
IHandler
|
键盘导向处理程序. |
tap
|
IHandler
|
Mobile touch hacks (quick tap and touch hold) handler. |
zoomControl
|
Control.Zoom
|
缩放控制. |
attributionControl
|
Control.Attribution
|
属性控制. |
地图窗口
望文思义,这是一个包括可以用来放置自定义图层的不同的地图窗口的对象。最大的区别是图层的叠置.
Property | 类型 | 描述 |
---|---|---|
mapPane
|
HTMLElement
|
包含其他地图窗口的窗口. |
tilePane
|
HTMLElement
|
切片图层的窗口. |
objectsPane
|
HTMLElement
|
包含除切片窗口以外所有窗口的窗口. |
shadowPane
|
HTMLElement
|
用来隐藏图层的窗口(如标注的隐藏). |
overlayPane
|
HTMLElement
|
这线段和多边形一类图层的窗口. |
markerPane
|
HTMLElement
|
标注图标的窗口. |
popupPane
|
HTMLElement
|
弹出的窗口. |
leaflet Api中文文档相关推荐
- leafLet入门教程兼leafLet API中文文档参考
leafLet官方文档链接(英文原版):https://leafletjs.com/reference-1.3.4.html#marker-bindpopup 文章目录 leafLet教程 一.简单入 ...
- leafLet入门教程兼leafLet API中文文档参考
英文文档参考:https://leafletjs.com/reference-1.3.4.html#popup 博客参考:https://blog.csdn.net/qq_36595013/artic ...
- Android 3.0 r1 API中文文档(107) —— AsyncPlayer
一.结构 public class AsyncPlayer extends Object java.lang.Object android.media.AsyncPlayer 二.概述 播放一个连续( ...
- Android2.2 API 中文文档系列(7) —— ImageButton
前言 第七篇关于ImageButton的翻译在翻译工具帮助下独立完成,加了一些自己的理解甚至截图,水平有限,欢迎指正.欢迎更多译者一起参与Android API 的中文翻译行动!我的邮箱over140 ...
- Android2.2 API 中文文档系列(6) —— ImageView
注意 请查看本文后期更新完整版: http://www.cnblogs.com/over140/archive/2011/06/08/2075054.html 声明 欢迎转载,但请保留文章原始出处:) ...
- Android 2.2 r1 API 中文文档系列(12) —— Button
前言 截止到这篇,总共翻译了Android API十二篇,其中有两篇是翻译组另外一名成员提供.翻译工作量虽大.虽难,但不管是对自己还是对别人都是巨大的帮助,少则一篇不嫌少,多则十篇不嫌多,再次呼吁大家 ...
- Android 2.2 r1 API 中文文档系列(11) —— RadioButton
一.结构 public class RadioButton extends CompoundButton java.lang.Object android.view.View ...
- Android2.2 r1 API 中文文档系列(10) —— CheckBox
前言 从本章开始,将直接翻译最新的Android 2.2 r1 版本的API,而之前的文章以后更新.补充.完善至新版.本章android.widget.CheckBox内容不多,目前翻译的选择策略是先 ...
- Android API中文文档(111) —— MailTo
一.结构 public class MailTo extends Object java.lang.Object android.net.MailTo 二.类概述 MailTo URL解析器.这个类解 ...
最新文章
- C51汇编伪指令 CSEG DSEG
- setscale方法的用法_基于BigDecimal.setScale的用法小结
- python 更改输出的颜色_python 输出指定的颜色
- (一)梳理前端知识体系,搞定大厂必考面试题
- Hexo搭建git博客
- pip 10.0.0 BUG 解决方案Traceback (most recent call last): File /usr/bin/pip3, line 9, in module...
- Shiro系列-Shiro中Realm如何使用
- NYOJ 116士兵杀敌(二) 树状数组
- 职称计算机xp练习题,职称计算机考试模块WindowsXP练习题(1)
- AJAX-----02远古时期的ajax
- 【POJ】1067 取石子游戏(博弈论)
- 谷歌安装Restlet Client插件
- 【JAVA】poi-tl简单实现调查问卷word模板
- 树莓派舵机控制c语言,第8章 树莓派控制伺服电机(舵机)
- Vue + Spring Boot 项目实战
- Foxmail登录网易邮箱提示LOGIN Login error user suspended
- 新手iso系统怎么安装 新手安装iso镜像文件详细步骤
- aws认证,aws有哪些认证,有什么用
- 163邮箱发送不出去服务器,我是网易163的免费邮箱,最近发现不能发邮件了,不知怎么回事,请热水人帮一下。...
- My97DatePicker 日期控制,开始时间不能大于结束时间,结束时间不能小于开始时间
热门文章
- 4g模块通过什么协议与服务器通信,4G通信模块的分析说明
- 印象笔记 - 记录生活的点点滴滴
- MP-BGP4访问控制 配置与详解
- 图灵测试,测的到底是什么?
- 30岁+的人如何进行自我提升和职场规划
- 安装zsh和zsh-autosuggestion 有效!
- 解决直接打开 vite +vue3 打包的 HTML 文件报错跨域 from origin ‘null‘ has been blocked by CORS policy
- python中输入汉字_python输入中文的实例方法
- python显示汉字_python如何显示中文字体
- MODIS(中分辨率成像光谱仪)简介