离线地图服务开发文档_离线地图开发

地图
- 用法示例
- 地图选项

地图方法

基础类

DOM操作方法

工具类

控制

基本类型

其它图层

矢量图层

UI图层

地图的其它设置
- 地图其它设置
- 地图层级

其它

用法示例示例

// 使用id为map的div容器初始化地图，同时指定地图的中心点和缩放级别
    BM.Config.HTTP_URL = '';
var map = BM.map('map','mapid', {
    center: [51.505, -0.09],
    zoom: 13
});

创建

厂	描述
`BM.map( <String> id, <String> mapid, <Map options> options?)`	给定`<div>`元素的DOM ID 以及可选的对象文字的实例化地图对象`Map options`。
`BM.map( <HTMLElement> el, <String> mapid, <Map options> options?)`	给定`<div>`HTML元素实例和可选的对象文字实例化地图对象`Map options`。

选项

配置	类型	默认	描述
`preferCanvas`	`Boolean`	`false`	是否`Path`应在渲染`Canvas`器上渲染s 。默认情况下，所有`Path`s都在`SVG`渲染器中呈现。

控制选项

配置	类型	默认	描述
`attributionControl`	`Boolean`	`true`	默认情况下是否将归因控件添加到地图中。
`zoomControl`	`Boolean`	`true`	默认情况下是否将缩放控件添加到地图中。

交互选项

配置	类型	默认	描述
`closePopupOnClick`	`Boolean`	`true`	`false`如果您不希望在用户单击地图时关闭弹出窗口，请将其设置为。
`zoomSnap`	`Number`	`1`	强制地图的缩放级别始终为此的倍数，尤其是在`fitBounds()`缩放或缩放后。默认情况下，缩放级别会捕捉到最接近的整数; 较低的值（例如`0.5`或`0.1`）允许更大的粒度。值`0` 表示缩放后的缩放级别`fitBounds`或者缩放缩放。
`zoomDelta`	`Number`	`1`	控制地图的缩放级别多少后改变 `zoomIn()`，`zoomOut()`，压制`+` 或`-`在键盘上，或者使用缩放控件。小于`1`（例如`0.5`）的值允许更大的粒度。
`trackResize`	`Boolean`	`true`	地图是否自动处理浏览器窗口调整大小以更新自身。
`boxZoom`	`Boolean`	`true`	是否可以在按住Shift键的同时通过拖动鼠标将地图缩放到指定的矩形区域。
`doubleClickZoom`	`Boolean\|String`	`true`	是否可以通过双击放大地图并通过双击同时按住缩放来缩小地图。如果通过 `'center'`，双击缩放将缩放到视图的中心，无论鼠标位于何处。
`dragging`	`Boolean`	`true`	是否可以使用鼠标/触摸拖动地图。

映射状态选项

配置	类型	默认	描述
`crs`	`CRS`	`BM.CRS.EPSG3857`	要使用的坐标参考系统。如果您不确定这意味着什么，请不要更改此项。
`center`	`LatLng`	`undefined`	地图的初始地理中心
`zoom`	`Number`	`undefined`	初始地图缩放级别
`minZoom`	`Number`	`*`	地图的最小缩放级别。如果未指定且至少有一个`GridLayer`或`TileLayer`在地图中，`minZoom`则将使用其中最低的选项。
`maxZoom`	`Number`	`*`	地图的最大缩放级别。如果未指定且至少有一个`GridLayer`或`TileLayer`在地图中，`maxZoom`则将使用其中最高的选项。
`layers`	`Layer[]`	`[]`	最初将添加到地图的图层数组
`maxBounds`	`LatLngBounds`	`null`	设置此选项后，地图会将视图限制为给定的地理边界，如果用户尝试在视图外平移，则会将用户反弹回来。要动态设置限制，请使用 `setMaxBounds`方法。
`renderer`	`Renderer`	`*`	在地图上绘制矢量图层的默认方法。`BM.SVG` 或`BM.Canvas`默认情况下取决于浏览器支持。

动画选项

配置	类型	默认	描述
`zoomAnimation`	`Boolean`	`true`	是否启用地图缩放动画。默认情况下，除了Android之外，所有支持CSS3过渡的浏览器都启用了它。
`zoomAnimationThreshold`	`Number`	`4`	如果缩放差异超过此值，则不会设置缩放动画。
`fadeAnimation`	`Boolean`	`true`	是否启用了平铺淡入淡出动画。默认情况下，除了Android之外，所有支持CSS3过渡的浏览器都启用了它。
`markerZoomAnimation`	`Boolean`	`true`	标记是否使用缩放动画为其缩放设置动画，如果禁用，它们将在动画的长度内消失。默认情况下，除了Android之外，所有支持CSS3过渡的浏览器都启用了它。
`transform3DLimit`	`Number`	`2^23`	定义CSS转换变换的最大大小。除非Web浏览器在执行大型操作后将图层放在错误的位置，否则不应更改默认值`panBy`。

平移惯性选项

配置	类型	默认	描述
`inertia`	`Boolean`	`*`	如果启用，则平移地图将具有惯性效果，其中地图在拖动时构建动量并且继续在相同方向上移动一段时间。在触摸设备上感觉特别好。除非在旧的Android设备上运行，否则默认启用。
`inertiaDeceleration`	`Number`	`3000`	惯性运动减速的速率，以像素/秒为单位。
`inertiaMaxSpeed`	`Number`	`Infinity`	惯性运动的最大速度，以像素/秒为单位。
`easeLinearity`	`Number`	`0.2`
`worldCopyJump`	`Boolean`	`false`	启用此选项后，地图会跟踪您平移到世界的另一个“副本”并无缝跳转到原始地图，以便所有叠加层（如标记和矢量图层）仍然可见。
`maxBoundsViscosity`	`Number`	`0.0`	如果`maxBounds`设置，则此选项将控制拖动地图时边界的实体程度。默认值`0.0`允许用户以正常速度拖动边界外，较高的值将减慢地图拖动外部边界，`1.0`并使边界完全固定，防止用户拖出边界外。

配置	类型	默认	描述
`keyboard`	`Boolean`	`true`	使地图可聚焦，并允许用户使用键盘箭头和`+`/ `-`键导航地图。
`keyboardPanDelta`	`Number`	`80`	按箭头键时平移的像素数量。

鼠标滚轮选项

配置	类型	默认	描述
`scrollWheelZoom`	`Boolean\|String`	`true`	是否可以使用鼠标滚轮缩放地图。如果通过`'center'`，它将缩放到视图的中心，无论鼠标在哪里。
`wheelDebounceTime`	`Number`	`40`	限制车轮可以发射的速率（以毫秒为单位）。默认情况下，用户不能每40毫秒更频繁地通过滚轮进行缩放。
`wheelPxPerZoomLevel`	`Number`	`60`	多少个滚动像素（由BM.DomEvent.getWheelDelta报告）表示更改一个完整缩放级别。较小的值将使轮缩放更快（反之亦然）。

触摸互动选项

配置	类型	默认	描述
`tap`	`Boolean`	`true`	支持移动黑客支持即时点击（在iOS / Android上修复200毫秒点击延迟）和触摸保持（触发`contextmenu`事件）。
`tapTolerance`	`Number`	`15`	用户在触摸期间可以移动手指的最大像素数，以将其视为有效的抽头。
`touchZoom`	`Boolean\|String`	`*`	是否可以通过用两个手指触摸拖动来缩放地图。如果通过`'center'`，它将缩放到视图的中心，无论触摸事件（手指）在哪里。支持具有触摸功能的Web浏览器，但旧的Androids除外。
`bounceAtZoomLimits`	`Boolean`	`true`	如果您不希望地图缩放超过最小/最大缩放，然后在缩放缩放时反弹，则将其设置为false。

活动

图层事件

事件	数据	描述
`baselayerchange`	`LayersControlEvent`	通过图层控件更改基础图层时触发。
`overlayadd`	`LayersControlEvent`	通过图层控件选择叠加层时触发。
`overlayremove`	`LayersControlEvent`	通过图层控件取消选择叠加层时触发。
`layeradd`	`LayerEvent`	将新图层添加到地图时触发。
`layerremove`	`LayerEvent`	从地图中删除某个图层时触发

映射状态更改事件

事件	数据	描述
`zoomlevelschange`	`Event`	由于添加或删除图层而改变地图上的缩放级别数时触发。
`resize`	`ResizeEvent`	调整地图大小时触发。
`unload`	`Event`	使用remove方法销毁地图时触发。
`viewreset`	`Event`	当地图需要重绘其内容时触发（这通常发生在地图缩放或加载）。对于创建自定义叠加层非常有用。
`load`	`Event`	初始化地图时（第一次设置中心和缩放时）触发。
`zoomstart`	`Event`	当地图缩放即将改变时触发（例如在缩放动画之前）。
`movestart`	`Event`	在地图视图开始更改时触发（例如，用户开始拖动地图）。
`zoom`	`Event`	在缩放级别的任何变化期间反复触发，包括缩放和飞行动画。
`move`	`Event`	在地图的任何移动过程中反复发射，包括平移和飞行动画。
`zoomend`	`Event`	在地图发生变化后，在任何动画之后触发。
`moveend`	`Event`	当地图中心停止变化时触发（例如，用户停止拖动地图）。

事件	数据	描述
`popupopen`	`PopupEvent`	在地图中打开弹出窗口时触发
`popupclose`	`PopupEvent`	关闭地图中的弹出窗口时触发
`autopanstart`	`Event`	打开弹出窗口时地图开始自动平移时触发。

事件	数据	描述
`tooltipopen`	`TooltipEvent`	在地图中打开工具提示时触发。
`tooltipclose`	`TooltipEvent`	关闭地图中的工具提示时触发。

位置活动

事件	数据	描述
`locationerror`	`ErrorEvent`	地理定位（使用该`locate`方法）失败时触发。
`locationfound`	`LocationEvent`	地理定位（使用`locate`方法）成功时触发。

互动活动

事件	数据	描述
`click`	`MouseEvent`	用户单击（或点击）地图时触发。
`dblclick`	`MouseEvent`	当用户双击（或双击）地图时触发。
`mousedown`	`MouseEvent`	当用户在地图上按下鼠标按钮时触发。
`mouseup`	`MouseEvent`	当用户在地图上释放鼠标按钮时触发。
`mouseover`	`MouseEvent`	鼠标进入地图时触发。
`mouseout`	`MouseEvent`	鼠标离开地图时触发。
`mousemove`	`MouseEvent`	鼠标在地图上移动时触发。
`contextmenu`	`MouseEvent`	当用户在地图上按下鼠标右键时触发，防止默认浏览器上下文菜单显示此事件是否有侦听器。当用户持续一次触摸（也称为长按）时，也会在手机上触发。
`keypress`	`KeyboardEvent`	当用户在聚焦地图时从键盘按下键时触发。
`preclick`	`MouseEvent`	鼠标在地图上单击之前触发（有时在任何现有点击处理程序开始运行之前需要点击某些内容时有用）。

其他方法

事件	数据	描述
`zoomanim`	`ZoomAnimEvent`	在缩放动画的每一帧上都会被触发

方法

方法	返回	描述
`getRenderer( <Path> layer)`	`Renderer`	返回`Renderer`应该用于呈现给定的实例`Path`。它将确保`renderer`地图和路径的选项得到遵守，并且渲染器确实存在于地图上。

层和控件方法

方法	返回	描述
`addControl( <Control> control)`	`this`	添加控件至地图视图
`removeControl( <Control> control)`	`this`	移除控件
`addLayer( <Layer> layer)`	`this`	添加层至地图视图
`removeLayer( <Layer> layer)`	`this`	移除层
`hasLayer( <Layer> layer)`	`Boolean`	查询是否有指定的层
`eachLayer( <Function> fn, <Object> context?)`	`this`	迭代映射的层，可选地指定迭代器函数的上下文。 `map.eachLayer(function(layer){ layer.bindPopup('Hello'); });`
`openPopup( <Popup> popup)`	`this`	关闭先前打开时打开指定的弹出窗口（以确保一次只能打开一个以获得可用性）。
`openPopup( <String\|HTMLElement> content, <LatLng> latlng, <Popup options> options?)`	`this`	创建具有指定内容和选项的弹出窗口，并在地图上的给定点中打开它。
`closePopup( <Popup> popup?)`	`this`	关闭先前使用openPopup（或给定的）打开的弹出窗口。
`openTooltip( <Tooltip> tooltip)`	`this`	打开指定的工具提示。
`openTooltip( <String\|HTMLElement> content, <LatLng> latlng, <Tooltip options> options?)`	`this`	创建具有指定内容和选项的工具提示并将其打开。
`closeTooltip( <Tooltip> tooltip?)`	`this`	关闭作为参数给出的工具提示。

地图状态修改

方法	返回	描述
`setView( <LatLng> center, <Number> zoom, <Zoom/pan options> options?)`	`this`	设置地图位置（地理位置和缩放级别））
`setZoom( <Number> zoom, <Zoom/pan options> options?)`	`this`	设置缩放级别
`zoomIn( <Number> delta?, <Zoom options> options?)`	`this`	通过`delta`（`zoomDelta`默认情况下）增加地图的缩放比例。
`zoomOut( <Number> delta?, <Zoom options> options?)`	`this`	通过`delta`（`zoomDelta`默认情况下）减小地图的缩放比例。
`setZoomAround( <LatLng> latlng, <Number> zoom, <Zoom options> options)`	`this`	缩放地图，同时使地图上的指定地理点保持静止（例如，在内部用于滚动缩放和双击缩放）。
`setZoomAround( <Point> offset, <Number> zoom, <Zoom options> options)`	`this`	放大地图，同时保持地图上的指定像素（相对于左上角）静止不动。
`fitBounds( <LatLngBounds> bounds, <fitBounds options> options?)`	`this`	限定地图可移动区域
`fitWorld( <fitBounds options> options?)`	`this`	设置一个地图视图，该视图主要包含可能具有最大缩放级别的整个世界。
`panTo( <LatLng> latlng, <Pan options> options?)`	`this`	移动地图到新的中心点
`panBy( <Point> offset, <Pan options> options?)`	`this`	按给定数量的像素（动画）平移地图。
`flyTo( <LatLng> latlng, <Number> zoom?, <Zoom/pan options> options?)`	`this`	移动至新的位置（中心和缩放）
`flyToBounds( <LatLngBounds> bounds, <fitBounds options> options?)`	`this`	平滑移动值新的位置,, `flyTo`但是接受一个类似于的边界参数`fitBounds`。
`setMaxBounds( <Bounds> bounds)`	`this`	将地图视图限制为给定边界（请参阅maxBounds选项）。
`setMinZoom( <Number> zoom)`	`this`	设置最小可用缩放级别（参照minZoom配置）
`setMaxZoom( <Number> zoom)`	`this`	设置最大可用缩放级别（参照maxZoom配置）
`panInsideBounds( <LatLngBounds> bounds, <Pan options> options?)`	`this`	将地图平移到位于给定边界内的最近视图（如果它还没有），使用特定选项（如果有）控制动画。
`invalidateSize( <Zoom/pan options> options)`	`this`	检查地图容器大小是否更改并更新地图（如果是这样） - 在动态更改地图大小后调用它，默认情况下也为动画设置动画。如果`options.pan`是`false`，则不会发生平移。如果`options.debounceMoveend`是`true`，它将延迟`moveend`事件，以便即使连续多次调用该方法也不会经常发生。
`invalidateSize( <Boolean> animate)`	`this`	检查地图容器大小是否更改并更新地图（如果是这样） - 在动态更改地图大小后调用它，默认情况下也为动画设置动画。
`stop()`	`this`	停止当前运行的动画（`panTo`和`flyTo`）

地理定位方法

方法	返回	描述
`locate( <Locate options> options?)`	`this`	尝试使用Geolocation API定位用户，触发包含`locationfound` 成功位置数据或`locationerror`失败事件的事件，并可选择将地图视图设置为用户关于检测准确性的位置（如果地理位置失败，则设置为世界视图）。请注意，如果您的网页未使用HTTPS，则此方法将在现代浏览器中失败（Chrome 50及更高版本）有关`Locate options`详细信息，请参阅。
`stopLocate()`	`this`	停止观看之前发起的位置`map.locate({watch: true})` ，如果调用了map.locate，则中止重置地图视图 `{setView: true}`。

其它方法

方法	返回	描述
`addHandler( <String> name, <Function> HandlerClass)`	`this`	`Handler`在给定其名称和构造函数的情况下，向地图添加新内容。
`remove()`	`this`	销毁地图并清楚所有相关的事件监听器。
`createPane( <String> name, <HTMLElement> container?)`	`HTMLElement`	如果已存在，则创建具有给定名称的新地图窗格，然后返回该窗格。`container`如果未设置，窗格将创建为主地图窗格的子窗口或子窗口。
`getPane( <String\|HTMLElement> pane)`	`HTMLElement`	给出其名称或其HTML元素（其标识）的地图窗格。
`getPanes()`	`Object`	返回一个普通对象，其中包含所有窗格的名称作为键，窗格作为值。
`getContainer()`	`HTMLElement`	返回包含地图的HTML元素。
`whenReady( <Function> fn, <Object> context?)`	`this`	`fn`使用视图（中心和缩放）和至少一个图层初始化地图时运行给定函数，或者如果已经初始化，则立即运行给定函数，可选地传递函数上下文。

获取地图状态方法

方法	返回	描述
`getCenter()`	`LatLng`	获取当前中心点
`getZoom()`	`Number`	获取当前缩放级别
`getBounds()`	`LatLngBounds`	获取当前视图可见边界
`getMinZoom()`	`Number`	获取当前最小缩放级别（如果在`minZoom`地图或任何图层的选项中设置），或`0`默认情况下。
`getMaxZoom()`	`Number`	获取当前最大缩放级别（如果在`maxZoom`地图或任何图层的选项中设置）。
`getBoundsZoom( <LatLngBounds> bounds, <Boolean> inside?)`	`Number`	返回给定边界完全适合地图视图的最大缩放级别。如果`inside`（可选）设置为`true`，则该方法将返回地图视图完全适合给定边界的最小缩放级别。
`getSize()`	`Point`	获取当前容器大小（px单位）
`getPixelBounds()`	`Bounds`	返回投影像素坐标中当前地图视图的边界（有时在图层和叠加层实现中很有用）。
`getPixelOrigin()`	`Point`	返回地图图层左上角点的投影像素坐标（在自定义图层和叠加层实现中很有用）。
`getPixelWorldBounds( <Number> zoom?)`	`Bounds`	返回缩放级别的像素坐标中的世界边界`zoom`。如果`zoom`省略，则使用地图的当前缩放级别。

