Appearance
flyTo(options)
参数
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| options.curve | 随着飞行路径出现的缩放“曲线”,通常 1.42 能满足绝大部分场景,1 为圆周运动 | Number | Number | 1.42 |
| options.minZoom | 位于飞行路径顶点的以 0 为起点的缩放级别。如果指定了 options.curve 可忽略这一选项。 | Number | Number | - |
| options.speed | 与 options.curve 相关的动态转换的平均速率。速率为 1.2 指,地图每秒以 1.2 倍于 options.curve 可见整屏(screenful)的速度随着飞行路径移动。 screenful 指地图的可见屏幕跨度区域。它不对应固定的物理距离,而是随缩放级别变化。 | Number | Number | 1.2 |
| options.screenSpeed | 线性时间曲线情况下,动态转换的平均速率,按照每秒的移动的 screenful 数量计算。 如果指定了 options.speed 则忽略该选项。 | Number | Number | - |
| options.maxDuration | 动效的最长持续时间,单位为微秒。如果持续时间超过此最大值,会重置为 0。 | Number | Number | - |
javascript
map.flyTo({ center: [0, 0], zoom: 9 })
// 使用flyTo 参数
map.flyTo({
center: [0, 0],
zoom: 9,
speed: 0.2,
curve: 1,
})getBounds()
返回地图的地理边界。当 bearing 或 pitch 非零, 可视区域不是轴对齐的矩形,结果是包含可视区域的最小边界。
getMaxBounds()
返回地图限制的最大地理边界,如果没有设置,则返回null 。
setMaxBounds(bounds)
设置或清除地图的地理边界。
平移和缩放都必须在这些范围内进行。如果平移或缩放的位置超出了范围,系统将按操作者的请求,选择范围内最接近的一个点或缩放级别显示。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| bounds | 设置最大边界。如果提供值为 null 或 undefined ,函数将移除地图的最大边界。 | LngLatBounds|null|undefined | LngLatBounds |null|undefined | - |
setMinZoom(minZoom)
设置或清除地图的最小缩放等级。如果地图现在的缩放等级低于新的最小值,地图将缩放到新的最小值。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| minZoom | 设置最小缩放等级(0-24)。如果提供值为 null 或 undefined ,函数将移除当前的最小缩放值(即设置为 0)。 | number|null|undefined | number|null|undefined | - |
getMinZoom()
返回地图允许的最小缩放级别。
setMaxZoom()
设置或清除地图的最大缩放等级。如果地图现在的缩放等级高于新的最大值,则地图将缩放到新的最大值。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| maxZoom | 设置最大缩放等级。如果提供值为 null 或 undefined ,函数将移除当前的最大缩放值(设置为 22)。 | number|null|undefined | number|null|undefined | - |
getRenderWorldCopies()
返回 renderWorldCopies 的状态。
setRenderWorldCopies()
设置 renderWorldCopies 的状态。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| renderWorldCopies | 如果为 true ,地图缩小时将渲染多个全局地图的副本。 undefined 被视为 true , null 被视为 false 。 | boolean | boolean | - |
getMaxZoom()
返回地图允许的最大缩放级别。
project(lnglat)
返回一个表示像素坐标的 Point,相对于地图的container,与指定的地理位置相对应。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| lnglat | 投影的地理学坐标。 | LngLatLike | LngLatLike | - |
unproject(point)
返回一个 LngLat,代表与指定像素坐标对应的地理坐标。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| point | 未投影的像素坐标。 | PointLike | PointLike | - |
isMoving()
如果地图由于摄像机动画或用户手势而平移、缩放、旋转或俯仰,则返回 true。
isZooming()
如果地图因摄像机动画或用户手势而缩放,则返回 true。
isRotating()
如果地图由于摄像机动画或用户手势而旋转,则返回 true。
on(type, layerId, listener)
为发生在特定样式图层要素上的特定事件添加监听器。 具体事件可见 Map Event。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| type | mouseenter 和 mouseover 当光标从地图画布外部进入指定图层的可视区域时被触发。 mouseleave 和 mouseout 当光标离开地图画布或指定图层的可视区域时被触发。 | string | 'mousedown','mouseup','click','dblclick','mousemove','mouseenter','mouseleave','mouseover','mouseout','contextmenu','touchstart','touchend',或'touchcancel' | - |
| layerId | 样式层的 ID。只有事件发生在图层可见要素上时才会触发监听器。事件将会得到一组包含匹配要素的 features 属性。 | string | string | |
| listener | 事件被触发时调用的函数。 | Function | Function |
on(type, listener)
为特定类型的事件添加监听器。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| type | 添加监听器的事件类型。 | string | string | - |
| listener | 使用传递给 fire 的数据对象调用监听函数,并使用 target 和 type 属性进行扩展。 | Function | Function | - |
off(type, listener)
移除先前用Map#on添加的事件监听器。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| type | 之前用来安装监听器的事件类型。 | string | string | - |
| listener | 之前安装的监听器函数。 | Function | Function | - |
off(type, layerId, listener)
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| type | 之前用来安装监听器的事件类型。 | string | string | - |
| layerId | 之前用来安装监听器的图层 ID。 | string | string | - |
| listener | 之前安装的监听器函数。 | Function | Function | - |
queryRenderedFeatures(geometry? ,options?)
返回一个 GeoJSON Feature objects 数组,这些对象表示满足查询参数的可见要素。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| geometry | 查询区域的几何形状: 单个的点或者是一个通过西南角和东北角的点界定的边界框。 省略该参数 (即,调用 Map#queryRenderedFeatures 使用零参数或仅使用 options 参数)相当于传递包含整个地图视区的边界框。 | (PointLike|Array<PointLike>)? | (PointLike|Array<PointLike>)? | - |
| options.layers | 要检查的查询的样式图层 id 数组。只返回这些图层中的要素。如果该参数未定义,将检查所有图层。 | Array<string>? | Array<string>? | - |
| options.filter | filter 限制查询结果。 | Array? | Array? | - |
| options.validate | 检查 [options.filter] 是否符合 EhhSdk Style Specification。禁用校验是一种性能优化,只有在您之前校验了将要传递给该函数的值之后,才应该使用这种优化。 | boolean | boolean | - |
javascript
// 查找一个点的所有要素
var features = map.queryRenderedFeatures([20, 35], {
layers: ['my-layer-name'],
})
// 查找一个静态边界盒子里的所有要素
var features = map.queryRenderedFeatures(
[
[10, 20],
[30, 50],
],
{ layers: ['my-layer-name'] }
)
// 查找一个点周围边界盒子里的所有要素
var width = 10
var height = 20
var features = map.queryRenderedFeatures(
[
[point.x - width / 2, point.y - height / 2],
[point.x + width / 2, point.y + height / 2],
],
{ layers: ['my-layer-name'] }
)
// 查询单个图层的所有渲染的要素
var features = map.queryRenderedFeatures({ layers: ['my-layer-name'] })querySourceFeature(sourceId, parameters?)
返回一个 GeoJSON Feature objects 数组,这些对象表示满足查询参数的指定矢量切片或 GeoJSON 数据源中的要素。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| sourceId | 查询矢量切片或 GeoJSON 数据源的 ID。 | string | string | - |
| parameters.sourceLayer | 查询矢量切片的图层的名称。 对于矢量切片数据源来说,该参数是必须的。 对于 GeoJSON 数据源则无需设置。 | string | string | - |
| parameters.filter | filter 限制查询结果。 | Array? | Array? | - |
| parameters.validate | 检查 [options.filter] 是否符合 EhhSdk Style Specification。禁用校验是一种性能优化,只有在您之前校验了将要传递给该函数的值之后,才应该使用这种优化。 | boolean | boolean | true |
setStyle(style, options?)
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| style | JSON 对象遵从在 EhhGisSDK 地图 样式说明描述的模式或者指向一个这样 JSON 的 URL。 | StyleSpecification|string|null | StyleSpecification|string|null | - |
| options.diff | 如果为 false,则强制执行“完整”更新,删除当前样式并构建给定的样式,而不是尝试基于差异的更新。 | boolean | boolean | - |
| options.localIdeographFontFamily | 定义一个 CSS 字体系列,用于在'CJK Unified Ideographs', 'Hiragana', 'Katakana' 和 'Hangul Syllables' 范围内本地覆盖字形的生成。在这些范围内,除了字体权重关键字(light/regular/medium/bold)之外,地图样式的字体设置将被忽略。设置为 false false,为这些字形范围启用地图样式中的字体设置。强制执行完整的更新。 | string | string | 'sans-serif' |
getstyle()
返回地图的样式对象,它能被用于重建地图样式。
isStyleLoaded()
返回一个布尔值来指示地图样式是否完全加载。
addSource(id, source)
为地图的样式添加数据源。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| id | 添加数据源的 ID。不能和存在的数据源冲突 | string | string | - |
| source | 数据源对象,遵从样式说明的 数据源定义 或 CanvasSourceOptions。 | Object | Object | - |
isSourceLoaded(id)
返回一个表示数据源是否加载成功的布尔值。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| id | 待检查数据源的 ID。 | string | string | - |
areTilesLoaded()
返回一个布尔值,表示来自样式中所有数据源的全部地图切片是否加载。
removeSource(id)
从地图样式中移除数据源。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| id | 待移除的数据源 ID。 | string | string | - |
getSource(id)
返回地图样式中指定 ID 的数据源。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| id | 待获取的数据源 ID。 | string | string | - |
setData(Features)
设置指定数据源数据 map.getSource(数据源名称).setData( { "type": "FeatureCollection", "features": [{ "type": "Feature", "properties": {}, "geometry": { "type": "Point", "coordinates": [经度,纬度] } },{ "type": "Feature", "properties": {}, "geometry": { "type": "Point", "coordinates": [经度,纬度] } }] } )
addImage(id, image, options)
给样式添加图像。图像可用于 icon-image, background-pattern, fill-pattern,和 line-pattern。 一个 Map#error 事件会被触发如果 sprite 中没有足够的空间用于添加此图像。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| id | 图像的 ID。 | string | string | - |
| image | 格式为 HTMLImageElement , ImageData 的图像,或具有 width , height ,和 data 的属性的对象,其格式都是 ImageData 。 | HTMLImageElement | ImageData | {width: number, height: number, data:(Uint8Array|Uint8ClampedArray)}| StyleImageInterface | HTMLImageElement | ImageData |{width: number, height: number, data:(Uint8Array| Uint8ClampedArray)}| StyleImageInterface | - |
| options.pixelRatio | 图像像素与屏幕真实像素的比例。 | any | any | - |
| options.sdf | 图像是否应该被解析为 SDF 图像。 | any | any | - |
updateImage(id, image)
更新一个已经存在的样式图像。此图像可以被用在 icon-image, background-pattern,fill-pattern,和 line-pattern。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| id | 图像的 ID。 | string | string | - |
| image | 格式为 HTMLImageElement , ImageData 的图像,或具有 width , height ,和 data 的属性的对象,其格式都是 ImageData 。 | HTMLImageElement | ImageData | {width: number, height: number, data:(Uint8Array|Uint8ClampedArray)}| StyleImageInterface | HTMLImageElement | ImageData |{width: number, height: number, data:(Uint8Array| Uint8ClampedArray)}| StyleImageInterface | - |
hasImage(id)
定义该图像是否已经被添加。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| id | 图像的 ID。 | string | string | - |
removeImage(id)
从样式中移除图像(例如 icon-image 或 background-pattern使用的图像)。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| id | 图像的 ID。 | string | string | - |
loadImage(url, callback)
使用 Map#addImage 从外部 URL 载入图像。外部域 必须支持 CORS。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| url | 图像的 URL。图像的格式必须为 png, webp 或者 jpg 。 | string | string | - |
| callback | 形式为 callback(error, data) 。 当图像成功载入或出现错误异常时调用。 | Function | Function | - |
listImages()
返回一个字符串数组,里面包含了当前地图中能够获取的所有 sprites/图像的名称。
addLayer(layer, beforeId?)
添加一个样式的图层到地图样式。
图层为来自特定数据源的数据定义样式。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| layer | 需要添加的样式图层,符合样式规范的 图层定义。 | Object | CustomLayerInterface | Object| CustomLayerInterface | - |
| beforeId | 用来插入新图层的现有图层 ID。 如果该参数(argument)被省略,该图层将会被添加到图层数组的末尾。 | string | string | - |
moveLayer(id, beforeId?)
将图层移动到另一个 z 轴位置(z-position)。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| id | 需要移动的图层 ID。 | string | string | - |
| beforeId | 用来插入新图层的现有图层 ID。 如果该参数(argument)被省略,该图层将会被添加到图层数组的末尾。 | string | string | - |
removeLayer(id)
从地图样式中移除指定 ID 的图层。
如果指定图层不存在,将会触发 error 事件。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| id | 需要移动的图层 ID。 | string | string | - |
getLayer(id)
返回地图样式中指定 ID 的图层。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| id | 需要获取的图层 ID。 | string | string | - |
setFilter(layerId, filter, options = {})
为指定样式图层设置筛选器。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| layerId | 需要应用筛选器的图层 ID。 | string | string | - |
| filter | 筛选器,需符合样式规范的 [筛选器定义] 。如果提供了 null 或 undefined ,函数会从图层中移除所有存在的筛选器。 | Array|null|undefined | Array|null|undefined | - |
| options.validate | 是否检查筛选器符合 EhhSdk 的样式定义。取消验证可以带来性能优化,但是应该只在之前已经检查过传入此函数的值时使用。 | boolean | boolean | true |
javascript
map.setFilter('my-layer', ['==', 'name', 'USA'])setLayerZoomRange(layerId, minzoom, maxzoom)
设置指定样式图层的缩放范围。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| layerId | 需要应用缩放范围的图层 ID。 | string | string | - |
| minzoom | 设置的最小缩放值(0-24)。 | number | number | - |
| maxzoom | 设置的最大缩放值(0-24)。 | number | number | - |
getFilter(layerId)
返回应用于指定样式图层的筛选器。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| layerId | 需要应用缩放范围的图层 ID。 | string | string | - |
setPaintProperty(layerId, name, value, options = {})
设置指定样式图层中 paint 属性的值。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| layerId | 需要设置 paint 渲染属性的图层 ID。 | string | string | - |
| name | 需要设置的 paint 渲染属性名称。 | string | string | - |
| value | 要设置的 paint 渲染属性值。 必须是一种符合 Style Specification 规定的属性类型。 | any | any | - |
| options.validate | 是否检查 value 符合 EhhSdk 样式规定。取消验证可以带来性能优化,但是应该只在之前已经检查过传入此函数的值时使用。 | boolean | boolean | true |
getPaintProperty(layerId, name)
返回指定样式图层中 paint 属性的值。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| layerId | 从中获取 paint 属性的图层的 ID。 | string | string | - |
| name | 需要获取的 paint 属性名称。 | string | string | - |
setLayoutProperty(layerId, name, value, options = {})
设置指定样式图层中布局属性的值。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| layerId | 需要在其中设置布局(layout)属性的图层 ID。 | string | string | - |
| name | 需要设置的布局属性名称。 | string | string | - |
| value | 布局属性的值。必须是一种符合 Style Specification 规定的属性类型。 | any | any | - |
| options.validate | 是否检查 value 符合 EhhSdk 样式规定。取消验证可以带来性能优化,但是应该只在之前已经检查过传入此函数的值时使用。 | boolean | boolean | true |
getLayoutProperty(layerId, name)
返回指定样式图层中布局属性的值。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| layerId | 从中获取布局属性的图层 ID。 | string | string | - |
| name | 需要获取的布局属性名称。 | string | string | - |
setLight(light, options = {})
设置光源(light)值的任意组合。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| light | 需要设置的光源属性。必须符合 Style Specification 定义。 | LightSpecification | LightSpecification | - |
| options.validate | 是否检查 value 符合 EhhSdk 样式规定。取消验证可以带来性能优化,但是应该只在之前已经检查过传入此函数的值时使用。 | boolean | boolean | true |
getLight()
返回光源对象的值
setFeatureState(feature, state)
设置要素的状态。状态 对象会与要素的现有状态合并。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| feature.id | 要素的唯一 ID 。 | string|number | string|number | - |
| feature.source | 用于要素的矢量数据源或者 GeoJSON 数据源的 ID 。 | string | string | - |
| feature.sourceLayer | (可选) 对于矢量切片数据源,sourceLayer 是必需的。 | string | string | - |
| state | 一个键值对集合。其中值应该是有效的 JSON 类型。此方法要求数据集中必须有 feature.id 属性。对于没有 feature ids 的 GeoJSON 数据源, 设置 generateIds 选项(在 GeoJSONSourceSpecification 中)以自动分配。 此选项根据数据源中要素的索引分配 IDs。 如果使用了 map.getSource('some id').setData(..)改变要素数据,则在重新应用状态时考虑更新的 id 值。 | Object | Object | - |
removeFeatureState(target, key)
移除要素状态,将其设置回默认行为。如果只有数据被指定,移除该数据源的所有状态。如果 target.id 也被指定,移除该要素状态的所有键。 如果键也被指定,从该要素状态中移除指定的键。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| target.id | (可选) 要素的唯一 ID 。在键没有被指定时可选。 | string|number | string|number | - |
| target.source | 用于要素的矢量数据源或 GeoJSON 数据源的 ID。 | string | string | - |
| target.sourceLayer | (可选) 对于矢量切片数据源,sourceLayer 是必需的。 | string | string | - |
getFeatureState(feature)
获取要素的状态。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| feature.id | 要素的唯一 ID。 | string|number | string|number | - |
| feature.source | 用于要素的矢量数据源或 GeoJSON 数据源的 ID。 | string | string | - |
| feature.sourceLayer | (可选) 对于矢量切片数据源,sourceLayer 是必需的。 | string | string | - |
getContainer()
返回地图的 HTML 嵌套元素。
getCanvasContainer()
返回包含地图 <canvas> 标签的 HTML 元素。
如果想给地图上添加非 EhhSdk 叠加图层,可以将其追加(append)在这一元素结尾。
该元素用于给地图交互性(如平移和缩放)进行事件绑定。它接受来自子元素 <canvas>, 但不接受来自地图控件的冒泡事件
getCanvas()
返回地图的 <canvas> 元素。
loaded()
返回一个表示地图是否载入完毕的布尔值。
返回 false 如果样式尚未完全载入,或者正在载入的数据源或样式的改动尚未完全载入。
remove()
清理并释放和地图相关的所有内部数据源。包括 DOM 元素,事件绑定,工作线程,和 WebGL 资源。当你使用完地图并希望不再占用浏览器资源时可以使用该方法。之后你将不能在地图上调用任何方法。
triggerRepaint()
触发一个显示框的渲染。使用自定义图层时,当图层发生改变,使用此方法去重渲染。 在下一个显示框渲染前多次调用此方法也只会渲染一次。
showTileBoundaries
获取并设置一个布尔值,用以表示地图是否会渲染切片边界。这些切片边界有助于查错。第一个矢量数据源的未压缩文件大小会被渲染到每一个切片的左上角,且在切片 ID 旁边。
showCollisionBoxes
获取并设置一个布尔值,指示地图是否会渲染数据源中所有符号周围的框,以及哪些符号已经被渲染,哪些因为冲突而被隐藏。这些信息有助于查错。
repiaint
获得并设置一个布尔值,用于指示地图是否将继续再渲染。该信息有助于分析效果。
getCenter()
返回地图的地理中心点
setCenter()
设置地图的地理中心点。等同于 jumpTo({center: center})。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| center | 需要设置的中心点。 | LngLatLike | LngLatLike | - |
| eventData | 该方法触发的事件对象需要添加的其它属性。 | Object | Object | - |
panBy(offset, options, eventData)
按指定偏移值平移地图。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| offset | x 和 y 坐标。用于平移地图 | PointLike | PointLike | - |
| options | - | AnimationOptions | AnimationOptions | - |
| eventData | 该方法触发的事件对象需要添加的其它属性。 | Object | Object | - |
panTo(lnglat, options, eventData)
用动画将地图平移到指定的位置。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| lnglat | 地图需要移动到的位置。 | LngLatLike | LngLatLike | - |
| options | - | AnimationOptions | AnimationOptions | - |
| eventData | 该方法触发的事件对象需要添加的其它属性。 | Object | Object | - |
getZoom()
返回地图当前的缩放级别。
setZoom()
设置地图的缩放级别。等同于 jumpTo({zoom: zoom})。
zoomTo(zoom, options, eventData)
以动态转换的方式将地图缩放到指定级别。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| zoom | 需要转换到的目标缩放级别。 | number | number | - |
| options | - | AnimationOptions | AnimationOptions | - |
| eventData | 该方法触发的事件对象需要添加的其它属性。 | Object | Object | - |
zoomIn(options, evenData)
将地图的缩放级别增加 1 级。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| options | - | AnimationOptions | AnimationOptions | - |
| eventData | 该方法触发的事件对象需要添加的其它属性。 | Object | Object | - |
zoomOut(options, eventData)
将地图的缩放级别降低 1 级。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| options | - | AnimationOptions | AnimationOptions | - |
| eventData | 该方法触发的事件对象需要添加的其它属性。 | Object | Object | - |
getBearing()
返回地图当前的方位角。方位角是指南针方向的指向,例如地图方位角为 90° 对应正东指向。
setBearing()
设置地图的方位角(旋转度)。方位角是指南针方向的指向,例如地图方位角为 90° 对应正东指向。
等同于 jumpTo({bearing: bearing})。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| bearing | 需要设置的方位角。 | number | number | - |
| eventData | 该方法触发的事件对象需要添加的其它属性。 | Object | Object | - |
rotateTo(bearing, options, eventData)
以动态转换的方式将地图旋转到指定方位角。方位角是指南针方向的指向,例如地图方位角为 90° 对应正东指向。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| bearing | 需要将地图旋转到的方位角。 | number | number | - |
| options | - | AnimationOptions | AnimationOptions | - |
| eventData | 该方法触发的事件对象需要添加的其它属性。 | Object | Object | - |
resetNorth(options, eventData)
以动态转换的方式将地图旋转到 0 度方位角(正北方)。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| options | - | AnimationOptions | AnimationOptions | - |
| eventData | 该方法触发的事件对象需要添加的其它属性。 | Object | Object | - |
resetNorthPitch(options, eventData)
以动态转换的方式将地图旋转到 0 度方位角(正北方)和 0 度倾斜角。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| options | - | AnimationOptions | AnimationOptions | - |
| eventData | 该方法触发的事件对象需要添加的其它属性。 | Object | Object | - |
snapToNorth(options, eventData)
前方位角足够接近 0 度时(也就是说位于 bearingSnap 域内时),将其自动调整到 0 度(正北方)。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| options | - | AnimationOptions | AnimationOptions | - |
| eventData | 该方法触发的事件对象需要添加的其它属性。 | Object | Object | - |
getPitch()
返回地图当前的倾斜度。
setPitch(pitch, eventData)
设置地图的倾斜度。等同于 jumpTo({pitch: pitch})。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| pitch | 需要设置的倾斜度,按照偏离屏幕水平面的度数计算(0-60)。 | number | number | - |
| eventData | 该方法触发的事件对象需要添加的其它属性。 | Object | Object | - |
cameraForBounds(bounds, options)
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| bounds | 将这些边界设在视口中心,使用最大的缩放级别和 Map#getMaxZoom() 使其适应该视口。 LatLngBounds 表示一个总是对齐坐标轴且方位角为 0 的范围。 | LatLngBoundsLike | LatLngBoundsLike | - |
| options.padding | 以给定边界添加的以像素为单位的填充量。 | number|padding|Options | number|padding|Options | - |
| options.offset | 给定边界中心到地图中心的偏移距离,以像素为单位。 | PointLike | PointLike | [0,0] |
| options.maxZoom | 地图视图转换到指定边界时允许的最大缩放级别。 | number | number | - |
javascript
var bbox = [
[-79, 43],
[-73, 45],
]
var newCameraTransform = map.cameraForBounds(bbox, {
padding: { top: 10, bottom: 25, left: 15, right: 5 },
})fitBounds(bounds, options, eventData)
在指定的地理边界内平移和缩放地图,以包含其可见区域。 当地图方位角不为 0 的时候,该函数会将方位角重置为 0。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| bounds | 将这些边界设在视口中心,使用最大的缩放级别和 Map#getMaxZoom() 使其适应该视口。 | LngLatBoundsLike | LngLatBoundsLike | - |
| options.padding | 以给定边界添加的以像素为单位的填充量。 | number|padding|Options | number|padding|Options | - |
| options.linear | 如果 true , 地图将使用 Map#easeTo。 如果 false , 地图将使用 Map#flyTo 进行转换。查看这些函数及 AnimationOptions 了解可用的选项信息。 | boolean | boolean | false |
| options.easing | 动态转换的缓冲函数。点击查看 AnimationOptions 。 | Function | Function | - |
| options.offset | 给定边界中心到地图中心的偏移距离,以像素为单位。 | PointLike | PointLike | [0,0] |
| options.maxZoom | 地图视图转换到指定边界时允许的最大缩放级别。 | number | number | - |
fitScreenCoordinates(p0, p1, bearing, options, eventData)
一旦地图旋转到指定方位角,就平移、旋转与缩放地图到由点 p0 与 p1 确定的限位框。 在不旋转下缩放,只需传入当前地图的方位角。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| p0 | 屏幕上第一个点,用像素坐标。 | PointLike | PointLike | - |
| p1 | 屏幕上第二个点,用像素坐标。 | PointLike | PointLike | - |
| bearing | 转换完成后期望的地图方位角,单位为度。 | number | number | - |
| options.padding | 以给定边界添加的以像素为单位的填充量。 | number|padding|Options | number|padding|Options | - |
| options.linear | 如果 true , 地图将使用 Map#easeTo。 如果 false , 地图将使用 Map#flyTo 进行转换。查看这些函数及 AnimationOptions 了解可用的选项信息。 | boolean | boolean | false |
| options.easing | 动态转换的缓冲函数。点击查看 AnimationOptions 。 | Function | Function | - |
| options.offset | 给定边界中心到地图中心的偏移距离,以像素为单位。 | PointLike | PointLike | [0,0] |
| options.maxZoom | 地图视图转换到指定边界时允许的最大缩放级别。 | number | number | - |
jumpTo(options, eventData)
不用动态转换的情况下改变中心点、 缩放级别、方位角和倾斜度的任意组合。地图将保留 options 没有指定的当前值。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| options | - | CameraOptions | CameraOptions | - |
| eventData | 该方法触发的事件对象需要添加的其它属性。 | Object | Object | - |
easeTo(options, eventData)
使用动态转换,将中心点、缩放级别、方位角和倾斜度组合的原有数值改为新数值。地图将保留 options 没有指定的当前值。
注意:转换将会瞬间触发如果用户的操作系统启用了 reduced motion 可访问特性。
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| options | 描述转换目标和动态效果的选项。 | any | CameraOptions 和 AnimationOptions 。 | - |
| eventData | 该方法触发的事件对象需要添加的其它属性。 | Object | Object | - |