leaflet-Map Methods-map方法 - 北京炫码科技有限公司

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

Methods for Layers and Controls

图层和控件的方法

Method 方法	Returns 返回	Description 描述
`addControl(<Control> control)`	`this`	将给定控件添加到地图
`removeControl(<Control> control)`	`this`	从地图中删除给定的控件
`addLayer(<Layer> layer)`	`this`	将给定图层添加到地图
`removeLayer(<Layer> layer)`	`this`	从地图中删除给定的图层。
`hasLayer(<Layer> layer)`	`Boolean`	如果给定图层当前已添加到地图，则返回 true
`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`	关闭作为参数给出的工具提示。

Methods for modifying map state

修改地图状态的方法

Method方法	Returns返回	Description描述
`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(<LatLngBounds> bounds)`	`this`	将地图视图限制在给定的范围内（请参阅 maxBounds 选项）。
`setMinZoom(<Number> zoom)`	`this`	设置可用缩放级别的下限（请参阅 minZoom 选项）。
`setMaxZoom(<Number> zoom)`	`this`	设置可用缩放级别的上限（请参阅 maxZoom 选项）。
`panInsideBounds(<LatLngBounds> bounds, <Pan options> options?)`	`this`	将地图平移到位于给定边界内的最近视图（如果还没有），使用特定选项控制动画（如果有）。
`panInside(<LatLng> latlng, <padding options> options?)`	`this`	将地图平移到最小量以使 latlng 可见。使用填充选项使显示适应更受限制的范围。如果 latlng 已经在（可选填充的）显示范围内，则不会平移地图。
`invalidateSize(<Zoom/pan options> options)`	`this`	检查地图容器大小是否发生变化并更新地图 – 在您动态更改地图大小后调用它，默认情况下也会为平移设置动画。如果 options.pan 为 false，则不会发生平移。如果 options.debounceMoveend 为 true，它会延迟 moveend 事件，这样即使连续多次调用该方法也不会经常发生。
`invalidateSize(<Boolean> animate)`	`this`	检查地图容器大小是否发生变化并更新地图 – 在您动态更改地图大小后调用它，默认情况下也会为平移设置动画。
`stop()`	`this`	停止当前正在运行的 panTo 或 flyTo 动画（如果有）。

Geolocation methods

地理定位方法

Method方法	Returns返回	Description描述
`locate(<Locate options> options?)`	`this`	尝试使用 Geolocation API 定位用户，触发 locationfound 事件，成功时使用位置数据，失败时触发 locationerror 事件，并可选择将地图视图设置为相对于检测精度的用户位置（如果地理定位失败，则设置为世界视图）。请注意，如果您的页面不使用 HTTPS，则此方法将在现代浏览器（Chrome 50 和更高版本）中失败，请参阅定位选项了解更多详细信息。
`stopLocate()`	`this`	如果使用 {setView: true} 调用了 map.locate，则停止查看之前由 map.locate({watch: true}) 启动的位置并中止重置地图视图。

Other Methods

Method方法	Returns返回	Description描述
`addHandler(<String> name, <Function> HandlerClass)`	`this`	Adds a new `Handler` to the map, given its name and constructor function.
`remove()`	`this`	销毁地图并清除所有相关的事件侦听器。
`createPane(<String> name, <HTMLElement> container?)`	`HTMLElement`	如果该名称尚不存在，则使用给定名称创建一个新的地图窗格，然后将其返回。该窗格创建为容器的子级，如果未设置，则创建为主地图窗格的子级。
`getPane(<String\|HTMLElement> pane)`	`HTMLElement`	根据名称或 HTML 元素（其标识）返回地图窗格。
`getPanes()`	`Object`	返回一个普通对象，其中包含所有窗格的名称作为键，窗格的名称作为值。
`getContainer()`	`HTMLElement`	返回包含映射的 HTML 元素。
`whenReady(<Function> fn, <Object> context?)`	`this`	当地图使用视图（居中和缩放）和至少一个图层进行初始化时，或者如果地图已初始化，则立即运行给定函数 fn，可以选择传递函数上下文。

Methods for Getting Map State

获取地图状态的方法

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

Conversion Methods

转换方法

Method	Returns	Description
`getZoomScale(<Number> toZoom, <Number> fromZoom)`	`Number`	返回要应用于从缩放级别从Zoom到ToZoom的地图过渡的比例因子。在内部用于帮助缩放动画。
`getScaleZoom(<Number> scale, <Number> fromZoom)`	`Number`	返回地图最终的缩放级别（如果地图处于“从Zoom”级别，并且所有内容都按比例因子缩放。与 getZoomScale 相反。
`project(<LatLng> latlng, <Number> zoom)`	`Point`	根据地图的 CRS 投影地理坐标 LatLng，然后根据缩放和 CRS 的变换对其进行缩放。结果是相对于 CRS 原点的像素坐标。
`unproject(<Point> point, <Number> zoom)`	`LatLng`	与项目相反。
`layerPointToLatLng(<Point> point)`	`LatLng`	给定相对于原点像素的像素坐标，返回相应的地理坐标（对于当前缩放级别）。
`latLngToLayerPoint(<LatLng> latlng)`	`Point`	给定地理坐标，返回相对于原点像素的相应像素坐标。
`wrapLatLng(<LatLng> latlng)`	`LatLng`	返回一个 LatLng，其中 lat 和 lng 已根据地图的 CRS 的 wrapLat 和 wrapLng 属性（如果它们超出 CRS 的边界）进行包装。默认情况下，这意味着经度环绕在日期变更线上，因此其值介于 -180 和 +180 度之间。
`wrapLatLngBounds(<LatLngBounds> bounds)`	`LatLngBounds`	返回与给定 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 对象，返回事件发生的地理坐标。

0 0 投票数

文章评分