转换方法

方法	返回	描述
`getZoomScale( <Number> toZoom, <Number> fromZoom)`	`Number`	返回要应用于从缩放级别`fromZoom`到的地图过渡的比例因子 `toZoom`。内部用于帮助缩放动画。
`getScaleZoom( <Number> scale, <Number> fromZoom)`	`Number`	返回地图最终的缩放级别，如果它处于`fromZoom` 等级并且所有内容都按比例缩放`scale`。逆的 `getZoomScale`。
`project( <LatLng> latlng, <Number> zoom)`	`Point`	项目的地理坐标`LatLng`根据地图的CRS的投影，则根据其刻度`zoom`和CRS的 `Transformation`。结果是相对于CRS原点的像素坐标。
`unproject( <Point> point, <Number> zoom)`	`LatLng`	逆的`project`。
`layerPointToLatLng( <Point> point)`	`LatLng`	给定相对于原点像素的像素坐标，返回相应的地理坐标（对于当前缩放级别）。
`latLngToLayerPoint( <LatLng> latlng)`	`Point`	给定地理坐标，返回相对于原始像素的对应像素坐标。
`wrapLatLng( <LatLng> latlng)`	`LatLng`	如果它们在CRS的边界之外，则返回一个`LatLng`where `lat`并且`lng`已根据地图的CRS `wrapLat`和`wrapLng`属性进行包装。默认情况下，这意味着经度缠绕在日期线上，因此其值介于-180和+180度之间。
`wrapLatLngBounds( <LatLngBounds> bounds)`	`LatLngBounds`	返回`LatLngBounds`与给定大小相同的大小，确保其中心位于CRS的边界内。默认情况下，这意味着中心经度围绕日期线缠绕，因此其值介于-180和+180度之间，并且大多数边界与CRS的边界重叠。
`distance( <LatLng> latlng1, <LatLng> latlng2)`	`Number`	根据地图的CRS返回两个地理坐标之间的距离。默认情况下，它以米为单位测量距离
`containerPointToLayerPoint( <Point> point)`	`Point`	给定相对于地图容器的像素坐标，返回相对于原始像素的对应像素坐标。
`layerPointToContainerPoint( <Point> point)`	`Point`	给定相对于原始像素的像素坐标，返回相对于地图容器的对应像素坐标。
`containerPointToLatLng( <Point> point)`	`LatLng`	给定相对于地图容器的像素坐标，返回相应的地理坐标（对于当前缩放级别）。
`latLngToContainerPoint( <LatLng> latlng)`	`Point`	给定地理坐标，返回相对于地图容器的对应像素坐标。
`mouseEventToContainerPoint( <MouseEvent> ev)`	`Point`	给定MouseEvent对象，返回相对于发生事件的地图容器的像素坐标。
`mouseEventToLayerPoint( <MouseEvent> ev)`	`Point`	给定MouseEvent对象，返回相对于发生事件的原点像素的像素坐标。
`mouseEventToLatLng( <MouseEvent> ev)`	`LatLng`	给定MouseEvent对象，返回事件发生的地理坐标。

▶从Evented继承的方法

方法	返回	描述
`on( <String> type, <Function> fn, <Object> context?)`	`this`	将侦听器函数（`fn`）添加到对象的特定事件类型。您可以选择指定侦听器的上下文（this关键字指向的对象）。您还可以传递多个以空格分隔的类型（例如`'click dblclick'`）。
`on( <Object> eventMap)`	`this`	添加一组类型/侦听器对，例如 `{click: onClick, mousemove: onMouseMove}`
`off( <String> type, <Function> fn?, <Object> context?)`	`this`	删除以前添加的侦听器功能。如果未指定任何函数，它将从对象中删除该特定事件的所有侦听器。请注意，如果您将自定义上下文传递给`on`，则必须传递相同的上下文`off`才能删除侦听器。
`off( <Object> eventMap)`	`this`	删除一组类型/侦听器对。
`off()`	`this`	删除对象上所有事件的所有侦听器。
`fire( <String> type, <Object> data?, <Boolean> propagate?)`	`this`	触发指定类型的事件。您可以选择提供数据对象 - 侦听器函数的第一个参数将包含其属性。该事件可以选择性地传播给事件父母。
`listens( <String> type)`	`Boolean`	返回`true`如果一个特定的事件类型有附带任何听众。
`once(…)`	`this`	表现为`on(…)`，除了监听器只会被触发一次然后被删除。
`addEventParent( <Evented> obj)`	`this`	添加事件父级 - `Evented`将接收传播事件的事件
`removeEventParent( <Evented> obj)`	`this`	删除事件父级，因此它将停止接收传播的事件
`addEventListener(…)`	`this`	别名来 `on(…)`
`removeEventListener(…)`	`this`	别名来 `off(…)`
`clearAllEventListeners(…)`	`this`	别名来 `off()`
`addOneTimeEventListener(…)`	`this`	别名来 `once(…)`
`fireEvent(…)`	`this`	别名来 `fire(…)`
`hasEventListeners(…)`	`Boolean`	别名来 `listens(…)`

属性

处理程序

属性	类型	描述
`boxZoom`	`Handler`	框（用鼠标移动拖动）缩放处理程序。
`doubleClickZoom`	`Handler`	双击缩放处理程序。
`dragging`	`Handler`	映射拖动处理程序（通过鼠标和触摸）。
`keyboard`	`Handler`	键盘导航处理程序
`scrollWheelZoom`	`Handler`	滚轮变焦处理程序。
`tap`	`Handler`	移动触摸黑客（快速点击和触摸保持）处理程序。
`touchZoom`	`Handler`	触摸变焦处理程序

地图窗格

窗格是用于控制地图上图层排序的DOM元素。您可以使用map.getPane或 map.getPanes方法访问窗格。可以使用该map.createPane方法创建新窗格。每个地图都有以下默认窗格，这些窗格仅在zIndex中有所不同。

窗格	类型	Z-指数	描述
`mapPane`	`HTMLElement`	`'auto'`	包含所有其他地图窗格的窗格
`tilePane`	`HTMLElement`	`200`	适用于`GridLayer`s和`TileLayer`s的窗格
`overlayPane`	`HTMLElement`	`400`	矢量窗格（`Path`s，`Polyline`s和`Polygon`s），`ImageOverlay`s和`VideoOverlay`s
`shadowPane`	`HTMLElement`	`500`	叠加阴影的窗格（例如`Marker`阴影）
`markerPane`	`HTMLElement`	`600`	窗格`Icon`第`Marker`小号
`tooltipPane`	`HTMLElement`	`650`	Pane for `Tooltip`s。
`popupPane`	`HTMLElement`	`700`	Pane for `Popup`s。

找到选项

一些地理位置方法Map在取options参数。这是一个普通的javascript对象，包含以下可选组件：

配置	类型	默认	描述
`watch`	`Boolean`	`false`	如果`true`，使用W3C `watchPosition`方法开始连续观察位置变化（而不是检测一次）。您可以稍后停止使用`map.stopLocate()`方法观看。
`setView`	`Boolean`	`false`	如果`true`，根据检测准确性自动将地图视图设置为用户位置，或者如果地理位置失败则自动将地图视图设置为世界视图。
`maxZoom`	`Number`	`Infinity`	使用`setView`选项时自动视图设置的最大缩放。
`timeout`	`Number`	`10000`	在触发`locationerror`事件之前等待地理定位响应的毫秒数。
`maximumAge`	`Number`	`0`	检测到的位置的最大年龄。如果小于自上次地理位置响应以来经过的毫秒数，`locate`则将返回缓存位置。
`enableHighAccuracy`	`Boolean`	`false`	实现高精度，请参阅W3C规范中的说明。

缩放选项

Map修改缩放级别的一些方法采用options 参数。这是一个普通的javascript对象，包含以下可选组件：

配置	类型	默认	描述
`animate`	`Boolean`		如果未指定，如果缩放原点位于当前视图内，则会发生缩放动画。如果`true`，地图将尝试动画缩放，而忽略缩放原点的位置。设置`false`将使其始终在没有动画的情况下完全重置视图。

平移选项

Map修改地图中心的一些方法采用options 参数。这是一个普通的javascript对象，包含以下可选组件：

配置	类型	默认	描述
`animate`	`Boolean`		如果`true`，如果可能的话，平移将始终是动画。如果`false`，它不会动画平移，如果平移超过屏幕，则重置地图视图，或者仅为地图窗格设置新的偏移（除了`panBy` 后者总是如此）。
`duration`	`Number`	`0.25`	动画平移的持续时间，以秒为单位。
`easeLinearity`	`Number`	`0.25`	平移动画缓动的曲率因子（Cubic Bezier曲线的第三个参数）。1.0表示线性动画，数字越小，曲线越弯曲。
`noMoveStart`	`Boolean`	`false`	如果`true`，平移不会`movestart`在启动时触发事件（内部用于平移惯性）。

缩放/平移选项

▶从缩放选项继承的选项

配置	类型	默认	描述
`animate`	`Boolean`		如果未指定，如果缩放原点位于当前视图内，则会发生缩放动画。如果`true`，地图将尝试动画缩放，而忽略缩放原点的位置。设置`false`将使其始终在没有动画的情况下完全重置视图。

▶从Pan选项继承的选项

配置	类型	默认	描述
`duration`	`Number`	`0.25`	动画平移的持续时间，以秒为单位。
`easeLinearity`	`Number`	`0.25`	平移动画缓动的曲率因子（Cubic Bezier曲线的第三个参数）。1.0表示线性动画，数字越小，曲线越弯曲。
`noMoveStart`	`Boolean`	`false`	如果`true`，平移不会`movestart`在启动时触发事件（内部用于平移惯性）。

FitBounds选项

配置	类型	默认	描述
`paddingTopLeft`	`Point`	`[0, 0]`	设置在将视图设置为适合边界时不应考虑的地图容器左上角的填充量。如果您在地图上有一些控件叠加层（如侧边栏）并且您不希望它们遮挡您要缩放的对象，则非常有用。
`paddingBottomRight`	`Point`	`[0, 0]`	地图右下角也是如此。
`padding`	`Point`	`[0, 0]`	相当于将左上角和右下角填充设置为相同的值。
`maxZoom`	`Number`	`null`	要使用的最大缩放比例。

▶从缩放选项继承的选项

配置	类型	默认	描述
`animate`	`Boolean`		如果未指定，如果缩放原点位于当前视图内，则会发生缩放动画。如果`true`，地图将尝试动画缩放，而忽略缩放原点的位置。设置`false`将使其始终在没有动画的情况下完全重置视图。

▶从Pan选项继承的选项

配置	类型	默认	描述
`duration`	`Number`	`0.25`	动画平移的持续时间，以秒为单位。
`easeLinearity`	`Number`	`0.25`	平移动画缓动的曲率因子（Cubic Bezier曲线的第三个参数）。1.0表示线性动画，数字越小，曲线越弯曲。
`noMoveStart`	`Boolean`	`false`	如果`true`，平移不会`movestart`在启动时触发事件（内部用于平移惯性）。

标记

BM.Marker用于在地图上显示可点击/可拖动的图标。延伸Layer。

用法示例

BM.marker([50.5, 30.5]).addTo(map);

创建

厂	描述
`BM.marker( <LatLng> latlng, <Marker options> options?)`	给定地理点和可选的选项对象实例化Marker对象。

选项

配置	类型	默认	描述
`icon`	`Icon`	`*`	用于渲染标记的图标实例。有关如何自定义标记图标的详细信息，请参阅图标文档。如果未指定，`BM.Icon.Default`则使用公共实例。
`draggable`	`Boolean`	`false`	标记是否可以通过鼠标/触摸进行拖动。
`autoPan`	`Boolean`	`false`	`true`如果您希望地图在标记到达边缘时执行平移动画，请将其设置为。
`autoPanPadding`	`Point`	`Point(50, 50)`	相当于将左上角和右下角的autopan填充设置为相同的值。
`autoPanSpeed`	`Number`	`10`	地图应移动的像素数。
`keyboard`	`Boolean`	`true`	是否可以使用键盘选中标记，然后按Enter键单击。
`title`	`String`	`''`	标记悬停时显示的浏览器工具提示的文本（默认情况下不是工具提示）。
`alt`	`String`	`''`	`alt`图标图像属性的文本（对辅助功能非常有用）。
`zIndexOffset`	`Number`	`0`	默认情况下，标记图像zIndex会根据其纬度自动设置。如果要将标记放在所有其他标记（或下方）之上，请指定高值`1000`（或分别为高负值），请使用此选项。
`opacity`	`Number`	`1.0`	标记的不透明度。
`riseOnHover`	`Boolean`	`false`	如果`true`，当您将鼠标悬停在其上时，标记将会显示在其他标记之上。
`riseOffset`	`Number`	`250`	用于该`riseOnHover`功能的z-index偏移量。
`pane`	`String`	`'markerPane'`	`Map pane` 将添加标记图标的位置。
`bubblingMouseEvents`	`Boolean`	`false`	何时`true`，此标记上的鼠标事件将在地图上触发相同的事件（除非`BM.DomEvent.stopPropagation`使用）。

▶从交互层继承的选项

配置	类型	默认	描述
`interactive`	`Boolean`	`true`	如果`false`，图层不会发出鼠标事件，并将作为底层地图的一部分。

▶继承自Layer的选项

配置	类型	默认	描述
`attribution`	`String`	`null`	要在归属控件中显示的字符串，描述图层数据，例如“©Mapbox”。

活动

除了共享层的方法等addTo()，并remove()与弹出方法等bindPopup（）也可以使用以下方法：

事件	数据	描述
`move`	`Event`	`setLatLng`通过拖动移动标记时触发。新旧坐标包含在事件参数中`oldLatLng`，如`latlng`。

拖动事件

事件	数据	描述
`dragstart`	`Event`	用户开始拖动标记时触发。
`movestart`	`Event`	标记开始移动时触发（因为拖动）。
`drag`	`Event`	用户拖动标记时反复触发。
`dragend`	`DragEndEvent`	用户停止拖动标记时触发。
`moveend`	`Event`	当标记停止移动（因拖动）时触发。

▶从交互层继承的鼠标事件

事件	数据	描述
`click`	`MouseEvent`	用户单击（或点击）图层时触发。
`dblclick`	`MouseEvent`	当用户双击（或双击）图层时触发。
`mousedown`	`MouseEvent`	当用户在图层上按下鼠标按钮时触发。
`mouseup`	`MouseEvent`	当用户释放在图层上按下的鼠标按钮时触发。
`mouseover`	`MouseEvent`	鼠标进入图层时触发。
`mouseout`	`MouseEvent`	当鼠标离开图层时触发。
`contextmenu`	`MouseEvent`	当用户右键单击图层时触发，防止默认浏览器上下文菜单显示此事件是否有侦听器。当用户持续一次触摸（也称为长按）时，也会在手机上触发。

▶从Layer继承的事件

事件	数据	描述
`add`	`Event`	将图层添加到地图后触发
`remove`	`Event`	从地图中删除图层后触发

▶从Layer继承的弹出事件

事件	数据	描述
`popupopen`	`PopupEvent`	打开绑定到此图层的弹出窗口时触发
`popupclose`	`PopupEvent`	绑定到此图层的弹出窗口关闭时触发

▶从Layer继承的工具提示事件

事件	数据	描述
`tooltipopen`	`TooltipEvent`	打开绑定到此图层的工具提示时触发。
`tooltipclose`	`TooltipEvent`	绑定到此图层的工具提示关闭时触发。

方法

方法	返回	描述
`toGeoJSON()`	`Object`	返回一个 `GeoJSON`标记的表示（作为GeoJSON `Point`特征）。
`getLatLng()`	`LatLng`	返回标记的当前地理位置。
`setLatLng( <LatLng> latlng)`	`this`	将标记位置更改为给定点。
`setZIndexOffset( <Number> offset)`	`this`	更改标记的zIndex偏移量。
`setIcon( <Icon> icon)`	`this`	更改标记图标。
`setOpacity( <Number> opacity)`	`this`	更改标记的不透明度。

▶从Layer继承的方法

方法	返回	描述
`addTo( <Map\|LayerGroup> map)`	`this`	将图层添加到给定的地图或图层组。
`remove()`	`this`	从当前处于活动状态的地图中删除图层。
`removeFrom( <Map> map)`	`this`	从给定的地图中删除图层
`getPane( <String> name?)`	`HTMLElement`	返回`HTMLElement`表示地图上命名窗格的内容。如果`name`省略，则返回此图层的窗格。
`getAttribution()`	`String`	由the使用`attribution control`，返回归属选项。

▶从Layer继承的Popup方法

