Leaflet v1.0.0 Map接口API

Map

API的核心类—用来在页面上创建map并维护。

用法

<pre name="code" class="javascript">// initialize the map on the "map" div with a given center and zoomvar map = L.map('map', {    center: [51.505, -0.09],    zoom: 13});

创建

工厂方法描述L.map(<String> id,<Map options> options?) 使用给定的<div>的DOM id和Map options来实例化一个map。L.map(<HTMLElement> el,<Map options> options?)使用给定的<div>HTML元素和Map options来实例化一个map。

选项

选项类型默认值描述preferCanvasBooleanfalse决定 Path是否应该在Canvas中渲染，默认情况下，所有Path都在SVG渲染器中被渲染。

控制选项

选项类型默认值描述attributionControlBooleantrueattribution Control默认是否添加到map上。zoomControlBooleantruezoom Control默认是否添加到map上。

交互选项

选项类型   默认值描述closePopupOnClickBooleantrue如果不想在用户点击map时关闭弹出，请将该选项设置为falsezoomSnapNumber1强制map的缩放尺寸是该值的多倍，尤其在fitBounds()和pinch-zoom之后。默认情况下，缩放水平紧随最近的整数；
比较小的取值（比如0.5或0.1）允许更大的粒度。0值表示缩放水平不会随fitBounds或者pinch-zoom变化。zoomDeltaNumber1使用zoomIn()、zoomOut()，敲下键盘上的+或者只用zoom control之后，控制map的缩放水平。比1小的值(比如0.5)
允许更大的粒度。trackResizeBooleantrue决定map是否自动适应流量窗口大小。boxZoomBooleantrue决定map是否可以变焦到按住shift键并拖拽鼠标选定的矩形区域。doubleClickZoomBoolean|Stringtrue决定map在双击时是否可以变大，按住shift双击时是否可以缩小。如果使用“center”参数，双击zoom将会缩放至视图
中心，不管鼠标在什么位置。draggingBooleantrue决定map是否可以用鼠标或者触控拖拽。

地图状态选项

选项类型默认值描述crsCRSL.CRS.EPSG3857坐标参照系使用，如果你不明白它的意思，建议不要修改。centerLatLngundefined初始化map的地理中心zoomNumberundefined初始化map的缩放水平minZoomNumberundefinedmap的最小缩放水平，使用任意的minZoom选项设置map层maxZoomNumberundefinedmap的最大缩放水平，使用任意的maxZoom选项设置map层layersLayer[][]初始添加到map的layer数组maxBoundsLatLngBoundsnull该选项设置后，map就会将视图限定在给定的地理边界，用户尝试查看视图之外时会弹回至界限之内。
使用setMaxBound方法可以设置这种动态限制。rendererRenderer*在map上绘制矢量层的默认方法，根据浏览器的支持情况，其默认值可以是L.SVG或者L.Canvas。

动画选项

选项类型默认值描述fadeAnimationBooleantrue瓦片淡入淡出动画是否使能，默认情况下，除了Android以外所有支持CSS3 Transitions属性的浏览器都是使能的。markerZoomAnimationBooleantruemarker是否激活缩放动画，如果去使能对于动画的长度他们会消失（这里可能翻译的有问题）。默认情况下，
除了Android以外所有支持CSS3 Transitions属性的浏览器都是使能的。transform3DLimitNumber2^23。定义CSS 平移变换的最大尺寸。建议不要改变默认值，除非完成一次较大的panBy之后，web浏览器位置层位置有误zoomAnimationBooleantruemap缩放动画是否使能，默认情况下，除了Android以外所有支持CSS3 Transitions属性的浏览器都是使能的。zoomAnimationThresholdNumber4缩放大小超过该设定值时缩放动画失效。

摇摆惯性选项（Panning Inertia Options）

选项类型默认值描述inertiaBoolean*如果使能，拖拽或者向同一方向持续移动一段时间，map的摇摆将具有惯性效果。在触屏设备上尤其效果出色。
默认情况下，除非运行在旧的Andrid设备上，该属性是使能的。inertiaDecelerationNumber3000惯性移动减速的速率，单位：pixels/second。inertiaMaxSpeedNumberInfinity惯性移动的最大速率，单位：pixels/second。easeLinearityNumber0.2 worldCopyJumpBooleanfalse该选项使能后，当移动到世界的另一个“拷贝”时，map可以进行追踪，并且无缝跳转至原始的，这样所有的覆盖物比如marker和vector依然可见。maxBoundsViscosityNumber0.0如果设置了maxBounds选项，该选项用来控制向周围拖拽map时边界线的宽度。默认值是0.0，表示允许用户用正常速度拖拽到边界之外，1.0表示边界是完全固定的，阻止用户拖出边界以外。

