MapContext – 第 3 页 – 微信小程序开发指南

MapContext.getRegion(Object object)

基础库 1.4.0 开始支持，低版本需做兼容处理。

以 Promise 风格调用：不支持

微信小程序插件：支持

微信鸿蒙 OS 版：支持

相关文档: map

功能描述

获取当前地图的视野范围

参数

Object object

属性	类型	必填	说明
success	function	否	接口调用成功的回调函数
fail	function	否	接口调用失败的回调函数
complete	function	否	接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数

Object res

属性

类型

说明

southwest

Object

西南角经纬度

	结构属性	类型	说明
	longitude	number	经度
	latitude	number	纬度

northeast

Object

东北角经纬度

	结构属性	类型	说明
	longitude	number	经度
	latitude	number	纬度

获取地图中心位置

以 Promise 风格调用：不支持

微信小程序插件：支持

相关文档: map

功能描述

获取当前地图中心的经纬度。返回的是 gcj02 坐标系，可以用于 wx.openLocation()

参数

Object object

属性	类型	必填	说明
iconPath	string	否	图标路径，支持网络路径、本地路径、代码包路径
success	function	否	接口调用成功的回调函数
fail	function	否	接口调用失败的回调函数
complete	function	否	接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数

Object res

属性	类型	说明
longitude	number	经度
latitude	number	纬度

MapContext.fromScreenLocation(Object object)

基础库 2.14.0 开始支持，低版本需做兼容处理。

以 Promise 风格调用：不支持

微信小程序插件：支持

相关文档: map

功能描述

获取屏幕上的点对应的经纬度，坐标原点为地图左上角。

参数

Object object

属性	类型	必填	说明
x	Number	是	x 坐标值
y	Number	是	y 坐标值
success	function	否	接口调用成功的回调函数
fail	function	否	接口调用失败的回调函数
complete	function	否	接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数

Object res

属性	类型	说明
latitude	number	纬度
longitude	number	经度

MapContext.executeVisualLayerCommand(Object object)

基础库 2.26.0 开始支持，低版本需做兼容处理。

以 Promise 风格调用：不支持

微信小程序插件：支持

微信鸿蒙 OS 版：支持

相关文档: map

功能描述

执行可视化图层指令，结合 MapContext.on('visualLayerEvent') 监听事件使用。

参数

Object object

属性	类型	必填	说明
layerId	string	是	可视化图层id
command	string	是	图层指令
success	function	否	接口调用成功的回调函数
fail	function	否	接口调用失败的回调函数
complete	function	否	接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数

Object res

属性	类型	说明
errMsg	string	调用结果
data	string	SDK 返回的 JSON 数据

MapContext.eraseLines(Object object)

基础库 2.5.0 开始支持，低版本需做兼容处理。

以 Promise 风格调用：不支持

微信小程序插件：支持

微信鸿蒙 OS 版：支持

相关文档: map

功能描述

擦除或置灰已添加到地图中的线段。

参数

Object object

属性类型默认值必填说明

lines Array.<Object> 是要擦除的线段数组。详见 polyline 属性。

结构属性

类型

默认值

必填

说明

number

是

线段的 id。

index

number

是

指定线段的某一段，线段起点 index 为 0

point

Object

是

指定线段某一段中的点

	结构属性	类型	默认值	必填	说明
	longitude	number		是	经度
	latitude	number		是	纬度

clear

boolean

true

否

为 true 时擦除，false 时置灰

success function 否接口调用成功的回调函数

fail function 否接口调用失败的回调函数

complete function 否接口调用结束的回调函数（调用成功、失败都会执行）

MapContext.addVisualLayer(Object object)

基础库 2.20.1 开始支持，低版本需做兼容处理。

以 Promise 风格调用：不支持

微信小程序插件：支持

微信鸿蒙 OS 版：支持

相关文档: map

功能描述

添加可视化图层。需要刷新时，interval 可设置的最小值为 15 s。

参数

Object object

属性	类型	默认值	必填	说明
layerId	String		是	可视化图层id（创建图层指引)
interval	Number	0	否	刷新周期，单位秒
zIndex	Number	1	否	图层绘制顺序
opacity	Number	1	否	图层透明度
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

MapContext.addMarkers(Object object)

基础库 2.13.0 开始支持，低版本需做兼容处理。

以 Promise 风格调用：不支持

微信小程序插件：支持

微信鸿蒙 OS 版：支持

相关文档: map

功能描述

添加 marker。

参数

Object object

属性	类型	默认值	必填	说明
markers	Array		是	同传入 map 组件的 marker 属性
clear	boolean	false	否	是否先清空地图上所有 marker
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

MapContext.addGroundOverlay(Object object)

基础库 2.14.0 开始支持，低版本需做兼容处理。

以 Promise 风格调用：不支持

微信小程序插件：支持

微信鸿蒙 OS 版：支持

相关文档: map

功能描述

创建自定义图片图层，图片会随着地图缩放而缩放。

参数

Object object

属性

类型

默认值

必填

说明

Number

是

图片图层 id

src

String

是

图片路径，支持网络图片、临时路径、代码包路径

bounds

Object

是

图片覆盖的经纬度范围

结构属性

类型

默认值

必填

说明

southwest

Object

是

西南角经纬度

	结构属性	类型	默认值	必填	说明
	longitude	number		是	经度
	latitude	number		是	纬度

northeast

Object

是

东北角经纬度

	结构属性	类型	默认值	必填	说明
	longitude	number		是	经度
	latitude	number		是	纬度

visible

Boolean

true

否

是否可见

zIndex

Number

否

图层绘制顺序

opacity

Number

否

图层透明度

success

function

否

接口调用成功的回调函数

fail

function

否

接口调用失败的回调函数

complete

function

否

接口调用结束的回调函数（调用成功、失败都会执行）

MapContext.addCustomLayer(Object object)

基础库 2.12.0 开始支持，低版本需做兼容处理。

以 Promise 风格调用：不支持

微信小程序插件：支持

相关文档: map

功能描述

添加个性化图层。图层创建参考文档

参数

Object object

属性	类型	必填	说明
layerId	string	是	个性化图层id
success	function	否	接口调用成功的回调函数
fail	function	否	接口调用失败的回调函数
complete	function	否	接口调用结束的回调函数（调用成功、失败都会执行）

MapContext.addArc(Object object)

基础库 2.22.0 开始支持，低版本需做兼容处理。

以 Promise 风格调用：不支持

微信小程序插件：支持

微信鸿蒙 OS 版：支持

相关文档: map

功能描述

添加弧线，途经点与夹角必须设置一个。途经点必须在起终点有效坐标范围内，否则不能生成正确的弧线，同时设置夹角角度时，以夹角角度为准。夹角定义为起点到终点，与起点外切线逆时针旋转的角度。工具侧暂未支持。

参数

Object object

属性

类型

默认值

必填

说明

number

是

圆弧 id

start

Object

是

起始点

	结构属性	类型	默认值	必填	说明
	longitude	number		是	经度
	latitude	number		是	纬度

end

Object

是

终点

	结构属性	类型	默认值	必填	说明
	longitude	number		是	经度
	latitude	number		是	纬度

pass

Object

否

途经点

	结构属性	类型	默认值	必填	说明
	longitude	number		是	经度
	latitude	number		是	纬度

angle

number

否

夹角角度

width

number

否

线宽

color

number

#000000

否

线的颜色

success

function

否

接口调用成功的回调函数

fail

function

否

接口调用失败的回调函数

complete

function

否

接口调用结束的回调函数（调用成功、失败都会执行）