方法	返回	描述
`bindPopup( <String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	使用传递`content`将弹出窗口绑定到图层，并设置必要的事件侦听器。如果a `Function`被传递，它将接收图层作为第一个参数，并应返回一个`String`或`HTMLElement`。
`unbindPopup()`	`this`	删除以前绑定的弹出窗口`bindPopup`。
`openPopup( <LatLng> latlng?)`	`this`	`latlng`如果未`latlng`传递，则在指定或默认弹出锚点处打开绑定弹出窗口。
`closePopup()`	`this`	如果已打开，则关闭绑定到此图层的弹出窗口。
`togglePopup()`	`this`	打开或关闭绑定到此图层的弹出窗口，具体取决于其当前状态。
`isPopupOpen()`	`boolean`	返回`true`如果绑定到该层的弹出当前处于打开状态。
`setPopupContent( <String\|HTMLElement\|Popup> content)`	`this`	设置绑定到此图层的弹出窗口的内容。
`getPopup()`	`Popup`	返回绑定到此图层的弹出窗口。

▶继承自Layer的工具提示方法

方法	返回	描述
`bindTooltip( <String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	使用传递`content`将工具提示绑定到图层并设置必要的事件侦听器。如果a `Function`被传递，它将接收图层作为第一个参数，并应返回一个`String`或`HTMLElement`。
`unbindTooltip()`	`this`	删除以前绑定的工具提示`bindTooltip`。
`openTooltip( <LatLng> latlng?)`	`this`	`latlng`如果未`latlng`传递，则在指定或默认工具提示锚点处打开绑定工具提示。
`closeTooltip()`	`this`	如果已打开，则关闭绑定到此图层的工具提示。
`toggleTooltip()`	`this`	打开或关闭绑定到此图层的工具提示，具体取决于其当前状态。
`isTooltipOpen()`	`boolean`	返回`true`绑定到此图层的工具提示当前是否打开。
`setTooltipContent( <String\|HTMLElement\|Tooltip> content)`	`this`	设置绑定到此图层的工具提示的内容。
`getTooltip()`	`Tooltip`	返回绑定到此图层的工具提示。

▶从Evented继承的方法

方法	返回	描述
`on( <String> type, <Function> fn, <Object> context?)`	`this`	将侦听器函数（`fn`）添加到对象的特定事件类型。您可以选择指定侦听器的上下文（this关键字指向的对象）。您还可以传递多个以空格分隔的类型（例如`'click dblclick'`）。
`on( <Object> eventMap)`	`this`	添加一组类型/侦听器对，例如 `{click: onClick, mousemove: onMouseMove}`
`off( <String> type, <Function> fn?, <Object> context?)`	`this`	删除以前添加的侦听器功能。如果未指定任何函数，它将从对象中删除该特定事件的所有侦听器。请注意，如果您将自定义上下文传递给`on`，则必须传递相同的上下文`off`才能删除侦听器。
`off( <Object> eventMap)`	`this`	删除一组类型/侦听器对。
`off()`	`this`	删除对象上所有事件的所有侦听器。
`fire( <String> type, <Object> data?, <Boolean> propagate?)`	`this`	触发指定类型的事件。您可以选择提供数据对象 - 侦听器函数的第一个参数将包含其属性。该事件可以选择性地传播给事件父母。
`listens( <String> type)`	`Boolean`	返回`true`如果一个特定的事件类型有附带任何听众。
`once(…)`	`this`	表现为`on(…)`，除了监听器只会被触发一次然后被删除。
`addEventParent( <Evented> obj)`	`this`	添加事件父级 - `Evented`将接收传播事件的事件
`removeEventParent( <Evented> obj)`	`this`	删除事件父级，因此它将停止接收传播的事件
`addEventListener(…)`	`this`	别名来 `on(…)`
`removeEventListener(…)`	`this`	别名来 `off(…)`
`clearAllEventListeners(…)`	`this`	别名来 `off()`
`addOneTimeEventListener(…)`	`this`	别名来 `once(…)`
`fireEvent(…)`	`this`	别名来 `fire(…)`
`hasEventListeners(…)`	`Boolean`	别名来 `listens(…)`

属性

交互处理程序

交互处理程序是标记实例的属性，允许您在运行时控制交互行为，启用或禁用某些功能，如拖动（请参阅Handler方法）。例：

marker.dragging.disable();

属性	类型	描述
`dragging`	`Handler`	标记拖动处理程序（通过鼠标和触摸）。仅在标记位于地图上时有效（否则设置`marker.options.draggable`）。

用于在地图的某些位置打开弹出窗口。使用Map.openPopup打开弹出窗口，同时确保一次只打开一个弹出窗口（建议用于可用性），或使用Map.addLayer打开任意数量的弹出窗口。

如果你想将弹出窗口绑定到标记点击然后打开它，那很简单：

marker.bindPopup(popupContent).openPopup();

折线之类的路径叠加也有一个bindPopup方法。这是在地图上打开弹出窗口的更复杂方法：

var popup = BM.popup()
    .setLatLng(latlng)
    .setContent('<p>Hello world!<br />This is a nice popup.</p>')
    .openOn(map);

厂	描述
`BM.popup( <Popup options> options?, <Layer> source?)`	实例化一个`Popup`给定可选`options`对象的对象，该对象描述其外观和位置，以及一个可选`source`对象，用于标记弹出窗口，引用其引用的图层。

配置	类型	默认	描述
`maxWidth`	`Number`	`300`	弹出窗口的最大宽度（以像素为单位）。
`minWidth`	`Number`	`50`	弹出窗口的最小宽度（以像素为单位）。
`maxHeight`	`Number`	`null`	如果设置，如果其内容超过它，则在弹出窗口内创建一个具有给定高度的可滚动容器。
`autoPan`	`Boolean`	`true`	`false`如果您不希望地图执行平移动画以适合打开的弹出窗口，请将其设置为。
`autoPanPaddingTopLeft`	`Point`	`null`	执行autopanning后，弹出窗口和地图视图左上角之间的边距。
`autoPanPaddingBottomRight`	`Point`	`null`	执行自动平次后，地图视图的弹出窗口和右下角之间的边距。
`autoPanPadding`	`Point`	`Point(5, 5)`	相当于将左上角和右下角的autopan填充设置为相同的值。
`keepInView`	`Boolean`	`false`	将它设置为`true`如果要防止用户平移弹出关闭屏幕，而它是开放的。
`closeButton`	`Boolean`	`true`	控制弹出窗口中是否存在关闭按钮。
`autoClose`	`Boolean`	`true`	将它设置为`false`，如果你想另一个弹出打开时覆盖弹出关闭的默认行为。
`closeOnEscapeKey`	`Boolean`	`true`	将它设置为`false`，如果要覆盖ESC键的默认行为的弹出窗口的关闭。
`closeOnClick`	`Boolean`	`*`	如果要在用户单击地图时覆盖弹出窗口关闭的默认行为，请设置它。默认为地图的`closePopupOnClick`选项。
`className`	`String`	`''`	要分配给弹出窗口的自定义CSS类名称。

▶继承自DivOverlay的选项

配置	类型	默认	描述
`offset`	`Point`	`Point(0, 7)`	弹出位置的偏移量。用于在某些叠加层上打开弹出窗口时控制弹出窗口的锚点。
`pane`	`String`	`'popupPane'`	`Map pane` 弹出窗口将被添加的位置。

▶继承自Layer的选项

配置	类型	默认	描述
`attribution`	`String`	`null`	要在归属控件中显示的字符串，描述图层数据，例如“©Mapbox”。

活动

▶从Layer继承的事件

事件	数据	描述
`add`	`Event`	将图层添加到地图后触发
`remove`	`Event`	从地图中删除图层后触发

▶从Layer继承的弹出事件

事件	数据	描述
`popupopen`	`PopupEvent`	打开绑定到此图层的弹出窗口时触发
`popupclose`	`PopupEvent`	绑定到此图层的弹出窗口关闭时触发

▶从Layer继承的工具提示事件

事件	数据	描述
`tooltipopen`	`TooltipEvent`	打开绑定到此图层的工具提示时触发。
`tooltipclose`	`TooltipEvent`	绑定到此图层的工具提示关闭时触发。

方法	返回	描述
`getLatLng()`	`LatLng`	返回弹出窗口的地理位置。
`setLatLng( <LatLng> latlng)`	`this`	设置弹出窗口打开的地理位置。
`getContent()`	`String\|HTMLElement`	返回弹出窗口的内容。
`setContent( <String\|HTMLElement\|Function> htmlContent)`	`this`	设置弹出窗口的HTML内容。如果传递函数，源图层将传递给函数。该函数应该返回一个`String`或`HTMLElement`在弹出窗口中使用。
`getElement()`	`String\|HTMLElement`	getContent（）的别名
`update()`	`null`	更新弹出内容，布局和位置。用于更改内部更改后的弹出窗口，例如图像加载。
`isOpen()`	`Boolean`	`true`弹出窗口在地图上可见时返回。
`bringToFront()`	`this`	将此弹出窗口置于其他弹出窗口之前（在同一个地图窗格中）。
`bringToBack()`	`this`	将此弹出窗口置于其他弹出窗口的后面（在同一个地图窗格中）。
`openOn( <Map> map)`	`this`	将弹出窗口添加到地图并关闭上一个。同样的`map.openPopup(popup)`。

▶从Layer继承的方法

方法	返回	描述
`addTo( <Map\|LayerGroup> map)`	`this`	将图层添加到给定的地图或图层组。
`remove()`	`this`	从当前处于活动状态的地图中删除图层。
`removeFrom( <Map> map)`	`this`	从给定的地图中删除图层
`getPane( <String> name?)`	`HTMLElement`	返回`HTMLElement`表示地图上命名窗格的内容。如果`name`省略，则返回此图层的窗格。
`getAttribution()`	`String`	由the使用`attribution control`，返回归属选项。

▶从Layer继承的Popup方法

方法	返回	描述
`bindPopup( <String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	使用传递`content`将弹出窗口绑定到图层，并设置必要的事件侦听器。如果a `Function`被传递，它将接收图层作为第一个参数，并应返回一个`String`或`HTMLElement`。
`unbindPopup()`	`this`	删除以前绑定的弹出窗口`bindPopup`。
`openPopup( <LatLng> latlng?)`	`this`	`latlng`如果未`latlng`传递，则在指定或默认弹出锚点处打开绑定弹出窗口。
`closePopup()`	`this`	如果已打开，则关闭绑定到此图层的弹出窗口。
`togglePopup()`	`this`	打开或关闭绑定到此图层的弹出窗口，具体取决于其当前状态。
`isPopupOpen()`	`boolean`	返回`true`如果绑定到该层的弹出当前处于打开状态。
`setPopupContent( <String\|HTMLElement\|Popup> content)`	`this`	设置绑定到此图层的弹出窗口的内容。
`getPopup()`	`Popup`	返回绑定到此图层的弹出窗口。

▶继承自Layer的工具提示方法

方法	返回	描述
`bindTooltip( <String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	使用传递`content`将工具提示绑定到图层并设置必要的事件侦听器。如果a `Function`被传递，它将接收图层作为第一个参数，并应返回一个`String`或`HTMLElement`。
`unbindTooltip()`	`this`	删除以前绑定的工具提示`bindTooltip`。
`openTooltip( <LatLng> latlng?)`	`this`	`latlng`如果未`latlng`传递，则在指定或默认工具提示锚点处打开绑定工具提示。
`closeTooltip()`	`this`	如果已打开，则关闭绑定到此图层的工具提示。
`toggleTooltip()`	`this`	打开或关闭绑定到此图层的工具提示，具体取决于其当前状态。
`isTooltipOpen()`	`boolean`	返回`true`绑定到此图层的工具提示当前是否打开。
`setTooltipContent( <String\|HTMLElement\|Tooltip> content)`	`this`	设置绑定到此图层的工具提示的内容。
`getTooltip()`	`Tooltip`	返回绑定到此图层的工具提示。

▶从Evented继承的方法

方法	返回	描述
`on( <String> type, <Function> fn, <Object> context?)`	`this`	将侦听器函数（`fn`）添加到对象的特定事件类型。您可以选择指定侦听器的上下文（this关键字指向的对象）。您还可以传递多个以空格分隔的类型（例如`'click dblclick'`）。
`on( <Object> eventMap)`	`this`	添加一组类型/侦听器对，例如 `{click: onClick, mousemove: onMouseMove}`
`off( <String> type, <Function> fn?, <Object> context?)`	`this`	删除以前添加的侦听器功能。如果未指定任何函数，它将从对象中删除该特定事件的所有侦听器。请注意，如果您将自定义上下文传递给`on`，则必须传递相同的上下文`off`才能删除侦听器。
`off( <Object> eventMap)`	`this`	删除一组类型/侦听器对。
`off()`	`this`	删除对象上所有事件的所有侦听器。
`fire( <String> type, <Object> data?, <Boolean> propagate?)`	`this`	触发指定类型的事件。您可以选择提供数据对象 - 侦听器函数的第一个参数将包含其属性。该事件可以选择性地传播给事件父母。
`listens( <String> type)`	`Boolean`	返回`true`如果一个特定的事件类型有附带任何听众。
`once(…)`	`this`	表现为`on(…)`，除了监听器只会被触发一次然后被删除。
`addEventParent( <Evented> obj)`	`this`	添加事件父级 - `Evented`将接收传播事件的事件
`removeEventParent( <Evented> obj)`	`this`	删除事件父级，因此它将停止接收传播的事件
`addEventListener(…)`	`this`	别名来 `on(…)`
`removeEventListener(…)`	`this`	别名来 `off(…)`
`clearAllEventListeners(…)`	`this`	别名来 `off()`
`addOneTimeEventListener(…)`	`this`	别名来 `once(…)`
`fireEvent(…)`	`this`	别名来 `fire(…)`
`hasEventListeners(…)`	`Boolean`	别名来 `listens(…)`

用于在地图图层上显示小文本。

marker.bindTooltip("my tooltip text").openTooltip();

关于工具提示偏移的注意事项。

该offset工具提示选项：它默认为[0,0]，这是特定于一个工具提示。添加正x偏移以将工具提示向右移动，并使用正y偏移将其移动到底部。负数将移至左侧和顶部。
该tooltipAnchor图标选项：这只会被视为标记。如果使用自定义图标，则应调整此值。

厂	描述
`BM.tooltip( <Tooltip options> options?, <Layer> source?)`	实例化一个Tooltip对象，给定一个`options`描述其外观和位置的可选`source`对象，以及一个可选对象，用于标记工具提示，并引用它引用的Layer。

配置	类型	默认	描述
`pane`	`String`	`'tooltipPane'`	`Map pane` 将添加工具提示的位置。
`offset`	`Point`	`Point(0, 0)`	工具提示位置的可选偏移量。
`direction`	`String`	`'auto'`	方向在哪里打开工具提示。可能的值有：`right`，`left`， `top`，`bottom`，`center`，`auto`。 `auto`将之间进行动态切换`right`和`left`根据地图上的工具提示位置。
`permanent`	`Boolean`	`false`	是永久打开工具提示还是仅在鼠标悬停时打开工具提示。
`sticky`	`Boolean`	`false`	如果为true，则工具提示将跟随鼠标而不是固定在要素中心。
`interactive`	`Boolean`	`false`	如果为true，则工具提示将侦听要素事件。
`opacity`	`Number`	`0.9`	工具提示容器不透明度。

▶继承自DivOverlay的选项

配置	类型	默认	描述
`className`	`String`	`''`	要分配给弹出窗口的自定义CSS类名称。

▶继承自Layer的选项

配置	类型	默认	描述
`attribution`	`String`	`null`	要在归属控件中显示的字符串，描述图层数据，例如“©Mapbox”。

活动

▶从Layer继承的事件

事件	数据	描述
`add`	`Event`	将图层添加到地图后触发
`remove`	`Event`	从地图中删除图层后触发

▶从Layer继承的弹出事件

事件	数据	描述
`popupopen`	`PopupEvent`	打开绑定到此图层的弹出窗口时触发
`popupclose`	`PopupEvent`	绑定到此图层的弹出窗口关闭时触发

▶从Layer继承的工具提示事件

事件	数据	描述
`tooltipopen`	`TooltipEvent`	打开绑定到此图层的工具提示时触发。
`tooltipclose`	`TooltipEvent`	绑定到此图层的工具提示关闭时触发。

方法

▶从Layer继承的方法

方法	返回	描述
`addTo( <Map\|LayerGroup> map)`	`this`	将图层添加到给定的地图或图层组。
`remove()`	`this`	从当前处于活动状态的地图中删除图层。
`removeFrom( <Map> map)`	`this`	从给定的地图中删除图层
`getPane( <String> name?)`	`HTMLElement`	返回`HTMLElement`表示地图上命名窗格的内容。如果`name`省略，则返回此图层的窗格。
`getAttribution()`	`String`	由the使用`attribution control`，返回归属选项。

▶从Layer继承的Popup方法

方法	返回	描述
`bindPopup( <String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	使用传递`content`将弹出窗口绑定到图层，并设置必要的事件侦听器。如果a `Function`被传递，它将接收图层作为第一个参数，并应返回一个`String`或`HTMLElement`。
`unbindPopup()`	`this`	删除以前绑定的弹出窗口`bindPopup`。
`openPopup( <LatLng> latlng?)`	`this`	`latlng`如果未`latlng`传递，则在指定或默认弹出锚点处打开绑定弹出窗口。
`closePopup()`	`this`	如果已打开，则关闭绑定到此图层的弹出窗口。
`togglePopup()`	`this`	打开或关闭绑定到此图层的弹出窗口，具体取决于其当前状态。
`isPopupOpen()`	`boolean`	返回`true`如果绑定到该层的弹出当前处于打开状态。
`setPopupContent( <String\|HTMLElement\|Popup> content)`	`this`	设置绑定到此图层的弹出窗口的内容。
`getPopup()`	`Popup`	返回绑定到此图层的弹出窗口。

▶继承自Layer的工具提示方法

方法	返回	描述
`bindTooltip( <String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	使用传递`content`将工具提示绑定到图层并设置必要的事件侦听器。如果a `Function`被传递，它将接收图层作为第一个参数，并应返回一个`String`或`HTMLElement`。
`unbindTooltip()`	`this`	删除以前绑定的工具提示`bindTooltip`。
`openTooltip( <LatLng> latlng?)`	`this`	`latlng`如果未`latlng`传递，则在指定或默认工具提示锚点处打开绑定工具提示。
`closeTooltip()`	`this`	如果已打开，则关闭绑定到此图层的工具提示。
`toggleTooltip()`	`this`	打开或关闭绑定到此图层的工具提示，具体取决于其当前状态。
`isTooltipOpen()`	`boolean`	返回`true`绑定到此图层的工具提示当前是否打开。
`setTooltipContent( <String\|HTMLElement\|Tooltip> content)`	`this`	设置绑定到此图层的工具提示的内容。
`getTooltip()`	`Tooltip`	返回绑定到此图层的工具提示。

▶从Evented继承的方法

方法	返回	描述
`on( <String> type, <Function> fn, <Object> context?)`	`this`	将侦听器函数（`fn`）添加到对象的特定事件类型。您可以选择指定侦听器的上下文（this关键字指向的对象）。您还可以传递多个以空格分隔的类型（例如`'click dblclick'`）。
`on( <Object> eventMap)`	`this`	添加一组类型/侦听器对，例如 `{click: onClick, mousemove: onMouseMove}`
`off( <String> type, <Function> fn?, <Object> context?)`	`this`	删除以前添加的侦听器功能。如果未指定任何函数，它将从对象中删除该特定事件的所有侦听器。请注意，如果您将自定义上下文传递给`on`，则必须传递相同的上下文`off`才能删除侦听器。
`off( <Object> eventMap)`	`this`	删除一组类型/侦听器对。
`off()`	`this`	删除对象上所有事件的所有侦听器。
`fire( <String> type, <Object> data?, <Boolean> propagate?)`	`this`	触发指定类型的事件。您可以选择提供数据对象 - 侦听器函数的第一个参数将包含其属性。该事件可以选择性地传播给事件父母。
`listens( <String> type)`	`Boolean`	返回`true`如果一个特定的事件类型有附带任何听众。
`once(…)`	`this`	表现为`on(…)`，除了监听器只会被触发一次然后被删除。
`addEventParent( <Evented> obj)`	`this`	添加事件父级 - `Evented`将接收传播事件的事件
`removeEventParent( <Evented> obj)`	`this`	删除事件父级，因此它将停止接收传播的事件
`addEventListener(…)`	`this`	别名来 `on(…)`
`removeEventListener(…)`	`this`	别名来 `off(…)`
`clearAllEventListeners(…)`	`this`	别名来 `off()`
`addOneTimeEventListener(…)`	`this`	别名来 `once(…)`
`fireEvent(…)`	`this`	别名来 `fire(…)`
`hasEventListeners(…)`	`Boolean`	别名来 `listens(…)`

TileLayer

用于在地图上加载和显示切片图层。延伸GridLayer。

用法示例

BM.tileLayer('http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png?{foo}', {foo: 'bar'}).addTo(map);

网址模板

以下形式的字符串：

'http://{s}.somedomain.com/blabla/{z}/{x}/{y}{r}.png'

{s}装置可用的子域中的一个（顺序地用于帮助每个域限制浏览器并行请求;子域值在选项中指定; a，b或c通过默认，可省略），{z}-缩放级别，{x}以及{y}-瓷砖坐标。{r}可用于将“@ 2x”添加到URL以加载视网膜图块。您可以在模板中使用自定义键，这些键将从TileLayer选项中进行评估，如下所示：

BM.tileLayer('http://{s}.somedomain.com/{foo}/{z}/{x}/{y}.png', {foo: 'bar'});

创建

扩展方法

厂	描述
`BM.tilelayer( <String> urlTemplate, <TileLayer options> options?)`	在给定a `URL template`和可选的options对象的情况下实例化tile图层对象。

选项

配置	类型	默认	描述
`minZoom`	`Number`	`0`	显示此图层的最小缩放级别（包括）。
`maxZoom`	`Number`	`18`	此图层将显示的最大缩放级别（包括）。
`subdomains`	`String\|String[]`	`'abc'`	磁贴服务的子域。可以以一个字符串（每个字母是子域名）或字符串数组的形式传递。
`errorTileUrl`	`String`	`''`	要显示的图块图像的URL，以代替无法加载的图块。
`zoomOffset`	`Number`	`0`	平铺URL中使用的缩放编号将使用此值进行偏移。
`tms`	`Boolean`	`false`	如果`true`，反转瓷砖的Y轴编号（为TMS服务启用此功能）。
`zoomReverse`	`Boolean`	`false`	如果设置为true，则平铺URL中使用的缩放编号将反转（`maxZoom - zoom`而不是`zoom`）
`detectRetina`	`Boolean`	`false`	如果`true`和用户在视网膜显示器上，它将要求四个指定尺寸的一半的瓷砖和一个更大的缩放级别来代替一个以利用高分辨率。
`crossOrigin`	`Boolean`	`false`	如果为true，则所有切片的crossOrigin属性都将设置为''。如果要访问切片像素数据，则需要这样做。

▶继承自GridLayer的选项

配置	类型	默认	描述
`tileSize`	`Number\|Point`	`256`	网格中瓷砖的宽度和高度。如果宽度和高度相等，则使用数字，`BM.point(width, height)`否则。
`opacity`	`Number`	`1.0`	瓷砖的不透明度。可以在`createTile()`函数中使用。
`updateWhenIdle`	`Boolean`	`(depends)`	仅在平移结束时加载新图块。 `true`默认情况下在移动浏览器上，以避免过多请求并保持平滑导航。 `false`否则，为了在平移期间显示新的图块，因为`keepBuffer`在桌面浏览器中很容易在该选项之外平移。
`updateWhenZooming`	`Boolean`	`true`	默认情况下，平滑缩放动画（在触摸缩放期间或a `flyTo()`）将每个整数缩放级别更新网格图层。将此选项设置为`false`仅在平滑动画结束时才更新网格图层。
`updateInterval`	`Number`	`200`	`updateInterval`平移时，平铺每毫秒不会更新一次。
`zIndex`	`Number`	`1`	切片图层的显式zIndex。
`bounds`	`LatLngBounds`	`undefined`	如果设置，则仅将瓷砖加载到集合中`LatLngBounds`。
`maxNativeZoom`	`Number`	`undefined`	磁贴源可用的最大缩放数。如果指定，则所有缩放级别以上的图块`maxNativeZoom`将从`maxNativeZoom`级别加载并自动缩放。
`minNativeZoom`	`Number`	`undefined`	磁贴源可用的最小缩放编号。如果指定，则所有缩放级别以下的图块`minNativeZoom`将从`minNativeZoom`级别加载并自动缩放。
`noWrap`	`Boolean`	`false`	该层是否包裹在antimeridian周围。如果`true`，GridLayer只会以低缩放级别显示一次。当地图CRS没有环绕时没有效果。可与之配合使用 `bounds` 防止请求超出CRS限制的磁贴。
`pane`	`String`	`'tilePane'`	`Map pane` 将添加网格图层的位置。
`className`	`String`	`''`	要分配给切片图层的自定义类名。默认为空。
`keepBuffer`	`Number`	`2`	平移地图时，请在卸载之前保留此许多行和列的切片。

▶继承自Layer的选项

配置	类型	默认	描述
`attribution`	`String`	`null`	要在归属控件中显示的字符串，描述图层数据，例如“©Mapbox”。

活动

▶从GridLayer继承的事件

事件	数据	描述
`loading`	`Event`	网格图层开始加载图块时触发。
`tileunload`	`TileEvent`	在移除瓷砖时触发（例如，当瓷砖离开屏幕时）。
`tileloadstart`	`TileEvent`	请求磁贴并在开始加载时触发。
`tileerror`	`TileErrorEvent`	加载磁贴时出错。
`tileload`	`TileEvent`	当瓷砖加载时触发。
`load`	`Event`	当网格图层加载所有可见的图块时触发。

▶从Layer继承的事件

事件	数据	描述
`add`	`Event`	将图层添加到地图后触发
`remove`	`Event`	从地图中删除图层后触发

▶从Layer继承的弹出事件

事件	数据	描述
`popupopen`	`PopupEvent`	打开绑定到此图层的弹出窗口时触发
`popupclose`	`PopupEvent`	绑定到此图层的弹出窗口关闭时触发

▶从Layer继承的工具提示事件

事件	数据	描述
`tooltipopen`	`TooltipEvent`	打开绑定到此图层的工具提示时触发。
`tooltipclose`	`TooltipEvent`	绑定到此图层的工具提示关闭时触发。

方法

方法	返回	描述
`setUrl( <String> url, <Boolean> noRedraw?)`	`this`	更新图层的URL模板并重新绘制它（除非`noRedraw`设置为`true`）。
`createTile( <Object> coords, <Function> done?)`	`HTMLElement`	仅在内部调用，覆盖GridLayer `createTile()` 以返回具有`<img>`给定的适当图像URL 的HTML元素`coords`。将`done` 在分片已经加载回调被调用。

扩展方法

图层扩展TileLayer可能会重新实现以下方法。

方法	返回	描述
`getTileUrl( <Object> coords)`	`String`	仅在内部调用，返回给定其坐标的tile的URL。扩展类`TileLayer`可以覆盖此函数以提供自定义切片URL命名方案。

▶从GridLayer继承的方法

方法	返回	描述
`bringToFront()`	`this`	将切片图层置于所有切片图层的顶部。
`bringToBack()`	`this`	将切片图层置于所有切片图层的底部。
`getContainer()`	`HTMLElement`	返回包含此图层的切片的HTML元素。
`setOpacity( <Number> opacity)`	`this`	更改网格图层的不透明度。
`setZIndex( <Number> zIndex)`	`this`	更改网格图层的zIndex。
`isLoading()`	`Boolean`	返回`true`如果在网格层有块尚未加载完毕。
`redraw()`	`this`	使图层清除所有图块并再次请求它们。
`getTileSize()`	`Point`	将tileSize选项规范化为一个点。由`createTile()`方法使用。

▶从Layer继承的方法

方法	返回	描述
`addTo( <Map\|LayerGroup> map)`	`this`	将图层添加到给定的地图或图层组。
`remove()`	`this`	从当前处于活动状态的地图中删除图层。
`removeFrom( <Map> map)`	`this`	从给定的地图中删除图层
`getPane( <String> name?)`	`HTMLElement`	返回`HTMLElement`表示地图上命名窗格的内容。如果`name`省略，则返回此图层的窗格。
`getAttribution()`	`String`	由the使用`attribution control`，返回归属选项。

▶从Layer继承的Popup方法

方法	返回	描述
`bindPopup( <String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	使用传递`content`将弹出窗口绑定到图层，并设置必要的事件侦听器。如果a `Function`被传递，它将接收图层作为第一个参数，并应返回一个`String`或`HTMLElement`。
`unbindPopup()`	`this`	删除以前绑定的弹出窗口`bindPopup`。
`openPopup( <LatLng> latlng?)`	`this`	`latlng`如果未`latlng`传递，则在指定或默认弹出锚点处打开绑定弹出窗口。
`closePopup()`	`this`	如果已打开，则关闭绑定到此图层的弹出窗口。
`togglePopup()`	`this`	打开或关闭绑定到此图层的弹出窗口，具体取决于其当前状态。
`isPopupOpen()`	`boolean`	返回`true`如果绑定到该层的弹出当前处于打开状态。
`setPopupContent( <String\|HTMLElement\|Popup> content)`	`this`	设置绑定到此图层的弹出窗口的内容。
`getPopup()`	`Popup`	返回绑定到此图层的弹出窗口。

▶继承自Layer的工具提示方法

方法	返回	描述
`bindTooltip( <String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	使用传递`content`将工具提示绑定到图层并设置必要的事件侦听器。如果a `Function`被传递，它将接收图层作为第一个参数，并应返回一个`String`或`HTMLElement`。
`unbindTooltip()`	`this`	删除以前绑定的工具提示`bindTooltip`。
`openTooltip( <LatLng> latlng?)`	`this`	`latlng`如果未`latlng`传递，则在指定或默认工具提示锚点处打开绑定工具提示。
`closeTooltip()`	`this`	如果已打开，则关闭绑定到此图层的工具提示。
`toggleTooltip()`	`this`	打开或关闭绑定到此图层的工具提示，具体取决于其当前状态。
`isTooltipOpen()`	`boolean`	返回`true`绑定到此图层的工具提示当前是否打开。
`setTooltipContent( <String\|HTMLElement\|Tooltip> content)`	`this`	设置绑定到此图层的工具提示的内容。
`getTooltip()`	`Tooltip`	返回绑定到此图层的工具提示。

▶从Evented继承的方法

方法	返回	描述
`on( <String> type, <Function> fn, <Object> context?)`	`this`	将侦听器函数（`fn`）添加到对象的特定事件类型。您可以选择指定侦听器的上下文（this关键字指向的对象）。您还可以传递多个以空格分隔的类型（例如`'click dblclick'`）。
`on( <Object> eventMap)`	`this`	添加一组类型/侦听器对，例如 `{click: onClick, mousemove: onMouseMove}`
`off( <String> type, <Function> fn?, <Object> context?)`	`this`	删除以前添加的侦听器功能。如果未指定任何函数，它将从对象中删除该特定事件的所有侦听器。请注意，如果您将自定义上下文传递给`on`，则必须传递相同的上下文`off`才能删除侦听器。
`off( <Object> eventMap)`	`this`	删除一组类型/侦听器对。
`off()`	`this`	删除对象上所有事件的所有侦听器。
`fire( <String> type, <Object> data?, <Boolean> propagate?)`	`this`	触发指定类型的事件。您可以选择提供数据对象 - 侦听器函数的第一个参数将包含其属性。该事件可以选择性地传播给事件父母。
`listens( <String> type)`	`Boolean`	返回`true`如果一个特定的事件类型有附带任何听众。
`once(…)`	`this`	表现为`on(…)`，除了监听器只会被触发一次然后被删除。
`addEventParent( <Evented> obj)`	`this`	添加事件父级 - `Evented`将接收传播事件的事件
`removeEventParent( <Evented> obj)`	`this`	删除事件父级，因此它将停止接收传播的事件
`addEventListener(…)`	`this`	别名来 `on(…)`
`removeEventListener(…)`	`this`	别名来 `off(…)`
`clearAllEventListeners(…)`	`this`	别名来 `off()`
`addOneTimeEventListener(…)`	`this`	别名来 `once(…)`
`fireEvent(…)`	`this`	别名来 `fire(…)`
`hasEventListeners(…)`	`Boolean`	别名来 `listens(…)`

用于在地图上将WMS服务显示为切片图层。延伸TileLayer。

用法示例

var nexrad = BM.tileLayer.wms("http://mesonet.agron.iastate.edu/cgi-bin/wms/nexrad/n0r.cgi", {
    layers: 'nexrad-n0r-900913',
    format: 'image/png',
    transparent: true,
    attribution: "Weather data © 2012 IEM Nexrad"
});

创建

厂	描述
`BM.tileLayer.wms( <String> baseUrl, <TileLayer.WMS options> options)`	给定WMS服务的基本URL和WMS参数/选项对象，实例化WMS切片层对象。

选项

如果使用此处未记录的任何自定义选项，它们将作为每个请求URL中的额外参数发送到WMS服务器。这对于非标准供应商WMS参数非常有用。

配置	类型	默认	描述
`layers`	`String`	`''`	（必需）要显示的以逗号分隔的WMS图层列表。
`styles`	`String`	`''`	以逗号分隔的WMS样式列表。
`format`	`String`	`'image/jpeg'`	WMS图像格式（`'image/png'`用于具有透明度的图层）。
`transparent`	`Boolean`	`false`	如果`true`，WMS服务将返回具有透明度的图像。
`version`	`String`	`'1.1.1'`	要使用的WMS服务的版本
`crs`	`CRS`	`null`	坐标参考系统用于WMS请求，默认为映射CRS。如果您不确定这意味着什么，请不要更改此项。
`uppercase`	`Boolean`	`false`	如果`true`，WMS请求参数键将为大写。

▶继承自TileLayer的选项

配置	类型	默认	描述
`minZoom`	`Number`	`0`	显示此图层的最小缩放级别（包括）。
`maxZoom`	`Number`	`18`	此图层将显示的最大缩放级别（包括）。
`subdomains`	`String\|String[]`	`'abc'`	磁贴服务的子域。可以以一个字符串（每个字母是子域名）或字符串数组的形式传递。
`errorTileUrl`	`String`	`''`	要显示的图块图像的URL，以代替无法加载的图块。
`zoomOffset`	`Number`	`0`	平铺URL中使用的缩放编号将使用此值进行偏移。
`tms`	`Boolean`	`false`	如果`true`，反转瓷砖的Y轴编号（为TMS服务启用此功能）。
`zoomReverse`	`Boolean`	`false`	如果设置为true，则平铺URL中使用的缩放编号将反转（`maxZoom - zoom`而不是`zoom`）
`detectRetina`	`Boolean`	`false`	如果`true`和用户在视网膜显示器上，它将要求四个指定尺寸的一半的瓷砖和一个更大的缩放级别来代替一个以利用高分辨率。
`crossOrigin`	`Boolean`	`false`	如果为true，则所有切片的crossOrigin属性都将设置为''。如果要访问切片像素数据，则需要这样做。

▶继承自GridLayer的选项

配置	类型	默认	描述
`tileSize`	`Number\|Point`	`256`	网格中瓷砖的宽度和高度。如果宽度和高度相等，则使用数字，`BM.point(width, height)`否则。
`opacity`	`Number`	`1.0`	瓷砖的不透明度。可以在`createTile()`函数中使用。
`updateWhenIdle`	`Boolean`	`(depends)`	仅在平移结束时加载新图块。 `true`默认情况下在移动浏览器上，以避免过多请求并保持平滑导航。 `false`否则，为了在平移期间显示新的图块，因为`keepBuffer`在桌面浏览器中很容易在该选项之外平移。
`updateWhenZooming`	`Boolean`	`true`	默认情况下，平滑缩放动画（在触摸缩放期间或a `flyTo()`）将每个整数缩放级别更新网格图层。将此选项设置为`false`仅在平滑动画结束时才更新网格图层。
`updateInterval`	`Number`	`200`	`updateInterval`平移时，平铺每毫秒不会更新一次。
`zIndex`	`Number`	`1`	切片图层的显式zIndex。
`bounds`	`LatLngBounds`	`undefined`	如果设置，则仅将瓷砖加载到集合中`LatLngBounds`。
`maxNativeZoom`	`Number`	`undefined`	磁贴源可用的最大缩放数。如果指定，则所有缩放级别以上的图块`maxNativeZoom`将从`maxNativeZoom`级别加载并自动缩放。
`minNativeZoom`	`Number`	`undefined`	磁贴源可用的最小缩放编号。如果指定，则所有缩放级别以下的图块`minNativeZoom`将从`minNativeZoom`级别加载并自动缩放。
`noWrap`	`Boolean`	`false`	该层是否包裹在antimeridian周围。如果`true`，GridLayer只会以低缩放级别显示一次。当地图CRS没有环绕时没有效果。可与之配合使用 `bounds` 防止请求超出CRS限制的磁贴。
`pane`	`String`	`'tilePane'`	`Map pane` 将添加网格图层的位置。
`className`	`String`	`''`	要分配给切片图层的自定义类名。默认为空。
`keepBuffer`	`Number`	`2`	平移地图时，请在卸载之前保留此许多行和列的切片。

▶继承自Layer的选项

配置	类型	默认	描述
`attribution`	`String`	`null`	要在归属控件中显示的字符串，描述图层数据，例如“©Mapbox”。

活动

▶从GridLayer继承的事件

事件	数据	描述
`loading`	`Event`	网格图层开始加载图块时触发。
`tileunload`	`TileEvent`	在移除瓷砖时触发（例如，当瓷砖离开屏幕时）。
`tileloadstart`	`TileEvent`	请求磁贴并在开始加载时触发。
`tileerror`	`TileErrorEvent`	加载磁贴时出错。
`tileload`	`TileEvent`	当瓷砖加载时触发。
`load`	`Event`	当网格图层加载所有可见的图块时触发。

▶从Layer继承的事件

事件	数据	描述
`add`	`Event`	将图层添加到地图后触发
`remove`	`Event`	从地图中删除图层后触发

▶从Layer继承的弹出事件

事件	数据	描述
`popupopen`	`PopupEvent`	打开绑定到此图层的弹出窗口时触发
`popupclose`	`PopupEvent`	绑定到此图层的弹出窗口关闭时触发

▶从Layer继承的工具提示事件

事件	数据	描述
`tooltipopen`	`TooltipEvent`	打开绑定到此图层的工具提示时触发。
`tooltipclose`	`TooltipEvent`	绑定到此图层的工具提示关闭时触发。

方法

方法	返回	描述
`setParams( <Object> params, <Boolean> noRedraw?)`	`this`	使用新参数合并对象并在当前屏幕上重新请求切片（除非`noRedraw`设置为true）。

▶从TileLayer继承的方法

方法	返回	描述
`setUrl( <String> url, <Boolean> noRedraw?)`	`this`	更新图层的URL模板并重新绘制它（除非`noRedraw`设置为`true`）。
`createTile( <Object> coords, <Function> done?)`	`HTMLElement`	仅在内部调用，覆盖GridLayer `createTile()` 以返回具有`<img>`给定的适当图像URL 的HTML元素`coords`。将`done` 在分片已经加载回调被调用。

▶从GridLayer继承的方法

方法	返回	描述
`bringToFront()`	`this`	将切片图层置于所有切片图层的顶部。
`bringToBack()`	`this`	将切片图层置于所有切片图层的底部。
`getContainer()`	`HTMLElement`	返回包含此图层的切片的HTML元素。
`setOpacity( <Number> opacity)`	`this`	更改网格图层的不透明度。
`setZIndex( <Number> zIndex)`	`this`	更改网格图层的zIndex。
`isLoading()`	`Boolean`	返回`true`如果在网格层有块尚未加载完毕。
`redraw()`	`this`	使图层清除所有图块并再次请求它们。
`getTileSize()`	`Point`	将tileSize选项规范化为一个点。由`createTile()`方法使用。

▶从Layer继承的方法

方法	返回	描述
`addTo( <Map\|LayerGroup> map)`	`this`	将图层添加到给定的地图或图层组。
`remove()`	`this`	从当前处于活动状态的地图中删除图层。
`removeFrom( <Map> map)`	`this`	从给定的地图中删除图层
`getPane( <String> name?)`	`HTMLElement`	返回`HTMLElement`表示地图上命名窗格的内容。如果`name`省略，则返回此图层的窗格。
`getAttribution()`	`String`	由the使用`attribution control`，返回归属选项。

▶从Layer继承的Popup方法

方法	返回	描述
`bindPopup( <String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	使用传递`content`将弹出窗口绑定到图层，并设置必要的事件侦听器。如果a `Function`被传递，它将接收图层作为第一个参数，并应返回一个`String`或`HTMLElement`。
`unbindPopup()`	`this`	删除以前绑定的弹出窗口`bindPopup`。
`openPopup( <LatLng> latlng?)`	`this`	`latlng`如果未`latlng`传递，则在指定或默认弹出锚点处打开绑定弹出窗口。
`closePopup()`	`this`	如果已打开，则关闭绑定到此图层的弹出窗口。
`togglePopup()`	`this`	打开或关闭绑定到此图层的弹出窗口，具体取决于其当前状态。
`isPopupOpen()`	`boolean`	返回`true`如果绑定到该层的弹出当前处于打开状态。
`setPopupContent( <String\|HTMLElement\|Popup> content)`	`this`	设置绑定到此图层的弹出窗口的内容。
`getPopup()`	`Popup`	返回绑定到此图层的弹出窗口。

▶继承自Layer的工具提示方法

方法	返回	描述
`bindTooltip( <String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	使用传递`content`将工具提示绑定到图层并设置必要的事件侦听器。如果a `Function`被传递，它将接收图层作为第一个参数，并应返回一个`String`或`HTMLElement`。
`unbindTooltip()`	`this`	删除以前绑定的工具提示`bindTooltip`。
`openTooltip( <LatLng> latlng?)`	`this`	`latlng`如果未`latlng`传递，则在指定或默认工具提示锚点处打开绑定工具提示。
`closeTooltip()`	`this`	如果已打开，则关闭绑定到此图层的工具提示。
`toggleTooltip()`	`this`	打开或关闭绑定到此图层的工具提示，具体取决于其当前状态。
`isTooltipOpen()`	`boolean`	返回`true`绑定到此图层的工具提示当前是否打开。
`setTooltipContent( <String\|HTMLElement\|Tooltip> content)`	`this`	设置绑定到此图层的工具提示的内容。
`getTooltip()`	`Tooltip`	返回绑定到此图层的工具提示。

▶从Evented继承的方法

方法	返回	描述
`on( <String> type, <Function> fn, <Object> context?)`	`this`	将侦听器函数（`fn`）添加到对象的特定事件类型。您可以选择指定侦听器的上下文（this关键字指向的对象）。您还可以传递多个以空格分隔的类型（例如`'click dblclick'`）。
`on( <Object> eventMap)`	`this`	添加一组类型/侦听器对，例如 `{click: onClick, mousemove: onMouseMove}`
`off( <String> type, <Function> fn?, <Object> context?)`	`this`	删除以前添加的侦听器功能。如果未指定任何函数，它将从对象中删除该特定事件的所有侦听器。请注意，如果您将自定义上下文传递给`on`，则必须传递相同的上下文`off`才能删除侦听器。
`off( <Object> eventMap)`	`this`	删除一组类型/侦听器对。
`off()`	`this`	删除对象上所有事件的所有侦听器。
`fire( <String> type, <Object> data?, <Boolean> propagate?)`	`this`	触发指定类型的事件。您可以选择提供数据对象 - 侦听器函数的第一个参数将包含其属性。该事件可以选择性地传播给事件父母。
`listens( <String> type)`	`Boolean`	返回`true`如果一个特定的事件类型有附带任何听众。
`once(…)`	`this`	表现为`on(…)`，除了监听器只会被触发一次然后被删除。
`addEventParent( <Evented> obj)`	`this`	添加事件父级 - `Evented`将接收传播事件的事件
`removeEventParent( <Evented> obj)`	`this`	删除事件父级，因此它将停止接收传播的事件
`addEventListener(…)`	`this`	别名来 `on(…)`
`removeEventListener(…)`	`this`	别名来 `off(…)`
`clearAllEventListeners(…)`	`this`	别名来 `off()`
`addOneTimeEventListener(…)`	`this`	别名来 `once(…)`
`fireEvent(…)`	`this`	别名来 `fire(…)`
`hasEventListeners(…)`	`Boolean`	别名来 `listens(…)`

ImageOverlay

用于在地图的特定边界上加载和显示单个图像。延伸Layer。

用法示例

var imageUrl = 'http://www.lib.utexas.edu/maps/historical/newark_nj_1922.jpg',
    imageBounds = [[40.712216, -74.22655], [40.773941, -74.12544]];
BM.imageOverlay(imageUrl, imageBounds).addTo(map);

创建

厂	描述
`BM.imageOverlay( <String> imageUrl, <LatLngBounds> bounds, <ImageOverlay options> options?)`	给定图像的URL及其所绑定的地理边界，以实例化图像叠加对象。

选项

配置	类型	默认	描述
`opacity`	`Number`	`1.0`	图像叠加层的不透明度。
`alt`	`String`	`''`	`alt`图像属性的文本（对辅助功能非常有用）。
`interactive`	`Boolean`	`false`	如果`true`，图像叠加将在单击或悬停时发出鼠标事件。
`crossOrigin`	`Boolean`	`false`	如果为true，则图像的crossOrigin属性设置为''。如果要访问图像像素数据，则需要这样做。
`errorOverlayUrl`	`String`	`''`	显示覆盖图像的URL，代替无法加载的叠加层。
`zIndex`	`Number`	`1`	切片图层的显式zIndex。
`className`	`String`	`''`	要分配给图像的自定义类名。默认为空。

▶从交互层继承的选项

配置	类型	默认	描述
`bubblingMouseEvents`	`Boolean`	`true`	何时`true`，此图层上的鼠标事件将在地图上触发相同的事件（除非`BM.DomEvent.stopPropagation`使用）。

▶继承自Layer的选项

配置	类型	默认	描述
`pane`	`String`	`'overlayPane'`	默认情况下，图层将添加到地图的叠加窗格中。覆盖此选项将导致默认情况下将图层放置在另一个窗格上。
`attribution`	`String`	`null`	要在归属控件中显示的字符串，描述图层数据，例如“©Mapbox”。

活动

事件	数据	描述
`load`	`Event`	ImageOverlay图层加载其图像时触发
`error`	`Event`	ImageOverlay图层加载其图像时触发

▶从交互层继承的鼠标事件

事件	数据	描述
`click`	`MouseEvent`	用户单击（或点击）图层时触发。
`dblclick`	`MouseEvent`	当用户双击（或双击）图层时触发。
`mousedown`	`MouseEvent`	当用户在图层上按下鼠标按钮时触发。
`mouseup`	`MouseEvent`	当用户释放在图层上按下的鼠标按钮时触发。
`mouseover`	`MouseEvent`	鼠标进入图层时触发。
`mouseout`	`MouseEvent`	当鼠标离开图层时触发。
`contextmenu`	`MouseEvent`	当用户右键单击图层时触发，防止默认浏览器上下文菜单显示此事件是否有侦听器。当用户持续一次触摸（也称为长按）时，也会在手机上触发。

▶从Layer继承的事件

事件	数据	描述
`add`	`Event`	将图层添加到地图后触发
`remove`	`Event`	从地图中删除图层后触发

▶从Layer继承的弹出事件

事件	数据	描述
`popupopen`	`PopupEvent`	打开绑定到此图层的弹出窗口时触发
`popupclose`	`PopupEvent`	绑定到此图层的弹出窗口关闭时触发

▶从Layer继承的工具提示事件

事件	数据	描述
`tooltipopen`	`TooltipEvent`	打开绑定到此图层的工具提示时触发。
`tooltipclose`	`TooltipEvent`	绑定到此图层的工具提示关闭时触发。

方法

方法	返回	描述
`setOpacity( <Number> opacity)`	`this`	设置叠加层的不透明度。
`bringToFront()`	`this`	将图层置于所有叠加层的顶部。
`bringToBack()`	`this`	将图层置于所有叠加层的底部。
`setUrl( <String> url)`	`this`	更改图像的URL。
`setBounds( <LatLngBounds> bounds)`	`this`	更新此ImageOverlay所涵盖的边界更改图像叠加层的zIndex。
`getBounds()`	`LatLngBounds`	获取此ImageOverlay涵盖的范围
`getElement()`	`HTMLElement`	返回`HTMLImageElement` 此叠加层使用的实例。

▶从Layer继承的方法

方法	返回	描述
`addTo( <Map\|LayerGroup> map)`	`this`	将图层添加到给定的地图或图层组。
`remove()`	`this`	从当前处于活动状态的地图中删除图层。
`removeFrom( <Map> map)`	`this`	从给定的地图中删除图层
`getPane( <String> name?)`	`HTMLElement`	返回`HTMLElement`表示地图上命名窗格的内容。如果`name`省略，则返回此图层的窗格。
`getAttribution()`	`String`	由the使用`attribution control`，返回归属选项。

▶从Layer继承的Popup方法

方法	返回	描述
`bindPopup( <String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	使用传递`content`将弹出窗口绑定到图层，并设置必要的事件侦听器。如果a `Function`被传递，它将接收图层作为第一个参数，并应返回一个`String`或`HTMLElement`。
`unbindPopup()`	`this`	删除以前绑定的弹出窗口`bindPopup`。
`openPopup( <LatLng> latlng?)`	`this`	`latlng`如果未`latlng`传递，则在指定或默认弹出锚点处打开绑定弹出窗口。
`closePopup()`	`this`	如果已打开，则关闭绑定到此图层的弹出窗口。
`togglePopup()`	`this`	打开或关闭绑定到此图层的弹出窗口，具体取决于其当前状态。
`isPopupOpen()`	`boolean`	返回`true`如果绑定到该层的弹出当前处于打开状态。
`setPopupContent( <String\|HTMLElement\|Popup> content)`	`this`	设置绑定到此图层的弹出窗口的内容。
`getPopup()`	`Popup`	返回绑定到此图层的弹出窗口。

▶继承自Layer的工具提示方法

方法	返回	描述
`bindTooltip( <String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	使用传递`content`将工具提示绑定到图层并设置必要的事件侦听器。如果a `Function`被传递，它将接收图层作为第一个参数，并应返回一个`String`或`HTMLElement`。
`unbindTooltip()`	`this`	删除以前绑定的工具提示`bindTooltip`。
`openTooltip( <LatLng> latlng?)`	`this`	`latlng`如果未`latlng`传递，则在指定或默认工具提示锚点处打开绑定工具提示。
`closeTooltip()`	`this`	如果已打开，则关闭绑定到此图层的工具提示。
`toggleTooltip()`	`this`	打开或关闭绑定到此图层的工具提示，具体取决于其当前状态。
`isTooltipOpen()`	`boolean`	返回`true`绑定到此图层的工具提示当前是否打开。
`setTooltipContent( <String\|HTMLElement\|Tooltip> content)`	`this`	设置绑定到此图层的工具提示的内容。
`getTooltip()`	`Tooltip`	返回绑定到此图层的工具提示。

▶从Evented继承的方法

方法	返回	描述
`on( <String> type, <Function> fn, <Object> context?)`	`this`	将侦听器函数（`fn`）添加到对象的特定事件类型。您可以选择指定侦听器的上下文（this关键字指向的对象）。您还可以传递多个以空格分隔的类型（例如`'click dblclick'`）。
`on( <Object> eventMap)`	`this`	添加一组类型/侦听器对，例如 `{click: onClick, mousemove: onMouseMove}`
`off( <String> type, <Function> fn?, <Object> context?)`	`this`	删除以前添加的侦听器功能。如果未指定任何函数，它将从对象中删除该特定事件的所有侦听器。请注意，如果您将自定义上下文传递给`on`，则必须传递相同的上下文`off`才能删除侦听器。
`off( <Object> eventMap)`	`this`	删除一组类型/侦听器对。
`off()`	`this`	删除对象上所有事件的所有侦听器。
`fire( <String> type, <Object> data?, <Boolean> propagate?)`	`this`	触发指定类型的事件。您可以选择提供数据对象 - 侦听器函数的第一个参数将包含其属性。该事件可以选择性地传播给事件父母。
`listens( <String> type)`	`Boolean`	返回`true`如果一个特定的事件类型有附带任何听众。
`once(…)`	`this`	表现为`on(…)`，除了监听器只会被触发一次然后被删除。
`addEventParent( <Evented> obj)`	`this`	添加事件父级 - `Evented`将接收传播事件的事件
`removeEventParent( <Evented> obj)`	`this`	删除事件父级，因此它将停止接收传播的事件
`addEventListener(…)`	`this`	别名来 `on(…)`
`removeEventListener(…)`	`this`	别名来 `off(…)`
`clearAllEventListeners(…)`	`this`	别名来 `off()`
`addOneTimeEventListener(…)`	`this`	别名来 `once(…)`
`fireEvent(…)`	`this`	别名来 `fire(…)`
`hasEventListeners(…)`	`Boolean`	别名来 `listens(…)`

VideoOverlay

用于在地图的特定边界上加载和显示视频播放器。延伸ImageOverlay。视频叠加层使用<video> HTML5元素。

用法示例

var videoUrl = 'https://www.mapbox.com/bites/00188/patricia_nasa.webm',
    videoBounds = [[ 32, -130], [ 13, -100]];
BM.VideoOverlay(videoUrl, videoBounds ).addTo(map);

创建

厂	描述
`BM.videoOverlay( <String\|Array\|HTMLVideoElement> video, <LatLngBounds> bounds, <VideoOverlay options> options?)`	给定视频的URL（或URL数组，甚至视频元素）及其所绑定的地理边界，以实例化图像叠加对象。

选项

配置	类型	默认	描述
`autoplay`	`Boolean`	`true`	视频是否在加载时自动开始播放。
`loop`	`Boolean`	`true`	视频是否会在播放时循环回到开头。

▶继承自ImageOverlay的选项

配置	类型	默认	描述
`opacity`	`Number`	`1.0`	图像叠加层的不透明度。
`alt`	`String`	`''`	`alt`图像属性的文本（对辅助功能非常有用）。
`interactive`	`Boolean`	`false`	如果`true`，图像叠加将在单击或悬停时发出鼠标事件。
`crossOrigin`	`Boolean`	`false`	如果为true，则图像的crossOrigin属性设置为''。如果要访问图像像素数据，则需要这样做。
`errorOverlayUrl`	`String`	`''`	显示覆盖图像的URL，代替无法加载的叠加层。
`zIndex`	`Number`	`1`	切片图层的显式zIndex。
`className`	`String`	`''`	要分配给图像的自定义类名。默认为空。

▶从交互层继承的选项

配置	类型	默认	描述
`bubblingMouseEvents`	`Boolean`	`true`	何时`true`，此图层上的鼠标事件将在地图上触发相同的事件（除非`BM.DomEvent.stopPropagation`使用）。

▶继承自Layer的选项

配置	类型	默认	描述
`pane`	`String`	`'overlayPane'`	默认情况下，图层将添加到地图的叠加窗格中。覆盖此选项将导致默认情况下将图层放置在另一个窗格上。
`attribution`	`String`	`null`	要在归属控件中显示的字符串，描述图层数据，例如“©Mapbox”。

活动

事件	数据	描述
`load`	`Event`	视频加载完第一帧后触发

▶从ImageOverlay继承的事件

事件	数据	描述
`error`	`Event`	ImageOverlay图层加载其图像时触发

▶从交互层继承的鼠标事件

事件	数据	描述
`click`	`MouseEvent`	用户单击（或点击）图层时触发。
`dblclick`	`MouseEvent`	当用户双击（或双击）图层时触发。
`mousedown`	`MouseEvent`	当用户在图层上按下鼠标按钮时触发。
`mouseup`	`MouseEvent`	当用户释放在图层上按下的鼠标按钮时触发。
`mouseover`	`MouseEvent`	鼠标进入图层时触发。
`mouseout`	`MouseEvent`	当鼠标离开图层时触发。
`contextmenu`	`MouseEvent`	当用户右键单击图层时触发，防止默认浏览器上下文菜单显示此事件是否有侦听器。当用户持续一次触摸（也称为长按）时，也会在手机上触发。

▶从Layer继承的事件

事件	数据	描述
`add`	`Event`	将图层添加到地图后触发
`remove`	`Event`	从地图中删除图层后触发

▶从Layer继承的弹出事件

事件	数据	描述
`popupopen`	`PopupEvent`	打开绑定到此图层的弹出窗口时触发
`popupclose`	`PopupEvent`	绑定到此图层的弹出窗口关闭时触发

▶从Layer继承的工具提示事件

事件	数据	描述
`tooltipopen`	`TooltipEvent`	打开绑定到此图层的工具提示时触发。
`tooltipclose`	`TooltipEvent`	绑定到此图层的工具提示关闭时触发。

方法

方法	返回	描述
`getElement()`	`HTMLVideoElement`	返回`HTMLVideoElement` 此叠加层使用的实例。

▶从ImageOverlay继承的方法

方法	返回	描述
`setOpacity( <Number> opacity)`	`this`	设置叠加层的不透明度。
`bringToFront()`	`this`	将图层置于所有叠加层的顶部。
`bringToBack()`	`this`	将图层置于所有叠加层的底部。
`setUrl( <String> url)`	`this`	更改图像的URL。
`setBounds( <LatLngBounds> bounds)`	`this`	更新此ImageOverlay所涵盖的边界更改图像叠加层的zIndex。
`getBounds()`	`LatLngBounds`	获取此ImageOverlay涵盖的范围

▶从Layer继承的方法

方法	返回	描述
`addTo( <Map\|LayerGroup> map)`	`this`	将图层添加到给定的地图或图层组。
`remove()`	`this`	从当前处于活动状态的地图中删除图层。
`removeFrom( <Map> map)`	`this`	从给定的地图中删除图层
`getPane( <String> name?)`	`HTMLElement`	返回`HTMLElement`表示地图上命名窗格的内容。如果`name`省略，则返回此图层的窗格。
`getAttribution()`	`String`	由the使用`attribution control`，返回归属选项。

▶从Layer继承的Popup方法

方法	返回	描述
`bindPopup( <String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	使用传递`content`将弹出窗口绑定到图层，并设置必要的事件侦听器。如果a `Function`被传递，它将接收图层作为第一个参数，并应返回一个`String`或`HTMLElement`。
`unbindPopup()`	`this`	删除以前绑定的弹出窗口`bindPopup`。
`openPopup( <LatLng> latlng?)`	`this`	`latlng`如果未`latlng`传递，则在指定或默认弹出锚点处打开绑定弹出窗口。
`closePopup()`	`this`	如果已打开，则关闭绑定到此图层的弹出窗口。
`togglePopup()`	`this`	打开或关闭绑定到此图层的弹出窗口，具体取决于其当前状态。
`isPopupOpen()`	`boolean`	返回`true`如果绑定到该层的弹出当前处于打开状态。
`setPopupContent( <String\|HTMLElement\|Popup> content)`	`this`	设置绑定到此图层的弹出窗口的内容。
`getPopup()`	`Popup`	返回绑定到此图层的弹出窗口。

▶继承自Layer的工具提示方法

方法	返回	描述
`bindTooltip( <String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	使用传递`content`将工具提示绑定到图层并设置必要的事件侦听器。如果a `Function`被传递，它将接收图层作为第一个参数，并应返回一个`String`或`HTMLElement`。
`unbindTooltip()`	`this`	删除以前绑定的工具提示`bindTooltip`。
`openTooltip( <LatLng> latlng?)`	`this`	`latlng`如果未`latlng`传递，则在指定或默认工具提示锚点处打开绑定工具提示。
`closeTooltip()`	`this`	如果已打开，则关闭绑定到此图层的工具提示。
`toggleTooltip()`	`this`	打开或关闭绑定到此图层的工具提示，具体取决于其当前状态。
`isTooltipOpen()`	`boolean`	返回`true`绑定到此图层的工具提示当前是否打开。
`setTooltipContent( <String\|HTMLElement\|Tooltip> content)`	`this`	设置绑定到此图层的工具提示的内容。
`getTooltip()`	`Tooltip`	返回绑定到此图层的工具提示。

▶从Evented继承的方法

方法	返回	描述
`on( <String> type, <Function> fn, <Object> context?)`	`this`	将侦听器函数（`fn`）添加到对象的特定事件类型。您可以选择指定侦听器的上下文（this关键字指向的对象）。您还可以传递多个以空格分隔的类型（例如`'click dblclick'`）。
`on( <Object> eventMap)`	`this`	添加一组类型/侦听器对，例如 `{click: onClick, mousemove: onMouseMove}`
`off( <String> type, <Function> fn?, <Object> context?)`	`this`	删除以前添加的侦听器功能。如果未指定任何函数，它将从对象中删除该特定事件的所有侦听器。请注意，如果您将自定义上下文传递给`on`，则必须传递相同的上下文`off`才能删除侦听器。
`off( <Object> eventMap)`	`this`	删除一组类型/侦听器对。
`off()`	`this`	删除对象上所有事件的所有侦听器。
`fire( <String> type, <Object> data?, <Boolean> propagate?)`	`this`	触发指定类型的事件。您可以选择提供数据对象 - 侦听器函数的第一个参数将包含其属性。该事件可以选择性地传播给事件父母。
`listens( <String> type)`	`Boolean`	返回`true`如果一个特定的事件类型有附带任何听众。
`once(…)`	`this`	表现为`on(…)`，除了监听器只会被触发一次然后被删除。
`addEventParent( <Evented> obj)`	`this`	添加事件父级 - `Evented`将接收传播事件的事件
`removeEventParent( <Evented> obj)`	`this`	删除事件父级，因此它将停止接收传播的事件
`addEventListener(…)`	`this`	别名来 `on(…)`
`removeEventListener(…)`	`this`	别名来 `off(…)`
`clearAllEventListeners(…)`	`this`	别名来 `off()`
`addOneTimeEventListener(…)`	`this`	别名来 `once(…)`
`fireEvent(…)`	`this`	别名来 `fire(…)`
`hasEventListeners(…)`	`Boolean`	别名来 `listens(…)`

路径

一个抽象类，包含矢量叠加（Polygon，Polyline，Circle）之间共享的选项和常量。不要直接使用它。延伸Layer。

选项

配置	类型	默认	描述
`stroke`	`Boolean`	`true`	是否沿路径绘制笔划。将其设置`false`为禁用多边形或圆形的边框。
`color`	`String`	`'#3388ff'`	中风颜色
`weight`	`Number`	`3`	笔画宽度（以像素为单位）
`opacity`	`Number`	`1.0`	中风不透明度
`lineCap`	`String`	`'round'`	一个字符串，用于定义要在笔划结束时使用的形状。
`lineJoin`	`String`	`'round'`	一个字符串，用于定义要在笔触的角上使用的形状。
`dashArray`	`String`	`null`	用于定义笔触虚线图案的字符串。`Canvas`在某些旧浏览器中不适用于动态图层。
`dashOffset`	`String`	`null`	一个字符串，用于定义到破折号模式的距离以启动破折号。`Canvas`在某些旧浏览器中不适用于动态图层。
`fill`	`Boolean`	`depends`	是否用颜色填充路径。将其设置`false`为禁用填充多边形或圆形。
`fillColor`	`String`	`*`	填色。默认为`color`选项的值
`fillOpacity`	`Number`	`0.2`	填充不透明度。
`fillRule`	`String`	`'evenodd'`	一个字符串，用于定义如何确定形状的内部。
`bubblingMouseEvents`	`Boolean`	`true`	何时`true`，此路径上的鼠标事件将在地图上触发相同的事件（除非`BM.DomEvent.stopPropagation`使用）。
`renderer`	`Renderer`		将此特定实例`Renderer`用于此路径。优先于地图的默认渲染器。
`className`	`String`	`null`	在元素上设置自定义类名。仅适用于SVG渲染器。

▶从交互层继承的选项

配置	类型	默认	描述
`interactive`	`Boolean`	`true`	如果`false`，图层不会发出鼠标事件，并将作为底层地图的一部分。

▶继承自Layer的选项

配置	类型	默认	描述
`pane`	`String`	`'overlayPane'`	默认情况下，图层将添加到地图的叠加窗格中。覆盖此选项将导致默认情况下将图层放置在另一个窗格上。
`attribution`	`String`	`null`	要在归属控件中显示的字符串，描述图层数据，例如“©Mapbox”。

活动

▶从交互层继承的鼠标事件

事件	数据	描述
`click`	`MouseEvent`	用户单击（或点击）图层时触发。
`dblclick`	`MouseEvent`	当用户双击（或双击）图层时触发。
`mousedown`	`MouseEvent`	当用户在图层上按下鼠标按钮时触发。
`mouseup`	`MouseEvent`	当用户释放在图层上按下的鼠标按钮时触发。
`mouseover`	`MouseEvent`	鼠标进入图层时触发。
`mouseout`	`MouseEvent`	当鼠标离开图层时触发。
`contextmenu`	`MouseEvent`	当用户右键单击图层时触发，防止默认浏览器上下文菜单显示此事件是否有侦听器。当用户持续一次触摸（也称为长按）时，也会在手机上触发。

▶从Layer继承的事件

事件	数据	描述
`add`	`Event`	将图层添加到地图后触发
`remove`	`Event`	从地图中删除图层后触发

▶从Layer继承的弹出事件

事件	数据	描述
`popupopen`	`PopupEvent`	打开绑定到此图层的弹出窗口时触发
`popupclose`	`PopupEvent`	绑定到此图层的弹出窗口关闭时触发

▶从Layer继承的工具提示事件

事件	数据	描述
`tooltipopen`	`TooltipEvent`	打开绑定到此图层的工具提示时触发。
`tooltipclose`	`TooltipEvent`	绑定到此图层的工具提示关闭时触发。

方法

方法	返回	描述
`redraw()`	`this`	重绘图层。更改路径使用的坐标后，有时很有用。
`setStyle( <Path options> style)`	`this`	根据`Path options`对象中的选项更改Path的外观。
`bringToFront()`	`this`	将图层置于所有路径图层的顶部。
`bringToBack()`	`this`	将图层置于所有路径图层的底部。

▶从Layer继承的方法

方法	返回	描述
`addTo( <Map\|LayerGroup> map)`	`this`	将图层添加到给定的地图或图层组。
`remove()`	`this`	从当前处于活动状态的地图中删除图层。
`removeFrom( <Map> map)`	`this`	从给定的地图中删除图层
`getPane( <String> name?)`	`HTMLElement`	返回`HTMLElement`表示地图上命名窗格的内容。如果`name`省略，则返回此图层的窗格。
`getAttribution()`	`String`	由the使用`attribution control`，返回归属选项。

▶从Layer继承的Popup方法

方法	返回	描述
`bindPopup( <String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	使用传递`content`将弹出窗口绑定到图层，并设置必要的事件侦听器。如果a `Function`被传递，它将接收图层作为第一个参数，并应返回一个`String`或`HTMLElement`。
`unbindPopup()`	`this`	删除以前绑定的弹出窗口`bindPopup`。
`openPopup( <LatLng> latlng?)`	`this`	`latlng`如果未`latlng`传递，则在指定或默认弹出锚点处打开绑定弹出窗口。
`closePopup()`	`this`	如果已打开，则关闭绑定到此图层的弹出窗口。
`togglePopup()`	`this`	打开或关闭绑定到此图层的弹出窗口，具体取决于其当前状态。
`isPopupOpen()`	`boolean`	返回`true`如果绑定到该层的弹出当前处于打开状态。
`setPopupContent( <String\|HTMLElement\|Popup> content)`	`this`	设置绑定到此图层的弹出窗口的内容。
`getPopup()`	`Popup`	返回绑定到此图层的弹出窗口。

▶继承自Layer的工具提示方法

方法	返回	描述
`bindTooltip( <String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	使用传递`content`将工具提示绑定到图层并设置必要的事件侦听器。如果a `Function`被传递，它将接收图层作为第一个参数，并应返回一个`String`或`HTMLElement`。
`unbindTooltip()`	`this`	删除以前绑定的工具提示`bindTooltip`。
`openTooltip( <LatLng> latlng?)`	`this`	`latlng`如果未`latlng`传递，则在指定或默认工具提示锚点处打开绑定工具提示。
`closeTooltip()`	`this`	如果已打开，则关闭绑定到此图层的工具提示。
`toggleTooltip()`	`this`	打开或关闭绑定到此图层的工具提示，具体取决于其当前状态。
`isTooltipOpen()`	`boolean`	返回`true`绑定到此图层的工具提示当前是否打开。
`setTooltipContent( <String\|HTMLElement\|Tooltip> content)`	`this`	设置绑定到此图层的工具提示的内容。
`getTooltip()`	`Tooltip`	返回绑定到此图层的工具提示。

▶从Evented继承的方法

方法	返回	描述
`on( <String> type, <Function> fn, <Object> context?)`	`this`	将侦听器函数（`fn`）添加到对象的特定事件类型。您可以选择指定侦听器的上下文（this关键字指向的对象）。您还可以传递多个以空格分隔的类型（例如`'click dblclick'`）。
`on( <Object> eventMap)`	`this`	添加一组类型/侦听器对，例如 `{click: onClick, mousemove: onMouseMove}`
`off( <String> type, <Function> fn?, <Object> context?)`	`this`	删除以前添加的侦听器功能。如果未指定任何函数，它将从对象中删除该特定事件的所有侦听器。请注意，如果您将自定义上下文传递给`on`，则必须传递相同的上下文`off`才能删除侦听器。
`off( <Object> eventMap)`	`this`	删除一组类型/侦听器对。
`off()`	`this`	删除对象上所有事件的所有侦听器。
`fire( <String> type, <Object> data?, <Boolean> propagate?)`	`this`	触发指定类型的事件。您可以选择提供数据对象 - 侦听器函数的第一个参数将包含其属性。该事件可以选择性地传播给事件父母。
`listens( <String> type)`	`Boolean`	返回`true`如果一个特定的事件类型有附带任何听众。
`once(…)`	`this`	表现为`on(…)`，除了监听器只会被触发一次然后被删除。
`addEventParent( <Evented> obj)`	`this`	添加事件父级 - `Evented`将接收传播事件的事件
`removeEventParent( <Evented> obj)`	`this`	删除事件父级，因此它将停止接收传播的事件
`addEventListener(…)`	`this`	别名来 `on(…)`
`removeEventListener(…)`	`this`	别名来 `off(…)`
`clearAllEventListeners(…)`	`this`	别名来 `off()`
`addOneTimeEventListener(…)`	`this`	别名来 `once(…)`
`fireEvent(…)`	`this`	别名来 `fire(…)`
`hasEventListeners(…)`	`Boolean`	别名来 `listens(…)`

折线

用于在地图上绘制折线叠加层的类。延伸Path。

用法示例

// create a red polyline from an array of LatLng points
var latlngs = [
    [45.51, -122.68],
    [37.77, -122.43],
    [34.04, -118.2]
];
var polyline = BM.polyline(latlngs, {color: 'red'}).addTo(map);
// zoom the map to the polyline
map.fitBounds(polyline.getBounds());

您还可以传递多维数组来表示MultiPolyline形状：

// create a red polyline from an array of arrays of LatLng points
var latlngs = [
    [[45.51, -122.68],
     [37.77, -122.43],
     [34.04, -118.2]],
    [[40.78, -73.91],
     [41.83, -87.62],
     [32.76, -96.72]]
];

创建

厂	描述
`BM.polyline( <LatLng[]> latlngs, <Polyline options> options?)`	在给定地理点数组和可选的选项对象的情况下实例化折线对象。您可以通过传递地理点数组的数组来创建`Polyline`具有多个单独行（`MultiPolyline`）的对象。

选项

配置	类型	默认	描述
`smoothFactor`	`Number`	`1.0`	在每个缩放级别上简化折线的程度。更多意味着更好的性能和更流畅的外观，更少意味着更准确的表示。
`noClip`	`Boolean`	`false`	禁用折线剪裁。

▶继承自Path的选项

配置	类型	默认	描述
`stroke`	`Boolean`	`true`	是否沿路径绘制笔划。将其设置`false`为禁用多边形或圆形的边框。
`color`	`String`	`'#3388ff'`	中风颜色
`weight`	`Number`	`3`	笔画宽度（以像素为单位）
`opacity`	`Number`	`1.0`	中风不透明度
`lineCap`	`String`	`'round'`	一个字符串，用于定义要在笔划结束时使用的形状。
`lineJoin`	`String`	`'round'`	一个字符串，用于定义要在笔触的角上使用的形状。
`dashArray`	`String`	`null`	用于定义笔触虚线图案的字符串。`Canvas`在某些旧浏览器中不适用于动态图层。
`dashOffset`	`String`	`null`	一个字符串，用于定义到破折号模式的距离以启动破折号。`Canvas`在某些旧浏览器中不适用于动态图层。
`fill`	`Boolean`	`depends`	是否用颜色填充路径。将其设置`false`为禁用填充多边形或圆形。
`fillColor`	`String`	`*`	填色。默认为`color`选项的值
`fillOpacity`	`Number`	`0.2`	填充不透明度。
`fillRule`	`String`	`'evenodd'`	一个字符串，用于定义如何确定形状的内部。
`bubblingMouseEvents`	`Boolean`	`true`	何时`true`，此路径上的鼠标事件将在地图上触发相同的事件（除非`BM.DomEvent.stopPropagation`使用）。
`renderer`	`Renderer`		将此特定实例`Renderer`用于此路径。优先于地图的默认渲染器。
`className`	`String`	`null`	在元素上设置自定义类名。仅适用于SVG渲染器。

▶从交互层继承的选项

配置	类型	默认	描述
`interactive`	`Boolean`	`true`	如果`false`，图层不会发出鼠标事件，并将作为底层地图的一部分。

▶继承自Layer的选项

配置	类型	默认	描述
`pane`	`String`	`'overlayPane'`	默认情况下，图层将添加到地图的叠加窗格中。覆盖此选项将导致默认情况下将图层放置在另一个窗格上。
`attribution`	`String`	`null`	要在归属控件中显示的字符串，描述图层数据，例如“©Mapbox”。

活动

▶从交互层继承的鼠标事件

事件	数据	描述
`click`	`MouseEvent`	用户单击（或点击）图层时触发。
`dblclick`	`MouseEvent`	当用户双击（或双击）图层时触发。
`mousedown`	`MouseEvent`	当用户在图层上按下鼠标按钮时触发。
`mouseup`	`MouseEvent`	当用户释放在图层上按下的鼠标按钮时触发。
`mouseover`	`MouseEvent`	鼠标进入图层时触发。
`mouseout`	`MouseEvent`	当鼠标离开图层时触发。
`contextmenu`	`MouseEvent`	当用户右键单击图层时触发，防止默认浏览器上下文菜单显示此事件是否有侦听器。当用户持续一次触摸（也称为长按）时，也会在手机上触发。

▶从Layer继承的事件

事件	数据	描述
`add`	`Event`	将图层添加到地图后触发
`remove`	`Event`	从地图中删除图层后触发

▶从Layer继承的弹出事件

事件	数据	描述
`popupopen`	`PopupEvent`	打开绑定到此图层的弹出窗口时触发
`popupclose`	`PopupEvent`	绑定到此图层的弹出窗口关闭时触发

▶从Layer继承的工具提示事件

事件	数据	描述
`tooltipopen`	`TooltipEvent`	打开绑定到此图层的工具提示时触发。
`tooltipclose`	`TooltipEvent`	绑定到此图层的工具提示关闭时触发。

方法

方法	返回	描述
`toGeoJSON()`	`Object`	返回一个 `GeoJSON`折线的表示（作为GeoJSON `LineString`或`MultiLineString`特征）。
`getLatLngs()`	`LatLng[]`	返回路径中的点数组，或者在多折线的情况下返回嵌套的点数组。
`setLatLngs( <LatLng[]> latlngs)`	`this`	用给定的地理点数组替换折线中的所有点。
`isEmpty()`	`Boolean`	`true`如果折线没有LatLng，则返回。
`closestLayerPoint()`	`Point`	返回最接近`p`折线的点。
`getCenter()`	`LatLng`	返回折线的中心（质心）。
`getBounds()`	`LatLngBounds`	返回`LatLngBounds`路径。
`addLatLng( <LatLng> latlng)`	`this`	将一个给定点添加到折线。默认情况下，在多折线的情况下添加到折线的第一个环，但可以通过将特定环作为LatLng数组（您可以在之前访问`getLatLngs`）来覆盖。

▶从Path继承的方法

方法	返回	描述
`redraw()`	`this`	重绘图层。更改路径使用的坐标后，有时很有用。
`setStyle( <Path options> style)`	`this`	根据`Path options`对象中的选项更改Path的外观。
`bringToFront()`	`this`	将图层置于所有路径图层的顶部。
`bringToBack()`	`this`	将图层置于所有路径图层的底部。

▶从Layer继承的方法

方法	返回	描述
`addTo( <Map\|LayerGroup> map)`	`this`	将图层添加到给定的地图或图层组。
`remove()`	`this`	从当前处于活动状态的地图中删除图层。
`removeFrom( <Map> map)`	`this`	从给定的地图中删除图层
`getPane( <String> name?)`	`HTMLElement`	返回`HTMLElement`表示地图上命名窗格的内容。如果`name`省略，则返回此图层的窗格。
`getAttribution()`	`String`	由the使用`attribution control`，返回归属选项。

▶从Layer继承的Popup方法

方法	返回	描述
`bindPopup( <String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	使用传递`content`将弹出窗口绑定到图层，并设置必要的事件侦听器。如果a `Function`被传递，它将接收图层作为第一个参数，并应返回一个`String`或`HTMLElement`。
`unbindPopup()`	`this`	删除以前绑定的弹出窗口`bindPopup`。
`openPopup( <LatLng> latlng?)`	`this`	`latlng`如果未`latlng`传递，则在指定或默认弹出锚点处打开绑定弹出窗口。
`closePopup()`	`this`	如果已打开，则关闭绑定到此图层的弹出窗口。
`togglePopup()`	`this`	打开或关闭绑定到此图层的弹出窗口，具体取决于其当前状态。
`isPopupOpen()`	`boolean`	返回`true`如果绑定到该层的弹出当前处于打开状态。
`setPopupContent( <String\|HTMLElement\|Popup> content)`	`this`	设置绑定到此图层的弹出窗口的内容。
`getPopup()`	`Popup`	返回绑定到此图层的弹出窗口。

▶继承自Layer的工具提示方法

方法	返回	描述
`bindTooltip( <String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	使用传递`content`将工具提示绑定到图层并设置必要的事件侦听器。如果a `Function`被传递，它将接收图层作为第一个参数，并应返回一个`String`或`HTMLElement`。
`unbindTooltip()`	`this`	删除以前绑定的工具提示`bindTooltip`。
`openTooltip( <LatLng> latlng?)`	`this`	`latlng`如果未`latlng`传递，则在指定或默认工具提示锚点处打开绑定工具提示。
`closeTooltip()`	`this`	如果已打开，则关闭绑定到此图层的工具提示。
`toggleTooltip()`	`this`	打开或关闭绑定到此图层的工具提示，具体取决于其当前状态。
`isTooltipOpen()`	`boolean`	返回`true`绑定到此图层的工具提示当前是否打开。
`setTooltipContent( <String\|HTMLElement\|Tooltip> content)`	`this`	设置绑定到此图层的工具提示的内容。
`getTooltip()`	`Tooltip`	返回绑定到此图层的工具提示。

▶从Evented继承的方法

方法	返回	描述
`on( <String> type, <Function> fn, <Object> context?)`	`this`	将侦听器函数（`fn`）添加到对象的特定事件类型。您可以选择指定侦听器的上下文（this关键字指向的对象）。您还可以传递多个以空格分隔的类型（例如`'click dblclick'`）。
`on( <Object> eventMap)`	`this`	添加一组类型/侦听器对，例如 `{click: onClick, mousemove: onMouseMove}`
`off( <String> type, <Function> fn?, <Object> context?)`	`this`	删除以前添加的侦听器功能。如果未指定任何函数，它将从对象中删除该特定事件的所有侦听器。请注意，如果您将自定义上下文传递给`on`，则必须传递相同的上下文`off`才能删除侦听器。
`off( <Object> eventMap)`	`this`	删除一组类型/侦听器对。
`off()`	`this`	删除对象上所有事件的所有侦听器。
`fire( <String> type, <Object> data?, <Boolean> propagate?)`	`this`	触发指定类型的事件。您可以选择提供数据对象 - 侦听器函数的第一个参数将包含其属性。该事件可以选择性地传播给事件父母。
`listens( <String> type)`	`Boolean`	返回`true`如果一个特定的事件类型有附带任何听众。
`once(…)`	`this`	表现为`on(…)`，除了监听器只会被触发一次然后被删除。
`addEventParent( <Evented> obj)`	`this`	添加事件父级 - `Evented`将接收传播事件的事件
`removeEventParent( <Evented> obj)`	`this`	删除事件父级，因此它将停止接收传播的事件
`addEventListener(…)`	`this`	别名来 `on(…)`
`removeEventListener(…)`	`this`	别名来 `off(…)`
`clearAllEventListeners(…)`	`this`	别名来 `off()`
`addOneTimeEventListener(…)`	`this`	别名来 `once(…)`
`fireEvent(…)`	`this`	别名来 `fire(…)`
`hasEventListeners(…)`	`Boolean`	别名来 `listens(…)`

多边形

用于在地图上绘制多边形叠加层的类。延伸Polyline。请注意，创建多边形时传递的点不应该具有等于第一个点的额外最后一个点 - 最好过滤掉这些点。

用法示例

// create a red polygon from an array of LatLng points
var latlngs = [[37, -109.05],[41, -109.03],[41, -102.05],[37, -102.04]];
var polygon = BM.polygon(latlngs, {color: 'red'}).addTo(map);
// zoom the map to the polygon
map.fitBounds(polygon.getBounds());

您还可以传递一系列latlngs数组，第一个数组表示外部形状，另一个数组表示外部形状中的孔：

var latlngs = [
  [[37, -109.05],[41, -109.03],[41, -102.05],[37, -102.04]], // outer ring
  [[37.29, -108.58],[40.71, -108.58],[40.71, -102.50],[37.29, -102.50]] // hole
];

此外，您可以传递多维数组以表示MultiPolygon形状。

var latlngs = [
  [ // first polygon
    [[37, -109.05],[41, -109.03],[41, -102.05],[37, -102.04]], // outer ring
    [[37.29, -108.58],[40.71, -108.58],[40.71, -102.50],[37.29, -102.50]] // hole
  ],
  [ // second polygon
    [[41, -111.03],[45, -111.04],[45, -104.05],[41, -104.05]]
  ]
];

创建

厂	描述
`BM.polygon( <LatLng[]> latlngs, <Polyline options> options?)`

选项

▶从Polyline继承的选项

配置	类型	默认	描述
`smoothFactor`	`Number`	`1.0`	在每个缩放级别上简化折线的程度。更多意味着更好的性能和更流畅的外观，更少意味着更准确的表示。
`noClip`	`Boolean`	`false`	禁用折线剪裁。

▶继承自Path的选项

配置	类型	默认	描述
`stroke`	`Boolean`	`true`	是否沿路径绘制笔划。将其设置`false`为禁用多边形或圆形的边框。
`color`	`String`	`'#3388ff'`	中风颜色
`weight`	`Number`	`3`	笔画宽度（以像素为单位）
`opacity`	`Number`	`1.0`	中风不透明度
`lineCap`	`String`	`'round'`	一个字符串，用于定义要在笔划结束时使用的形状。
`lineJoin`	`String`	`'round'`	一个字符串，用于定义要在笔触的角上使用的形状。
`dashArray`	`String`	`null`	用于定义笔触虚线图案的字符串。`Canvas`在某些旧浏览器中不适用于动态图层。
`dashOffset`	`String`	`null`	一个字符串，用于定义到破折号模式的距离以启动破折号。`Canvas`在某些旧浏览器中不适用于动态图层。
`fill`	`Boolean`	`depends`	是否用颜色填充路径。将其设置`false`为禁用填充多边形或圆形。
`fillColor`	`String`	`*`	填色。默认为`color`选项的值
`fillOpacity`	`Number`	`0.2`	填充不透明度。
`fillRule`	`String`	`'evenodd'`	一个字符串，用于定义如何确定形状的内部。
`bubblingMouseEvents`	`Boolean`	`true`	何时`true`，此路径上的鼠标事件将在地图上触发相同的事件（除非`BM.DomEvent.stopPropagation`使用）。
`renderer`	`Renderer`		将此特定实例`Renderer`用于此路径。优先于地图的默认渲染器。
`className`	`String`	`null`	在元素上设置自定义类名。仅适用于SVG渲染器。

▶从交互层继承的选项

配置	类型	默认	描述
`interactive`	`Boolean`	`true`	如果`false`，图层不会发出鼠标事件，并将作为底层地图的一部分。

▶继承自Layer的选项

配置	类型	默认	描述
`pane`	`String`	`'overlayPane'`	默认情况下，图层将添加到地图的叠加窗格中。覆盖此选项将导致默认情况下将图层放置在另一个窗格上。
`attribution`	`String`	`null`	要在归属控件中显示的字符串，描述图层数据，例如“©Mapbox”。

活动

▶从交互层继承的鼠标事件

事件	数据	描述
`click`	`MouseEvent`	用户单击（或点击）图层时触发。
`dblclick`	`MouseEvent`	当用户双击（或双击）图层时触发。
`mousedown`	`MouseEvent`	当用户在图层上按下鼠标按钮时触发。
`mouseup`	`MouseEvent`	当用户释放在图层上按下的鼠标按钮时触发。
`mouseover`	`MouseEvent`	鼠标进入图层时触发。
`mouseout`	`MouseEvent`	当鼠标离开图层时触发。
`contextmenu`	`MouseEvent`	当用户右键单击图层时触发，防止默认浏览器上下文菜单显示此事件是否有侦听器。当用户持续一次触摸（也称为长按）时，也会在手机上触发。

▶从Layer继承的事件

事件	数据	描述
`add`	`Event`	将图层添加到地图后触发
`remove`	`Event`	从地图中删除图层后触发

▶从Layer继承的弹出事件

事件	数据	描述
`popupopen`	`PopupEvent`	打开绑定到此图层的弹出窗口时触发
`popupclose`	`PopupEvent`	绑定到此图层的弹出窗口关闭时触发

▶从Layer继承的工具提示事件

事件	数据	描述
`tooltipopen`	`TooltipEvent`	打开绑定到此图层的工具提示时触发。
`tooltipclose`	`TooltipEvent`	绑定到此图层的工具提示关闭时触发。

方法

方法	返回	描述
`toGeoJSON()`	`Object`	返回一个 `GeoJSON`多边形的表示（作为GeoJSON `Polygon`或`MultiPolygon`Feature）。

▶从Polyline继承的方法

方法	返回	描述
`getLatLngs()`	`LatLng[]`	返回路径中的点数组，或者在多折线的情况下返回嵌套的点数组。
`setLatLngs( <LatLng[]> latlngs)`	`this`	用给定的地理点数组替换折线中的所有点。
`isEmpty()`	`Boolean`	`true`如果折线没有LatLng，则返回。
`closestLayerPoint()`	`Point`	返回最接近`p`折线的点。
`getCenter()`	`LatLng`	返回折线的中心（质心）。
`getBounds()`	`LatLngBounds`	返回`LatLngBounds`路径。
`addLatLng( <LatLng> latlng)`	`this`	将一个给定点添加到折线。默认情况下，在多折线的情况下添加到折线的第一个环，但可以通过将特定环作为LatLng数组（您可以在之前访问`getLatLngs`）来覆盖。

▶从Path继承的方法

方法	返回	描述
`redraw()`	`this`	重绘图层。更改路径使用的坐标后，有时很有用。
`setStyle( <Path options> style)`	`this`	根据`Path options`对象中的选项更改Path的外观。
`bringToFront()`	`this`	将图层置于所有路径图层的顶部。
`bringToBack()`	`this`	将图层置于所有路径图层的底部。

▶从Layer继承的方法

方法	返回	描述
`addTo( <Map\|LayerGroup> map)`	`this`	将图层添加到给定的地图或图层组。
`remove()`	`this`	从当前处于活动状态的地图中删除图层。
`removeFrom( <Map> map)`	`this`	从给定的地图中删除图层
`getPane( <String> name?)`	`HTMLElement`	返回`HTMLElement`表示地图上命名窗格的内容。如果`name`省略，则返回此图层的窗格。
`getAttribution()`	`String`	由the使用`attribution control`，返回归属选项。

▶从Layer继承的Popup方法

方法	返回	描述
`bindPopup( <String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	使用传递`content`将弹出窗口绑定到图层，并设置必要的事件侦听器。如果a `Function`被传递，它将接收图层作为第一个参数，并应返回一个`String`或`HTMLElement`。
`unbindPopup()`	`this`	删除以前绑定的弹出窗口`bindPopup`。
`openPopup( <LatLng> latlng?)`	`this`	`latlng`如果未`latlng`传递，则在指定或默认弹出锚点处打开绑定弹出窗口。
`closePopup()`	`this`	如果已打开，则关闭绑定到此图层的弹出窗口。
`togglePopup()`	`this`	打开或关闭绑定到此图层的弹出窗口，具体取决于其当前状态。
`isPopupOpen()`	`boolean`	返回`true`如果绑定到该层的弹出当前处于打开状态。
`setPopupContent( <String\|HTMLElement\|Popup> content)`	`this`	设置绑定到此图层的弹出窗口的内容。
`getPopup()`	`Popup`	返回绑定到此图层的弹出窗口。

▶继承自Layer的工具提示方法

方法	返回	描述
`bindTooltip( <String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	使用传递`content`将工具提示绑定到图层并设置必要的事件侦听器。如果a `Function`被传递，它将接收图层作为第一个参数，并应返回一个`String`或`HTMLElement`。
`unbindTooltip()`	`this`	删除以前绑定的工具提示`bindTooltip`。
`openTooltip( <LatLng> latlng?)`	`this`	`latlng`如果未`latlng`传递，则在指定或默认工具提示锚点处打开绑定工具提示。
`closeTooltip()`	`this`	如果已打开，则关闭绑定到此图层的工具提示。
`toggleTooltip()`	`this`	打开或关闭绑定到此图层的工具提示，具体取决于其当前状态。
`isTooltipOpen()`	`boolean`	返回`true`绑定到此图层的工具提示当前是否打开。
`setTooltipContent( <String\|HTMLElement\|Tooltip> content)`	`this`	设置绑定到此图层的工具提示的内容。
`getTooltip()`	`Tooltip`	返回绑定到此图层的工具提示。

▶从Evented继承的方法

方法	返回	描述
`on( <String> type, <Function> fn, <Object> context?)`	`this`	将侦听器函数（`fn`）添加到对象的特定事件类型。您可以选择指定侦听器的上下文（this关键字指向的对象）。您还可以传递多个以空格分隔的类型（例如`'click dblclick'`）。
`on( <Object> eventMap)`	`this`	添加一组类型/侦听器对，例如 `{click: onClick, mousemove: onMouseMove}`
`off( <String> type, <Function> fn?, <Object> context?)`	`this`	删除以前添加的侦听器功能。如果未指定任何函数，它将从对象中删除该特定事件的所有侦听器。请注意，如果您将自定义上下文传递给`on`，则必须传递相同的上下文`off`才能删除侦听器。
`off( <Object> eventMap)`	`this`	删除一组类型/侦听器对。
`off()`	`this`	删除对象上所有事件的所有侦听器。
`fire( <String> type, <Object> data?, <Boolean> propagate?)`	`this`	触发指定类型的事件。您可以选择提供数据对象 - 侦听器函数的第一个参数将包含其属性。该事件可以选择性地传播给事件父母。
`listens( <String> type)`	`Boolean`	返回`true`如果一个特定的事件类型有附带任何听众。
`once(…)`	`this`	表现为`on(…)`，除了监听器只会被触发一次然后被删除。
`addEventParent( <Evented> obj)`	`this`	添加事件父级 - `Evented`将接收传播事件的事件
`removeEventParent( <Evented> obj)`	`this`	删除事件父级，因此它将停止接收传播的事件
`addEventListener(…)`	`this`	别名来 `on(…)`
`removeEventListener(…)`	`this`	别名来 `off(…)`
`clearAllEventListeners(…)`	`this`	别名来 `off()`
`addOneTimeEventListener(…)`	`this`	别名来 `once(…)`
`fireEvent(…)`	`this`	别名来 `fire(…)`
`hasEventListeners(…)`	`Boolean`	别名来 `listens(…)`

长方形

用于在地图上绘制矩形叠加层的类。延伸Polygon。

用法示例

// define rectangle geographical bounds
var bounds = [[54.559322, -5.767822], [56.1210604, -3.021240]];
// create an orange rectangle
BM.rectangle(bounds, {color: "#ff7800", weight: 1}).addTo(map);
// zoom the map to the rectangle bounds
map.fitBounds(bounds);

创建

厂	描述
`BM.rectangle( <LatLngBounds> latLngBounds, <Polyline options> options?)`

选项

▶从Polyline继承的选项

配置	类型	默认	描述
`smoothFactor`	`Number`	`1.0`	在每个缩放级别上简化折线的程度。更多意味着更好的性能和更流畅的外观，更少意味着更准确的表示。
`noClip`	`Boolean`	`false`	禁用折线剪裁。

▶继承自Path的选项

配置	类型	默认	描述
`stroke`	`Boolean`	`true`	是否沿路径绘制笔划。将其设置`false`为禁用多边形或圆形的边框。
`color`	`String`	`'#3388ff'`	中风颜色
`weight`	`Number`	`3`	笔画宽度（以像素为单位）
`opacity`	`Number`	`1.0`	中风不透明度
`lineCap`	`String`	`'round'`	一个字符串，用于定义要在笔划结束时使用的形状。
`lineJoin`	`String`	`'round'`	一个字符串，用于定义要在笔触的角上使用的形状。
`dashArray`	`String`	`null`	用于定义笔触虚线图案的字符串。`Canvas`在某些旧浏览器中不适用于动态图层。
`dashOffset`	`String`	`null`	一个字符串，用于定义到破折号模式的距离以启动破折号。`Canvas`在某些旧浏览器中不适用于动态图层。
`fill`	`Boolean`	`depends`	是否用颜色填充路径。将其设置`false`为禁用填充多边形或圆形。
`fillColor`	`String`	`*`	填色。默认为`color`选项的值
`fillOpacity`	`Number`	`0.2`	填充不透明度。
`fillRule`	`String`	`'evenodd'`	一个字符串，用于定义如何确定形状的内部。
`bubblingMouseEvents`	`Boolean`	`true`	何时`true`，此路径上的鼠标事件将在地图上触发相同的事件（除非`BM.DomEvent.stopPropagation`使用）。
`renderer`	`Renderer`		将此特定实例`Renderer`用于此路径。优先于地图的默认渲染器。
`className`	`String`	`null`	在元素上设置自定义类名。仅适用于SVG渲染器。

▶从交互层继承的选项

配置	类型	默认	描述
`interactive`	`Boolean`	`true`	如果`false`，图层不会发出鼠标事件，并将作为底层地图的一部分。

▶继承自Layer的选项

配置	类型	默认	描述
`pane`	`String`	`'overlayPane'`	默认情况下，图层将添加到地图的叠加窗格中。覆盖此选项将导致默认情况下将图层放置在另一个窗格上。
`attribution`	`String`	`null`	要在归属控件中显示的字符串，描述图层数据，例如“©Mapbox”。

活动

▶从交互层继承的鼠标事件

事件	数据	描述
`click`	`MouseEvent`	用户单击（或点击）图层时触发。
`dblclick`	`MouseEvent`	当用户双击（或双击）图层时触发。
`mousedown`	`MouseEvent`	当用户在图层上按下鼠标按钮时触发。
`mouseup`	`MouseEvent`	当用户释放在图层上按下的鼠标按钮时触发。
`mouseover`	`MouseEvent`	鼠标进入图层时触发。
`mouseout`	`MouseEvent`	当鼠标离开图层时触发。
`contextmenu`	`MouseEvent`	当用户右键单击图层时触发，防止默认浏览器上下文菜单显示此事件是否有侦听器。当用户持续一次触摸（也称为长按）时，也会在手机上触发。

▶从Layer继承的事件

事件	数据	描述
`add`	`Event`	将图层添加到地图后触发
`remove`	`Event`	从地图中删除图层后触发

▶从Layer继承的弹出事件

事件	数据	描述
`popupopen`	`PopupEvent`	打开绑定到此图层的弹出窗口时触发
`popupclose`	`PopupEvent`	绑定到此图层的弹出窗口关闭时触发

▶从Layer继承的工具提示事件

事件	数据	描述
`tooltipopen`	`TooltipEvent`	打开绑定到此图层的工具提示时触发。
`tooltipclose`	`TooltipEvent`	绑定到此图层的工具提示关闭时触发。

方法

方法	返回	描述
`setBounds( <LatLngBounds> latLngBounds)`	`this`	使用传递的边界重绘矩形。

▶从Polygon继承的方法

方法	返回	描述
`toGeoJSON()`	`Object`	返回一个 `GeoJSON`多边形的表示（作为GeoJSON `Polygon`或`MultiPolygon`Feature）。

▶从Polyline继承的方法

方法	返回	描述
`getLatLngs()`	`LatLng[]`	返回路径中的点数组，或者在多折线的情况下返回嵌套的点数组。
`setLatLngs( <LatLng[]> latlngs)`	`this`	用给定的地理点数组替换折线中的所有点。
`isEmpty()`	`Boolean`	`true`如果折线没有LatLng，则返回。
`closestLayerPoint()`	`Point`	返回最接近`p`折线的点。
`getCenter()`	`LatLng`	返回折线的中心（质心）。
`getBounds()`	`LatLngBounds`	返回`LatLngBounds`路径。
`addLatLng( <LatLng> latlng)`	`this`	将一个给定点添加到折线。默认情况下，在多折线的情况下添加到折线的第一个环，但可以通过将特定环作为LatLng数组（您可以在之前访问`getLatLngs`）来覆盖。

▶从Path继承的方法

方法	返回	描述
`redraw()`	`this`	重绘图层。更改路径使用的坐标后，有时很有用。
`setStyle( <Path options> style)`	`this`	根据`Path options`对象中的选项更改Path的外观。
`bringToFront()`	`this`	将图层置于所有路径图层的顶部。
`bringToBack()`	`this`	将图层置于所有路径图层的底部。

▶从Layer继承的方法

方法	返回	描述
`addTo( <Map\|LayerGroup> map)`	`this`	将图层添加到给定的地图或图层组。
`remove()`	`this`	从当前处于活动状态的地图中删除图层。
`removeFrom( <Map> map)`	`this`	从给定的地图中删除图层
`getPane( <String> name?)`	`HTMLElement`	返回`HTMLElement`表示地图上命名窗格的内容。如果`name`省略，则返回此图层的窗格。
`getAttribution()`	`String`	由the使用`attribution control`，返回归属选项。

▶从Layer继承的Popup方法

方法	返回	描述
`bindPopup( <String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	使用传递`content`将弹出窗口绑定到图层，并设置必要的事件侦听器。如果a `Function`被传递，它将接收图层作为第一个参数，并应返回一个`String`或`HTMLElement`。
`unbindPopup()`	`this`	删除以前绑定的弹出窗口`bindPopup`。
`openPopup( <LatLng> latlng?)`	`this`	`latlng`如果未`latlng`传递，则在指定或默认弹出锚点处打开绑定弹出窗口。
`closePopup()`	`this`	如果已打开，则关闭绑定到此图层的弹出窗口。
`togglePopup()`	`this`	打开或关闭绑定到此图层的弹出窗口，具体取决于其当前状态。
`isPopupOpen()`	`boolean`	返回`true`如果绑定到该层的弹出当前处于打开状态。
`setPopupContent( <String\|HTMLElement\|Popup> content)`	`this`	设置绑定到此图层的弹出窗口的内容。
`getPopup()`	`Popup`	返回绑定到此图层的弹出窗口。

▶继承自Layer的工具提示方法

方法	返回	描述
`bindTooltip( <String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	使用传递`content`将工具提示绑定到图层并设置必要的事件侦听器。如果a `Function`被传递，它将接收图层作为第一个参数，并应返回一个`String`或`HTMLElement`。
`unbindTooltip()`	`this`	删除以前绑定的工具提示`bindTooltip`。
`openTooltip( <LatLng> latlng?)`	`this`	`latlng`如果未`latlng`传递，则在指定或默认工具提示锚点处打开绑定工具提示。
`closeTooltip()`	`this`	如果已打开，则关闭绑定到此图层的工具提示。
`toggleTooltip()`	`this`	打开或关闭绑定到此图层的工具提示，具体取决于其当前状态。
`isTooltipOpen()`	`boolean`	返回`true`绑定到此图层的工具提示当前是否打开。
`setTooltipContent( <String\|HTMLElement\|Tooltip> content)`	`this`	设置绑定到此图层的工具提示的内容。
`getTooltip()`	`Tooltip`	返回绑定到此图层的工具提示。

▶从Evented继承的方法

方法	返回	描述
`on( <String> type, <Function> fn, <Object> context?)`	`this`	将侦听器函数（`fn`）添加到对象的特定事件类型。您可以选择指定侦听器的上下文（this关键字指向的对象）。您还可以传递多个以空格分隔的类型（例如`'click dblclick'`）。
`on( <Object> eventMap)`	`this`	添加一组类型/侦听器对，例如 `{click: onClick, mousemove: onMouseMove}`
`off( <String> type, <Function> fn?, <Object> context?)`	`this`	删除以前添加的侦听器功能。如果未指定任何函数，它将从对象中删除该特定事件的所有侦听器。请注意，如果您将自定义上下文传递给`on`，则必须传递相同的上下文`off`才能删除侦听器。
`off( <Object> eventMap)`	`this`	删除一组类型/侦听器对。
`off()`	`this`	删除对象上所有事件的所有侦听器。
`fire( <String> type, <Object> data?, <Boolean> propagate?)`	`this`	触发指定类型的事件。您可以选择提供数据对象 - 侦听器函数的第一个参数将包含其属性。该事件可以选择性地传播给事件父母。
`listens( <String> type)`	`Boolean`	返回`true`如果一个特定的事件类型有附带任何听众。
`once(…)`	`this`	表现为`on(…)`，除了监听器只会被触发一次然后被删除。
`addEventParent( <Evented> obj)`	`this`	添加事件父级 - `Evented`将接收传播事件的事件
`removeEventParent( <Evented> obj)`	`this`	删除事件父级，因此它将停止接收传播的事件
`addEventListener(…)`	`this`	别名来 `on(…)`
`removeEventListener(…)`	`this`	别名来 `off(…)`
`clearAllEventListeners(…)`	`this`	别名来 `off()`
`addOneTimeEventListener(…)`	`this`	别名来 `once(…)`
`fireEvent(…)`	`this`	别名来 `fire(…)`
`hasEventListeners(…)`	`Boolean`	别名来 `listens(…)`

圈

用于在地图上绘制圆形叠加层的类。延伸CircleMarker。这是一个近似值，并开始偏离靠近极点的真实圆（由于投影失真）。

用法示例

BM.circle([50.5, 30.5], {radius: 200}).addTo(map);

创建

厂	描述
`BM.circle( <LatLng> latlng, <Circle options> options?)`	实例化给定地理点的圆对象，以及包含圆半径的选项对象。
`BM.circle( <LatLng> latlng, <Number> radius, <Circle options> options?)`	实例化圆圈的过时方式，与0.7.x代码兼容。不要在新的应用程序或插件中使用。

选项

配置	类型	默认	描述
`radius`	`Number`		圆的半径，以米为单位。

▶继承自Path的选项

配置	类型	默认	描述
`stroke`	`Boolean`	`true`	是否沿路径绘制笔划。将其设置`false`为禁用多边形或圆形的边框。
`color`	`String`	`'#3388ff'`	中风颜色
`weight`	`Number`	`3`	笔画宽度（以像素为单位）
`opacity`	`Number`	`1.0`	中风不透明度
`lineCap`	`String`	`'round'`	一个字符串，用于定义要在笔划结束时使用的形状。
`lineJoin`	`String`	`'round'`	一个字符串，用于定义要在笔触的角上使用的形状。
`dashArray`	`String`	`null`	用于定义笔触虚线图案的字符串。`Canvas`在某些旧浏览器中不适用于动态图层。
`dashOffset`	`String`	`null`	一个字符串，用于定义到破折号模式的距离以启动破折号。`Canvas`在某些旧浏览器中不适用于动态图层。
`fill`	`Boolean`	`depends`	是否用颜色填充路径。将其设置`false`为禁用填充多边形或圆形。
`fillColor`	`String`	`*`	填色。默认为`color`选项的值
`fillOpacity`	`Number`	`0.2`	填充不透明度。
`fillRule`	`String`	`'evenodd'`	一个字符串，用于定义如何确定形状的内部。
`bubblingMouseEvents`	`Boolean`	`true`	何时`true`，此路径上的鼠标事件将在地图上触发相同的事件（除非`BM.DomEvent.stopPropagation`使用）。
`renderer`	`Renderer`		将此特定实例`Renderer`用于此路径。优先于地图的默认渲染器。
`className`	`String`	`null`	在元素上设置自定义类名。仅适用于SVG渲染器。

▶从交互层继承的选项

配置	类型	默认	描述
`interactive`	`Boolean`	`true`	如果`false`，图层不会发出鼠标事件，并将作为底层地图的一部分。

▶继承自Layer的选项

配置	类型	默认	描述
`pane`	`String`	`'overlayPane'`	默认情况下，图层将添加到地图的叠加窗格中。覆盖此选项将导致默认情况下将图层放置在另一个窗格上。
`attribution`	`String`	`null`	要在归属控件中显示的字符串，描述图层数据，例如“©Mapbox”。

活动

▶从交互层继承的鼠标事件

事件	数据	描述
`click`	`MouseEvent`	用户单击（或点击）图层时触发。
`dblclick`	`MouseEvent`	当用户双击（或双击）图层时触发。
`mousedown`	`MouseEvent`	当用户在图层上按下鼠标按钮时触发。
`mouseup`	`MouseEvent`	当用户释放在图层上按下的鼠标按钮时触发。
`mouseover`	`MouseEvent`	鼠标进入图层时触发。
`mouseout`	`MouseEvent`	当鼠标离开图层时触发。
`contextmenu`	`MouseEvent`	当用户右键单击图层时触发，防止默认浏览器上下文菜单显示此事件是否有侦听器。当用户持续一次触摸（也称为长按）时，也会在手机上触发。

▶从Layer继承的事件

事件	数据	描述
`add`	`Event`	将图层添加到地图后触发
`remove`	`Event`	从地图中删除图层后触发

▶从Layer继承的弹出事件

事件	数据	描述
`popupopen`	`PopupEvent`	打开绑定到此图层的弹出窗口时触发
`popupclose`	`PopupEvent`	绑定到此图层的弹出窗口关闭时触发

▶从Layer继承的工具提示事件

事件

用法示例 示例

创建

选项

控制选项

交互选项

映射状态选项

动画选项

平移惯性选项

键盘导航选项

鼠标滚轮选项

触摸互动选项

活动

图层事件

映射状态更改事件

弹出事件

工具提示事件

位置活动

互动活动

其他方法

方法

层和控件方法

地图状态修改

地理定位方法

其它方法

获取地图状态方法

转换方法

属性

处理程序

地图窗格

找到选项

缩放选项

平移选项

缩放/平移选项

FitBounds选项

标记

用法示例

创建

选项

活动

拖动事件

方法

属性

交互处理程序

弹出

用法示例

创建

选项

活动

方法

提示

用法示例

创建

选项

活动

方法

TileLayer

用法示例

网址模板

创建

扩展方法

选项

活动

方法

扩展方法

TileLayer.WMS

用法示例

创建

选项

活动

方法

ImageOverlay

用法示例

创建

选项

活动

方法

VideoOverlay

用法示例

创建

选项

用法示例示例