键盘导航选项（Keyboard Navigation Options）

选项类型默认值描述keyboardBooleantrue使map可聚焦，允许用户使用键盘箭头和+/-键导航mapkeyboardPanDeltaNumber80按下箭头键时移动的像素数量

鼠标滚轮选项（Mousewheel option）

选项类型默认值描述scrollWheelZoomBoolean|Stringtrue决定是否可以使用鼠标滚轮缩放map。如果传入“center“参数，地图会缩放至视图中心，不管鼠标在什么地方。wheelDebounceTimeNumber40限定鼠标滚轮持续的频率。默认情况下不可以每40ms使用一次滚轮。wheelPxPerZoomLevelNumber60完全缩放一次代表多少像素。较小值使滚滚轮缩放更快。

触控交互选项（Touch interaction options）

选项类型默认值描述tapBooleantrue使mobile hacks支持instant taps（在IOS和安卓上固定200ms的单击延迟）和touch holds（看作是contextmenu事件）tapToleranceNumber15在触摸屏幕期间一个有效的tap需要用户移动手指的最大像素数量touchZoomBoolean|String*是否可以用两只手指触摸拖拽缩放map。如果传递”center“参数，地图会缩放至视图中心，无论手指在map哪个位置触发缩放。bounceAtZoomLimitsBooleantrue如果不愿使用双指触控map缩放超过最小/最大值，并且在超过极限值时会弹，请将该选项置为false。

事件（Event）

层事件（Layer event）

事件数据描述baselayerchangeLayersControlEvent通过layer control改变基础层时触发overlayaddLayersControlEvent通过layer control选中覆盖层时触发overlayremoveLayersControlEvent通过layer control取消选中覆盖层时触发layeradd LayerEvent一个新的层添加到map时触发layerremoveLayerEvent一些层从map中移除时触发

map状态改变事件（Map state change events）

事件数据描述zoomlevelschangeEvent添加或者删除一个层时map上的缩放水平变化时触发resize
ResizeEventmap改变大小时触发unloadEvent使用remove方法销毁map时触发viewresetEventmap需要重绘内容时触发（通常在map缩放或者加载时触发）。尤其对创建传统的覆盖层有用。loadEventmap初始化时触发（map的中心和缩放第一次设置时）zoomstartEventmap将要缩放时触发（例如，缩放开始前）movestartEventmap视图将要变化时触发（例如，用户开始拖拽map）zoomEventmap上任何缩放水平变化重复发生时触发，包括pan和fly动画。moveEventmap上任何移动重复发生时触发，包括pan和fly动画。zoomendEvent任何动画之后，地图发生变化都会触发moveendEvent当map中心停止变化时触发（用户停止拖拽map）

弹出框事件（Popup event）

事件数据描述popupopenPopupEvent在map上打开弹出框时触发popupclosePopupEventmap上的弹出框关闭时触发autopanstartEvent打开弹出框时map开始autopanning时触发

工具提示事件（Tooltip event）

事件数据描述tooltipopenTooltipEvent在map上打开tooltip时触发tooltipcloseTooltipEvent关闭map上tooltip时触发

交互事件（Interaction event）

事件数据描述clickMouseEvent用户在map上单击（或者触摸）时触发。dblclickMouseEvent用户在map上双击（或者两次触摸）时触发。mousedownMouseEvent用户在map上按下鼠标按键时触发。mouseupMouseEvent用户在map上松开鼠标按键时触发。mouseoverMouseEvent鼠标进入map时触发。mouseoutMouseEvent鼠标离开map时触发。mousemoveMouseEvent鼠标经过map时触发。contextmenuMouseEvent用户在map上按下鼠标右键时触发，如果监听器在监听该事件，可以阻止浏览器显示默认情景菜单。keypressKeyboardEventmap是焦点时，用户从键盘上按下一个键时触发。preclickMouseEvent鼠标在map上单击之前触发（在已经存在的单击事件执行之前，如果您想要在鼠标单击时进行一些处理时会有用）。

动画选项（Animation Options）

事件数据描述zoomanimZoomAnimEvent缩放时每个帧都会触发。

位置事件（Location event）

事件数据描述locationerrorErrorEvent地理定位失败时触发（使用locate方法）。locationfoundLocationEvent地理定位成功时触发（使用locate方法）。