本模块提供地图主要功能入口。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

起始版本：4.1.0(11)

导入模块

import { map } from '@kit.MapKit';

本模块提供以下类或接口，完成移动地图、添加覆盖物等功能。

名称	类型	说明
MapComponentController	MapComponentController	MapComponentController是地图服务的主要功能入口类，与地图有关的所有方法从此处接入。
BaseOverlay	BaseOverlay	覆盖物基础类，Marker、MapCircle、MapPolyline等覆盖物继承该基础类。
Marker	Marker	标记。
MapPolyline	MapPolyline	折线。
MapPolygon	MapPolygon	多边形，多边形可以是凸面或凹面，它可以跨越180子午线并且可以具有未填充的孔。
MapCircle	MapCircle	圆。
CameraUpdate	CameraUpdate	相机移动参数。
BasePriorityOverlay	BasePriorityOverlay	定义了支持优先级设置的覆盖物的基础类，PointAnnotation和Bubble继承该基础类。
PointAnnotation	PointAnnotation	地图上的点注释。
Bubble	Bubble	气泡。
Projection	Projection	用于在屏幕坐标和经纬度之间进行转换。
LatLngBoundsUtils	LatLngBoundsUtils	LatLngBounds工具类。
Animation	Animation	动画抽象类。
AlphaAnimation	AlphaAnimation	控制透明度的动画类。
RotateAnimation	RotateAnimation	控制旋转的动画类。
ScaleAnimation	ScaleAnimation	控制缩放的动画类。
TranslateAnimation	TranslateAnimation	控制移动的动画类。
FontSizeAnimation	FontSizeAnimation	控制字体大小的动画类。
PlayImageAnimation	PlayImageAnimation	播放多张图片的帧动画。
AnimationSet	AnimationSet	动画类的集合。
ClusterOverlay	ClusterOverlay	聚合图层。
ImageOverlay	ImageOverlay	图片覆盖物。
BuildingOverlay	BuildingOverlay	3D建筑物。
TraceOverlay	TraceOverlay	动态轨迹。
MapArc	MapArc	弧线。
SpatialRelationUtil	SpatialRelationUtil	点面关系计算工具类。
AnimateResult	AnimateResult	动画结果类。
MarkerDelegate	MarkerDelegate	标记代理。
MapEventManager	MapEventManager	地图监听事件管理器。
AnimationFillMode	AnimationFillMode	枚举类，动画执行完成后的状态。
AnimationRepeatMode	AnimationRepeatMode	枚举类，重复执行的模式。

本模块提供以下方法，支持重新设置地图状态、设置经纬度范围、放大缩小地图层级等功能。

名称	说明
newCameraPosition	给地图设置一个新的状态。
newLatLng	设置地图的中心点和缩放层级。
newLatLngBounds	设置地图经纬度范围；设置地图区域和边界之间的距离。
newLatLngBounds	设置地图经纬度范围；设置经纬度矩形范围的屏幕高宽；设置地图区域和边界之间的距离。
scrollBy	按像素移动地图中心点。
zoomBy	根据给定增量并以给定的屏幕像素点为中心点缩放地图级别。
zoomIn	放大地图缩放级别，在当前地图显示的级别基础上加1。
zoomOut	缩小地图缩放级别，在当前地图显示的级别基础上减1。
zoomTo	设置地图缩放级别。
calculateDistance	计算坐标点之间的距离。
convertCoordinate	坐标系转换。建议使用convertCoordinateSync。
convertCoordinateSync	坐标系转换。
rectifyCoordinate	坐标纠偏。

MapComponentController

地图的主要功能入口类，与地图有关的所有方法从此处接入。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

示例：

import { MapComponent, mapCommon, map } from '@kit.MapKit';
import { AsyncCallback } from '@kit.BasicServicesKit';

@Entry
@Component
struct HuaweiMapDemo {
  private TAG = "HuaweiMapDemo";
  private mapOptions?: mapCommon.MapOptions;
  private callback?: AsyncCallback<map.MapComponentController>;
  private mapController?: map.MapComponentController;
  private mapEventManager?: map.MapEventManager;

  aboutToAppear(): void {
    // 地图初始化参数，设置地图中心点坐标及层级
    this.mapOptions = {
      position: {
        target: {
          latitude: 39.9,
          longitude: 116.4
        },
        zoom: 10
      }
    };

    // 地图初始化的回调
    this.callback = async (err, mapController) => {
      if (!err) {
        // 获取地图的控制器类，用来操作地图
        this.mapController = mapController;
        // 返回地图组件的监听事件管理接口
        this.mapEventManager = this.mapController.getEventManager();
        let callback = () => {
          console.info(this.TAG, `on-mapLoad`);
        }
        this.mapEventManager.on("mapLoad", callback);

        // 执行自定义的方法
        this.customizedMethod();
      }
    };
  }

  // 自定义的方法
  private customizedMethod() {
    // ...
  }

  build() {
    Stack() {
      // 调用MapComponent组件初始化地图
      MapComponent({ mapOptions: this.mapOptions, mapCallback: this.callback })
        .width('100%')
        .height('100%')
    }.height('100%')
  }
}

MapComponentController中的方法需要放在上述示例的地图初始化的回调中运行或自定义的方法中运行。

[h2]animateCamera

animateCamera(update: CameraUpdate, duration?: number): void

在指定的持续时间内以动画的形式更新相机状态。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
update	CameraUpdate	是	相机状态将要发生的变化。
duration	number	否	动画的持续时间，单位：ms，默认值为250，取值范围：大于0，小于等于0按照默认值处理。

示例：

let target: mapCommon.LatLng = {
  latitude: 39.9,
  longitude: 116.4
};
let cameraPosition: mapCommon.CameraPosition = {
  target: target,
  zoom: 10
};
// 新建CameraUpdate对象
let cameraUpdate: map.CameraUpdate = map.newCameraPosition(cameraPosition);
// 在1000ms内以动画的形式移动相机
this.mapController.animateCamera(cameraUpdate, 1000);

[h2]animateCameraStatus

animateCameraStatus(update: CameraUpdate, duration?: number): Promise<AnimateResult>

在指定的持续时间内以动画的形式更新相机状态，并返回动画结果。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
update	CameraUpdate	是	相机状态将要发生的变化。
duration	number	否	动画的持续时间，单位：ms，默认值为250，取值范围：大于0，小于等于0按照默认值处理。

返回值：

类型	说明
Promise<AnimateResult>	Promise对象，返回AnimateResult。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.

示例：

let target: mapCommon.LatLng = {
  latitude: 39.9,
  longitude: 116.4
};
let cameraPosition: mapCommon.CameraPosition = {
  target: target,
  zoom: 10
};
// 新建CameraUpdate对象
let cameraUpdate: map.CameraUpdate = map.newCameraPosition(cameraPosition);
// 在1000ms内以动画的形式移动相机
let animateResult = await this.mapController.animateCameraStatus(cameraUpdate, 1000);

[h2]animateCameraWithMarker

animateCameraWithMarker(update: CameraUpdate, marker: Marker, duration: number): Promise<AnimateResult>

在指定的持续时间内以动画的形式更新相机状态，并更新指定的marker。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
update	CameraUpdate	是	相机状态将要发生的变化。
marker	Marker	是	标记。
duration	number	是	动画的持续时间，单位：ms，默认值为250，取值范围：大于0，小于等于0按照默认值处理。

返回值：

类型	说明
Promise<AnimateResult>	Promise对象，返回AnimateResult。

示例：

let target: mapCommon.LatLng = {
  latitude: 39.9,
  longitude: 116.4
};
let cameraPosition: mapCommon.CameraPosition = {
  target: target,
  zoom: 10
};
// 新建CameraUpdate对象
let cameraUpdate: map.CameraUpdate = map.newCameraPosition(cameraPosition);
// marker初始化参数
let markerOptions: mapCommon.MarkerOptions = {
  position: {
    latitude: 39.9,
    longitude: 116.4
  },
  title: "dhw",
  icon: 'icon/icon.png',
  clickable: true
};
// 新建marker
let marker = await this.mapController?.addMarker(markerOptions);
// 在1000ms内以动画的形式移动相机, 并更新指定的marker
await this.mapController.animateCameraWithMarker(cameraUpdate, marker, 1000);

[h2]animateCameraWithMarkers

animateCameraWithMarkers(update: CameraUpdate, markers: Array<Marker>, duration: number): Promise<AnimateResult>

在指定的持续时间内以动画的形式更新相机状态，并更新传入的marker，支持传一组标记。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
update	CameraUpdate	是	相机状态将要发生的变化。
markers	Array<Marker>	是	一组标记。说明：一组标记的位置必须相同，否则会返回401错误码。
duration	number	是	动画的持续时间，单位：ms，默认值为250，取值范围：大于0，小于等于0按照默认值处理。

返回值：

类型	说明
Promise<AnimateResult>	Promise对象，返回AnimateResult。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.

示例：

let target: mapCommon.LatLng = {
  latitude: 39.9,
  longitude: 116.4
};
let cameraPosition: mapCommon.CameraPosition = {
  target: target,
  zoom: 10
};
// 新建CameraUpdate对象
let cameraUpdate: map.CameraUpdate = map.newCameraPosition(cameraPosition);
// marker1初始化参数
let markerOptions1: mapCommon.MarkerOptions = {
  position: {
    latitude: 31.984410259206815,
    longitude: 118.76625379397866
  },
  title: "icon",
  icon: 'icon/icon.png',
  clickable: true
};
let markerOptions2: mapCommon.MarkerOptions = {
  position: {
    latitude: 31.984410259206815,
    longitude: 118.76625379397866
  },
  title: "avocado",
  icon: 'icon/avocado.png',
  clickable: true,
  anchorU: 0.5,
  anchorV: 1
};
let marker1 = await this.mapController?.addMarker(markerOptions1);
// marker2初始化参数
let marker2 = await this.mapController?.addMarker(markerOptions2);
// 在1000ms内以动画的形式移动相机, 并更新指定的marker
await this.mapController.animateCameraWithMarkers(cameraUpdate, [marker1, marker2], 1000);

[h2]stopAnimation

stopAnimation(): void

停止当前执行的改变地图状态的动画。调用该方法时，相机立即停止移动并保持在该位置。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

示例：

this.mapController.stopAnimation();

[h2]clear

clear(): void

移除地图上所有的圆、标记、折线等覆盖物。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

示例：

this.mapController.clear();

[h2]moveCamera

moveCamera(update: CameraUpdate): void

更新相机状态。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
update	CameraUpdate	是	相机状态将要发生的变化。

示例：

let target: mapCommon.LatLng = {
  latitude: 39.9,
  longitude: 116.4
};
let cameraPosition: mapCommon.CameraPosition = {
  target: target,
  zoom: 10
};
// 新建CameraUpdate对象
let cameraUpdate: map.CameraUpdate = map.newCameraPosition(cameraPosition);
// 移动相机
this.mapController.moveCamera(cameraUpdate);

[h2]getCameraPosition

getCameraPosition(): mapCommon.CameraPosition

获取相机的当前状态信息。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
mapCommon.CameraPosition	相机的当前状态信息。

示例：

let cameraPosition: mapCommon.CameraPosition = this.mapController.getCameraPosition();

[h2]setLatLngBounds

setLatLngBounds(bounds: mapCommon.LatLngBounds): void

指定一个mapCommon.LatLngBounds来约束相机目标，使用户移动地图时，相机目标不会移出此边界。当设置新的边界时，新边界将覆盖之前设置的边界。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
bounds	mapCommon.LatLngBounds	是	约束相机目标的边界。说明：西南角纬度大于东北角纬度时不生效。

示例：

let bounds:mapCommon.LatLngBounds = {
  northeast: {
    latitude: 31,
    longitude: 118
  },
  southwest: {
    latitude: 30,
    longitude: 117
  }
};
this.mapController.setLatLngBounds(bounds);

[h2]setPointToCenter

setPointToCenter(point: mapCommon.MapPoint): void

将屏幕上的像素位置设置为地图的中心点。使用此方法后，地图将根据设置的屏幕坐标进行缩放和旋转。异常值按无响应处理。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
point	mapCommon.MapPoint	是	屏幕坐标点。

示例：

let point: mapCommon.MapPoint = {
  positionX: 1000,
  positionY: 1000
};
this.mapController.setPointToCenter(point);

[h2]setMaxZoom

setMaxZoom(maxZoom: number): void

设置相机最大缩放级别。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
maxZoom	number	是	相机最大缩放级别，取值范围：[2, 20]。传入的值高于20，最大缩放级别会取20。传入的值小于2，最大缩放级别会取2。传入的值小于当前minZoom，最大缩放级别和最小缩放级别都会被设置为当前传入的值。

参数名

类型

必填

说明

maxZoom

number

是

相机最大缩放级别，取值范围：[2, 20]。

传入的值高于20，最大缩放级别会取20。

传入的值小于2，最大缩放级别会取2。

传入的值小于当前minZoom，最大缩放级别和最小缩放级别都会被设置为当前传入的值。

示例：

this.mapController.setMaxZoom(10);

[h2]setMinZoom

setMinZoom(minZoom: number): void

设置相机最小缩放级别。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
minZoom	number	是	相机最小缩放级别，取值范围：[2, 20]。传入的值高于20，最小缩放级别会取20。传入的值小于2，最小缩放级别会取2。传入的值大于当前maxZoom，最大缩放级别和最小缩放级别都会被设置为当前传入的值。

参数名

类型

必填

说明

minZoom

number

是

相机最小缩放级别，取值范围：[2, 20]。

传入的值高于20，最小缩放级别会取20。

传入的值小于2，最小缩放级别会取2。

传入的值大于当前maxZoom，最大缩放级别和最小缩放级别都会被设置为当前传入的值。

示例：

this.mapController.setMinZoom(3);

[h2]getMaxZoom

getMaxZoom(): number

获取相机最大缩放级别。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
number	相机最大缩放级别。

示例：

let maxZoom: number = this.mapController.getMaxZoom();

[h2]getMinZoom

getMinZoom(): number

获取相机最小缩放级别。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
number	相机最小缩放级别。

示例：

let minZoom: number = this.mapController.getMinZoom();

[h2]setTrafficEnabled

setTrafficEnabled(enabled: boolean): void

打开或关闭路况图层。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
enabled	boolean	是	true：打开路况图层 false：关闭路况图层默认值为false。

参数名

类型

必填

说明

enabled

boolean

是

true：打开路况图层
false：关闭路况图层

默认值为false。

示例：

this.mapController.setTrafficEnabled(true);

[h2]isTrafficEnabled

isTrafficEnabled(): boolean

获取路况图层开启状态。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
boolean	true：路况图层为开启状态 false：路况图层为关闭状态

示例：

let isTrafficEnabled: boolean = this.mapController.isTrafficEnabled();

[h2]setBuildingEnabled

setBuildingEnabled(enabled: boolean): void

打开或者关闭3D建筑图层。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
enabled	boolean	是	true：打开3D建筑图层 false：关闭3D建筑图层默认值为false。说明：打开3D建筑图层后将地图层级缩放至建筑物可视层，即可展现3D图层效果。

参数名

类型

必填

说明

enabled

boolean

是

true：打开3D建筑图层
false：关闭3D建筑图层

默认值为false。

说明：

打开3D建筑图层后将地图层级缩放至建筑物可视层，即可展现3D图层效果。

示例：

this.mapController.setBuildingEnabled(true);

[h2]isBuildingEnabled

isBuildingEnabled(): boolean

获取3D建筑图层开启状态。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
boolean	true：3D建筑图层为开启状态 false：3D建筑图层为关闭状态

示例：

let isBuildingEnabled: boolean = this.mapController.isBuildingEnabled();

[h2]setMyLocationEnabled

setMyLocationEnabled(myLocationEnabled: boolean): void

“我的位置”图层功能开关，默认使用系统的连续定位能力显示用户位置。开关打开后，“我的位置”按钮默认显示在地图的右下角。点击“我的位置”按钮，将会在屏幕中心显示当前定位，以蓝色圆点的形式呈现。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
myLocationEnabled	boolean	是	true：启用“我的位置”图层 false：禁用“我的位置”图层默认值为false。

参数名

类型

必填

说明

myLocationEnabled

boolean

是

true：启用“我的位置”图层
false：禁用“我的位置”图层

默认值为false。

示例：

this.mapController.setMyLocationEnabled(true);

[h2]setMyLocation

setMyLocation(location: geoLocationManager.Location): void

Map Kit默认使用系统的连续定位能力显示用户位置，如果您希望定制显示频率或者精准度，可以调用此接口设置“我的位置”坐标。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
location	geoLocationManager.Location	是	用户的位置。说明： location参数需使用WGS84坐标系。

示例：

// 需要引入@kit.LocationKit模块
import { geoLocationManager } from '@kit.LocationKit';

let location = await geoLocationManager.getCurrentLocation();
this.mapController.setMyLocation(location);

[h2]setMyLocationStyle

setMyLocationStyle(style: mapCommon.MyLocationStyle): Promise<void>

设置用户的位置样式。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
style	mapCommon.MyLocationStyle	是	用户的位置样式。说明：如果displayType使用FOLLOW_ROTATE需应用申请传感器权限：ohos.permission.ACCELEROMETER。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

let style: mapCommon.MyLocationStyle = { 
  anchorU: 0.5, 
  anchorV: 0.5, 
  radiusFillColor: 0xffff0000, 
  // icon为自定义图标资源，使用时需要替换，图标存放在resources/rawfile
  icon: 'icon/avocado.png'   
};
await this.mapController.setMyLocationStyle(style);

[h2]isMyLocationEnabled

isMyLocationEnabled(): boolean

获取“我的位置”图层的开启状态。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
boolean	“我的位置”图层的开启状态。 true：启用 false：禁用

类型

说明

boolean

“我的位置”图层的开启状态。

true：启用
false：禁用

示例：

let isMyLocationEnabled: boolean = this.mapController.isMyLocationEnabled();

[h2]setZoomGesturesEnabled

setZoomGesturesEnabled(enabled: boolean): void

设置是否启用缩放手势。默认情况下，缩放手势处于启用状态。

启用状态，用户可以使用以下手势缩放相机：
1. 单指双击可将缩放级别提高1（放大）层级，用双指单击可将缩放级别降低1（缩小）层级。
2. 双指张合，实现放大缩小。
3. 单指双击实现单指缩放，第二次点时按住，然后上划缩小，或下划放大。
禁用状态，缩放手势无效。此设置不影响缩放按钮，也不限制通过接口移动相机和相机动画。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
enabled	boolean	是	true：启用缩放手势 false：禁用缩放手势默认值为true。

参数名

类型

必填

说明

enabled

boolean

是

true：启用缩放手势
false：禁用缩放手势

默认值为true。

示例：

this.mapController.setZoomGesturesEnabled(true);

[h2]isZoomGesturesEnabled

isZoomGesturesEnabled(): boolean

获取缩放手势功能的启用状态。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
boolean	缩放手势功能的启用状态。 true：启用缩放手势 false：禁用缩放手势

类型

说明

boolean

缩放手势功能的启用状态。

true：启用缩放手势
false：禁用缩放手势

示例：

let isZoomGesturesEnabled: boolean = this.mapController.isZoomGesturesEnabled();

[h2]setScrollGesturesEnabled

setScrollGesturesEnabled(enabled: boolean): void

设置是否启用滚动手势。默认情况下，滚动手势处于启用状态。

启用状态，用户可以通过滑动来平移相机。
禁用状态，滑动无效。此设置不限制通过接口移动相机和相机动画。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
enabled	boolean	是	true：启用滚动手势 false：禁用滚动手势默认值为true。

参数名

类型

必填

说明

enabled

boolean

是

true：启用滚动手势
false：禁用滚动手势

默认值为true。

示例：

this.mapController.setScrollGesturesEnabled(true);

[h2]isScrollGesturesEnabled

isScrollGesturesEnabled(): boolean

获取滚动手势的启用状态。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
boolean	滚动手势的启用状态。 true：启用滚动手势 false：禁用滚动手势

类型

说明

boolean

滚动手势的启用状态。

true：启用滚动手势
false：禁用滚动手势

示例：

let isScrollGesturesEnabled: boolean = this.mapController.isScrollGesturesEnabled();

[h2]setRotateGesturesEnabled

setRotateGesturesEnabled(enabled: boolean): void

设置是否启用旋转手势，默认情况下，旋转手势处于启用状态。

启用状态，用户可以使用两指旋转手势旋转相机。
禁用状态，用户将无法通过手势旋转相机。此设置不限制用户点击指南针图标以重置相机方向，也不限制通过接口移动相机和相机动画。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
enabled	boolean	是	true：启用旋转手势 false：禁用旋转手势默认值为true。

参数名

类型

必填

说明

enabled

boolean

是

true：启用旋转手势
false：禁用旋转手势

默认值为true。

示例：

this.mapController.setRotateGesturesEnabled(true);

[h2]isRotateGesturesEnabled

isRotateGesturesEnabled(): boolean

获取旋转手势的启用状态。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
boolean	旋转手势的启用状态。 true：启用旋转手势 false：禁用旋转手势

类型

说明

boolean

旋转手势的启用状态。

true：启用旋转手势
false：禁用旋转手势

示例：

let isRotateGesturesEnabled: boolean = this.mapController.isRotateGesturesEnabled();

[h2]setTiltGesturesEnabled

setTiltGesturesEnabled(enabled: boolean): void

设置是否启用倾斜手势，默认情况下，倾斜手势处于启用状态。

启用状态，用户可以使用两指垂直向上滑动来倾斜相机。
禁用状态，用户无法通过手势来倾斜相机。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
enabled	boolean	是	true：启用倾斜手势 false：禁用倾斜手势默认值为true。

参数名

类型

必填

说明

enabled

boolean

是

true：启用倾斜手势
false：禁用倾斜手势

默认值为true。

示例：

this.mapController.setTiltGesturesEnabled(true);

[h2]isTiltGesturesEnabled

isTiltGesturesEnabled(): boolean

获取倾斜手势的启用状态。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
boolean	倾斜手势的启用状态。 true：启用倾斜手势 false：禁用倾斜手势

类型

说明

boolean

倾斜手势的启用状态。

true：启用倾斜手势
false：禁用倾斜手势

示例：

let isTiltGesturesEnabled: boolean = this.mapController.isTiltGesturesEnabled();

[h2]setZoomControlsEnabled

setZoomControlsEnabled(enabled: boolean): void

设置是否启用缩放控制器，默认情况下，缩放控件处于启用状态。

启用状态，地图上会出现一对按钮的缩放控件（用于缩放地图）。点击按钮时，会使相机放大（或缩小）一个缩放级别。
禁用状态，不会显示缩放控件。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
enabled	boolean	是	true：启用缩放控制器 false：禁用缩放控制器默认值为true。

参数名

类型

必填

说明

enabled

boolean

是

true：启用缩放控制器
false：禁用缩放控制器

默认值为true。

示例：

this.mapController.setZoomControlsEnabled(true);

[h2]isZoomControlsEnabled

isZoomControlsEnabled(): boolean

获取缩放控制器的启用状态。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
boolean	缩放控制器的启用状态。 true：启用缩放控制器 false：禁用缩放控制器

类型

说明

boolean

缩放控制器的启用状态。

true：启用缩放控制器
false：禁用缩放控制器

示例：

let isZoomControlsEnabled: boolean = this.mapController.isZoomControlsEnabled();

[h2]setMyLocationControlsEnabled

setMyLocationControlsEnabled(enabled: boolean): void

设置是否启用“我的位置”按钮。只显示按钮，在不开启“我的位置”图层功能的情况下，点击按钮没反应。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
enabled	boolean	是	true：启用“我的位置”按钮 false：禁用“我的位置”按钮默认值为false。

参数名

类型

必填

说明

enabled

boolean

是

true：启用“我的位置”按钮
false：禁用“我的位置”按钮

默认值为false。

示例：

this.mapController.setMyLocationControlsEnabled(true);

[h2]isMyLocationControlsEnabled

isMyLocationControlsEnabled(): boolean

获取“我的位置”按钮的启用状态。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
boolean	“我的位置”按钮的启用状态。 true：启用 false：禁用

类型

说明

boolean

“我的位置”按钮的启用状态。

true：启用
false：禁用

示例：

let isMyLocationControlsEnabled: boolean = this.mapController.isMyLocationControlsEnabled();

[h2]setScaleControlsEnabled

setScaleControlsEnabled(enabled: boolean): void

设置是否启用比例尺。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
enabled	boolean	是	true：启用比例尺 false：禁用比例尺默认值为false。

参数名

类型

必填

说明

enabled

boolean

是

true：启用比例尺
false：禁用比例尺

默认值为false。

示例：

this.mapController.setScaleControlsEnabled(true);

[h2]isScaleControlsEnabled

isScaleControlsEnabled(): boolean

获取比例尺的启用状态。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
boolean	比例尺的启用状态。 true：启用 false：禁用

类型

说明

boolean

比例尺的启用状态。

true：启用
false：禁用

示例：

let isScaleControlsEnabled: boolean = this.mapController.isScaleControlsEnabled();

[h2]setCompassControlsEnabled

setCompassControlsEnabled(enabled: boolean): void

设置是否启用指南针。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
enabled	boolean	是	true：启用指南针 false：禁用指南针默认值为true。

参数名

类型

必填

说明

enabled

boolean

是

true：启用指南针
false：禁用指南针

默认值为true。

示例：

this.mapController.setCompassControlsEnabled(true);

[h2]isCompassControlsEnabled

isCompassControlsEnabled(): boolean

获取指南针的启用状态。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
boolean	指南针的启用状态。 true：启用 false：禁用

类型

说明

boolean

指南针的启用状态。

true：启用
false：禁用

示例：

let isCompassControlsEnabled: boolean = this.mapController.isCompassControlsEnabled();

[h2]setGestureScaleByMapCenter

setGestureScaleByMapCenter(enabled: boolean): void

设置以固定屏幕中心点进行缩放功能是否可用，默认是禁用状态。

启用状态，地图将以传入的固定屏幕点进行缩放。通过setPointToCenter方法设置屏幕中心点坐标。
禁用状态，将以手指点击的位置为中心进行缩放。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
enabled	boolean	是	true：启用，地图将以传入的固定屏幕点进行缩放。 false：禁用，地图将以手指点击的位置为中心进行缩放。默认值为false。

参数名

类型

必填

说明

enabled

boolean

是

true：启用，地图将以传入的固定屏幕点进行缩放。
false：禁用，地图将以手指点击的位置为中心进行缩放。

默认值为false。

示例：

this.mapController.setGestureScaleByMapCenter(true);

[h2]isGestureScaleByMapCenter

isGestureScaleByMapCenter(): boolean

获取以固定屏幕中心点进行缩放功能的开启状态。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
boolean	以固定屏幕中心点进行缩放功能的开启状态。 true：启用 false：禁用

类型

说明

boolean

以固定屏幕中心点进行缩放功能的开启状态。

true：启用
false：禁用

示例：

let isGestureScaleByMapCenter: boolean = this.mapController.isGestureScaleByMapCenter();

[h2]setLogoAlignment

setLogoAlignment(alignment: mapCommon.LogoAlignment): void

设置地图Logo的对齐方式。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
alignment	mapCommon.LogoAlignment	是	地图Logo的对齐方式，默认值为LogoAlignment.BOTTOM_START。

示例：

this.mapController.setLogoAlignment(mapCommon.LogoAlignment.BOTTOM_START);

[h2]setLogoPadding

setLogoPadding(padding: mapCommon.Padding): void

设置地图边界与Logo之间的间距。Logo不随横竖屏而改变，大小固定不随地图缩放变化。

当您设置的任意padding值超出范围（例如：负值，或超出边界）时被认为非法，Logo位置不变化。
当Logo位置在左下角时left、bottom生效。
当Logo位置在右上角时right、top生效，以此类推。

在调整设置地图边界与Logo之间的间距时，请避免隐藏或遮盖Logo。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
padding	mapCommon.Padding	是	地图边界与Logo之间的间距。

示例：

let padding: mapCommon.Padding = {
  left: 0,
  bottom: 50
};
this.mapController.setLogoPadding(padding);

[h2]getScalePerPixel

getScalePerPixel(): number

获取当前缩放级别下，地图上1像素点对应的长度，单位：米。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
number	地图上1像素点对应的长度，单位：米。

示例：

let scalePerPixel: number = this.mapController.getScalePerPixel();

[h2]addMarker

addMarker(options: mapCommon.MarkerOptions): Promise<Marker>

在地图上添加一个标记。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
options	mapCommon.MarkerOptions	是	标记的属性设置。

返回值：

类型	说明
Promise<Marker>	Promise对象，返回Marker。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.
1002601001	The object to be operated does not exist.

示例：

// Marker初始化参数
let markerOptions: mapCommon.MarkerOptions = {
  position: {
    latitude: 39.9,
    longitude: 116.4
  },
  rotation: 0,
  visible: true,
  zIndex: 0,
  alpha: 1,
  anchorU: 0.5,
  anchorV: 1,
  clickable: true,
  draggable: true,
  flat: false,
  // 图标存放在resources/rawfile
  icon: 'test.png'
};
// 在地图上添加一个marker
let marker: map.Marker = await this.mapController.addMarker(markerOptions);

[h2]addCircle

addCircle(options: mapCommon.MapCircleOptions): Promise<MapCircle>

在地图上添加一个圆，指定圆心经纬度和圆的半径，用于表示某个位置的周边范围。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
options	mapCommon.MapCircleOptions	是	圆的属性设置。

返回值：

类型	说明
Promise<MapCircle>	Promise对象，返回MapCircle。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.
1002601001	The object to be operated does not exist.

示例：

// Circle初始化参数
let mapCircleOptions: mapCommon.MapCircleOptions = { 
  center: {
    latitude: 39.9,
    longitude: 116.4
  },
  patterns:[{ type: 0, length: 100 }, { type: 1, length: 100 }, { type: 2, length: 100 }],
  radius: 700,
  fillColor: 0XFF00FFFF,
  strokeColor: 0xFFFF0000,
  strokeWidth: 10,
  zIndex: 15
};
// 在地图上添加一个Circle
let mapCircle: map.MapCircle = await this.mapController.addCircle(mapCircleOptions);

[h2]addPolyline

addPolyline(options: mapCommon.MapPolylineOptions): Promise<MapPolyline>

在地图上添加一条折线。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
options	mapCommon.MapPolylineOptions	是	折线的属性设置。

返回值：

类型	说明
Promise<MapPolyline>	Promise对象，返回MapPolyline。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.
1002601001	The object to be operated does not exist.

示例：

// 初始化参数
let polylineOption: mapCommon.MapPolylineOptions = {
  // 折线坐标点，必传
  points: [{ latitude: 31.984410, longitude: 118.7662537 },
    { latitude: 31.084410, longitude: 118.0662537 }
  ],
  clickable: true,
  color: 0xff000000,
  startCap: mapCommon.CapStyle.BUTT,
  endCap: mapCommon.CapStyle.BUTT,
  geodesic: false,
  jointType: mapCommon.JointType.DEFAULT,
  visible: true,
  width: 10,
  zIndex: 0,
  gradient: false
};
// 在地图上添加一条折线
let mapPolyline: map.MapPolyline = await this.mapController.addPolyline(polylineOption);

[h2]addPolygon

addPolygon(options: mapCommon.MapPolygonOptions): Promise<MapPolygon>

在地图上添加一个多边形。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
options	mapCommon.MapPolygonOptions	是	多边形的属性设置。

返回值：

类型	说明
Promise<MapPolygon>	Promise对象，返回MapPolygon。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.
1002601001	The object to be operated does not exist.

示例：

// 初始化参数
let polygonOptions: mapCommon.MapPolygonOptions = {
  // 多边形坐标点，必传
  points: [{ latitude: 31.98441, longitude: 118.066253 },
    {latitude: 31.98441, longitude: 118.766253},
    { latitude: 32.98441, longitude: 118.766253 },
    { latitude: 32.98441, longitude: 118.066253 }
  ],
  clickable: true,
  fillColor: 0xff00DE00,
  geodesic: false,
  strokeColor: 0xff000000,
  jointType: mapCommon.JointType.DEFAULT,
  strokeWidth: 10,
  visible: true,
  zIndex: 10
};
// 在地图上添加一个多边形
let mapPolygon: map.MapPolygon = await this.mapController.addPolygon(polygonOptions);

[h2]addPointAnnotation

addPointAnnotation(params: mapCommon.PointAnnotationParams): Promise<PointAnnotation>

在地图上添加一个点注释。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
params	mapCommon.PointAnnotationParams	是	点注释的属性设置。

返回值：

类型	说明
Promise<PointAnnotation>	Promise对象，返回PointAnnotation。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.
1002601001	The object to be operated does not exist.

示例：

let pointAnnotationOptions: mapCommon.PointAnnotationParams = {
  // 定义点注释图标锚点
  position: {
    latitude: 39.918,
    longitude: 116.397
  },
  // 定义点注释名称与地图poi名称相同时，是否支持去重
  repeatable: true,
  // 定义点注释的碰撞规则
  collisionRule: mapCommon.CollisionRule.NAME,
  // 定义点注释的标题，数组长度最小为1，最大为3
  titles: [{
    // 定义标题内容
    content: "Title1",
    // 定义标题字体颜色
    color: 0xFF000000,
    // 定义标题字体大小
    fontSize: 15,
    // 定义标题描边颜色
    strokeColor: 0xFFFFFFFF,
    // 定义标题描边宽度
    strokeWidth: 2,
    // 定义标题字体样式
    fontStyle: mapCommon.FontStyle.ITALIC
  }],
  // 定义点注释的图标，图标存放在resources/rawfile
  icon: "icon/avocado.png",
  // 定义点注释是否展示图标
  showIcon: true,
  // 定义点注释的锚点在水平方向上的位置
  anchorU: 0.5,
  // 定义点注释的锚点在垂直方向上的位置
  anchorV: 1,
  // 定义点注释的显示属性，为true时，在被碰撞后仍能显示
  forceVisible: false,
  // 定义碰撞优先级，数值越大，优先级越低
  priority: 3,
  // 定义点注释展示的最小层级
  minZoom: 2,
  // 定义点注释展示的最大层级
  maxZoom: 20,
  // 定义点注释是否可见
  visible: true,
  // 定义点注释叠加层级属性
  zIndex: 10
};
let pointAnnotation: map.PointAnnotation = await this.mapController.addPointAnnotation(pointAnnotationOptions);

[h2]addBubble

addBubble(params: mapCommon.BubbleParams): Promise<Bubble>

在地图上添加气泡。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
params	mapCommon.BubbleParams	是	气泡的属性设置。

返回值：

类型	说明
Promise<Bubble>	Promise对象，返回Bubble。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.
1002601001	The object to be operated does not exist.

示例：

let bubbleOptions: mapCommon.BubbleParams = {
  // 气泡位置
  positions: [[{ latitude: 31, longitude: 118 }]],
  // 气泡图标，需要传4个方向的图标，图标存放在resources/rawfile
  icons: [
    'icon.png',
    'icon.png',
    'icon.png',
    'icon.png'
  ],
  // 定义气泡的显示属性，为true时，在被碰撞后仍能显示
  forceVisible: true,
  // 定义气泡碰撞优先级，数值越大，优先级越低
  priority: 3,
  // 定义气泡展示的最小层级
  minZoom: 2,
  // 定义气泡展示的最大层级
  maxZoom: 20,
  // 定义气泡是否可见
  visible: true,
  // 定义气泡叠加层级属性
  zIndex: 1
};
let bubble: map.Bubble = await this.mapController.addBubble(bubbleOptions);

[h2]setPadding

setPadding(padding?: mapCommon.Padding): void

设置地图和边界的距离来定义地图的可见区域。地图图层元素将适应填充，例如，缩放控件、指南针等将被移动到适应定义的区域，相机将相对于可见区域的中心移动。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
padding	mapCommon.Padding	否	地图和边界的距离，默认值为{ left: 0, right: 0, top: 0, bottom: 0 }。

示例：

// 初始化参数，左边距0，底边距50
let padding: mapCommon.Padding = {
  left: 0,
  bottom: 50
};
this.mapController.setPadding(padding);

[h2]getProjection

getProjection(): Projection

获取Projection对象，用于实现屏幕坐标和经纬度坐标之间的相互转换。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
Projection	Projection对象。

示例：

let projection: map.Projection = this.mapController.getProjection();

[h2]setCustomMapStyle

setCustomMapStyle(customMapStyleOptions: mapCommon.CustomMapStyleOptions): Promise<void>

将地图样式修改为自定义样式。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
customMapStyleOptions	mapCommon.CustomMapStyleOptions	是	自定义样式参数。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
1002601002	The custom map style file does not exist.
1002601004	The style content format is incorrect.

示例：

// styleId需要替换为您自己的样式ID，样式ID可在Petal Maps Studio平台上创建
let param: mapCommon.CustomMapStyleOptions = {
  styleId: "xxxxxxx"
};
await this.mapController.setCustomMapStyle(param);

[h2]getDayNightMode

getDayNightMode(): mapCommon.DayNightMode

查询地图的日间夜间模式。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

返回值：

类型	说明
mapCommon.DayNightMode	日间夜间模式。

示例：

let mode = this.mapController.getDayNightMode();

[h2]setDayNightMode

setDayNightMode(mode: mapCommon.DayNightMode): void

设置地图的日间夜间模式。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
mode	mapCommon.DayNightMode	是	日间夜间模式。

示例：

this.mapController.setDayNightMode(mapCommon.DayNightMode.AUTO);

[h2]getMapType

getMapType(): mapCommon.MapType

查询地图类型。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

返回值：

类型	说明
mapCommon.MapType	查询地图的类型。

示例：

let mapType = this.mapController.getMapType();

[h2]setMapType

setMapType(mapType: mapCommon.MapType): void

设置地图类型。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
mapType	mapCommon.MapType	是	地图类型。

示例：

this.mapController.setMapType(mapCommon.MapType.TERRAIN);

[h2]setScalePosition

setScalePosition(point: mapCommon.MapPoint): void

设置比例尺控件的位置。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
point	mapCommon.MapPoint	是	比例尺位置。

示例：

let point: mapCommon.MapPoint = {
  // 以当前地图组件左上角为原点，向右移动1000
  positionX: 1000,
  // 以当前地图组件左上角为原点，向下移动1000
  positionY: 1000
};
this.mapController.setScalePosition(point);

[h2]getScaleLevel

getScaleLevel(): number

查询当前层级的比例尺大小。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

返回值：

类型	说明
number	接口返回比例尺上的文本数字，单位：米。

示例：

let level = this.mapController.getScaleLevel();

[h2]setCompassPosition

setCompassPosition(point: mapCommon.MapPoint): void

设置指南针位置。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
point	mapCommon.MapPoint	是	设置指南针位置，即指南针左上角相对地图组件左上角的偏移量，单位：px。

示例：

let point: mapCommon.MapPoint = {
  positionX: 10,
  positionY: 10
};
this.mapController.setCompassPosition(point);

[h2]setAllGesturesEnabled

setAllGesturesEnabled(enabled: boolean): void

提供禁用所有手势的接口。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

enabled

boolean

是

true：启用手势
false：禁用手势

默认值为true。

示例：

this.mapController.setAllGesturesEnabled(true);

[h2]getScaleControlsHeight

getScaleControlsHeight(): number

获取比例尺控件的高度。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

返回值：

类型	说明
number	比例尺控件的高度，单位：vp。

示例：

let height = this.mapController.getScaleControlsHeight();

[h2]getScaleControlsWidth

getScaleControlsWidth(): number

获取比例尺控件的宽度。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

返回值：

类型	说明
number	比例尺控件的宽度，单位：vp。

示例：

let width = this.mapController.getScaleControlsWidth();

[h2]setAlwaysShowScaleEnabled

setAlwaysShowScaleEnabled(enabled: boolean): void

设置是否始终显示比例尺。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

enabled

boolean

是

true：始终显示
false：关闭始终显示，比例尺显示2秒后关闭

默认值为false。

示例：

this.mapController.setAlwaysShowScaleEnabled(true);

[h2]isAlwaysShowScaleEnabled

isAlwaysShowScaleEnabled(): boolean

返回是否始终显示比例尺。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

返回值：

类型	说明
boolean	true: 始终显示 false: 关闭始终显示

示例：

let scaleEnabled: boolean = this.mapController.isAlwaysShowScaleEnabled();

[h2]addClusterOverlay

addClusterOverlay(params: mapCommon.ClusterOverlayParams): Promise<ClusterOverlay>

新增聚合图层。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
params	mapCommon.ClusterOverlayParams	是	聚合图层参数。

返回值：

类型	说明
Promise<ClusterOverlay>	Promise对象，返回ClusterOverlay。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.
1002601001	The object to be operated does not exist.

示例：

let clusterItem1: mapCommon.ClusterItem = {
  position: {
    latitude: 31.98,
    longitude: 118.766
  }
};
let clusterItem2: mapCommon.ClusterItem = {
  position: {
    latitude: 31.68,
    longitude: 118.366
  }
};
let array: Array<mapCommon.ClusterItem> = [
  clusterItem1,
  clusterItem2
];
let clusterOverlayParams: mapCommon.ClusterOverlayParams = { distance: 40, clusterItems: array };
let clusterOverlay: map.ClusterOverlay = await this.mapController.addClusterOverlay(clusterOverlayParams);

[h2]addImageOverlay

addImageOverlay(params: mapCommon.ImageOverlayParams): Promise<ImageOverlay>

新增图片覆盖物。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
params	mapCommon.ImageOverlayParams	是	覆盖物参数。

返回值：

类型	说明
Promise<ImageOverlay>	Promise对象，返回ImageOverlay。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.
1002601001	The object to be operated does not exist.

示例：

let imageOverlayParams: mapCommon.ImageOverlayParams = {
  bounds: {
    southwest: { latitude: 32, longitude: 118 },
    northeast: { latitude: 32.4, longitude: 118.4 }
  },
  image: 'icon/icon.png',
  transparency: 0.3,
  zIndex: 101,
  anchorU: 0.5,
  anchorV: 0.5,
  clickable: true,
  visible: true,
  bearing: 0
};
let imageOverlay = await this.mapController?.addImageOverlay(imageOverlayParams);

[h2]snapshot

snapshot(): Promise<image.PixelMap>

生成地图快照。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

返回值：

类型	说明
Promise<image.PixelMap>	Promise对象，返回image.PixelMap。

示例：

import { image } from '@kit.ImageKit';

let image: image.PixelMap = await this.mapController.snapshot();

[h2]addBuildingOverlay

addBuildingOverlay(params: mapCommon.BuildingOverlayParams): Promise<BuildingOverlay>

添加3D建筑物。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
params	mapCommon.BuildingOverlayParams	是	3D建筑物相关属性。

返回值：

类型	说明
Promise<BuildingOverlay>	Promise对象，返回BuildingOverlay。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.
1002601001	The object to be operated does not exist.

示例：

let points: Array<mapCommon.LatLng> = [
  {
    latitude: 31.984794,
    longitude: 118.765865
  },
  {
    latitude: 31.98468,
    longitude: 118.766076
  },
  {
    latitude: 31.98472,
    longitude: 118.766116
  },
  {
    latitude: 31.98463,
    longitude: 118.766292
  },
  {
    latitude: 31.984586,
    longitude: 118.766251
  },
  {
    latitude: 31.984536,
    longitude: 118.766344
  },
  {
    latitude: 31.984633,
    longitude: 118.766446
  },
  {
    latitude: 31.9848,
    longitude: 118.766285
  },
  {
    latitude: 31.984925,
    longitude: 118.766312
  },
  {
    latitude: 31.985282,
    longitude: 118.766661
  },
  {
    latitude: 31.985438,
    longitude: 118.766419
  },
  {
    latitude: 31.985801,
    longitude: 118.766755
  },
  {
    latitude: 31.985856,
    longitude: 118.766504
  },
  {
    latitude: 31.985785,
    longitude: 118.766434
  },
  {
    latitude: 31.985821,
    longitude: 118.766278
  },
  {
    latitude: 31.985897,
    longitude: 118.766311
  },
  {
    latitude: 31.985944,
    longitude: 118.766095
  },
  {
    latitude: 31.985909,
    longitude: 118.766069
  },
  {
    latitude: 31.985794,
    longitude: 118.765989
  },
  {
    latitude: 31.9857,
    longitude: 118.766029
  },
  {
    latitude: 31.985658,
    longitude: 118.766164
  },
  {
    latitude: 31.985647,
    longitude: 118.766271
  },
  {
    latitude: 31.985574,
    longitude: 118.766297
  },
  {
    latitude: 31.985458,
    longitude: 118.766285
  },
  {
    latitude: 31.985271,
    longitude: 118.766002
  },
  {
    latitude: 31.985219,
    longitude: 118.766002
  },
  {
    latitude: 31.985135,
    longitude: 118.766029
  },
  {
    latitude: 31.985093,
    longitude: 118.766083
  },
  {
    latitude: 31.985019,
    longitude: 118.766109
  },
  {
    latitude: 31.984978,
    longitude: 118.766083
  },
  {
    latitude: 31.984794,
    longitude: 118.765865
  }
];
points.reverse();
// 3D建筑参数
let buildingOverlayOptions: mapCommon.BuildingOverlayParams =
  {
    // 3D建筑的范围参数（点为顺时针绘制）
    points: points,
    // 3D建筑的高度
    totalHeight: 51,
    // 3D建筑的选中楼层高度
    floorBottomHeight: 33,
    // 3D建筑的顶部颜色
    topFaceColor: 0xffa4b8f7,
    // 3D建筑的侧面颜色
    sideFaceColor: 0x44a4b8f7,
    // 3D建筑的选中楼层颜色
    floorColor: 0xff000000,
    // 3D建筑的展示层级
    showLevel: 14,
    // 3D建筑选中楼层从底部升起的动画时长
    animationDuration: 5000,
    // 3D建筑侧面的纹理
    sideTexture: { image: $r("app.media.side_tex"), height: 3, width: 3 },
    // 3D建筑选中楼层的纹理
    floorTexture: { image: $r("app.media.floor_tex"), height: 3, width: 3 }
  };
let cameraUpdate = map.newCameraPosition({
  target: {
    latitude: 31.984794,
    longitude: 118.765865
  },
  zoom: 18, tilt: 70
});
// 将地图镜头移动到3D建筑区域
this.mapController?.moveCamera(cameraUpdate);
// 新建3D建筑
let buildingOverlay: map.BuildingOverlay = await this.mapController?.addBuildingOverlay(buildingOverlayOptions);

[h2]addTraceOverlay

addTraceOverlay(params: mapCommon.TraceOverlayParams, markers?: Array<Marker>): Promise<TraceOverlay>

绘制动态轨迹，支持传一组标记，标记将和轨迹一起移动。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
params	mapCommon.TraceOverlayParams	是	动态轨迹参数。
markers	Array<Marker>	否	动态轨迹的图片数组。说明：一组标记的位置必须相同。

返回值：

类型	说明
Promise<TraceOverlay>	Promise对象，返回TraceOverlay。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.
1002601001	The object to be operated does not exist.

示例：

// marker1的参数
let markerOptions1: mapCommon.MarkerOptions = {
  position: {
    latitude: 31.99227173519985,
    longitude: 118.7622219990476
  },
  icon: $r("app.media.track_setting_sport_map_marker_22"),
  anchorU: 0.5,
  anchorV: 1,
  visible: true
};
// 新增marker1
let markerBoy1 = await this.mapController.addMarker(markerOptions1);
let boyImages1: map.PlayImageAnimation = new map.PlayImageAnimation();
boyImages1.setDuration(1000);
let resourceArray: Array<Resource> = new Array();
resourceArray.push($r("app.media.side_0"));
resourceArray.push($r("app.media.side_1"));
resourceArray.push($r("app.media.side_2"));
resourceArray.push($r("app.media.side_3"));
resourceArray.push($r("app.media.side_4"));
resourceArray.push($r("app.media.side_5"));
resourceArray.push($r("app.media.side_6"));
resourceArray.push($r("app.media.side_7"));
resourceArray.push($r("app.media.side_8"));
resourceArray.push($r("app.media.side_9"));
resourceArray.push($r("app.media.side_10"));
resourceArray.push($r("app.media.side_11"));
resourceArray.push($r("app.media.side_12"));
resourceArray.push($r("app.media.side_13"));
resourceArray.push($r("app.media.side_14"));
resourceArray.push($r("app.media.side_15"));
resourceArray.push($r("app.media.side_16"));
resourceArray.push($r("app.media.side_17"));
resourceArray.push($r("app.media.side_18"));
resourceArray.push($r("app.media.side_19"));
resourceArray.push($r("app.media.side_20"));
await boyImages1.addImages(resourceArray);
boyImages1.setRepeatCount(-1);

// marker1添加动画
markerBoy1.setAnimation(boyImages1);
markerBoy1.startAnimation();

// marker2的参数
let markerOptions2: mapCommon.MarkerOptions = {
  position: {
    latitude: 31.99227173519985,
    longitude: 118.7622219990476
  },
  icon: $r("app.media.track_setting_sport_map_marker_22"),
  anchorU: 0.5,
  anchorV: 1,
  visible: false
};
// 新增marker2
let markerBoy2 = await this.mapController.addMarker(markerOptions2);
let boyImages2: map.PlayImageAnimation = new map.PlayImageAnimation();
boyImages2.setDuration(1000);
let resourceArray2: Array<Resource> = new Array();
resourceArray2.push($r("app.media.behavior_front_cycling_boy_000"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_001"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_002"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_003"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_004"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_005"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_006"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_007"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_008"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_009"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_010"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_011"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_012"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_013"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_014"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_015"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_016"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_017"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_018"));
await boyImages2.addImages(resourceArray2);
boyImages2.setRepeatCount(-1);
// marker2添加动画
markerBoy2.setAnimation(boyImages2);
markerBoy2.startAnimation();

let points: Array<mapCommon.LatLng> = new Array();
points.push({ latitude: 31.99685233070878, longitude: 118.75846023442728 });
points.push({ latitude: 31.99671325810786, longitude: 118.75846738985165 });
points.push({ latitude: 31.99659191076709, longitude: 118.7585347621686 });
points.push({ latitude: 31.99648202537233, longitude: 118.7586266510386 });
points.push({ latitude: 31.99637707201552, longitude: 118.75872004590596 });
points.push({ latitude: 31.996278207010903, longitude: 118.75880449946251 });
points.push({ latitude: 31.996187481969695, longitude: 118.7588781960278 });
points.push({ latitude: 31.996092248919354, longitude: 118.75895330554488 });
points.push({ latitude: 31.995962740450565, longitude: 118.75904721407304 });
points.push({ latitude: 31.995792921394, longitude: 118.75916904998051 });
points.push({ latitude: 31.995601885713416, longitude: 118.7593235241019 });
points.push({ latitude: 31.995398221178277, longitude: 118.75949998588176 });
points.push({ latitude: 31.995185902197715, longitude: 118.7596871082939 });
points.push({ latitude: 31.994983473052656, longitude: 118.75987334062296 });
points.push({ latitude: 31.99482433699269, longitude: 118.76002095184032 });
points.push({ latitude: 31.994709073721708, longitude: 118.76012902920532 });
points.push({ latitude: 31.99460732100702, longitude: 118.76023892576234 });
points.push({ latitude: 31.99449284962087, longitude: 118.7603694232856 });
points.push({ latitude: 31.99435358179254, longitude: 118.76053622438056 });
points.push({ latitude: 31.99420771148339, longitude: 118.76072790126692 });
points.push({ latitude: 31.994075194901523, longitude: 118.7609100960977 });
points.push({ latitude: 31.993952686158877, longitude: 118.7610741329013 });
points.push({ latitude: 31.993840180644217, longitude: 118.7612193418965 });
points.push({ latitude: 31.993733787150244, longitude: 118.76135383115654 });
points.push({ latitude: 31.993617206525155, longitude: 118.76150529647698 });

// 动态轨迹的入参
let tranceOptions: mapCommon.TraceOverlayParams = {
  // 轨迹点
  points: points,
  // 轨迹的动画时长
  animationDuration: 5000,
  // 相机是否跟随动画移动
  isMapMoving: true,
  // 轨迹的颜色
  color: 0xAAFFAA00,
  // 轨迹的宽度
  width: 20,
  // 轨迹的动画回调（回调轨迹点的index）
  animationCallback: (pointIndex) => {
    // 换成骑行
    if (pointIndex === 10) {
      markerBoy1.setVisible(false);
      markerBoy2.setVisible(true);
    }
  }
};
let markers: Array<map.Marker> = new Array();
markers.push(markerBoy1, markerBoy2);
// 新增轨迹点动画
let traceOverlay: map.TraceOverlay = await this.mapController.addTraceOverlay(tranceOptions, markers);

[h2]addArc

addArc(params: mapCommon.MapArcParams): MapArc

在地图上添加一条弧线。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
params	mapCommon.MapArcParams	是	弧线的相关属性。

返回值：

类型	说明
MapArc	返回MapArc。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.
1002601001	The object to be operated does not exist.

示例：

// 设置弧线参数
let mapArcParams: mapCommon.MapArcParams = {
  // 弧线起点坐标
  startPoint: {
    latitude: 39.913138,
    longitude: 116.415112
  },
  // 弧线终点坐标
  endPoint: {
    latitude: 28.239473,
    longitude: 112.954094
  },
  // 弧线中心点坐标
  centerPoint: {
    latitude: 33.86970399048567,
    longitude: 112.08633528544145
  },
  width: 10,
  color: 0xffff0000,
  visible: true,
  zIndex: 100
};
// 添加弧线
this.mapController.addArc(mapArcParams);

[h2]show

show(): void

将地图切换到前台，开发者在绘制地图页面的生命周期onPageShow中调用。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

示例：

// 页面每次显示时触发一次，包括路由过程、应用进入前台等场景，仅@Entry装饰的自定义组件生效
onPageShow(): void {
  // 绘制地图页面的生命周期onPageShow，将地图切换到前台
  if (this.mapController) {
    this.mapController.show();
  }
}

[h2]hide

hide(): void

将地图切换到后台，开发者在绘制地图页面的生命周期onPageHide中调用。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

示例：

// 页面每次隐藏时触发一次，包括路由过程、应用进入后台等场景，仅@Entry装饰的自定义组件生效。
onPageHide(): void {
  // 绘制地图页面的生命周期onPageHide，将地图切换到后台
  if (this.mapController) {
    this.mapController.hide();
  }
}

[h2]getEventManager

getEventManager(): MapEventManager

返回地图监听事件管理器。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

返回值：

类型	说明
MapEventManager	地图监听事件管理器。

示例：

let mapEventManager: map.MapEventManager = this.mapController.getEventManager();

[h2]setDisplayOrder

setDisplayOrder(types: Array<mapCommon.MapElementType>): void

设置地图元素的显示顺序，按照从低到高排列，即后面的覆盖物会压盖前面的覆盖物。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

types

Array<mapCommon.MapElementType>

是

地图元素类型，默认顺序为[1, 2, 3, 4]。

入参的长度必须是4，且必须是mapCommon.MapElementType的4个取值，如果不满足，则返回错误码401。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.

示例：

let mapElementTypeArr: Array<mapCommon.MapElementType> = [
  mapCommon.MapElementType.OVERLAY,
  mapCommon.MapElementType.POI,
  mapCommon.MapElementType.CUSTOM_POI,
  mapCommon.MapElementType.MARKER];
this.mapController.setDisplayOrder(mapElementTypeArr);

[h2]on(type: 'cameraChange')

on(type: 'cameraChange', callback: Callback<mapCommon.LatLng>): void

监听地图相机状态变化事件。使用callback异步回调。此回调不会在动画过程中触发，而是在动画结束时触发。

建议使用MapEventManager.on(type: 'cameraChange')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'cameraChange'：监听地图相机状态变化事件。
callback	Callback<mapCommon.LatLng>	是	回调函数，返回mapCommon.LatLng，监听地图相机状态变化事件。该回调不会在动画过程中触发，而是在动画结束时触发。

示例：

this.mapController.on("cameraChange", (position) => {
  console.info("cameraChange", `on-cameraChange position = ${position.longitude}`);
});

[h2]off(type: 'cameraChange')

off(type: 'cameraChange', callback: Callback<void>): void

取消监听地图相机状态变化事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'cameraChange')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'cameraChange'：监听地图相机状态变化事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("cameraChange", (position) => {
  console.info("cameraChange", `off-cameraChange`);
});

[h2]on(type: 'cameraIdle')

on(type: 'cameraIdle', callback: Callback<void>): void

监听相机移动结束事件。使用callback异步回调。

建议使用MapEventManager.on(type: 'cameraIdle')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'cameraIdle'：监听相机移动结束事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.on("cameraIdle", () => {
  console.info("cameraIdle", `on-cameraIdle`);
});

[h2]off(type: 'cameraIdle')

off(type: 'cameraIdle', callback: Callback<void>): void

取消监听相机移动结束事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'cameraIdle')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'cameraIdle'：监听相机移动结束事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("cameraIdle", () => {
  console.info("cameraIdle", `off-cameraIdle`);
});

[h2]on(type: 'cameraMoveCancel')

on(type: 'cameraMoveCancel', callback: Callback<void>): void

监听相机移动取消事件。使用callback异步回调。

建议使用MapEventManager.on(type: 'cameraMoveCancel')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'cameraMoveCancel'：监听地图相机移动取消事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.on("cameraMoveCancel", () => {
  console.info("cameraMoveCancel", `on-cameraMoveCancel`);
});

[h2]off(type: 'cameraMoveCancel')

off(type: 'cameraMoveCancel', callback: Callback<void>): void

取消监听相机移动取消事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'cameraMoveCancel')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'cameraMoveCancel'：监听地图相机移动取消事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("cameraMoveCancel", () => {
  console.info("cameraMoveCancel", `off-cameraMoveCancel`);
});

[h2]on(type: 'cameraMove')

on(type: 'cameraMove', callback: Callback<void>): void

监听相机移动事件。使用callback异步回调。

建议使用MapEventManager.on(type: 'cameraMove')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'cameraMove'：监听相机移动事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.on("cameraMove", () => {
  console.info("cameraMove", `on-cameraMove`);
});

[h2]off(type: 'cameraMove')

off(type: 'cameraMove', callback: Callback<void>): void

取消监听相机移动事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'cameraMove')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'cameraMove'：监听相机移动事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("cameraMove", () => {
  console.info("cameraMove", `off-cameraMove`);
});

[h2]on(type: 'cameraMoveStart')

on(type: 'cameraMoveStart', callback: Callback<number>): void

监听相机移动开始事件。使用callback异步回调。

建议使用MapEventManager.on(type: 'cameraMoveStart')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名

类型

必填

说明

type

string

是

'cameraMoveStart'：监听相机移动开始事件。

callback

Callback<number>

是

回调函数，返回number。

number表示相机改变的原因：

1：地图上的用户手势
2：用户交互产生的默认动画
3：开发人员启动的动画

示例：

this.mapController.on("cameraMoveStart", (reason) => {
  console.info("cameraMoveStart", `on-cameraMoveStart reason = ${reason}`);
});

[h2]off(type: 'cameraMoveStart')

off(type: 'cameraMoveStart', callback: Callback<void>): void

取消监听相机移动开始事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'cameraMoveStart')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'cameraMoveStart'：监听相机移动开始事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("cameraMoveStart", () => {
  console.info("cameraMoveStart", `off-cameraMoveStart`);
});

[h2]on(type: 'mapClick')

on(type: 'mapClick', callback: Callback<mapCommon.LatLng>): void

监听地图点击事件。使用callback异步回调。

建议使用MapEventManager.on(type: 'mapClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'mapClick'：监听地图点击事件。
callback	Callback<mapCommon.LatLng>	是	回调函数，返回mapCommon.LatLng。

示例：

this.mapController.on("mapClick", (position) => {
  console.info("mapClick", `on-mapClick position = ${position.longitude}`);
});

[h2]off(type: 'mapClick')

off(type: 'mapClick', callback: Callback<void>): void

取消监听地图点击事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'mapClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'mapClick'：监听地图点击事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("mapClick", () => {
  console.info("mapClick", `off-mapClick`);
});

[h2]on(type: 'mapLoad')

on(type: 'mapLoad', callback: Callback<void>): void

监听地图加载事件。使用callback异步回调。

建议使用MapEventManager.on(type: 'mapLoad')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'mapLoad'：监听地图加载事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.on("mapLoad", () => {
  console.info("mapLoad", `on-mapLoad`);
});

[h2]off(type: 'mapLoad')

off(type: 'mapLoad', callback: Callback<void>): void

取消监听地图加载事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'mapLoad')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'mapLoad'：监听地图加载事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("mapLoad", () => {
  console.info("mapLoad", `off-mapLoad`);
});

[h2]on(type: 'mapLongClick')

on(type: 'mapLongClick', callback: Callback<mapCommon.LatLng>): void

监听地图长按事件。使用callback异步回调。

建议使用MapEventManager.on(type: 'mapLongClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'mapLongClick'：监听地图长按事件。
callback	Callback<mapCommon.LatLng>	是	回调函数，返回mapCommon.LatLng。

示例：

this.mapController.on("mapLongClick", () => {
  console.info("mapLongClick", `on-mapLongClick`);
});

[h2]off(type: 'mapLongClick')

off(type: 'mapLongClick', callback: Callback<void>): void

取消监听地图长按事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'mapLongClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'mapLongClick'：监听地图长按事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("mapLongClick", () => {
  console.info("mapLongClick", `off-mapLongClick`);
});

[h2]on(type: 'myLocationButtonClick')

on(type: 'myLocationButtonClick', callback: Callback<void>): void

监听“我的位置”按钮点击事件。使用callback异步回调。

建议使用MapEventManager.on(type: 'myLocationButtonClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'myLocationButtonClick'：监听“我的位置”按钮点击事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.on("myLocationButtonClick", () => {
  console.info("myLocationButtonClick", `on-myLocationButtonClick`);
});

[h2]off(type: 'myLocationButtonClick')

off(type: 'myLocationButtonClick', callback: Callback<void>): void

取消监听“我的位置”按钮点击事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'myLocationButtonClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'myLocationButtonClick'：监听“我的位置”按钮点击事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("myLocationButtonClick", () => {
  console.info("myLocationButtonClick", `off-myLocationButtonClick`);
});

[h2]on(type: 'myLocationClick')

on(type: 'myLocationClick', callback: Callback<mapCommon.LatLng>): void

监听“我的位置”点击事件。使用callback异步回调。

建议使用MapEventManager.on(type: 'myLocationClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'myLocationClick'：监听“我的位置”点击事件。
callback	Callback<mapCommon.LatLng>	是	回调函数，返回mapCommon.LatLng。

示例：

this.mapController.on("myLocationClick", (position) => {
  console.info("myLocationClick", `on-myLocationClick position = ${position.longitude}`);
});

[h2]off(type: 'myLocationClick')

off(type: 'myLocationClick', callback: Callback<void>): void

取消监听“我的位置”点击事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'myLocationClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'myLocationClick'：监听“我的位置”点击事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("myLocationClick", () => {
  console.info("myLocationClick", `off-myLocationClick`);
});

[h2]on(type: 'poiClick')

on(type: 'poiClick', callback: Callback<mapCommon.Poi>): void

监听Poi点击事件。使用callback异步回调。

建议使用MapEventManager.on(type: 'poiClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'poiClick'：监听Poi点击事件。
callback	Callback<mapCommon.Poi>	是	回调函数，返回mapCommon.Poi。

示例：

this.mapController.on("poiClick", (poi) => {
  console.info("poiClick", `on-poiClick poi = ${poi.id}`);
});

[h2]off(type: 'poiClick')

off(type: 'poiClick', callback: Callback<void>): void

取消监听Poi点击事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'poiClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'poiClick'：监听Poi点击事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("poiClick", () => {
 console.info("poiClick", `off-poiClick`);
});

[h2]on(type: 'markerClick')

on(type: 'markerClick', callback: Callback<Marker>): void

监听标记点击事件。使用callback异步回调。

建议使用MapEventManager.on(type: 'markerClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'markerClick'：监听标记点击事件。
callback	Callback<Marker>	是	回调函数，返回Marker。

示例：

this.mapController.on("markerClick", (marker) => {
 console.info("markerClick", `on-markerClick position = ${marker.getId()}`);
});

[h2]off(type: 'markerClick')

off(type: 'markerClick', callback: Callback<void>): void

取消监听标记点击事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'markerClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'markerClick'：监听标记点击事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("markerClick", () => {
 console.info("markerClick", `off-markerClick`);
});

[h2]on(type: 'markerDragStart')

on(type: 'markerDragStart', callback: Callback<Marker>): void

监听标记开始拖拽事件。使用callback异步回调。

建议使用MapEventManager.on(type: 'markerDragStart')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'markerDragStart'：监听标记开始拖拽事件。
callback	Callback<Marker>	是	回调函数，返回Marker。

示例：

this.mapController.on("markerDragStart", (marker) => {
 console.info("markerDragStart", `on-markerDragStart position = ${marker.getId()}`);
});

[h2]off(type: 'markerDragStart')

off(type: 'markerDragStart', callback: Callback<void>): void

取消监听标记开始拖拽事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'markerDragStart')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'markerDragStart'：监听标记开始拖拽事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("markerDragStart", () => {
 console.info("markerDragStart", `off-markerDragStart`);
});

[h2]on(type: 'markerDrag')

on(type: 'markerDrag', callback: Callback<Marker>): void

监听标记拖拽事件。使用callback异步回调。

建议使用MapEventManager.on(type: 'markerDrag')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'markerDrag'：监听标记拖拽事件。
callback	Callback<Marker>	是	回调函数，返回Marker。

示例：

this.mapController.on("markerDrag", (marker) => {
 console.info("markerDrag", `on-markerDrag position = ${marker.getId()}`);
});

[h2]off(type: 'markerDrag')

off(type: 'markerDrag', callback: Callback<void>): void

取消监听标记拖拽事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'markerDrag')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'markerDrag'：监听标记拖拽事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("markerDrag", () => {
 console.info("markerDrag", `off-markerDrag`);
});

[h2]on(type: 'markerDragEnd')

on(type: 'markerDragEnd', callback: Callback<Marker>): void

监听标记拖拽结束事件。使用callback异步回调。

建议使用MapEventManager.on(type: 'markerDragEnd')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'markerDragEnd'：监听标记拖拽结束事件。
callback	Callback<Marker>	是	回调函数，返回Marker。

示例：

this.mapController.on("markerDragEnd", (marker) => {
 console.info("markerDragEnd", `on-markerDragEnd position = ${marker.getId()}`);
});

[h2]off(type: 'markerDragEnd')

off(type: 'markerDragEnd', callback: Callback<void>): void

取消监听标记拖动结束事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'markerDragEnd')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'markerDragEnd'：监听标记拖动结束事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("markerDragEnd", () => {
 console.info("markerDragEnd", `off-markerDragEnd`);
});

[h2]on(type: 'circleClick')

on(type: 'circleClick', callback: Callback<MapCircle>): void

监听圆点击事件。使用callback异步回调。

建议使用MapEventManager.on(type: 'circleClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'circleClick'：监听圆点击事件。
callback	Callback<MapCircle>	是	回调函数，返回MapCircle。

示例：

this.mapController.on("circleClick", (position) => {
 console.info("circleClick", `on-circleClick position = ${position.getCenter().longitude}`);
});

[h2]off(type: 'circleClick')

off(type: 'circleClick', callback: Callback<void>): void

取消监听圆点击事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'circleClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'circleClick'：监听圆点击事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("circleClick", () => {
 console.info("circleClick", `off-circleClick`);
});

[h2]on(type: 'polylineClick')

on(type: 'polylineClick', callback: Callback<MapPolyline>): void

监听折线点击事件。使用callback异步回调。

建议使用MapEventManager.on(type: 'polylineClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'polylineClick'：监听折线点击事件。
callback	Callback<MapPolyline>	是	回调函数，返回MapPolyline。

示例：

this.mapController.on("polylineClick", (polyline) => {
  console.info("polylineClick", `on-polylineClick position = ${polyline.getId()}`);
});

[h2]off(type: 'polylineClick')

off(type: 'polylineClick', callback: Callback<void>): void

取消监听折线点击事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'polylineClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'polylineClick'：监听折线点击事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("polylineClick", () => {
 console.info("polylineClick", `off-polylineClick`);
});

[h2]on(type: 'polygonClick')

on(type: 'polygonClick', callback: Callback<MapPolygon>): void

监听多边形点击事件。使用callback异步回调。

建议使用MapEventManager.on(type: 'polygonClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'polygonClick'：监听多边形点击事件。
callback	Callback<MapPolygon>	是	回调函数，返回MapPolygon。

示例：

this.mapController.on("polygonClick", (polygon) => {
  console.info("polygonClick", `on-polygonClick position = ${polygon.getId()}`);
});

[h2]off(type: 'polygonClick')

off(type: 'polygonClick', callback: Callback<void>): void

取消监听多边形点击事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'polygonClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'polygonClick'：监听多边形点击事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("polygonClick", () => {
 console.info("polygonClick", `off-polygonClick`);
});

[h2]on(type: 'infoWindowClick')

on(type: 'infoWindowClick', callback: Callback<Marker>): void

监听信息窗点击事件。使用callback异步回调。

建议使用MapEventManager.on(type: 'infoWindowClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'infoWindowClick'：监听信息窗点击事件。
callback	Callback<Marker>	是	回调函数，返回Marker。

示例：

this.mapController.on("infoWindowClick", (infoWindow) => {
 console.info("infoWindowClick", `on-infoWindowClick infoWindow = ${infoWindow.getId()}`);
});

[h2]off(type: 'infoWindowClick')

off(type: 'infoWindowClick', callback: Callback<void>): void

取消监听信息窗点击事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'infoWindowClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'infoWindowClick'：监听信息窗点击事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("infoWindowClick", () => {
 console.info("infoWindowClick", `off-infoWindowClick`);
});

[h2]on(type: 'infoWindowClose')

on(type: 'infoWindowClose', callback: Callback<Marker>): void

监听信息窗关闭事件。使用callback异步回调。

建议使用MapEventManager.on(type: 'infoWindowClose')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'infoWindowClose'：监听信息窗关闭事件。
callback	Callback<Marker>	是	回调函数，返回Marker。

示例：

this.mapController.on("infoWindowClose", (infoWindowClose) => {
 console.info("infoWindowClose", `on-infoWindowClose infoWindowClose = ${infoWindowClose.getId()}`);
});

[h2]off(type: 'infoWindowClose')

off(type: 'infoWindowClose', callback: Callback<void>): void

取消监听信息窗关闭事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'infoWindowClose')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'infoWindowClose'：监听信息窗关闭事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("infoWindowClose", () => {
 console.info("infoWindowClose", `off-infoWindowClose`);
});

[h2]on(type: 'pointAnnotationClick')

on(type: 'pointAnnotationClick', callback: Callback<PointAnnotation>): void

监听点注释点击事件。使用callback异步回调。

建议使用MapEventManager.on(type: 'pointAnnotationClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'pointAnnotationClick'：监听点注释点击事件。
callback	Callback<PointAnnotation>	是	回调函数，返回PointAnnotation。

示例：

this.mapController.on("pointAnnotationClick", (pointAnnotation) => {
 console.info("pointAnnotationClick", `on-PointAnnotationClick pointAnnotation = ${pointAnnotation.getId()}`);
});

[h2]off(type: 'pointAnnotationClick')

off(type: 'pointAnnotationClick', callback: Callback<void>): void

取消监听点注释点击事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'pointAnnotationClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'pointAnnotationClick'：监听点注释点击事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("pointAnnotationClick", () => {
 console.info("pointAnnotationClick", `off-PointAnnotationClick`);
});

[h2]on(type: 'bubbleClick')

on(type: 'bubbleClick', callback: Callback<Bubble>): void

监听气泡点击事件。使用callback异步回调。

建议使用MapEventManager.on(type: 'bubbleClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'bubbleClick'：监听气泡点击事件。
callback	Callback<Bubble>	是	回调函数，返回Bubble。

示例：

this.mapController.on("bubbleClick", (bubble) => {
 console.info("bubbleClick", `on-BubbleClick bubble = ${bubble.getId()}`);
});

[h2]off(type: 'bubbleClick')

off(type: 'bubbleClick', callback: Callback<void>): void

取消监听气泡点击事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'bubbleClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'bubbleClick'：监听气泡点击事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("bubbleClick", () => {
 console.info("bubbleClick", `off-BubbleClick`);
});

[h2]on(type: 'imageOverlayClick')

on(type: 'imageOverlayClick', callback: Callback<ImageOverlay>): void

监听覆盖物点击事件。使用callback异步回调。

建议使用MapEventManager.on(type: 'imageOverlayClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'imageOverlayClick'：监听覆盖物点击事件。
callback	Callback<ImageOverlay>	是	回调函数，返回ImageOverlay。

示例：

// 监听覆盖物点击事件的回调
let imageOverlayCallback: Callback<map.ImageOverlay> = (imageOverlay: map.ImageOverlay) => {
  console.info("imageOverlay:" + imageOverlay?.getId());
};
this.mapController.on("imageOverlayClick", imageOverlayCallback);

[h2]off(type: 'imageOverlayClick')

off(type: 'imageOverlayClick', callback?: Callback<ImageOverlay>): void

取消监听覆盖物点击事件。使用callback异步回调。

建议使用MapEventManager.off(type: 'imageOverlayClick')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'imageOverlayClick'：监听覆盖物点击事件。
callback	Callback<ImageOverlay>	否	回调函数，返回ImageOverlay，当不填时清除所有监听回调。

示例：

let imageOverlayCallback: Callback<map.ImageOverlay> = (imageOverlay: map.ImageOverlay) => {
  console.info("imageOverlay:" + imageOverlay?.getId());
};
this.mapController.off("imageOverlayClick", imageOverlayCallback);

[h2]on(type: 'error')

on(type: 'error', callback: ErrorCallback): void

监听发生的异常。

建议使用MapEventManager.on(type: 'error')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'error'：监听发生的异常。
callback	ErrorCallback	是	回调函数，监听异常事件的回调。

示例：

this.mapController.on("error", (error) => {
  console.error("error", `on-error: Code: ${error.code}, message: ${error.message}`);
});

[h2]off(type: 'error')

off(type: 'error', callback: Callback<void>): void

取消监听发生的异常。使用callback异步回调。

建议使用MapEventManager.off(type: 'error')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'error'：监听发生的异常。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

this.mapController.off("error", () => {
console.error("error", `off-error`);
});

BaseOverlay

覆盖物基础类。Marker、MapPolyline、MapPolygon、MapCircle、MapArc、ImageOverlay、BasePriorityOverlay等覆盖物继承该基础类。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回类型	方法
string	getId() 获取覆盖物的ID属性。
number	getZIndex() 获取覆盖物的z指数。
Object	getTag() 覆盖物的tag属性。
boolean	isVisible() 覆盖物的可见性。
void	remove() 从地图移除覆盖物。
void	setZIndex(zIndex: number) 设置覆盖物的z指数。
void	setTag(tag: Object) 设置覆盖物的tag属性。
void	setVisible(visible: boolean) 设置覆盖物的可见性。

[h2]getId

getId(): string

获取覆盖物的ID。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
string	覆盖物的ID。

示例：

// 以marker为例
let markerOptions: mapCommon.MarkerOptions = {
  position: {latitude: 39.9, longitude: 116.4}
};
let marker: map.Marker = await this.mapController.addMarker(markerOptions);
let id: string = marker.getId();

[h2]getZIndex

getZIndex(): number

获取覆盖物的z指数。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
number	覆盖物的z指数。z指数指覆盖物的叠加顺序，具有较大z指数的覆盖物会绘制在具有较小z指数的覆盖物上，具有相同z指数的叠加顺序为元素添加的先后顺序。覆盖物初始化时如果未设置zIndex参数，默认值为0。异常值按默认值处理。

示例：

// 以marker为例
let zIndex: number = marker.getZIndex();

[h2]getTag

getTag(): Object

获取覆盖物的tag属性。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
Object	覆盖物的tag属性。

示例：

// 以marker为例
let tag: Object = marker.getTag();

[h2]isVisible

isVisible(): boolean

获取覆盖物的可见性。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型

说明

boolean

覆盖物的可见性。

true：可见
false：不可见

示例：

// 以marker为例
let isVisible: boolean = marker.isVisible();

[h2]remove

remove(): void

从地图移除覆盖物。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

示例：

// 以marker为例
marker.remove();

[h2]setZIndex

setZIndex(zIndex: number): void

设置覆盖物的z指数。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
zIndex	number	是	覆盖物的z指数。z指数指覆盖物的叠加顺序，具有较大z指数的覆盖物会绘制在具有较小z指数的覆盖物上，具有相同z指数的叠加顺序为元素添加的先后顺序。覆盖物初始化时如果未设置zIndex参数，默认值为0。异常值按默认值处理。

示例：

// 以marker为例
marker.setZIndex(3);

[h2]setTag

setTag(tag: Object): void

设置覆盖物的tag属性。tag属性可以是任意对象，如果设置为空，则清除tag。当您不再需要使用tag时，您可以调用setTag(null)或setTag(undefined)清除tag，以防止应用程序发生内存泄漏。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
tag	Object	是	覆盖物的tag属性。

示例：

// 以marker为例
let tag = "tag-1";
marker.setTag(tag);

[h2]setVisible

setVisible(visible: boolean): void

设置覆盖物的可见性，默认可见。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名

类型

必填

说明

visible

boolean

是

覆盖物的可见性。

true：可见
false：不可见

默认值为true。

示例：

// 以marker为例
marker.setVisible(true);

Marker

标记，继承BaseOverlay。在调用map.MapComponentController类的addMarker方法时会返回该类型的实例。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

模块提供以下方法，支持更新和查询标记相关属性，其它方法见覆盖物基础类BaseOverlay。

返回类型	方法
string	getTitle() 返回信息窗的标题。
string	getSnippet() 返回信息窗的子标题。
number	getAlpha() 标记的透明度，取值范围：[0, 1]。
mapCommon.LatLng	getPosition() 标记的位置。
number	getRotation() 标记的旋转角度。
boolean	isClickable() 获取标记的可点击性。
boolean	isDraggable() 标记是否可以通过长按来拖拽。
boolean	isFlat() 标记是否平贴地图。
void	setAlpha(alpha: number) 标记的透明度。
void	setClickable(clickable: boolean) 设置标记是否可点击。
void	setDraggable(draggable: boolean) 设置标记是否可以长按拖拽。
void	setFlat(flat: boolean) 设置标记是否平贴地图。
Promise<void>	setIcon(icon: string \| image.PixelMap \| Resource) 设置标记的图标，使用Promise异步回调。
void	setMarkerAnchor(anchorU: number, anchorV: number) 设置标记的锚点位置。
void	setPosition(latLng: mapCommon.LatLng) 设置标记的位置坐标。
void	setRotation(rotation: number) 设置标记的旋转角度。
void	setTitle(title: string) 设置信息窗的标题。
void	setSnippet(snippet: string) 设置信息窗的子标题。
void	setInfoWindowAnchor(anchorU: number, anchorV: number) 设置信息窗的锚点位置。
void	setInfoWindowVisible(visible: boolean) 设置信息窗是否可见。
boolean	isInfoWindowVisible() 返回信息窗是否可见。
void	setAnimation(animation: Animation) 设置标记的动画。不支持FontSizeAnimation。
void	startAnimation() 启动标记的动画。
void	clearAnimation() 清除标记的动画。
number	getAltitude() 获取海拔高度。
void	setAltitude(altitude: number) 设置海拔高度。

示例：

let markerOptions: mapCommon.MarkerOptions = {
  position: {latitude: 39.9, longitude: 116.4}
};
let marker: map.Marker = await this.mapController.addMarker(markerOptions);

[h2]getTitle

getTitle(): string

返回信息窗的标题。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
string	信息窗的标题。

示例：

let title: string = marker.getTitle();

[h2]getSnippet

getSnippet(): string

返回信息窗的子标题。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
string	信息窗的子标题。

示例：

let snippet: string = marker.getSnippet();

[h2]getAlpha

getAlpha(): number

获取标记的透明度。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
number	标记的透明度，取值范围：[0, 1]。

示例：

let alpha: number = marker.getAlpha();

[h2]getPosition

getPosition(): mapCommon.LatLng

获取标记的位置。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
mapCommon.LatLng	标记的位置。

示例：

let position: mapCommon.LatLng = marker.getPosition();

[h2]getRotation

getRotation(): number

获取标记的旋转角度。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
number	标记的旋转角度。

示例：

let rotation: number = marker.getRotation();

[h2]isClickable

isClickable(): boolean

获取标记是否可以点击。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型

说明

boolean

标记是否可以点击。

true：可以
false：不可以

示例：

let isClickable: boolean = marker.isClickable();

[h2]isDraggable

isDraggable(): boolean

获取标记是否可以通过长按来拖拽。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型

说明

boolean

标记是否可以通过长按来拖拽。

true：可以
false：不可以

示例：

let isDraggable: boolean = marker.isDraggable();

[h2]isFlat

isFlat(): boolean

获取标记是否平贴地图。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型

说明

boolean

标记是否平贴地图。

true：平贴地图
false：面对相机

示例：

let isFlat: boolean = marker.isFlat();

[h2]setAlpha

setAlpha(alpha: number): void

设置标记的透明度属性。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名

类型

必填

说明

alpha

number

是

标记的透明度，取值范围：[0, 1]，默认值为1。

0：完全透明
1：完全不透明

示例：

marker.setAlpha(0.5);

[h2]setClickable

setClickable(clickable: boolean): void

设置标记是否可以点击。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名

类型

必填

说明

clickable

boolean

是

设置标记是否可以点击，默认值为false。

true：可以
false：不可以

示例：

marker.setClickable(true);

[h2]setDraggable

setDraggable(draggable: boolean): void

设置标记是否可以长按拖拽。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名

类型

必填

说明

draggable

boolean

是

是否可以长按拖拽，默认值为false。

true：可以
false：不可以

示例：

marker.setDraggable(true);

[h2]setFlat

setFlat(flat: boolean): void

设置标记是否平贴地图。如果标记平贴地图，则在相机旋转和倾斜时，标记仍将停留在地图上，它将保持与照相机缩放时相同的大小。如果标记面对相机，它将始终面向相机绘制，并随相机旋转和倾斜。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名

类型

必填

说明

flat

boolean

是

是否平贴地图，默认值为false。

true：平贴地图
false：面对相机

示例：

marker.setFlat(true);

[h2]setIcon

setIcon(icon: string | image.PixelMap | Resource): Promise<void>

设置标记的图标。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名

类型

必填

说明

icon

string | image.PixelMap | Resource

是

标记的图标。

图片格式支持jpg、jpeg、png、gif、webp、svg。
string类型入参支持两种格式：
- 资源相对路径格式：图标存放在resources/rawfile，icon参数传入rawfile文件夹下的相对路径。
- toDataURL格式（如data:image/png;base64,<图片的Base64字节编码值>）

说明：

从5.0.0(12)版本开始，icon属性支持Resource和image.PixelMap类型。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

await marker.setIcon('icon/test.png');

[h2]setMarkerAnchor

setMarkerAnchor(anchorU: number, anchorV: number): void

设置标记的锚点位置。锚点是标记图标接触地图平面的点，图标的左顶点为（0, 0）点，右顶点为（1, 0）点，左底点为（0, 1）点，右底点为（1, 1）点。例如，在标记X（0.5, 0.3）处的锚点坐标如下：

点击放大

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
anchorU	number	是	锚点的水平坐标，以图像宽度的比例，取值范围：[0, 1]。
anchorV	number	是	锚点的垂直坐标，以图像高度的比例，取值范围：[0, 1]。

示例：

marker.setMarkerAnchor(1.0, 1.0);

[h2]setPosition

setPosition(latLng: mapCommon.LatLng): void

设置标记的位置坐标。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
latLng	mapCommon.LatLng	是	标记的位置坐标。

示例：

let position: mapCommon.LatLng = {latitude: 39.9, longitude: 116.4};
marker.setPosition(position);

[h2]setRotation

setRotation(rotation: number): void

设置标记的旋转角度，即标记围绕标记锚点顺时针旋转的角度，旋转轴垂直于标记。默认旋转角度为0，默认位置为北对齐。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名

类型

必填

说明

rotation

number

是

标记的旋转角度。

以正北方向为0度、顺时针方向为正的角度，默认值为0，取值范围：[0, 360)。超出取值范围的值会换算成取值范围内的值，比如361会被换算成1，-1换算为359。

示例：

marker.setRotation(30);

[h2]setTitle

setTitle(title: string): void

设置信息窗的标题。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
title	string	是	信息窗的标题。

示例：

marker.setTitle("title");

[h2]setSnippet

setSnippet(snippet: string): void

设置信息窗的子标题。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
snippet	string	是	信息窗的子标题。

示例：

marker.setSnippet("su");

[h2]setInfoWindowAnchor

setInfoWindowAnchor(anchorU: number, anchorV: number): void

设置信息窗的锚点位置。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
anchorU	number	是	锚点在水平方向上的位置，取值范围：[0, 1]。
anchorV	number	是	锚点在垂直方向上的位置，取值范围：[0, 1]。

示例：

marker.setInfoWindowAnchor(0.5, 0.5);

[h2]setInfoWindowVisible

setInfoWindowVisible(visible: boolean): void

设置信息窗是否可见。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名

类型

必填

说明

visible

boolean

是

设置信息窗是否可见。

true：可见
false：不可见

示例：

marker.setInfoWindowVisible(true);

[h2]isInfoWindowVisible

isInfoWindowVisible(): boolean

返回信息窗是否可见。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型

说明

boolean

信息窗口是否可见。

true：可见
false：不可见

示例：

let visible: boolean = marker.isInfoWindowVisible();

[h2]setAnimation

setAnimation(animation: Animation): void

设置标记的动画，不支持FontSizeAnimation。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
animation	Animation	是	动画。

示例：

let animation: map.AlphaAnimation = new map.AlphaAnimation(0.2, 1);
animation.setDuration(3000);
let callbackStart = () => {
  console.info("animationStart", `callback`);
};
let callbackEnd = () => {
  console.info("animationEnd", `callback`);
};
animation.on("animationStart", callbackStart);
animation.on("animationEnd", callbackEnd);
animation.setFillMode(map.AnimationFillMode.BACKWARDS);
animation.setRepeatMode(map.AnimationRepeatMode.RESTART);
animation.setRepeatCount(100);
marker.setAnimation(animation);

[h2]startAnimation

startAnimation(): void

启动标记的动画。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

示例：

let animation: map.AlphaAnimation = new map.AlphaAnimation(0.2, 1);
animation.setDuration(3000);
let callbackStart = () => {
  console.info("animationStart", `callback`);
};
let callbackEnd = () => {
  console.info("animationEnd", `callback`);
};
animation.on("animationStart", callbackStart);
animation.on("animationEnd", callbackEnd);
animation.setFillMode(map.AnimationFillMode.BACKWARDS);
animation.setRepeatMode(map.AnimationRepeatMode.RESTART);
animation.setRepeatCount(100);

marker.setAnimation(animation);
marker.startAnimation();

[h2]clearAnimation

clearAnimation(): void

清除标记的动画。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

示例：

marker.clearAnimation();

[h2]getAltitude

getAltitude(): number

获取海拔高度。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

返回值：

类型	说明
number	海拔高度，单位：米。

示例：

let altitude: number = marker.getAltitude();

[h2]setAltitude

setAltitude(altitude: number): void

设置海拔高度。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
altitude	number	是	海拔高度，单位：米。

示例：

marker.setAltitude(500);

MapPolyline

折线，继承BaseOverlay。在调用map.MapComponentController类的addPolyline方法时会返回该类型的实例。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

模块提供以下方法，支持更新和查询折线相关属性，其它方法见覆盖物基础类BaseOverlay。

返回类型	方法
number	getColor() 获取折线的颜色。
Array<number>	getColors() 获取折线的多段颜色。
mapCommon.CapStyle	getEndCap() 获取折线的末尾端点样式。
mapCommon.JointType	getJointType() 获取折线除起始和结束顶点之外的所有顶点的节点类型。
Array<mapCommon.PatternItem>	getPatterns() 获取折线的样式。
Array<mapCommon.LatLng>	getPoints() 获取折线的顶点坐标。
mapCommon.CapStyle	getStartCap() 获取折线的起始端点样式。
number	getWidth() 获取折线的宽度。
boolean	isClickable() 获取折线的可点击性。
boolean	isGeodesic() 获取折线的线段是否为大地曲线。
boolean	isGradient() 获取渐变属性。
void	setClickable(clickable: boolean) 设置折线的可点击性。
void	setColor(color: number) 设置折线的颜色。
void	setColors(colors: Array<number>) 设置折线的多段颜色。
void	setEndCap(endCap: mapCommon.CapStyle) 设置折线的末尾端点样式。
void	setGeodesic(geodesic: boolean) 设置是否将折线的每个线段绘制为大地线。
void	setGradient(gradient: boolean) 设置渐变属性。
void	setJointType(jointType: mapCommon.JointType) 设置折线除起始和结束顶点之外的所有顶点的节点类型。
void	setPatterns(patterns: Array<mapCommon.PatternItem>) 设置折线的样式。
void	setPoints(points: Array<mapCommon.LatLng>) 设置折线的顶点坐标。
void	setStartCap(startCap: mapCommon.CapStyle) 设置折线的起始端点样式。
void	setWidth(width: number) 设置折线的宽度。
Promise<void>	setCustomTexture(customTexture: ResourceStr \| image.PixelMap) 设置折线纹理，使用Promise异步回调。

示例：

let polylineOption: mapCommon.MapPolylineOptions = {
  points: [
    { latitude: 31.68, longitude: 118.166 },
    { latitude: 31.48, longitude: 118.366 },
    { latitude: 31.28, longitude: 118.766 }
  ]
};
let mapPolyline = await this.mapController.addPolyline(polylineOption);

[h2]getColor

getColor(): number

获取折线的颜色值。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
number	ARGB格式颜色值。

示例：

let color: number = mapPolyline.getColor();

[h2]getColors

getColors(): Array<number>

获取折线的分段颜色值数组。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
Array<number>	折线的分段颜色值数组。

示例：

let colors: Array<number> = mapPolyline.getColors();

[h2]getEndCap

getEndCap(): mapCommon.CapStyle

获取折线的末尾端点样式。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
mapCommon.CapStyle	折线的末尾端点样式。

示例：

let endCap: mapCommon.CapStyle = mapPolyline.getEndCap();

[h2]getJointType

getJointType(): mapCommon.JointType

获取折线除起始和结束顶点之外的所有顶点的节点类型属性。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
mapCommon.JointType	折线除起始和结束顶点之外的所有顶点的节点类型属性。

示例：

let jointType: mapCommon.JointType = mapPolyline.getJointType();

[h2]getPatterns

getPatterns(): Array<mapCommon.PatternItem>

获取折线的样式属性。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
Array<mapCommon.PatternItem>	折线的样式属性。

示例：

let patterns: Array<mapCommon.PatternItem> = mapPolyline.getPatterns();

[h2]getPoints

getPoints(): Array<mapCommon.LatLng>

获取折线的顶点坐标属性。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
Array<mapCommon.LatLng>	折线的顶点坐标属性。

示例：

let points: Array<mapCommon.LatLng> = mapPolyline.getPoints();

[h2]getStartCap

getStartCap(): mapCommon.CapStyle

获取折线的起始端点样式。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
mapCommon.CapStyle	折线的起始端点样式。

示例：

let startCap: mapCommon.CapStyle = mapPolyline.getStartCap();

[h2]getWidth

getWidth(): number

获取折线的宽度属性。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
number	折线的宽度属性，单位：px。

示例：

let width: number = mapPolyline.getWidth();

[h2]isClickable

isClickable(): boolean

获取折线的可点击属性。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型

说明

boolean

折线的可点击性。

true：可点击
false：不可点击

示例：

let isClickable: boolean = mapPolyline.isClickable();

[h2]isGeodesic

isGeodesic(): boolean

获取折线的大地线属性。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型

说明

boolean

折线的大地线属性。

true：大地线
false：非大地线

示例：

let isGeodesic: boolean = mapPolyline.isGeodesic();

[h2]isGradient

isGradient(): boolean

获取折线的渐变属性。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型

说明

boolean

折线的渐变属性。

true：渐变
false：不渐变

示例：

let isGradient: boolean = mapPolyline.isGradient();

[h2]setClickable

setClickable(clickable: boolean): void

设置折线是否可以点击。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名

类型

必填

说明

clickable

boolean

是

设置折线是否可以点击，默认值为false。

true：可以
false：不可以

示例：

mapPolyline.setClickable(true);

[h2]setColor

setColor(color: number): void

设置折线的颜色值。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
color	number	是	ARGB格式颜色值。

示例：

mapPolyline.setColor(0xff000000);

[h2]setColors

setColors(colors: Array<number>): void

设置折线的多段颜色值数组。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
colors	Array<number>	是	多段颜色，ARGB格式颜色值数组。

示例：

mapPolyline.setColors([0xffffff00, 0xff000000]);

[h2]setEndCap

setEndCap(endCap: mapCommon.CapStyle): void

设置折线的末尾端点样式。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
endCap	mapCommon.CapStyle	是	折线的末尾端点样式。

示例：

mapPolyline.setEndCap(mapCommon.CapStyle.BUTT);

[h2]setGeodesic

setGeodesic(geodesic: boolean): void

设置是否将折线的每个线段绘制为大地线。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名

类型

必填

说明

geodesic

boolean

是

将折线的每个线段绘制为大地线，默认值为false。

true：每段绘制为大地线
false：不是大地线

示例：

mapPolyline.setGeodesic(true);

[h2]setGradient

setGradient(gradient: boolean): void

设置折线的渐变属性是否启用。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名

类型

必填

说明

gradient

boolean

是

设置渐变属性是否启用，默认值为false。

true：渐变
false：不渐变

示例：

mapPolyline.setGradient(true);

[h2]setJointType

setJointType(jointType: mapCommon.JointType): void

设置折线除起始和结束顶点之外的所有顶点的节点类型。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
jointType	mapCommon.JointType	是	节点类型。

示例：

mapPolyline.setJointType(mapCommon.JointType.DEFAULT);

[h2]setPatterns

setPatterns(patterns: Array<mapCommon.PatternItem>): void

设置折线的样式。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
patterns	Array<mapCommon.PatternItem>	是	PatternItem对象的集合。

示例：

let linePattern: Array<mapCommon.PatternItem> = [
  { type: mapCommon.PatternItemType.DASH, length: 100 },
  { type: mapCommon.PatternItemType.DOT, length: 100 },
  { type: mapCommon.PatternItemType.GAP, length: 100 }
];
mapPolyline.setPatterns(linePattern);

[h2]setPoints

setPoints(points: Array<mapCommon.LatLng>): void

设置折线的顶点坐标。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
points	Array<mapCommon.LatLng>	是	折线顶点的集合。默认情况下，折线不闭合；要形成闭合的折线，起点和终点必须相同。

示例：

let points: Array<mapCommon.LatLng> = [
  { latitude: 31.18, longitude: 118.766 },
  { latitude: 31.38, longitude: 118.366 },
  { latitude: 31.68, longitude: 118.566 },
  { latitude: 31.98, longitude: 118.266 },
  { latitude: 31.88, longitude: 118.866 }
];
mapPolyline.setPoints(points);

[h2]setStartCap

setStartCap(startCap: mapCommon.CapStyle): void

设置折线的起始端点样式。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
startCap	mapCommon.CapStyle	是	折线的起始端点样式。

示例：

mapPolyline.setStartCap(mapCommon.CapStyle.BUTT);

[h2]setWidth

setWidth(width: number): void

设置折线的宽度。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
width	number	是	折线的宽度，单位：px，取值范围：大于等于0。

示例：

mapPolyline.setWidth(20);

[h2]setCustomTexture

setCustomTexture(customTexture: ResourceStr | image.PixelMap): Promise<void>

设置折线纹理。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
customTexture	ResourceStr \| image.PixelMap	是	折线纹理。建议纹理使用没有背景色（透明色）的图片。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

await mapPolyline.setCustomTexture("icon/naviline_arrow.png");

MapPolygon

多边形，继承BaseOverlay。多边形可以是凸面或凹面，它可以跨越180子午线并且可以具有未填充的孔。在调用map.MapComponentController类的addPolygon方法时会返回该类型的实例。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

模块提供以下方法，支持更新和查询多边形相关属性，其它方法见覆盖物基础类BaseOverlay。

返回类型	方法
number	getFillColor() 获取ARGB格式的多边形的填充色值。
Array<Array<mapCommon.LatLng>>	getHoles() 获取多边形的空心洞。
Array<mapCommon.LatLng>	getPoints() 获取多边形的顶点坐标。
number	getStrokeColor() 获取多边形的边框颜色。
mapCommon.JointType	getJointType() 获取多边形的顶点样式。
Array<mapCommon.PatternItem>	getPatterns() 获取多边形的边框样式。
number	getStrokeWidth() 获取多边形的边框宽度。
boolean	isClickable() 获取多边形的可点击性。
boolean	isGeodesic() 获取多边形的线段是否为大地线。
void	setClickable(clickable: boolean) 设置多边形的可点击性。
void	setFillColor(color: number) 设置多边形的填充色。
void	setGeodesic(geodesic: boolean) 设置是否将多边形的每个线段绘制为大地线。
void	setHoles(holes: Array<Array<mapCommon.LatLng>>) 设置多边形的空心洞。
void	setPoints(points: Array<mapCommon.LatLng>) 设置多边形的顶点坐标。
void	setStrokeColor(color: number) 设置多边形的边框颜色。
void	setJointType(jointType: mapCommon.JointType) 设置多边形的顶点样式。
void	setPatterns(patterns: Array<mapCommon.PatternItem>) 设置多边形的边框样式。
void	setStrokeWidth(width: number) 设置多边形的边框宽度。

示例：

let polygonOptions: mapCommon.MapPolygonOptions = {
  points: [
    { latitude: 31.9844102, longitude: 118.7662 },
    { latitude: 31.9844102, longitude: 123.7662 },
    { latitude: 36.9844102, longitude: 123.7662 },
    { latitude: 36.9844102, longitude: 118.7662 }
  ]
};
let mapPolygon = await this.mapController.addPolygon(polygonOptions);

[h2]getFillColor

getFillColor(): number

获取ARGB格式的多边形的填充色值。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
number	ARGB格式的颜色值。

示例：

let fillColor: number = mapPolygon.getFillColor();

[h2]getHoles

getHoles(): Array<Array<mapCommon.LatLng>>

获取多边形的空心洞。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
Array<Array<mapCommon.LatLng>>	多边形的空心洞数组，其中空心洞是LatLng数组。

示例：

let holes: Array<Array<mapCommon.LatLng>> = mapPolygon.getHoles();

[h2]getPoints

getPoints(): Array<mapCommon.LatLng>

获取多边形的顶点坐标。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
Array<mapCommon.LatLng>	多边形的顶点坐标。

示例：

let points: Array<mapCommon.LatLng> = mapPolygon.getPoints();

[h2]getStrokeColor

getStrokeColor(): number

获取多边形的边框颜色。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
number	ARGB格式颜色值，默认值为黑色（0xff000000）。

示例：

let strokeColor: number = mapPolygon.getStrokeColor();

[h2]getJointType

getJointType(): mapCommon.JointType

获取多边形的顶点样式。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
mapCommon.JointType	多边形的顶点样式。

示例：

let jointType: mapCommon.JointType = mapPolygon.getJointType();

[h2]getPatterns

getPatterns(): Array<mapCommon.PatternItem>

获取多边形的边框样式。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
Array<mapCommon.PatternItem>	多边形的边框样式。

示例：

let patterns: Array<mapCommon.PatternItem> = mapPolygon.getPatterns();

[h2]getStrokeWidth

getStrokeWidth(): number

获取多边形的边框宽度。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
number	多边形的边框宽度，单位：px。

示例：

let strokeWidth: number = mapPolygon.getStrokeWidth();

[h2]isClickable

isClickable(): boolean

获取多边形的可点击性。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型

说明

boolean

多边形的可点击性。

true：可点击
false：不可点击

示例：

let clickable: boolean = mapPolygon.isClickable();

[h2]isGeodesic

isGeodesic(): boolean

获取多边形的每个线段是否为大地线。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型

说明

boolean

多边形的每个线段是否为大地线。

true：大地线
false：非大地线

示例：

let geodesic: boolean = mapPolygon.isGeodesic();

[h2]setClickable

setClickable(clickable: boolean): void

设置多边形的可点击性。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名

类型

必填

说明

clickable

boolean

是

多边形的可点击性，默认是false。

true：可点击
false：不可点击

示例：

mapPolygon.setClickable(true);

[h2]setFillColor

setFillColor(color: number): void

设置多边形的填充色。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
color	number	是	ARGB格式颜色值，默认值为0x00000000（透明）。

示例：

mapPolygon.setFillColor(0xff000FFF);

[h2]setGeodesic

setGeodesic(geodesic: boolean): void

设置是否将多边形的每个线段绘制为大地线。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名

类型

必填

说明

geodesic

boolean

是

将多边形的每个线段绘制为大地线，默认值为false。

true：每段绘制为大地线
false：不是大地线

示例：

mapPolygon.setGeodesic(true);

[h2]setHoles

setHoles(holes: Array<Array<mapCommon.LatLng>>): void

设置多边形的空心洞。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
holes	Array<Array<mapCommon.LatLng>>	是	空心洞数组，其中空心洞是LatLng数组。

示例：

let holes: Array<Array<mapCommon.LatLng>> = [[
  { latitude: 31.98, longitude: 115.76 }, { latitude:31.98, longitude: 118.76 },
  { latitude: 35.98, longitude: 118.76 }, { latitude: 35.98, longitude: 118.76 }
]];
mapPolygon.setHoles(holes);

当空心洞的坐标贴合多边形边缘时，会导致渲染出现异常，渲染多余的空心区域。

[h2]setPoints

setPoints(points: Array<mapCommon.LatLng>): void

重新设置多边形的顶点坐标。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
points	Array<mapCommon.LatLng>	是	顶点坐标数组。

示例：

let points: Array<mapCommon.LatLng> = [
  { latitude: 31.98, longitude: 115.76 }, { latitude: 31.98, longitude: 118.76 },
  { latitude: 35.98, longitude: 118.76 }, { latitude: 35.98, longitude: 118.76 }
];
mapPolygon.setPoints(points);

[h2]setStrokeColor

setStrokeColor(color: number): void

设置多边形的边框颜色。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
color	number	是	ARGB格式颜色值，默认值为黑色（0xff000000）。

示例：

mapPolygon.setStrokeColor(0xff00DB93);

[h2]setJointType

setJointType(jointType: mapCommon.JointType): void

设置多边形的顶点样式。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
jointType	mapCommon.JointType	是	顶点样式，默认值为JointType.DEFAULT。

示例：

mapPolygon.setJointType(mapCommon.JointType.ROUND);

[h2]setPatterns

setPatterns(patterns: Array<mapCommon.PatternItem>): void

设置多边形的边框样式。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
patterns	Array<mapCommon.PatternItem>	是	PatternItem对象的数组。默认的边框样式为实心。

示例：

let linePatterns: Array<mapCommon.PatternItem> = [
  { type: mapCommon.PatternItemType.DASH, length: 100 },
  { type: mapCommon.PatternItemType.DOT, length: 100 },
  { type: mapCommon.PatternItemType.GAP, length: 100 }
];
mapPolygon.setPatterns(linePatterns);

[h2]setStrokeWidth

setStrokeWidth(width: number): void

设置多边形的边框宽度。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
width	number	是	边框的宽度，单位：px，默认值为10，取值范围：大于等于0。

示例：

mapPolygon.setStrokeWidth(30);

MapCircle

更新和查询圆的接口，继承BaseOverlay。在调用map.MapComponentController类的addCircle方法时会返回该类型的实例。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

模块提供以下方法，支持更新和查询圆形相关属性，其它方法见覆盖物基础类BaseOverlay。

返回类型	方法
mapCommon.LatLng	getCenter() 获取圆心经纬度。
number	getFillColor() 获取圆的填充色。
number	getRadius() 获取圆的半径。
number	getStrokeColor() 获取圆的边框颜色值。
Array<mapCommon.PatternItem>	getPatterns() 获取圆的边框样式。
number	getStrokeWidth() 获取圆的边框宽度。
boolean	isClickable() 获取圆的可点击性。
void	setCenter(center: mapCommon.LatLng) 给圆心设置经纬度坐标。
void	setClickable(clickable: boolean) 设置圆的可点击性。
void	setFillColor(color: number) 设置圆的填充色。
void	setRadius(radius: number) 设置圆的半径。
void	setStrokeColor(color: number) 设置圆的边框颜色。
void	setPatterns(patterns: Array<mapCommon.PatternItem>) 设置圆的边框样式。
void	setStrokeWidth(width: number) 设置圆的边框宽度。

示例：

let mapCircleOptions: mapCommon.MapCircleOptions = {
	center: {
	  latitude: 39.9,
	  longitude: 116.4
	},
	radius: 5000,
	fillColor: 0XFF00FFFF,
	strokeColor: 0xFFFF0000,
	strokeWidth: 10,
	zIndex: 15
};
let mapCircle = await this.mapController.addCircle(mapCircleOptions);

[h2]getCenter

getCenter(): mapCommon.LatLng

获取圆心经纬度。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
mapCommon.LatLng	获取圆心经纬度。

示例：

let center: mapCommon.LatLng = mapCircle.getCenter();

[h2]getFillColor

getFillColor(): number

获取圆的填充色。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
number	获取圆的填充色。

示例：

let fillColor: number = mapCircle.getFillColor();

[h2]getRadius

getRadius(): number

获取圆的半径。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
number	圆的半径，单位：米。

示例：

let radius: number = mapCircle.getRadius();

[h2]getStrokeColor

getStrokeColor(): number

获取圆的边框颜色值。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
number	ARGB格式颜色值，默认值为黑色（0xff000000）。

示例：

let strokeColor: number = mapCircle.getStrokeColor();

[h2]getPatterns

getPatterns(): Array<mapCommon.PatternItem>

获取圆的边框样式。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
Array<mapCommon.PatternItem>	圆的边框样式。

示例：

let patterns: Array<mapCommon.PatternItem> = mapCircle.getPatterns();

[h2]getStrokeWidth

getStrokeWidth(): number

获取圆的边框宽度。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
number	圆的边框宽度。

示例：

let strokeWidth: number = mapCircle.getStrokeWidth();

[h2]isClickable

isClickable(): boolean

获取圆的可点击性。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型

说明

boolean

圆的可点击性。

true：可点击
false：不可点击

示例：

let clickable: boolean = mapCircle.isClickable();

[h2]setCenter

setCenter(center: mapCommon.LatLng): void

给圆心设置经纬度坐标。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名

类型

必填

说明

center

mapCommon.LatLng

是

圆心经纬度坐标。

圆的中心点纬度在[-85.051119, 85.051119]范围内才能画出圆。若圆中心点纬度为-85.051119或85.051119时，能画出半径为1米的圆。

示例：

let center: mapCommon.LatLng = {latitude: 31.98, longitude: 116.4};
mapCircle.setCenter(center);

[h2]setClickable

setClickable(clickable: boolean): void

设置圆的可点击性。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名

类型

必填

说明

clickable

boolean

是

圆的可点击性，默认值为false。

true：可点击
false：不可点击

示例：

let clickable = true;
mapCircle.setClickable(clickable);

[h2]setFillColor

setFillColor(color: number): void

设置圆的填充色。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
color	number	是	圆的填充色，颜色值为ARGB格式。

示例：

let fillColor = 0xFF00FFFF;
mapCircle.setFillColor(fillColor);

[h2]setRadius

setRadius(radius: number): void

设置圆的半径。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
radius	number	是	圆的半径，单位：米，取值范围：大于等于0。

示例：

let radius = 300;
mapCircle.setRadius(radius);

[h2]setStrokeColor

setStrokeColor(color: number): void

设置圆的边框颜色。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
color	number	是	ARGB格式颜色值，默认值为黑色（0xff000000）。

示例：

let strokeColor = 0xFFFF0000;
mapCircle.setStrokeColor(strokeColor);

[h2]setPatterns

setPatterns(patterns: Array<mapCommon.PatternItem>): void

设置圆的边框样式。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
patterns	Array<mapCommon.PatternItem>	是	圆的边框样式。

示例：

let patterns: Array<mapCommon.PatternItem> = [
  { type: 0, length: 100 },
  { type: 1, length: 100 }, 
  { type: 2, length: 100 }];
mapCircle.setPatterns(patterns);

[h2]setStrokeWidth

setStrokeWidth(width: number): void

设置圆的边框宽度。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
width	number	是	圆的边框宽度，单位：px，取值范围：大于等于0。

示例：

let width = 10;
mapCircle.setStrokeWidth(width);

BasePriorityOverlay

具有优先级控制的覆盖物基础类，继承BaseOverlay。PointAnnotation和Bubble继承该基础类。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

模块提供以下方法，支持更新和查询具有优先级控制的覆盖物的相关属性，其它方法见覆盖物基础类BaseOverlay。

返回值	说明
number	getMaxZoom() 获取覆盖物的最大展示层级。
number	getMinZoom() 获取覆盖物的最小展示层级。
void	setPriority(priority: number) 设置覆盖物的碰撞优先级。
void	setZoom(minZoom: number, maxZoom: number) 设置覆盖物展示的最大最小层级。
void	setAnimation(animation: Animation) 设置覆盖物的动画。仅支持AlphaAnimation、ScaleAnimation和AnimationSet。
void	startAnimation() 启动覆盖物的动画。
void	clearAnimation() 清除覆盖物的动画。

[h2]getMaxZoom

getMaxZoom(): number

获取覆盖物的最大展示层级。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
number	覆盖物的最大展示层级。

示例：

// 以 pointAnnotation为例
let pointAnnotationOptions: mapCommon.PointAnnotationParams = {
  position: {
    latitude: 32.120750,
    longitude: 118.788765
  },
  titles: [{
    content: "南京夫子庙"
  }],
  icon: 'icon.png'
};
let pointAnnotation: map.PointAnnotation = await this.mapController.addPointAnnotation(pointAnnotationOptions);
let maxZoom: number = pointAnnotation.getMaxZoom();

[h2]getMinZoom

getMinZoom(): number

获取覆盖物的最小展示层级。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
number	覆盖物的最小展示层级。

示例：

// 以 pointAnnotation为例
let minZoom: number = pointAnnotation.getMinZoom();

[h2]setPriority

setPriority(priority: number): void

设置覆盖物碰撞优先级，值越大优先级越低。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
priority	number	是	设置覆盖物的碰撞优先级。

示例：

// 以 pointAnnotation为例
pointAnnotation.setPriority(100);

[h2]setZoom

setZoom(minZoom: number, maxZoom: number): void

设置覆盖物的显示层级。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名

类型

必填

说明

minZoom

number

是

覆盖物的最小显示层级，取值范围：[2, 20]。

传入的值高于20，最小缩放级别会取20。

传入的值小于2，最小缩放级别会取2。

说明：

minZoom大于maxZoom，方法不生效。

maxZoom

number

是

覆盖物的最大显示层级，取值范围：[2, 20]。

传入的值高于20，最大缩放级别会取20。

传入的值小于2，最大缩放级别会取2。

示例：

// 以pointAnnotation为例
pointAnnotation.setZoom(3, 10);

[h2]setAnimation

setAnimation(animation: Animation): void

设置覆盖物的动画。仅支持AlphaAnimation、ScaleAnimation和AnimationSet。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
animation	Animation	是	动画。

示例：

let animation: map.AlphaAnimation = new map.AlphaAnimation(0.2, 1);
animation.setDuration(3000);
let callbackStart = () => {
  console.info("animationStart", `callback`);
};
let callbackEnd = () => {
  console.info("animationEnd", `callback`);
};
animation.on("animationStart", callbackStart);
animation.on("animationEnd", callbackEnd);
animation.setFillMode(map.AnimationFillMode.BACKWARDS);
animation.setRepeatMode(map.AnimationRepeatMode.RESTART);
animation.setRepeatCount(100);

pointAnnotation.setAnimation(animation);

[h2]startAnimation

startAnimation(): void

启动覆盖物的动画。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

示例：

let animation: map.AlphaAnimation = new map.AlphaAnimation(0.2, 1);
animation.setDuration(3000);
let callbackStart = () => {
  console.info("animationStart", `callback`);
};
let callbackEnd = () => {
  console.info("animationEnd", `callback`);
};
animation.on("animationStart", callbackStart);
animation.on("animationEnd", callbackEnd);
animation.setFillMode(map.AnimationFillMode.BACKWARDS);
animation.setRepeatMode(map.AnimationRepeatMode.RESTART);
animation.setRepeatCount(100);

pointAnnotation.setAnimation(animation);
pointAnnotation.startAnimation();

[h2]clearAnimation

clearAnimation(): void

清除覆盖物的动画。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

示例：

pointAnnotation.clearAnimation();

PointAnnotation

点注释，继承BasePriorityOverlay。在调用map.MapComponentController类的addPointAnnotation方法时会返回该类型的实例。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

模块提供以下方法，支持更新和查询点注释相关属性，其它方法见覆盖物基础类BasePriorityOverlay。

返回值	说明
mapCommon.LatLng	getPosition() 获取点注释的锚点坐标。
mapCommon.Text	getTitleText() 获取点注释第一标题的属性。
void	setTitleText(text: mapCommon.Text) 设置第一标题属性（除content）。
void	setTitleAnimation(animation: FontSizeAnimation) 设置点注释的标题动画。
void	startTitleAnimation() 启动点注释的动画。

示例：

let pointAnnotationOptions: mapCommon.PointAnnotationParams = {
  position: {
    latitude: 32.120750,
    longitude: 118.788765
  },
  titles: [{
    content: "南京夫子庙"
  }],
  icon: 'icon.png'
};
let pointAnnotation: map.PointAnnotation = await this.mapController.addPointAnnotation(pointAnnotationOptions);

[h2]getPosition

getPosition(): mapCommon.LatLng

获取点注释的锚点坐标。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
mapCommon.LatLng	点注释的锚点坐标。

示例：

let position: mapCommon.LatLng = pointAnnotation.getPosition();

[h2]getTitleText

getTitleText(): mapCommon.Text

获取点注释第一标题的属性。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
mapCommon.Text	获取点注释第一标题的属性。

示例：

let titleText: mapCommon.Text = pointAnnotation.getTitleText();

[h2]setTitleText

setTitleText(text: mapCommon.Text): void

设置第一标题属性（除content）。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
text	mapCommon.Text	是	第一标题属性（除content）。说明：约束条件：fontSize、strokeWidth大于等于0。

示例：

// 以pointAnnotation为例
pointAnnotation.setTitleText({
  content: '',
  color: 0xff00ffff,
  fontSize: 15,
  strokeColor: 0xff00ff00,
  strokeWidth: 2,
  fontStyle: mapCommon.FontStyle.BOLD_ITALIC
});

[h2]setTitleAnimation

setTitleAnimation(animation: FontSizeAnimation): void

设置点注释的标题动画。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
animation	FontSizeAnimation	是	点注释的标题动画。

示例：

let animation: map.FontSizeAnimation = new map.FontSizeAnimation(5, 25);
animation.setDuration(3000);
animation.on("start",() => {
  console.info('start Font Animation');
});
animation.on("end",() => {
  console.info('end Font Animation');
});
// 设置动画完成的状态
animation.setFillMode(map.AnimationFillMode.BACKWARDS);
// 设置动画重复方式
animation.setRepeatMode(map.AnimationRepeatMode.REVERSE);
// 设置动画的插值器
animation.setInterpolator(Curve.Linear);
// 设置动画重复的次数
animation.setRepeatCount(100);
pointAnnotation.setTitleAnimation(animation);
pointAnnotation.startTitleAnimation();

[h2]startTitleAnimation

startTitleAnimation(): void

启动点注释的标题动画。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

示例：

pointAnnotation.startTitleAnimation();

Bubble

气泡，继承BasePriorityOverlay。在调用map.MapComponentController类的addBubble方法时会返回该类型的实例。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

模块提供以下方法，支持更新和查询气泡相关属性，其它方法见覆盖物基础类BasePriorityOverlay。

返回值

说明

Promise<void>

setIcons(icons: Array<string | image.PixelMap | Resource>)

设置气泡的图标。使用Promise异步回调。

void

setPositions(positions: Array<Array<mapCommon.LatLng>>)

设置气泡的候选位置坐标。

示例：

let bubbleOptions: mapCommon.BubbleParams = {
  positions: [[{
    latitude: 31.98, longitude: 118.766
  }]],
  icons: [
    'icon.png',
    'icon.png',
    'icon.png',
    'icon.png'
  ],
  forceVisible: true,
  priority: 3,
  minZoom: 2,
  maxZoom: 20,
  visible: true,
  zIndex: 1
};
let bubble: map.Bubble = await this.mapController.addBubble(bubbleOptions);

[h2]setIcons

setIcons(icons: Array<string | image.PixelMap | Resource>): Promise<void>

设置气泡的图标。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名

类型

必填

说明

icons

Array<string | image.PixelMap | Resource>

是

气泡的图标。

必须提供4个方向的图标，传入的图标宽高需要相同。
图片格式支持jpg、jpeg、png、gif、webp、svg。
string类型入参支持两种格式：
- 资源相对路径格式：图标存放在resources/rawfile，icon参数传入rawfile文件夹下的相对路径。
- toDataURL格式（如data:image/png;base64,<图片的Base64字节编码值>）。

说明：

从5.0.0(12)版本开始，icon属性支持Resource和image.PixelMap类型。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

import { image } from '@kit.ImageKit';

let icons: Array<string | image.PixelMap | Resource> = [
  'test1.png',
  'test2.png',
  'test3.png',
  'test4.png'
];
await bubble.setIcons(icons);

[h2]setPositions

setPositions(positions: Array<Array<mapCommon.LatLng>>): void

设置气泡的候选位置坐标。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
positions	Array<Array<mapCommon.LatLng>>	是	气泡的候选位置坐标。

示例：

let positions: Array<Array<mapCommon.LatLng>> = [[
  { latitude: 31.9844, longitude: 118.7112 },
  { latitude: 31.9844, longitude: 118.7262 },
  { latitude: 31.9844, longitude: 118.7362 },
  { latitude: 31.9844, longitude: 118.7462 },
  { latitude: 31.9844, longitude: 118.7562 },
  { latitude: 31.9844, longitude: 118.7662 },
  { latitude: 31.9844, longitude: 118.7762 }
]];
bubble.setPositions(positions);

CameraUpdate

CameraUpdate定义了相机移动参数。CameraUpdate的创建方法参见newCameraPosition等function。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

示例：

let target: mapCommon.LatLng = {
  latitude: 39.9,
  longitude: 116.4
};
let cameraPosition: mapCommon.CameraPosition = {
  target: target,
  zoom: 10
};
// 新建CameraUpdate对象
let cameraUpdate: map.CameraUpdate = map.newCameraPosition(cameraPosition);
// 移动相机
this.mapController.moveCamera(cameraUpdate);

Projection

用于在屏幕坐标和经纬度之间进行转换，在调用map.MapComponentController类的getProjection方法时会返回该类型的实例。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

模块提供以下方法。

返回类型	方法
mapCommon.LatLng	fromScreenLocation(point: mapCommon.MapPoint) 将屏幕像素点坐标转换成经纬度。
mapCommon.MapPoint	toScreenLocation(position: mapCommon.LatLng) 将经纬度转换为对应的屏幕上的点的坐标。
mapCommon.VisibleRegion	getVisibleRegion() 获取在屏幕坐标和地理经纬度坐标之间转换之后的可见区域。
mapCommon.LatLngBounds	getMapBounds(center: mapCommon.LatLng, zoom: number) 根据中心点和缩放级别获取地图控件对应的目标区域。

示例：

let projection: map.Projection = this.mapController?.getProjection();

[h2]fromScreenLocation

fromScreenLocation(point: mapCommon.MapPoint): mapCommon.LatLng

将屏幕像素点坐标转换成经纬度。屏幕位置是以相对于地图左上角（而不是整个屏幕的左上角）的屏幕像素（而非显示像素）指定的。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
point	mapCommon.MapPoint	是	屏幕上的坐标点，单位：px。

返回值：

类型

说明

mapCommon.LatLng

经纬度坐标。

对异常值进行处理，返回Number.NaN。

示例：

let point: mapCommon.MapPoint = {
  positionX: 10,
  positionY: 10
};
let latLng: mapCommon.LatLng = projection.fromScreenLocation(point);

[h2]toScreenLocation

toScreenLocation(position: mapCommon.LatLng): mapCommon.MapPoint

将经纬度转换为对应的屏幕上的点的坐标。屏幕上的点的坐标是以相对于地图左上角（而不是整个屏幕的左上角）的屏幕像素（而非显示像素）指定的。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名

类型

必填

说明

position

mapCommon.LatLng

是

经纬度坐标。

取值范围：经度[-180, 180]，纬度[-85.05, 85.05]。

返回值：

类型

说明

mapCommon.MapPoint

屏幕上的坐标点，单位：px。

对异常值进行处理，返回0。

示例：

let position: mapCommon.MapPoint = projection.toScreenLocation({ latitude: 31.984, longitude: 118.766 });

[h2]getVisibleRegion

getVisibleRegion(): mapCommon.VisibleRegion

获取在屏幕坐标和地理经纬度坐标之间转换之后的可见区域。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
mapCommon.VisibleRegion	可见区域。

示例：

let visibleRegion: mapCommon.VisibleRegion = projection.getVisibleRegion();

[h2]getMapBounds

getMapBounds(center: mapCommon.LatLng, zoom: number): mapCommon.LatLngBounds

根据中心点和缩放级别获取地图控件对应的目标区域。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
center	mapCommon.LatLng	是	中心点经纬度坐标。
zoom	number	是	缩放级别。

返回值：

类型	说明
mapCommon.LatLngBounds	目标区域。

示例：

let position: mapCommon.LatLng = {
  latitude: 31.98, longitude: 118.766
};
let result: mapCommon.LatLngBounds = projection.getMapBounds(position, 10);

LatLngBoundsUtils

LatLngBounds工具类。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

模块提供以下方法。

返回类型	方法
boolean	static contains(bounds: mapCommon.LatLngBounds, position: mapCommon.LatLng) 判断LatLngBounds是否包含某位置坐标。
boolean	static contains(src: mapCommon.LatLngBounds, target: mapCommon.LatLngBounds) 判断LatLngBounds是否包含目标区域。
mapCommon.LatLng	static getCenter(bounds: mapCommon.LatLngBounds) 获取LatLngBounds的中心经纬度坐标。
mapCommon.LatLngBounds	static include(position: mapCommon.LatLng, bounds?: mapCommon.LatLngBounds) 获取一个包含指定位置的LatLngBounds对象。

[h2]contains

static contains(bounds: mapCommon.LatLngBounds, position: mapCommon.LatLng): boolean

判断LatLngBounds是否包含某位置坐标。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
bounds	mapCommon.LatLngBounds	是	LatLngBounds对象。
position	mapCommon.LatLng	是	用于判断的位置坐标。

返回值：

类型

说明

boolean

true：包含该位置点。

false：不包含该位置点。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.

示例：

let bounds: mapCommon.LatLngBounds = {
  southwest: {
    latitude: 31.98, longitude: 118.766
  },
  northeast: {
    latitude: 32.08, longitude: 118.066
  }
};
let result: boolean = map.LatLngBoundsUtils.contains(bounds, { latitude: 15, longitude: 15 });

[h2]contains

static contains(src: mapCommon.LatLngBounds, target: mapCommon.LatLngBounds): boolean

判断LatLngBounds是否包含目标区域。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
src	mapCommon.LatLngBounds	是	LatLngBounds对象。
target	mapCommon.LatLngBounds	是	目标区域。

返回值：

类型

说明

boolean

true：包含该区域。

false：不包含该区域。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.

示例：

let src: mapCommon.LatLngBounds = {
  southwest: {
    latitude: 31.98, longitude: 118
  },
  northeast: {
    latitude: 31.08, longitude: 119
  }
};
let target: mapCommon.LatLngBounds = {
  southwest: {
    latitude: 33, longitude: 120
  },
  northeast: {
    latitude: 34, longitude: 121
  }
};

let result: boolean = map.LatLngBoundsUtils.contains(src, target);

[h2]getCenter

static getCenter(bounds: mapCommon.LatLngBounds): mapCommon.LatLng

获取LatLngBounds的中心经纬度坐标。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
bounds	mapCommon.LatLngBounds	是	LatLngBounds对象。

返回值：

类型	说明
mapCommon.LatLng	中心经纬度坐标。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.

示例：

let bounds: mapCommon.LatLngBounds = {
  southwest: {
    latitude: 31, longitude: 118
  },
  northeast: {
    latitude: 33, longitude: 119
  }
};
let center: mapCommon.LatLng = map.LatLngBoundsUtils.getCenter(bounds);

[h2]include

static include(position: mapCommon.LatLng, bounds?: mapCommon.LatLngBounds): mapCommon.LatLngBounds

获取一个包含指定位置的LatLngBounds对象。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
position	mapCommon.LatLng	是	位置坐标。
bounds	mapCommon.LatLngBounds	否	LatLngBounds对象。

返回值：

类型	说明
mapCommon.LatLngBounds	包含指定位置的LatLngBounds对象。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.

示例：

let resultBounds: mapCommon.LatLngBounds = map.LatLngBoundsUtils.include({ latitude: 31, longitude: 118 });

Animation

动画抽象类。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

模块提供以下方法。

返回类型	方法
void	setDuration(duration: number) 设置动画持续时间。
void	setFillMode(fillMode: AnimationFillMode) 设置动画执行完成后的状态。
void	setInterpolator(curve: Curves.Curve) 设置动画插值器。
void	setRepeatCount(repeatCount: number) 设置动画重复执行的次数。
void	setRepeatMode(repeatMode: AnimationRepeatMode) 设置重复执行的模式，默认从前往后执行。
void	on(type: 'start', callback: Callback<void>) 回调函数，监听动画开始事件。建议使用animation.on(type: 'animationStart')。
void	off(type: 'start', callback: Callback<void>) 回调函数，取消监听动画开始事件。建议使用animation.off(type: 'animationStart')。
void	on(type: 'end', callback: Callback<void>) 回调函数，监听动画结束事件。建议使用animation.on(type: 'animationEnd')。
void	off(type: 'end', callback: Callback<void>) 回调函数，取消监听动画结束事件。建议使用animation.off(type: 'animationEnd')。
void	on(type: 'animationStart', callback: Callback<void>) 回调函数，监听动画开始事件。
void	off(type: 'animationStart', callback?: Callback<void>) 回调函数，取消监听动画开始事件。
void	on(type: 'animationEnd', callback: Callback<void>) 回调函数，监听动画结束事件。
void	off(type: 'animationEnd', callback?: Callback<void>) 回调函数，取消监听动画结束事件。

示例：

let animation = new map.RotateAnimation(0, 270);
// 动画执行时间
animation.setDuration(2000);

// 动画结束状态
animation.setFillMode(map.AnimationFillMode.BACKWARDS);

// 动画重复模式
animation.setRepeatMode(map.AnimationRepeatMode.REVERSE);

// 动画重复次数
animation.setRepeatCount(100);

// 根据开发需要设置动画监听
let callbackStart = () => {
  console.info("animationStart", `callback`);
};
let callbackEnd = () => {
  console.info("animationEnd", `callback`);
};
animation.on("animationStart", callbackStart);
animation.on("animationEnd", callbackEnd);

[h2]setDuration

setDuration(duration: number): void

设置动画持续时间。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
duration	number	是	动画持续时间，单位：ms，默认值为250，取值范围：大于等于0。

示例：

animation.setDuration(3000);

[h2]setFillMode

setFillMode(fillMode: AnimationFillMode): void

设置动画执行完成后的状态。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
fillMode	AnimationFillMode	是	动画执行完成后的状态，默认值为AnimationFillMode.FORWARDS。

示例：

animation.setFillMode(map.AnimationFillMode.BACKWARDS);

[h2]setInterpolator

setInterpolator(curve: Curves.Curve): void

设置动画插值器。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
curve	Curves.Curve	是	动画插值器，默认值为Curve.Linear。

示例：

animation.setInterpolator(Curve.Linear);

[h2]setRepeatCount

setRepeatCount(repeatCount: number): void

设置动画重复执行的次数。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名

类型

必填

说明

repeatCount

number

是

动画重复执行的次数，默认值为0。

正数：根据值重复执行
0：动画不重复执行
-1：执行次数是无限
小于-1：使用默认值0
异常值按默认值处理

示例：

animation.setRepeatCount(100);

[h2]setRepeatMode

setRepeatMode(repeatMode: AnimationRepeatMode): void

设置重复执行的模式，默认从前往后执行。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
repeatMode	AnimationRepeatMode	是	重复执行的模式，默认值为AnimationRepeatMode.RESTART。

示例：

animation.setRepeatMode(map.AnimationRepeatMode.RESTART);

[h2]on(type: 'start')

on(type: 'start', callback: Callback<void>): void

监听动画开始事件。使用callback异步回调。

建议使用animation.on(type: 'animationStart')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'start'：动画开始事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

animation.on("start", () => {
  console.info(`start alphaAnimation`);
});

[h2]off(type: 'start')

off(type: 'start', callback: Callback<void>): void

取消监听动画开始事件。使用callback异步回调。

建议使用animation.off(type: 'animationStart')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'start'：动画开始事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

animation.off("start", () => {
  console.info(`start alphaAnimation`);
});

[h2]on(type: 'end')

on(type: 'end', callback: Callback<void>): void

监听动画结束事件。使用callback异步回调。

建议使用animation.on(type: 'animationEnd')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'end'：动画结束事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

animation.on("end", () => {
  console.info(`end alphaAnimation`);
});

[h2]off(type: 'end')

off(type: 'end', callback: Callback<void>): void

取消监听动画结束事件。使用callback异步回调。

建议使用animation.off(type: 'animationEnd')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
type	string	是	'end'：动画结束事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。

示例：

animation.off("end", () => {
  console.info(`end alphaAnimation`);
});

[h2]on(type: 'animationStart')

on(type: 'animationStart', callback: Callback<void>): void

监听动画开始事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'animationStart'：监听动画开始事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。监听动画开始事件。

示例：

let callback1 = () => {
  console.info("animationStart", `callback1`);
};
let callback2 = () => {
  console.info("animationStart", `callback2`);
};
let callback3 = () => {
  console.info("animationStart", `callback3`);
};
animation.on("animationStart", callback1);
animation.on("animationStart", callback2);
animation.on("animationStart", callback3);

[h2]off(type: 'animationStart')

off(type: 'animationStart', callback?: Callback<void>): void

取消监听动画开始事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'animationStart'：监听动画开始事件。

callback

Callback<void>

否

回调函数。无返回结果的回调函数。取消监听动画开始事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = () => {
  console.info("animationStart", `callback1`);
};
let callback2 = () => {
  console.info("animationStart", `callback2`);
};
let callback3 = () => {
  console.info("animationStart", `callback3`);
};
animation.on("animationStart", callback1);
animation.on("animationStart", callback2);
animation.on("animationStart", callback3);

// 只取消callback1对象的事件响应，当animationStart事件发生时，callback2和callback3会正常被调用
animation.off('animationStart', callback1);
// 取消全部animationStart事件响应
animation.off('animationStart');

[h2]on(type: 'animationEnd')

on(type: 'animationEnd', callback: Callback<void>): void

监听动画结束事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'animationEnd'：动画结束事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。监听动画结束事件。

示例：

let callback1 = () => {
  console.info("animationEnd", `callback1`);
};
let callback2 = () => {
  console.info("animationEnd", `callback2`);
};
let callback3 = () => {
  console.info("animationEnd", `callback3`);
};
animation.on("animationEnd", callback1);
animation.on("animationEnd", callback2);
animation.on("animationEnd", callback3);

[h2]off(type: 'animationEnd')

off(type: 'animationEnd', callback?: Callback<void>): void

取消监听动画结束事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'animationEnd'：监听动画结束事件。

callback

Callback<void>

否

回调函数。无返回结果的回调函数。取消监听动画结束事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = () => {
  console.info("animationEnd", `callback1`);
};
let callback2 = () => {
  console.info("animationEnd", `callback2`);
};
let callback3 = () => {
  console.info("animationEnd", `callback3`);
};
animation.on("animationEnd", callback1);
animation.on("animationEnd", callback2);
animation.on("animationEnd", callback3);

// 只取消callback1对象的事件响应，当animationEnd事件发生时，callback2和callback3会正常被调用
animation.off('animationEnd', callback1);
// 取消全部animationEnd事件响应
animation.off('animationEnd');

AlphaAnimation

AlphaAnimation(fromAlpha: number, toAlpha: number)

控制透明度的动画类，继承Animation。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

构造函数：

参数名	类型	必填	说明
fromAlpha	number	是	起始透明度。透明度范围为[0, 1]，1为不透明，0为完全透明。
toAlpha	number	是	目标透明度。透明度范围为[0, 1]，1为不透明，0为完全透明。

示例：

let animation: map.AlphaAnimation = new map.AlphaAnimation(0.2, 1);

RotateAnimation

RotateAnimation(fromDegree: number, toDegree: number)

控制旋转的动画类，继承Animation。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

构造函数：

参数名	类型	必填	说明
fromDegree	number	是	起始角度。角度的范围为[0, 360]。
toDegree	number	是	目标角度。角度的范围为[0, 360]。

示例：

let animation: map.RotateAnimation = new map.RotateAnimation(15, 150);

ScaleAnimation

ScaleAnimation(fromX: number, toX: number, fromY: number, toY: number)

控制缩放的动画类，继承Animation。

0表示缩小消失。

1表示不缩放。

小于1的值表示缩小。

大于1的值表示放大。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

构造函数：

参数名	类型	必填	说明
fromX	number	是	指动画开始时应用的水平缩放倍数。
toX	number	是	指动画结束时应用的水平缩放倍数。
fromY	number	是	指动画开始时应用的垂直缩放倍数。
toY	number	是	指动画结束时应用的垂直缩放倍数。

示例：

let animation: map.ScaleAnimation = new map.ScaleAnimation(1, 3, 1, 3);

TranslateAnimation

TranslateAnimation(target: mapCommon.LatLng)

控制移动的动画类，继承Animation。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

构造函数：

参数名	类型	必填	说明
target	mapCommon.LatLng	是	需要移动的目标位置，位置类型为经纬度。

示例：

let target: mapCommon.LatLng = { latitude: 31, longitude: 118 };
let animation: map.TranslateAnimation = new map.TranslateAnimation(target);

FontSizeAnimation

FontSizeAnimation(fromSize: number, toSize: number)

控制字体大小的动画类，继承Animation。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

构造函数：

参数名	类型	必填	说明
fromSize	number	是	起始的字体大小。
toSize	number	是	目标的字体大小。

示例：

let animation: map.FontSizeAnimation = new map.FontSizeAnimation(5, 25);

PlayImageAnimation

控制多张图片的帧动画，继承Animation。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

模块提供以下方法。

返回类型

方法

Promise<void>

addImages(images: Array<ResourceStr | image.PixelMap>)

添加图片，使用Promise异步回调。

示例：

import { image } from '@kit.ImageKit';

let images: Array<ResourceStr | image.PixelMap> = [
   'test1.png',
   'test2.png',
   'test3.png',
   'test4.png'
];
let playImageAnimation: map.PlayImageAnimation = new map.PlayImageAnimation();
await playImageAnimation.addImages(images);

[h2]addImages

addImages(images: Array<ResourceStr | image.PixelMap>): Promise<void>

添加动画的图片资源。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
images	Array<ResourceStr \| image.PixelMap>	是	动画的图片资源。说明：建议图片大小相同。图片数量不超过200张。持续时间需要大于33毫秒。如果不是，它将被更改为33。 string类型入参，图片存放在resources/rawfile。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.

示例：

import { image } from '@kit.ImageKit';

let images: Array<ResourceStr | image.PixelMap> = [
   'test1.png',
   'test2.png',
   'test3.png',
   'test4.png'
];
await playImageAnimation.addImages(images);

AnimationSet

AnimationSet(shareInterpolator: boolean)

动画类的集合，继承Animation。

动画类集合继承Animation方法，仅shareInterpolator为true时共享插值器，其他属性不共享，不支持设置。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

构造函数：

参数名

类型

必填

说明

shareInterpolator

boolean

是

定义是否共享插值器。

true：共享
false：不共享

模块提供以下方法。

返回类型

方法

void

addAnimation(animation: Animation)

动画类集合增加动画。

void

clearAnimation(): void

清空动画类集合。

示例：

let animation1: map.AlphaAnimation = new map.AlphaAnimation(0.2, 1);
let animation2: map.RotateAnimation = new map.RotateAnimation(15, 150);
let animation3: map.ScaleAnimation = new map.ScaleAnimation(1, 3, 1, 3);
let animation = new map.AnimationSet(true);
animation.setInterpolator(Curve.Linear);
animation.addAnimation(animation1);
animation.addAnimation(animation2);
animation.addAnimation(animation3);
animation.clearAnimation();

[h2]addAnimation

addAnimation(animation: Animation): void

动画类集合增加动画。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
animation	Animation	是	动画类集合增加动画。

示例：

let animation1: map.AlphaAnimation = new map.AlphaAnimation(0.2, 1);
let animation2: map.RotateAnimation = new map.RotateAnimation(15, 150);
let animation3: map.ScaleAnimation = new map.ScaleAnimation(1, 3, 1, 3);
let animation = new map.AnimationSet(true);
animation.addAnimation(animation1);
animation.addAnimation(animation2);
animation.addAnimation(animation3);

[h2]clearAnimation

clearAnimation(): void

清空动画类集合。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

示例：

let animation1: map.AlphaAnimation = new map.AlphaAnimation(0.2, 1);
let animation2: map.RotateAnimation = new map.RotateAnimation(15, 150);
let animation3: map.ScaleAnimation = new map.ScaleAnimation(1, 3, 1, 3);
let animation = new map.AnimationSet(true);
animation.addAnimation(animation1);
animation.addAnimation(animation2);
animation.addAnimation(animation3);
animation.clearAnimation();

ClusterOverlay

聚合图层类。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

模块提供以下方法，支持更新和查询聚合图层类相关属性。

返回值	说明
void	on(type: 'clusterClick', callback: Callback<Array<mapCommon.ClusterItem>>) 监听cluster的点击事件。建议使用ClusterOverlay.on(type: 'click')。
void	off(type: 'clusterClick', callback?: Callback<void>) 取消监听cluster的点击事件。建议使用ClusterOverlay.off(type: 'click')。
void	on(type: 'click', callback: Callback<Array<mapCommon.ClusterItem>>) 监听cluster的点击事件。
void	off(type: 'click', callback?: Callback<Array<mapCommon.ClusterItem>>) 取消监听cluster的点击事件。
Promise<void>	addItem(item: mapCommon.ClusterItem) 新增聚合节点，使用Promise异步回调。
Promise<void>	remove() 移除聚合图层，使用Promise异步回调。

示例：

let clusterItem1: mapCommon.ClusterItem = {
  position: {
    latitude: 31.984,
    longitude: 118.766
  }
};
let clusterItem2: mapCommon.ClusterItem = {
  position: {
    latitude: 31.974,
    longitude:118.75
  }
};
let array: Array<mapCommon.ClusterItem> = [
  clusterItem1,
  clusterItem2
];
let clusterOverlayParams: mapCommon.ClusterOverlayParams = { distance: 40, clusterItems: array };
let clusterOverlay: map.ClusterOverlay = await this.mapController.addClusterOverlay(clusterOverlayParams);

[h2]on(type: 'clusterClick')

on(type: 'clusterClick', callback: Callback<Array<mapCommon.ClusterItem>>): void

监听cluster的点击事件。使用callback异步回调。

建议使用ClusterOverlay.on(type: 'click')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'clusterClick'：聚合图层的聚合点点击监听事件。
callback	Callback<Array<mapCommon.ClusterItem>>	是	回调函数，返回Array<mapCommon.ClusterItem>。

示例：

clusterOverlay.on("clusterClick", (clusterItems) => {
  console.info(`callback: ${clusterItems.length}`);
});

[h2]off(type: 'clusterClick')

off(type: 'clusterClick', callback?: Callback<void>): void

取消监听cluster的点击事件。使用callback异步回调。

建议使用ClusterOverlay.off(type: 'click')。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'clusterClick'：聚合图层的聚合点点击监听事件。
callback	Callback<void>	否	回调函数。无返回结果的回调函数。

示例：

clusterOverlay.off("clusterClick", () => {
  console.info("callback off");
});

[h2]on(type: 'click')

on(type: 'click', callback: Callback<Array<mapCommon.ClusterItem>>): void

监听聚合图层的聚合点点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'click'：监听聚合图层的聚合点点击事件。
callback	Callback<Array<mapCommon.ClusterItem>>	是	回调函数，返回Array<mapCommon.ClusterItem>，监听聚合图层的聚合点点击事件。

示例：

let callback1 = (clusterItem: Array<mapCommon.ClusterItem>) => {
  console.info("click", `callback1 clusterItem length: ${clusterItem.length}`);
};
let callback2 = (clusterItem: Array<mapCommon.ClusterItem>) => {
  console.info("click", `callback2 clusterItem length: ${clusterItem.length}`);
};
let callback3 = (clusterItem: Array<mapCommon.ClusterItem>) => {
  console.info("click", `callback3 clusterItem length: ${clusterItem.length}`);
};
clusterOverlay.on("click", callback1);
clusterOverlay.on("click", callback2);
clusterOverlay.on("click", callback3);

[h2]off(type: 'click')

off(type: 'click', callback?: Callback<Array<mapCommon.ClusterItem>>): void

取消监听聚合图层的聚合点点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'click'：监听聚合图层的聚合点点击事件。

callback

Callback<Array<mapCommon.ClusterItem>>

否

回调函数，返回Array<mapCommon.ClusterItem>，取消监听聚合图层的聚合点点击事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = (clusterItem: Array<mapCommon.ClusterItem>) => {
  console.info("click", `callback1 clusterItem`);
};
let callback2 = (clusterItem: Array<mapCommon.ClusterItem>) => {
  console.info("click", `callback2 clusterItem`);
};
let callback3 = (clusterItem: Array<mapCommon.ClusterItem>) => {
  console.info("click", `callback3 clusterItem`);
};
clusterOverlay.on("click", callback1);
clusterOverlay.on("click", callback2);
clusterOverlay.on("click", callback3);

// 只取消callback1对象的事件响应，当click事件发生时，callback2和callback3会正常被调用
clusterOverlay.off('click', callback1);
// 取消全部click事件响应
clusterOverlay.off('click');

[h2]addItem

addItem(item: mapCommon.ClusterItem): Promise<void>

新增聚合节点。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
item	mapCommon.ClusterItem	是	待聚合节点。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

let clusterItem: mapCommon.ClusterItem = {
  position: {
    latitude: 31.98,
    longitude: 118.766
  }
};
await clusterOverlay.addItem(clusterItem);

[h2]remove

remove(): Promise<void>

移除聚合图层。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

await clusterOverlay.remove();

ImageOverlay

图片覆盖物。继承BaseOverlay。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

模块提供以下方法，支持更新和查询图片覆盖物相关属性，其他方法见覆盖物基础类BaseOverlay。

返回值	说明
number	getBearing() 获取覆盖物的旋转角度。
mapCommon.LatLngBounds	getBounds() 获取覆盖物的矩形区域。
number	getHeight() 获取覆盖物的高度。
number	getWidth() 获取覆盖物的宽度。
mapCommon.LatLng	getPosition() 获取覆盖物的位置。
number	getTransparency() 获取覆盖物的透明度。
boolean	isClickable() 获取覆盖物是否可点击。
void	setBearing(bearing: number) 设置覆盖物旋转角度。
void	setClickable(clickable: boolean) 设置覆盖物是否可点击。
void	setDimensions(width: number, height?: number) 设置覆盖物的宽度和高度。
Promise<void>	setImage(image: ResourceStr \| image.PixelMap) 设置覆盖物的图像，使用Promise异步回调。
void	setBounds(bounds: mapCommon.LatLngBounds) 设置覆盖物的矩形区域。
void	setPosition(position: mapCommon.LatLng) 设置覆盖物的位置。
void	setTransparency(transparency: number) 设置覆盖物的透明度。

示例：

let imageOverlayParams: mapCommon.ImageOverlayParams = {
  bounds: {
    southwest: { latitude: 32, longitude: 118 },
    northeast: { latitude: 32.4, longitude: 118.4 }
  },
  image: 'icon.png',
  transparency: 0.3,
  zIndex: 101,
  anchorU: 0.5,
  anchorV: 0.5,
  clickable: true,
  visible: true,
  bearing: 0
};
let imageOverlay = await this.mapController?.addImageOverlay(imageOverlayParams);
imageOverlay.setBearing(180);
let bearing: number = imageOverlay.getBearing();

[h2]getBearing

getBearing(): number

获取覆盖物的旋转角度。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

返回值：

类型	说明
number	返回覆盖物的旋转角度。

示例：

let bearing: number = imageOverlay.getBearing();

[h2]getBounds

getBounds(): mapCommon.LatLngBounds

获取覆盖物的矩形区域。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

返回值：

类型	说明
mapCommon.LatLngBounds	获取覆盖物的矩形区域。

示例：

let bounds: mapCommon.LatLngBounds = imageOverlay.getBounds();

[h2]getHeight

getHeight(): number

获取覆盖物的高度。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

返回值：

类型	说明
number	覆盖物的高度，单位：米。

示例：

let height: number = imageOverlay.getHeight();

[h2]getWidth

getWidth(): number

获取覆盖物的宽度。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

返回值：

类型	说明
number	覆盖物的宽度，单位：米。

示例：

let width: number = imageOverlay.getWidth();

[h2]getPosition

getPosition(): mapCommon.LatLng

获取覆盖物的位置。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

返回值：

类型	说明
mapCommon.LatLng	覆盖物的位置。

示例：

let position: mapCommon.LatLng = imageOverlay.getPosition();

[h2]getTransparency

getTransparency(): number

获取覆盖物的透明度。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

返回值：

类型	说明
number	覆盖物的透明度。取值范围：[0, 1]。0表示不透明，1表示全透明。

示例：

let transparency: number = imageOverlay.getTransparency();

[h2]isClickable

isClickable(): boolean

获取是否可点击。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

返回值：

类型

说明

boolean

是否可点击。

true：可点击
false：不可点击

示例：

let click: boolean = imageOverlay.isClickable();

[h2]setBearing

setBearing(bearing: number): void

设置覆盖物的旋转角度。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

bearing

number

是

覆盖物的旋转角度。

示例：

imageOverlay.setBearing(180);

[h2]setClickable

setClickable(clickable: boolean): void

设置是否开启可点击开关。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

clickable

boolean

是

是否开启可点击开关。

true：开启
false：不开启

示例：

imageOverlay.setClickable(false);

[h2]setDimensions

setDimensions(width: number, height?: number): void

设置覆盖物的宽度和高度。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
width	number	是	宽度。width为正整数，单位：米。
height	number	否	高度。height为正整数，单位：米。若不设置高度，则以覆盖物图片默认宽高比例显示高度。

示例：

imageOverlay.setDimensions(100000, 100000);

[h2]setImage

setImage(image: ResourceStr | image.PixelMap): Promise<void>

设置覆盖物的图像。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

image

ResourceStr | image.PixelMap

是

覆盖物的图像。

图片格式支持jpg、jpeg、png、gif、webp、svg。

说明：

ResourceStr为Resource和string两种格式，其中string类型入参支持两种格式：

资源相对路径格式：图标存放在resources/rawfile，image参数传入rawfile文件夹下的相对路径。
toDataURL格式（如data:image/png;base64,<图片的Base64字节编码值>）。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

await imageOverlay.setImage("icon.png");

[h2]setBounds

setBounds(bounds: mapCommon.LatLngBounds): void

设置覆盖物的矩形区域。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
bounds	mapCommon.LatLngBounds	是	覆盖物的矩形区域。

示例：

let bounds: mapCommon.LatLngBounds = {
  southwest: { longitude: 118, latitude: 31 },
  northeast: { longitude: 119, latitude: 32 }
};
imageOverlay.setBounds(bounds);

[h2]setPosition

setPosition(position: mapCommon.LatLng): void

设置覆盖物的位置。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
position	mapCommon.LatLng	是	覆盖物的位置。

示例：

let position: mapCommon.LatLng = { longitude: 118, latitude: 31 };
imageOverlay.setPosition(position);

[h2]setTransparency

setTransparency(transparency: number): void

设置覆盖物的透明度。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
transparency	number	是	覆盖物的透明度。取值范围：[0, 1]。0表示不透明，1表示全透明。

示例：

imageOverlay.setTransparency(0.1);

BuildingOverlay

3D建筑物。缩放到建筑物级别时，才显示3D建筑物效果。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

模块提供以下方法，支持更新和查询图片覆盖物相关属性，其他方法见覆盖物基础类BaseOverlay。

返回值	说明
string	getId() 返回3D建筑物的ID。
void	remove() 移除3D建筑物。
void	setSideVisible(visible: boolean) 设置是否显示3D建筑物的侧面和顶部。如果不想显示3D建筑物，需要同时将setSideVisible和setFloorVisible设置为false。
void	setFloorVisible(visible: boolean) 设置是否显示选中的楼层。
void	setFloorBottomHeight(height: number) 设置所选楼层底部到地面的高度。

示例：

let points: Array<mapCommon.LatLng> = [
  {
    latitude: 31.984794,
    longitude: 118.765865
  },
  {
    latitude: 31.98468,
    longitude: 118.766076
  },
  {
    latitude: 31.98472,
    longitude: 118.766116
  },
  {
    latitude: 31.98463,
    longitude: 118.766292
  },
  {
    latitude: 31.984586,
    longitude: 118.766251
  },
  {
    latitude: 31.984536,
    longitude: 118.766344
  },
  {
    latitude: 31.984633,
    longitude: 118.766446
  },
  {
    latitude: 31.9848,
    longitude: 118.766285
  },
  {
    latitude: 31.984925,
    longitude: 118.766312
  },
  {
    latitude: 31.985282,
    longitude: 118.766661
  },
  {
    latitude: 31.985438,
    longitude: 118.766419
  },
  {
    latitude: 31.985801,
    longitude: 118.766755
  },
  {
    latitude: 31.985856,
    longitude: 118.766504
  },
  {
    latitude: 31.985785,
    longitude: 118.766434
  },
  {
    latitude: 31.985821,
    longitude: 118.766278
  },
  {
    latitude: 31.985897,
    longitude: 118.766311
  },
  {
    latitude: 31.985944,
    longitude: 118.766095
  },
  {
    latitude: 31.985909,
    longitude: 118.766069
  },
  {
    latitude: 31.985794,
    longitude: 118.765989
  },
  {
    latitude: 31.9857,
    longitude: 118.766029
  },
  {
    latitude: 31.985658,
    longitude: 118.766164
  },
  {
    latitude: 31.985647,
    longitude: 118.766271
  },
  {
    latitude: 31.985574,
    longitude: 118.766297
  },
  {
    latitude: 31.985458,
    longitude: 118.766285
  },
  {
    latitude: 31.985271,
    longitude: 118.766002
  },
  {
    latitude: 31.985219,
    longitude: 118.766002
  },
  {
    latitude: 31.985135,
    longitude: 118.766029
  },
  {
    latitude: 31.985093,
    longitude: 118.766083
  },
  {
    latitude: 31.985019,
    longitude: 118.766109
  },
  {
    latitude: 31.984978,
    longitude: 118.766083
  },
  {
    latitude: 31.984794,
    longitude: 118.765865
  }
];
points.reverse();
// 3D建筑参数
let buildingOverlayOptions: mapCommon.BuildingOverlayParams =
  {
    // 3D建筑的范围参数（点为顺时针绘制）
    points: points,
    // 3D建筑的高度
    totalHeight: 51,
    // 3D建筑的选中楼层高度
    floorBottomHeight: 33,
    // 3D建筑的顶部颜色
    topFaceColor: 0xffa4b8f7,
    // 3D建筑的侧面颜色
    sideFaceColor: 0x44a4b8f7,
    // 3D建筑的选中楼层颜色
    floorColor: 0xff000000,
    // 3D建筑的展示层级
    showLevel: 14,
    // 3D建筑选中楼层从底部升起的动画时长
    animationDuration: 5000,
    // 3D建筑侧面的纹理
    sideTexture: { image: $r("app.media.side_tex"), height: 3, width: 3 },
    // 3D建筑选中楼层的纹理
    floorTexture: { image: $r("app.media.floor_tex"), height: 3, width: 3 }
  }
let buildingOverlay: map.BuildingOverlay= await this.mapController?.addBuildingOverlay(buildingOverlayOptions);

[h2]getId

getId(): string

返回3D建筑物的ID。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

返回值：

类型	说明
string	返回3D建筑物的ID。

示例：

let id: String = buildingOverlay.getId();

[h2]remove

remove(): void

移除3D建筑物。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

示例：

buildingOverlay.remove();

[h2]setSideVisible

setSideVisible(visible: boolean): void

设置是否显示3D建筑物的侧面和顶部。如果不需要显示3D建筑物，请同时将setSideVisible和setFloorVisible设置为false。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

visible

boolean

是

是否显示3D建筑物的侧面和顶部。

true：显示
false：不显示

示例：

buildingOverlay.setSideVisible(true);

[h2]setFloorVisible

setFloorVisible(visible: boolean): void

设置是否显示选中的楼层。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

visible

boolean

是

是否显示建筑物的所选楼层。

true：显示
false：不显示

示例：

buildingOverlay.setFloorVisible(true);

[h2]setFloorBottomHeight

setFloorBottomHeight(height: number): void

设置所选楼层底部到地面的高度。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
height	number	是	所选楼层底部到地面的高度，单位：米，取值范围：大于等于0。

示例：

buildingOverlay.setFloorBottomHeight(80);

TraceOverlay

动态轨迹。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

模块提供以下方法，支持更新和查询动态轨迹相关属性。

返回值	说明
string	getId() 返回动态轨迹的ID。
void	remove() 删除动态轨迹。
void	pause() 暂停动态轨迹回放。
void	resume() 恢复动态轨迹回放。

示例：

// marker1的参数
let markerOptions1: mapCommon.MarkerOptions = {
  position: {
    latitude: 31.99227173519985,
    longitude: 118.7622219990476
  },
  icon: $r("app.media.track_setting_sport_map_marker_22"),
  anchorU: 0.5,
  anchorV: 1,
  visible: true
};
// 新增marker1
let markerBoy1 = await this.mapController.addMarker(markerOptions1);
let boyImages1: map.PlayImageAnimation = new map.PlayImageAnimation();
boyImages1.setDuration(1000);
let resourceArray: Array<Resource> = new Array();
resourceArray.push($r("app.media.side_0"));
resourceArray.push($r("app.media.side_1"));
resourceArray.push($r("app.media.side_2"));
resourceArray.push($r("app.media.side_3"));
resourceArray.push($r("app.media.side_4"));
resourceArray.push($r("app.media.side_5"));
resourceArray.push($r("app.media.side_6"));
resourceArray.push($r("app.media.side_7"));
resourceArray.push($r("app.media.side_8"));
resourceArray.push($r("app.media.side_9"));
resourceArray.push($r("app.media.side_10"));
resourceArray.push($r("app.media.side_11"));
resourceArray.push($r("app.media.side_12"));
resourceArray.push($r("app.media.side_13"));
resourceArray.push($r("app.media.side_14"));
resourceArray.push($r("app.media.side_15"));
resourceArray.push($r("app.media.side_16"));
resourceArray.push($r("app.media.side_17"));
resourceArray.push($r("app.media.side_18"));
resourceArray.push($r("app.media.side_19"));
resourceArray.push($r("app.media.side_20"));
await boyImages1.addImages(resourceArray);
boyImages1.setRepeatCount(-1);

// marker1添加动画
markerBoy1.setAnimation(boyImages1);
markerBoy1.startAnimation();

// marker2的参数
let markerOptions2: mapCommon.MarkerOptions = {
  position: {
    latitude: 31.99227173519985,
    longitude: 118.7622219990476
  },
  icon: $r("app.media.track_setting_sport_map_marker_22"),
  anchorU: 0.5,
  anchorV: 1,
  visible: false
};
// 新增marker2
let markerBoy2 = await this.mapController.addMarker(markerOptions2);
let boyImages2: map.PlayImageAnimation = new map.PlayImageAnimation();
boyImages2.setDuration(1000);
let resourceArray2: Array<Resource> = new Array();
resourceArray2.push($r("app.media.behavior_front_cycling_boy_000"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_001"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_002"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_003"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_004"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_005"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_006"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_007"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_008"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_009"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_010"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_011"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_012"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_013"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_014"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_015"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_016"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_017"));
resourceArray2.push($r("app.media.behavior_front_cycling_boy_018"));
await boyImages2.addImages(resourceArray2);
boyImages2.setRepeatCount(-1);
// marker2添加动画
markerBoy2.setAnimation(boyImages2);
markerBoy2.startAnimation();

let points: Array<mapCommon.LatLng> = new Array();
points.push({ latitude: 31.99685233070878, longitude: 118.75846023442728 });
points.push({ latitude: 31.99671325810786, longitude: 118.75846738985165 });
points.push({ latitude: 31.99659191076709, longitude: 118.7585347621686 });
points.push({ latitude: 31.99648202537233, longitude: 118.7586266510386 });
points.push({ latitude: 31.99637707201552, longitude: 118.75872004590596 });
points.push({ latitude: 31.996278207010903, longitude: 118.75880449946251 });
points.push({ latitude: 31.996187481969695, longitude: 118.7588781960278 });
points.push({ latitude: 31.996092248919354, longitude: 118.75895330554488 });
points.push({ latitude: 31.995962740450565, longitude: 118.75904721407304 });
points.push({ latitude: 31.995792921394, longitude: 118.75916904998051 });
points.push({ latitude: 31.995601885713416, longitude: 118.7593235241019 });
points.push({ latitude: 31.995398221178277, longitude: 118.75949998588176 });
points.push({ latitude: 31.995185902197715, longitude: 118.7596871082939 });
points.push({ latitude: 31.994983473052656, longitude: 118.75987334062296 });
points.push({ latitude: 31.99482433699269, longitude: 118.76002095184032 });
points.push({ latitude: 31.994709073721708, longitude: 118.76012902920532 });
points.push({ latitude: 31.99460732100702, longitude: 118.76023892576234 });
points.push({ latitude: 31.99449284962087, longitude: 118.7603694232856 });
points.push({ latitude: 31.99435358179254, longitude: 118.76053622438056 });
points.push({ latitude: 31.99420771148339, longitude: 118.76072790126692 });
points.push({ latitude: 31.994075194901523, longitude: 118.7609100960977 });
points.push({ latitude: 31.993952686158877, longitude: 118.7610741329013 });
points.push({ latitude: 31.993840180644217, longitude: 118.7612193418965 });
points.push({ latitude: 31.993733787150244, longitude: 118.76135383115654 });
points.push({ latitude: 31.993617206525155, longitude: 118.76150529647698 });

// 动态轨迹的入参
let tranceOptions: mapCommon.TraceOverlayParams = {
  // 轨迹点
  points: points,
  // 轨迹的动画时长
  animationDuration: 5000,
  // 相机是否跟随动画移动
  isMapMoving: true,
  // 轨迹的颜色
  color: 0xAAFFAA00,
  // 轨迹的宽度
  width: 20,
  // 轨迹的动画回调（回调轨迹点的index）
  animationCallback: (pointIndex) => {
    // 换成骑行
    if (pointIndex === 10) {
      markerBoy1.setVisible(false);
      markerBoy2.setVisible(true);
    }
  }
};
let markers: Array<map.Marker> = new Array();
markers.push(markerBoy1, markerBoy2);
// 新增轨迹点动画
let traceOverlay: map.TraceOverlay = await this.mapController.addTraceOverlay(tranceOptions, markers);

[h2]getId

getId(): string

返回动态轨迹的ID。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

返回值：

类型	说明
string	返回动态轨迹的ID。

示例：

let id: string = traceOverlay.getId();

[h2]remove

remove(): void

删除动态轨迹。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

示例：

traceOverlay.remove();

[h2]pause

pause(): void

暂停动态轨迹回放。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

示例：

traceOverlay.pause();

[h2]resume

resume(): void

恢复动态轨迹回放。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

示例：

traceOverlay.resume();

MapArc

弧线。继承BaseOverlay。在调用map.MapComponentController类的addArc方法时会返回该类型的实例。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

模块提供以下方法，支持更新和查询弧线相关属性。

返回值	说明
number	getColor() 返回弧线的颜色。
number	getWidth() 返回弧线的宽度。
void	setColor(color: number) 设置弧线的颜色。颜色值为ARGB格式。
void	setWidth(width: number) 设置弧线的宽度。

示例：

// 设置弧线参数
let mapArcParams: mapCommon.MapArcParams = {
  // 弧线起点坐标
  startPoint: {
    latitude: 39.913138,
    longitude: 116.415112
  },
  // 弧线终点坐标
  endPoint: {
    latitude: 28.239473,
    longitude: 112.954094
  },
  // 弧线中心点坐标
  centerPoint: {
    latitude: 33.86970399048567,
    longitude: 112.08633528544145
  },
  width: 10,
  color: 0xffff0000,
  visible: true,
  zIndex: 100
};
// 添加弧线
let mapArc: map.MapArc = this.mapController.addArc(mapArcParams);

[h2]getColor

getColor(): number

获取弧线的颜色。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

返回值：

类型	说明
number	ARGB格式颜色值。

示例：

let color: number = mapArc.getColor();

[h2]getWidth

getWidth(): number

获取弧线的宽度。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

返回值：

类型	说明
number	弧线的宽度。

示例：

let width: number = mapArc.getWidth();

[h2]setColor

setColor(color: number): void

设置弧线的颜色。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
color	number	是	ARGB格式颜色值。

示例：

mapArc.setColor(0xffff00ff);

[h2]setWidth

setWidth(width: number): void

设置弧线的宽度。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
width	number	是	弧线的宽度，单位：px，取值范围：大于等于0。

示例：

mapArc.setWidth(20);

SpatialRelationUtil

点面关系计算工具类。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

[h2]isPointContainedInPolygon

static isPointContainedInPolygon(points: Array<mapCommon.LatLng>, point: mapCommon.LatLng): boolean

判断点是否在多边形区域内。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
points	Array<mapCommon.LatLng>	是	多边形区域坐标。
point	mapCommon.LatLng	是	需要判断的点坐标。

返回值：

类型

说明

boolean

点是否在多边形区域内。

true：在区域内
false：不在区域内

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.

示例：

// 调用该功能需要导入mapCommon模块
import { mapCommon } from '@kit.MapKit';

let points: Array<mapCommon.LatLng> = [
  { latitude: 31.693478, longitude: 118.434595 },
  { latitude: 31.693478, longitude: 118.534595 },
  { latitude: 32.993478, longitude: 118.734595 },
  { latitude: 32.993478, longitude: 118.934595 }
];
let point: mapCommon.LatLng = { latitude: 31.984, longitude: 118.766 };
let result: boolean = map.SpatialRelationUtil.isPointContainedInPolygon(points, point);

AnimateResult

动画结果类。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

名称

类型

只读

可选

说明

isFinished

boolean

否

是

动画是否结束。

true：已结束
false：未结束

isCanceled

boolean

否

是

动画是否取消。

true：已取消
false：未取消

MarkerDelegate

标记代理。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

名称	类型	只读	可选	说明
marker	Marker	否	是	用于显示代理的标记。

MapEventManager

地图监听事件管理器。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

示例：

let mapEventManager: map.MapEventManager = this.mapController.getEventManager();

[h2]on(type: 'cameraChange')

on(type: 'cameraChange', callback: Callback<mapCommon.LatLng>): void

监听地图相机状态变化。支持传递多个callback异步回调。此回调不会在动画过程中触发，而是在动画结束时触发。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'cameraChange'：监听地图相机状态变化事件。
callback	Callback<mapCommon.LatLng>	是	回调函数，返回mapCommon.LatLng，监听地图相机状态变化事件。该回调不会在动画过程中触发，而是在动画结束时触发。

示例：

let callback1 = (position: mapCommon.LatLng) => {
  console.info("cameraChange", `callback1 position = ${position.longitude}`);
};
let callback2 = (position: mapCommon.LatLng) => {
  console.info("cameraChange", `callback2 position = ${position.longitude}`);
};
let callback3 = (position: mapCommon.LatLng) => {
  console.info("cameraChange", `callback3 position = ${position.longitude}`);
};
mapEventManager.on("cameraChange", callback1);
mapEventManager.on("cameraChange", callback2);
mapEventManager.on("cameraChange", callback3);

[h2]off(type: 'cameraChange')

off(type: 'cameraChange', callback?: Callback<mapCommon.LatLng>): void

取消监听地图相机状态变化事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'cameraChange'：监听地图相机状态变化事件。

callback

Callback<mapCommon.LatLng>

否

回调函数，返回mapCommon.LatLng，取消监听地图相机状态变化事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = (position: mapCommon.LatLng) => {
  console.info("cameraChange", `callback1 position`);
};
let callback2 = (position: mapCommon.LatLng) => {
  console.info("cameraChange", `callback2 position`);
};
let callback3 = (position: mapCommon.LatLng) => {
  console.info("cameraChange", `callback3 position`);
};
mapEventManager.on("cameraChange", callback1);
mapEventManager.on("cameraChange", callback2);
mapEventManager.on("cameraChange", callback3);
// 只取消callback1对象的事件响应，当cameraChange事件发生时，callback2和callback3会正常被调用
mapEventManager.off('cameraChange', callback1);
// 取消所有cameraChange事件响应
mapEventManager.off('cameraChange');

[h2]on(type: 'cameraIdle')

on(type: 'cameraIdle', callback: Callback<void>): void

监听相机移动结束事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'cameraIdle'：监听相机移动结束事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。监听相机移动结束事件。

示例：

let callback1 = () => {
  console.info("cameraIdle", `callback1`);
};
let callback2 = () => {
  console.info("cameraIdle", `callback2`);
};
let callback3 = () => {
  console.info("cameraIdle", `callback3`);
};
mapEventManager.on("cameraIdle", callback1);
mapEventManager.on("cameraIdle", callback2);
mapEventManager.on("cameraIdle", callback3);

[h2]off(type: 'cameraIdle')

off(type: 'cameraIdle', callback?: Callback<void>): void

取消监听相机移动结束事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'cameraIdle'：监听相机移动结束事件。

callback

Callback<void>

否

回调函数。无返回结果的回调函数。取消监听相机移动结束事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = () => {
  console.info("cameraIdle", `callback1`);
};
let callback2 = () => {
  console.info("cameraIdle", `callback2`);
};
let callback3 = () => {
  console.info("cameraIdle", `callback3`);
};
mapEventManager.on("cameraIdle", callback1);
mapEventManager.on("cameraIdle", callback2);
mapEventManager.on("cameraIdle", callback3);
// 只取消callback1对象的事件响应，当cameraIdle事件发生时，callback2和callback3会正常被调用
mapEventManager.off('cameraIdle', callback1);
// 取消全部cameraIdle事件响应
mapEventManager.off('cameraIdle');

[h2]on(type: 'cameraMoveCancel')

on(type: 'cameraMoveCancel', callback: Callback<void>): void

监听相机移动取消事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'cameraMoveCancel'：监听地图相机移动取消事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数，监听地图相机移动取消事件。

示例：

let callback1 = () => {
  console.info("cameraMoveCancel", `callback1`);
};
let callback2 = () => {
  console.info("cameraMoveCancel", `callback2`);
};
let callback3 = () => {
  console.info("cameraMoveCancel", `callback3`);
};
mapEventManager.on("cameraMoveCancel", callback1);
mapEventManager.on("cameraMoveCancel", callback2);
mapEventManager.on("cameraMoveCancel", callback3);

[h2]off(type: 'cameraMoveCancel')

off(type: 'cameraMoveCancel', callback?: Callback<void>): void

取消监听相机移动取消事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'cameraMoveCancel'：监听地图相机移动取消事件。

callback

Callback<void>

否

回调函数。无返回结果的回调函数。取消监听地图相机移动取消事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = () => {
  console.info("cameraMoveCancel", `callback1`);
};
let callback2 = () => {
  console.info("cameraMoveCancel", `callback2`);
};
let callback3 = () => {
  console.info("cameraMoveCancel", `callback3`);
};
mapEventManager.on("cameraMoveCancel", callback1);
mapEventManager.on("cameraMoveCancel", callback2);
mapEventManager.on("cameraMoveCancel", callback3);
// 只取消callback1对象的事件响应，当cameraMoveCancel事件发生时，callback2和callback3会正常被调用
mapEventManager.off('cameraMoveCancel', callback1);
// 取消全部cameraMoveCancel事件响应
mapEventManager.off('cameraMoveCancel');

[h2]on(type: 'cameraMove')

on(type: 'cameraMove', callback: Callback<void>): void

监听相机移动事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'cameraMove'：监听相机移动事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。监听相机移动事件。

示例：

let callback1 = () => {
  console.info("cameraMove", `callback1`);
};
let callback2 = () => {
  console.info("cameraMove", `callback2`);
};
let callback3 = () => {
  console.info("cameraMove", `callback3`);
};
mapEventManager.on("cameraMove", callback1);
mapEventManager.on("cameraMove", callback2);
mapEventManager.on("cameraMove", callback3);

[h2]off(type: 'cameraMove')

off(type: 'cameraMove', callback?: Callback<void>): void

取消监听相机移动事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'cameraMove'：监听相机移动事件。

callback

Callback<void>

否

回调函数。无返回结果的回调函数。取消监听相机移动事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = () => {
  console.info("cameraMove", `callback1`);
};
let callback2 = () => {
  console.info("cameraMove", `callback2`);
};
let callback3 = () => {
  console.info("cameraMove", `callback3`);
};
mapEventManager.on("cameraMove", callback1);
mapEventManager.on("cameraMove", callback2);
mapEventManager.on("cameraMove", callback3);
// 只取消callback1对象的事件响应，当cameraMove事件发生时，callback2和callback3会正常被调用
mapEventManager.off('cameraMove', callback1);
// 取消全部cameraMove事件响应
mapEventManager.off('cameraMove');

[h2]on(type: 'cameraMoveStart')

on(type: 'cameraMoveStart', callback: Callback<number>): void

监听相机移动开始事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'cameraMoveStart'：监听相机移动开始事件。

callback

Callback<number>

是

回调函数，返回number，监听相机移动开始事件。

number表示相机改变的原因：

1：地图上的用户手势
2：用户交互产生的默认动画
3：开发人员启动的动画

示例：

let callback1 = (reason: number) => {
  console.info("cameraMoveStart", `callback1 reason = ${reason}`);
};
let callback2 = (reason: number) => {
  console.info("cameraMoveStart", `callback2 reason = ${reason}`);
};
let callback3 = (reason: number) => {
  console.info("cameraMoveStart", `callback3 reason = ${reason}`);
};
mapEventManager.on("cameraMoveStart", callback1);
mapEventManager.on("cameraMoveStart", callback2);
mapEventManager.on("cameraMoveStart", callback3);

[h2]off(type: 'cameraMoveStart')

off(type: 'cameraMoveStart', callback?: Callback<number>): void

取消监听相机移动开始事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'cameraMoveStart'：监听相机移动开始事件。

callback

Callback<number>

否

回调函数，返回number，取消监听相机移动开始事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

number表示相机改变的原因：

1：地图上的用户手势
2：用户交互产生的默认动画
3：开发人员启动的动画

示例：

let callback1 = (reason: number) => {
  console.info("cameraMoveStart", `callback1`);
};
let callback2 = (reason: number) => {
  console.info("cameraMoveStart", `callback2`);
};
let callback3 = (reason: number) => {
  console.info("cameraMoveStart", `callback3`);
};
mapEventManager.on("cameraMoveStart", callback1);
mapEventManager.on("cameraMoveStart", callback2);
mapEventManager.on("cameraMoveStart", callback3);

// 只取消callback1对象的事件响应，当cameraMoveStart事件发生时，callback2和callback3会正常被调用
mapEventManager.off('cameraMoveStart', callback1);
// 取消全部cameraMoveStart事件响应
mapEventManager.off('cameraMoveStart');

[h2]on(type: 'mapClick')

on(type: 'mapClick', callback: Callback<mapCommon.LatLng>): void

监听地图点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'mapClick'：监听地图点击事件。
callback	Callback<mapCommon.LatLng>	是	回调函数，返回mapCommon.LatLng，监听地图点击事件。

示例：

let callback1 = (position: mapCommon.LatLng) => {
  console.info("mapClick", `callback1 position = ${position.longitude}`);
};
let callback2 = (position: mapCommon.LatLng) => {
  console.info("mapClick", `callback2 position = ${position.longitude}`);
};
let callback3 = (position: mapCommon.LatLng) => {
  console.info("mapClick", `callback3 position = ${position.longitude}`);
};
mapEventManager.on("mapClick", callback1);
mapEventManager.on("mapClick", callback2);
mapEventManager.on("mapClick", callback3);

[h2]off(type: 'mapClick')

off(type: 'mapClick', callback?: Callback<mapCommon.LatLng>): void

取消监听地图点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'mapClick'：监听地图点击事件。

callback

Callback<mapCommon.LatLng>

否

回调函数，返回mapCommon.LatLng，取消监听地图点击事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = (position: mapCommon.LatLng) => {
  console.info("mapClick", `callback1 position`);
};
let callback2 = (position: mapCommon.LatLng) => {
  console.info("mapClick", `callback2 position`);
};
let callback3 = (position: mapCommon.LatLng) => {
  console.info("mapClick", `callback3 position`);
};
mapEventManager.on("mapClick", callback1);
mapEventManager.on("mapClick", callback2);
mapEventManager.on("mapClick", callback3);

// 只取消callback1对象的事件响应，当mapClick事件发生时，callback2和callback3会正常被调用
mapEventManager.off('mapClick', callback1);
// 取消全部mapClick事件响应
mapEventManager.off('mapClick');

[h2]on(type: 'mapLoad')

on(type: 'mapLoad', callback: Callback<void>): void

监听地图加载事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'mapLoad'：监听地图加载事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。监听地图加载事件。

示例：

let callback1 = () => {
  console.info("mapLoad", `callback1`);
};
let callback2 = () => {
  console.info("mapLoad", `callback2`);
};
let callback3 = () => {
  console.info("mapLoad", `callback3`);
};
mapEventManager.on("mapLoad", callback1);
mapEventManager.on("mapLoad", callback2);
mapEventManager.on("mapLoad", callback3);

[h2]off(type: 'mapLoad')

off(type: 'mapLoad', callback?: Callback<void>): void

取消监听地图加载事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'mapLoad'：监听地图加载事件。

callback

Callback<void>

否

回调函数。无返回结果的回调函数。取消监听地图加载事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = () => {
  console.info("mapLoad", `callback1`);
};
let callback2 = () => {
  console.info("mapLoad", `callback2`);
};
let callback3 = () => {
  console.info("mapLoad", `callback3`);
};
mapEventManager.on("mapLoad", callback1);
mapEventManager.on("mapLoad", callback2);
mapEventManager.on("mapLoad", callback3);

// 只取消callback1对象的事件响应，当mapLoad事件发生时，callback2和callback3会正常被调用
mapEventManager.off('mapLoad', callback1);
// 取消全部mapLoad事件响应
mapEventManager.off('mapLoad');

[h2]on(type: 'mapLongClick')

on(type: 'mapLongClick', callback: Callback<mapCommon.LatLng>): void

监听地图长按事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'mapLongClick'：监听地图长按事件。
callback	Callback<mapCommon.LatLng>	是	回调函数，返回mapCommon.LatLng，监听地图长按事件。

示例：

let callback1 = (position: mapCommon.LatLng) => {
  console.info("mapLongClick", `callback1 position = ${position.longitude}`);
};
let callback2 = (position: mapCommon.LatLng) => {
  console.info("mapLongClick", `callback2 position = ${position.longitude}`);
};
let callback3 = (position: mapCommon.LatLng) => {
  console.info("mapLongClick", `callback3 position = ${position.longitude}`);
};
mapEventManager.on("mapLongClick", callback1);
mapEventManager.on("mapLongClick", callback2);
mapEventManager.on("mapLongClick", callback3);

[h2]off(type: 'mapLongClick')

off(type: 'mapLongClick', callback?: Callback<mapCommon.LatLng>): void

取消监听地图长按事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'mapLongClick'：监听地图长按事件。

callback

Callback<mapCommon.LatLng>

否

回调函数，返回mapCommon.LatLng，监听地图长按事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = (position: mapCommon.LatLng) => {
  console.info("mapLongClick", `callback1 position`);
};
let callback2 = (position: mapCommon.LatLng) => {
  console.info("mapLongClick", `callback2 position`);
};
let callback3 = (position: mapCommon.LatLng) => {
  console.info("mapLongClick", `callback3 position`);
};
mapEventManager.on("mapLongClick", callback1);
mapEventManager.on("mapLongClick", callback2);
mapEventManager.on("mapLongClick", callback3);

// 只取消callback1对象的事件响应，当mapLongClick事件发生时，callback2和callback3会正常被调用
mapEventManager.off('mapLongClick', callback1);
// 取消全部mapLongClick事件响应
mapEventManager.off('mapLongClick');

[h2]on(type: 'myLocationButtonClick')

on(type: 'myLocationButtonClick', callback: Callback<void>): void

监听“我的位置”按钮点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'myLocationButtonClick'：监听“我的位置”按钮点击事件。
callback	Callback<void>	是	回调函数。无返回结果的回调函数。监听“我的位置”按钮点击事件。

示例：

let callback1 = () => {
  console.info("myLocationButtonClick", `callback1`);
};
let callback2 = () => {
  console.info("myLocationButtonClick", `callback2`);
};
let callback3 = () => {
  console.info("myLocationButtonClick", `callback3`);
};
mapEventManager.on("myLocationButtonClick", callback1);
mapEventManager.on("myLocationButtonClick", callback2);
mapEventManager.on("myLocationButtonClick", callback3);

[h2]off(type: 'myLocationButtonClick')

off(type: 'myLocationButtonClick', callback?: Callback<void>): void

取消监听“我的位置”按钮点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'myLocationButtonClick'：监听“我的位置”按钮点击事件。

callback

Callback<void>

否

回调函数。无返回结果的回调函数。取消监听“我的位置”按钮点击事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = () => {
  console.info("myLocationButtonClick", `callback1`);
};
let callback2 = () => {
  console.info("myLocationButtonClick", `callback2`);
};
let callback3 = () => {
  console.info("myLocationButtonClick", `callback3`);
};
mapEventManager.on("myLocationButtonClick", callback1);
mapEventManager.on("myLocationButtonClick", callback2);
mapEventManager.on("myLocationButtonClick", callback3);

// 只取消callback1对象的事件响应，当myLocationButtonClick事件发生时，callback2和callback3会正常被调用
mapEventManager.off('myLocationButtonClick', callback1);
// 取消全部myLocationButtonClick事件响应
mapEventManager.off('myLocationButtonClick');

[h2]on(type: 'myLocationClick')

on(type: 'myLocationClick', callback: Callback<mapCommon.LatLng>): void

监听“我的位置”点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'myLocationClick'：监听“我的位置”点击事件。
callback	Callback<mapCommon.LatLng>	是	回调函数，返回mapCommon.LatLng，监听“我的位置”点击事件。

示例：

let callback1 = (position: mapCommon.LatLng) => {
  console.info("myLocationClick", `callback1 position = ${position.longitude}`);
};
let callback2 = (position: mapCommon.LatLng) => {
  console.info("myLocationClick", `callback2 position = ${position.longitude}`);
};
let callback3 = (position: mapCommon.LatLng) => {
  console.info("myLocationClick", `callback3 position = ${position.longitude}`);
};
mapEventManager.on("myLocationClick", callback1);
mapEventManager.on("myLocationClick", callback2);
mapEventManager.on("myLocationClick", callback3);

[h2]off(type: 'myLocationClick')

off(type: 'myLocationClick', callback?: Callback<mapCommon.LatLng>): void

取消监听“我的位置”点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'myLocationClick'：监听“我的位置”点击事件。

callback

Callback<mapCommon.LatLng>

否

回调函数，返回mapCommon.LatLng，取消监听“我的位置”点击事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = (position: mapCommon.LatLng) => {
  console.info("myLocationClick", `callback1 position`);
};
let callback2 = (position: mapCommon.LatLng) => {
  console.info("myLocationClick", `callback2 position`);
};
let callback3 = (position: mapCommon.LatLng) => {
  console.info("myLocationClick", `callback3 position`);
};
mapEventManager.on("myLocationClick", callback1);
mapEventManager.on("myLocationClick", callback2);
mapEventManager.on("myLocationClick", callback3);

// 只取消callback1对象的事件响应，当myLocationClick事件发生时，callback2和callback3会正常被调用
mapEventManager.off('myLocationClick', callback1);
// 取消全部myLocationClick事件响应
mapEventManager.off('myLocationClick');

[h2]on(type: 'poiClick')

on(type: 'poiClick', callback: Callback<mapCommon.Poi>): void

监听Poi点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'poiClick'：监听Poi点击事件。
callback	Callback<mapCommon.Poi>	是	回调函数，返回mapCommon.Poi，监听Poi点击事件。

示例：

let callback1 = (poi: mapCommon.Poi) => {
  console.info("poiClick", `callback1 poi = ${poi.id}`);
};
let callback2 = (poi: mapCommon.Poi) => {
  console.info("poiClick", `callback2 poi = ${poi.id}`);
};
let callback3 = (poi: mapCommon.Poi) => {
  console.info("poiClick", `callback3 poi = ${poi.id}`);
};
mapEventManager.on("poiClick", callback1);
mapEventManager.on("poiClick", callback2);
mapEventManager.on("poiClick", callback3);

[h2]off(type: 'poiClick')

off(type: 'poiClick', callback?: Callback<mapCommon.Poi>): void

取消监听Poi点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'poiClick'：监听Poi点击事件。

callback

Callback<mapCommon.Poi>

否

回调函数，返回mapCommon.Poi，取消监听Poi点击事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = (poi: mapCommon.Poi) => {
  console.info("poiClick", `callback1 poi`);
};
let callback2 = (poi: mapCommon.Poi) => {
  console.info("poiClick", `callback2 poi`);
};
let callback3 = (poi: mapCommon.Poi) => {
  console.info("poiClick", `callback3 poi`);
};
mapEventManager.on("poiClick", callback1);
mapEventManager.on("poiClick", callback2);
mapEventManager.on("poiClick", callback3);

// 只取消callback1对象的事件响应，当poiClick事件发生时，callback2和callback3会正常被调用
mapEventManager.off('poiClick', callback1);
// 取消全部poiClick事件响应
mapEventManager.off('poiClick');

[h2]on(type: 'markerClick')

on(type: 'markerClick', callback: Callback<Marker>): void

监听标记点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'markerClick'：监听标记点击事件。
callback	Callback<Marker>	是	回调函数，返回Marker，监听标记点击事件。

示例：

let callback1 = (marker: map.Marker) => {
  console.info("markerClick", `callback1 marker = ${marker.getId()}`);
};
let callback2 = (marker: map.Marker) => {
  console.info("markerClick", `callback2 marker = ${marker.getId()}`);
};
let callback3 = (marker: map.Marker) => {
  console.info("markerClick", `callback3 marker = ${marker.getId()}`);
};
mapEventManager.on("markerClick", callback1);
mapEventManager.on("markerClick", callback2);
mapEventManager.on("markerClick", callback3);

[h2]off(type: 'markerClick')

off(type: 'markerClick', callback?: Callback<Marker>): void

取消监听标记点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'markerClick'：监听标记点击事件。

callback

Callback<Marker>

否

回调函数，返回Marker，取消监听标记点击事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = (marker: map.Marker) => {
  console.info("markerClick", `callback1 marker`);
};
let callback2 = (marker: map.Marker) => {
  console.info("markerClick", `callback2 marker`);
};
let callback3 = (marker: map.Marker) => {
  console.info("markerClick", `callback3 marker`);
};
mapEventManager.on("markerClick", callback1);
mapEventManager.on("markerClick", callback2);
mapEventManager.on("markerClick", callback3);

// 只取消callback1对象的事件响应，当markerClick事件发生时，callback2和callback3会正常被调用
mapEventManager.off('markerClick', callback1);
// 取消全部markerClick事件响应
mapEventManager.off('markerClick');

[h2]on(type: 'markerDragStart')

on(type: 'markerDragStart', callback: Callback<Marker>): void

监听标记开始拖拽事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'markerDragStart'：监听标记开始拖拽事件。
callback	Callback<Marker>	是	回调函数，返回Marker，监听标记开始拖拽事件。

示例：

let callback1 = (marker: map.Marker) => {
  console.info("markerDragStart", `callback1 marker = ${marker.getId()}`);
};
let callback2 = (marker: map.Marker) => {
  console.info("markerDragStart", `callback2 marker = ${marker.getId()}`);
};
let callback3 = (marker: map.Marker) => {
  console.info("markerDragStart", `callback3 marker = ${marker.getId()}`);
};
mapEventManager.on("markerDragStart", callback1);
mapEventManager.on("markerDragStart", callback2);
mapEventManager.on("markerDragStart", callback3);

[h2]off(type: 'markerDragStart')

off(type: 'markerDragStart', callback?: Callback<Marker>): void

取消监听标记开始拖拽事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'markerDragStart'：监听标记开始拖拽事件。

callback

Callback<Marker>

否

回调函数，返回Marker，取消监听标记开始拖拽事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = (marker: map.Marker) => {
  console.info("markerDragStart", `callback1 marker`);
};
let callback2 = (marker: map.Marker) => {
  console.info("markerDragStart", `callback2 marker`);
};
let callback3 = (marker: map.Marker) => {
  console.info("markerDragStart", `callback3 marker`);
};
mapEventManager.on("markerDragStart", callback1);
mapEventManager.on("markerDragStart", callback2);
mapEventManager.on("markerDragStart", callback3);

// 只取消callback1对象的事件响应，当markerDragStart事件发生时，callback2和callback3会正常被调用
mapEventManager.off('markerDragStart', callback1);
// 取消全部markerDragStart事件响应
mapEventManager.off('markerDragStart');

[h2]on(type: 'markerDrag')

on(type: 'markerDrag', callback: Callback<Marker>): void

监听标记拖拽事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'markerDrag'：监听标记拖拽事件。
callback	Callback<Marker>	是	回调函数，返回Marker，监听标记拖拽事件。

示例：

let callback1 = (marker: map.Marker) => {
  console.info("markerDrag", `callback1 marker = ${marker.getId()}`);
};
let callback2 = (marker: map.Marker) => {
  console.info("markerDrag", `callback2 marker = ${marker.getId()}`);
};
let callback3 = (marker: map.Marker) => {
  console.info("markerDrag", `callback3 marker = ${marker.getId()}`);
};
mapEventManager.on("markerDrag", callback1);
mapEventManager.on("markerDrag", callback2);
mapEventManager.on("markerDrag", callback3);

[h2]off(type: 'markerDrag')

off(type: 'markerDrag', callback?: Callback<Marker>): void

取消监听标记拖拽事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'markerDrag'：监听标记拖拽事件。

callback

Callback<Marker>

否

回调函数，返回Marker，取消监听标记拖拽事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = (marker: map.Marker) => {
  console.info("markerDrag", `callback1 marker`);
};
let callback2 = (marker: map.Marker) => {
  console.info("markerDrag", `callback2 marker`);
};
let callback3 = (marker: map.Marker) => {
  console.info("markerDrag", `callback3 marker`);
};
mapEventManager.on("markerDrag", callback1);
mapEventManager.on("markerDrag", callback2);
mapEventManager.on("markerDrag", callback3);

// 只取消callback1对象的事件响应，当markerDrag事件发生时，callback2和callback3会正常被调用
mapEventManager.off('markerDrag', callback1);
// 取消全部markerDrag事件响应
mapEventManager.off('markerDrag');

[h2]on(type: 'markerDragEnd')

on(type: 'markerDragEnd', callback: Callback<Marker>): void

监听标记拖拽结束事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'markerDragEnd'：监听标记拖拽结束事件。
callback	Callback<Marker>	是	回调函数，返回Marker，监听标记拖拽结束事件。

示例：

let callback1 = (marker: map.Marker) => {
  console.info("markerDragEnd", `callback1 marker = ${marker.getId()}`);
};
let callback2 = (marker: map.Marker) => {
  console.info("markerDragEnd", `callback2 marker = ${marker.getId()}`);
};
let callback3 = (marker: map.Marker) => {
  console.info("markerDragEnd", `callback3 marker = ${marker.getId()}`);
};
mapEventManager.on("markerDragEnd", callback1);
mapEventManager.on("markerDragEnd", callback2);
mapEventManager.on("markerDragEnd", callback3);

[h2]off(type: 'markerDragEnd')

off(type: 'markerDragEnd', callback?: Callback<Marker>): void

取消监听标记拖动结束事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'markerDragEnd'：监听标记拖动结束事件。

callback

Callback<Marker>

否

回调函数，返回Marker，取消监听标记拖拽结束事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = (marker: map.Marker) => {
  console.info("markerDragEnd", `callback1 marker`);
};
let callback2 = (marker: map.Marker) => {
  console.info("markerDragEnd", `callback2 marker`);
};
let callback3 = (marker: map.Marker) => {
  console.info("markerDragEnd", `callback3 marker`);
};
mapEventManager.on("markerDragEnd", callback1);
mapEventManager.on("markerDragEnd", callback2);
mapEventManager.on("markerDragEnd", callback3);

// 只取消callback1对象的事件响应，当markerDragEnd事件发生时，callback2和callback3会正常被调用
mapEventManager.off('markerDragEnd', callback1);
// 取消全部markerDragEnd事件响应
mapEventManager.off('markerDragEnd');

[h2]on(type: 'circleClick')

on(type: 'circleClick', callback: Callback<MapCircle>): void

监听圆点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'circleClick'：监听圆点击事件。
callback	Callback<MapCircle>	是	回调函数，返回MapCircle，监听圆点击事件。

示例：

let callback1 = (circle: map.MapCircle) => {
  console.info("circleClick", `callback1 circle = ${circle.getId()}`);
};
let callback2 = (circle: map.MapCircle) => {
  console.info("circleClick", `callback2 circle = ${circle.getId()}`);
};
let callback3 = (circle: map.MapCircle) => {
  console.info("circleClick", `callback3 circle = ${circle.getId()}`);
};
mapEventManager.on("circleClick", callback1);
mapEventManager.on("circleClick", callback2);
mapEventManager.on("circleClick", callback3);

[h2]off(type: 'circleClick')

off(type: 'circleClick', callback?: Callback<MapCircle>): void

取消监听圆点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'circleClick'：监听圆点击事件。

callback

Callback<MapCircle>

否

回调函数，返回MapCircle，取消监听圆点击事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = (circle: map.MapCircle) => {
  console.info("circleClick", `callback1 circle`);
};
let callback2 = (circle: map.MapCircle) => {
  console.info("circleClick", `callback2 circle`);
};
let callback3 = (circle: map.MapCircle) => {
  console.info("circleClick", `callback3 circle`);
};
mapEventManager.on("circleClick", callback1);
mapEventManager.on("circleClick", callback2);
mapEventManager.on("circleClick", callback3);

// 只取消callback1对象的事件响应，当circleClick事件发生时，callback2和callback3会正常被调用
mapEventManager.off('circleClick', callback1);
// 取消全部circleClick事件响应
mapEventManager.off('circleClick');

[h2]on(type: 'polylineClick')

on(type: 'polylineClick', callback: Callback<MapPolyline>): void

监听折线点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'polylineClick'：监听折线点击事件。
callback	Callback<MapPolyline>	是	回调函数，返回MapPolyline，监听折线点击事件。

示例：

let callback1 = (polyline: map.MapPolyline) => {
  console.info("polylineClick", `callback1 polyline = ${polyline.getId()}`);
};
let callback2 = (polyline: map.MapPolyline) => {
  console.info("polylineClick", `callback2 polyline = ${polyline.getId()}`);
};
let callback3 = (polyline: map.MapPolyline) => {
  console.info("polylineClick", `callback3 polyline = ${polyline.getId()}`);
};
mapEventManager.on("polylineClick", callback1);
mapEventManager.on("polylineClick", callback2);
mapEventManager.on("polylineClick", callback3);

[h2]off(type: 'polylineClick')

off(type: 'polylineClick', callback?: Callback<MapPolyline>): void

取消监听折线点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'polylineClick'：监听折线点击事件。

callback

Callback<MapPolyline>

否

回调函数，返回MapPolyline，取消监听折线点击事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = (polyline: map.MapPolyline) => {
  console.info("polylineClick", `callback1 polyline`);
};
let callback2 = (polyline: map.MapPolyline) => {
  console.info("polylineClick", `callback2 polyline`);
};
let callback3 = (polyline: map.MapPolyline) => {
  console.info("polylineClick", `callback3 polyline`);
};
mapEventManager.on("polylineClick", callback1);
mapEventManager.on("polylineClick", callback2);
mapEventManager.on("polylineClick", callback3);

// 只取消callback1对象的事件响应，当polylineClick事件发生时，callback2和callback3会正常被调用
mapEventManager.off('polylineClick', callback1);
// 取消全部polylineClick事件响应
mapEventManager.off('polylineClick');

[h2]on(type: 'polygonClick')

on(type: 'polygonClick', callback: Callback<MapPolygon>): void

监听多边形点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'polygonClick'：监听多边形点击事件。
callback	Callback<MapPolygon>	是	回调函数，返回MapPolygon，监听多边形点击事件。

示例：

let callback1 = (polygon: map.MapPolygon) => {
  console.info("polygonClick", `callback1 polygon = ${polygon.getId()}`);
};
let callback2 = (polygon: map.MapPolygon) => {
  console.info("polygonClick", `callback2 polygon = ${polygon.getId()}`);
};
let callback3 = (polygon: map.MapPolygon) => {
  console.info("polygonClick", `callback3 polygon = ${polygon.getId()}`);
};
mapEventManager.on("polygonClick", callback1);
mapEventManager.on("polygonClick", callback2);
mapEventManager.on("polygonClick", callback3);

[h2]off(type: 'polygonClick')

off(type: 'polygonClick', callback?: Callback<MapPolygon>): void

取消监听多边形点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'polygonClick'：监听多边形点击事件。

callback

Callback<MapPolygon>

否

回调函数，返回MapPolygon，取消监听多边形点击事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = (polygon: map.MapPolygon) => {
  console.info("polygonClick", `callback1 polygon`);
};
let callback2 = (polygon: map.MapPolygon) => {
  console.info("polygonClick", `callback2 polygon`);
};
let callback3 = (polygon: map.MapPolygon) => {
  console.info("polygonClick", `callback3 polygon`);
};
mapEventManager.on("polygonClick", callback1);
mapEventManager.on("polygonClick", callback2);
mapEventManager.on("polygonClick", callback3);

// 只取消callback1对象的事件响应，当polygonClick事件发生时，callback2和callback3会正常被调用
mapEventManager.off('polygonClick', callback1);
// 取消全部polygonClick事件响应
mapEventManager.off('polygonClick');

[h2]on(type: 'infoWindowClick')

on(type: 'infoWindowClick', callback: Callback<Marker>): void

监听信息窗点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'infoWindowClick'：监听信息窗点击事件。
callback	Callback<Marker>	是	回调函数，返回Marker，监听信息窗点击事件。

示例：

let callback1 = (infoWindow: map.Marker) => {
  console.info("infoWindowClick", `callback1 infoWindow = ${infoWindow.getId()}`);
};
let callback2 = (infoWindow: map.Marker) => {
  console.info("infoWindowClick", `callback2 infoWindow = ${infoWindow.getId()}`);
};
let callback3 = (infoWindow: map.Marker) => {
  console.info("infoWindowClick", `callback3 infoWindow = ${infoWindow.getId()}`);
};
mapEventManager.on("infoWindowClick", callback1);
mapEventManager.on("infoWindowClick", callback2);
mapEventManager.on("infoWindowClick", callback3);

[h2]off(type: 'infoWindowClick')

off(type: 'infoWindowClick', callback?: Callback<Marker>): void

取消监听信息窗点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'infoWindowClick'：监听信息窗点击事件。

callback

Callback<Marker>

否

回调函数，返回Marker，取消监听信息窗点击事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = (infoWindow: map.Marker) => {
  console.info("infoWindowClick", `callback1 infoWindow`);
};
let callback2 = (infoWindow: map.Marker) => {
  console.info("infoWindowClick", `callback2 infoWindow`);
};
let callback3 = (infoWindow: map.Marker) => {
  console.info("infoWindowClick", `callback3 infoWindow`);
};
mapEventManager.on("infoWindowClick", callback1);
mapEventManager.on("infoWindowClick", callback2);
mapEventManager.on("infoWindowClick", callback3);

// 只取消callback1对象的事件响应，当infoWindowClick事件发生时，callback2和callback3会正常被调用
mapEventManager.off('infoWindowClick', callback1);
// 取消全部infoWindowClick事件响应
mapEventManager.off('infoWindowClick');

[h2]on(type: 'infoWindowClose')

on(type: 'infoWindowClose', callback: Callback<Marker>): void

监听信息窗关闭事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'infoWindowClose'：监听信息窗关闭事件。
callback	Callback<Marker>	是	回调函数，返回Marker，监听信息窗关闭事件。

示例：

let callback1 = (infoWindow: map.Marker) => {
  console.info("infoWindowClose", `callback1 infoWindowClose = ${infoWindow.getId()}`);
};
let callback2 = (infoWindow: map.Marker) => {
  console.info("infoWindowClose", `callback2 infoWindowClose = ${infoWindow.getId()}`);
};
let callback3 = (infoWindow: map.Marker) => {
  console.info("infoWindowClose", `callback3 infoWindowClose = ${infoWindow.getId()}`);
};
mapEventManager.on("infoWindowClose", callback1);
mapEventManager.on("infoWindowClose", callback2);
mapEventManager.on("infoWindowClose", callback3);

[h2]off(type: 'infoWindowClose')

off(type: 'infoWindowClose', callback?: Callback<Marker>): void

取消监听信息窗关闭事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'infoWindowClose'：监听信息窗关闭事件。

callback

Callback<Marker>

否

回调函数，返回Marker，取消监听信息窗关闭事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = (infoWindow: map.Marker) => {
  console.info("infoWindowClose", `callback1 infoWindowClose`);
};
let callback2 = (infoWindow: map.Marker) => {
  console.info("infoWindowClose", `callback2 infoWindowClose`);
};
let callback3 = (infoWindow: map.Marker) => {
  console.info("infoWindowClose", `callback3 infoWindowClose`);
};
mapEventManager.on("infoWindowClose", callback1);
mapEventManager.on("infoWindowClose", callback2);
mapEventManager.on("infoWindowClose", callback3);

// 只取消callback1对象的事件响应，当infoWindowClose事件发生时，callback2和callback3会正常被调用
mapEventManager.off('infoWindowClose', callback1);
// 取消全部infoWindowClose事件响应
mapEventManager.off('infoWindowClose');

[h2]on(type: 'pointAnnotationClick')

on(type: 'pointAnnotationClick', callback: Callback<PointAnnotation>): void

监听点注释点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'pointAnnotationClick'：监听点注释点击事件。
callback	Callback<PointAnnotation>	是	回调函数，返回PointAnnotation，监听点注释点击事件。

示例：

let callback1 = (pointAnnotation: map.PointAnnotation) => {
  console.info("pointAnnotationClick", `callback1 pointAnnotation = ${pointAnnotation.getId()}`);
};
let callback2 = (pointAnnotation: map.PointAnnotation) => {
  console.info("pointAnnotationClick", `callback2 pointAnnotation = ${pointAnnotation.getId()}`);
};
let callback3 = (pointAnnotation: map.PointAnnotation) => {
  console.info("pointAnnotationClick", `callback3 pointAnnotation = ${pointAnnotation.getId()}`);
};
mapEventManager.on("pointAnnotationClick", callback1);
mapEventManager.on("pointAnnotationClick", callback2);
mapEventManager.on("pointAnnotationClick", callback3);

[h2]off(type: 'pointAnnotationClick')

off(type: 'pointAnnotationClick', callback?: Callback<PointAnnotation>): void

取消监听点注释点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'pointAnnotationClick'：监听点注释点击事件。

callback

Callback<PointAnnotation>

否

回调函数，返回PointAnnotation，取消监听点注释点击事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = (pointAnnotation: map.PointAnnotation) => {
  console.info("pointAnnotationClick", `callback1 pointAnnotation`);
};
let callback2 = (pointAnnotation: map.PointAnnotation) => {
  console.info("pointAnnotationClick", `callback2 pointAnnotation`);
};
let callback3 = (pointAnnotation: map.PointAnnotation) => {
  console.info("pointAnnotationClick", `callback3 pointAnnotation`);
};
mapEventManager.on("pointAnnotationClick", callback1);
mapEventManager.on("pointAnnotationClick", callback2);
mapEventManager.on("pointAnnotationClick", callback3);

// 只取消callback1对象的事件响应，当pointAnnotationClick事件发生时，callback2和callback3会正常被调用
mapEventManager.off('pointAnnotationClick', callback1);
// 取消全部pointAnnotationClick事件响应
mapEventManager.off('pointAnnotationClick');

[h2]on(type: 'bubbleClick')

on(type: 'bubbleClick', callback: Callback<Bubble>): void

监听气泡点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'bubbleClick'：监听气泡点击事件。
callback	Callback<Bubble>	是	回调函数，返回Bubble，监听气泡点击事件。

示例：

let callback1 = (bubble: map.Bubble) => {
  console.info("bubbleClick", `callback1 bubble = ${bubble.getId()}`);
};
let callback2 = (bubble: map.Bubble) => {
  console.info("bubbleClick", `callback2 bubble = ${bubble.getId()}`);
};
let callback3 = (bubble: map.Bubble) => {
  console.info("bubbleClick", `callback3 bubble = ${bubble.getId()}`);
};
mapEventManager.on("bubbleClick", callback1);
mapEventManager.on("bubbleClick", callback2);
mapEventManager.on("bubbleClick", callback3);

[h2]off(type: 'bubbleClick')

off(type: 'bubbleClick', callback?: Callback<Bubble>): void

取消监听气泡点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'bubbleClick'：监听气泡点击事件。

callback

Callback<Bubble>

否

回调函数，返回Bubble，取消监听气泡点击事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = (bubble: map.Bubble) => {
  console.info("bubbleClick", `callback1 bubble`);
};
let callback2 = (bubble: map.Bubble) => {
  console.info("bubbleClick", `callback2 bubble`);
};
let callback3 = (bubble: map.Bubble) => {
  console.info("bubbleClick", `callback3 bubble`);
};
mapEventManager.on("bubbleClick", callback1);
mapEventManager.on("bubbleClick", callback2);
mapEventManager.on("bubbleClick", callback3);

// 只取消callback1对象的事件响应，当bubbleClick事件发生时，callback2和callback3会正常被调用
mapEventManager.off('bubbleClick', callback1);
// 取消全部bubbleClick事件响应
mapEventManager.off('bubbleClick');

[h2]on(type: 'imageOverlayClick')

on(type: 'imageOverlayClick', callback: Callback<ImageOverlay>): void

监听覆盖物点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'imageOverlayClick'：监听覆盖物点击事件。
callback	Callback<ImageOverlay>	是	回调函数，返回ImageOverlay，监听覆盖物点击事件。

示例：

let callback1 = (imageOverlay: map.ImageOverlay) => {
  console.info("imageOverlayClick", `callback1 imageOverlay = ${imageOverlay.getId()}`);
};
let callback2 = (imageOverlay: map.ImageOverlay) => {
  console.info("imageOverlayClick", `callback2 imageOverlay = ${imageOverlay.getId()}`);
};
let callback3 = (imageOverlay: map.ImageOverlay) => {
  console.info("imageOverlayClick", `callback3 imageOverlay = ${imageOverlay.getId()}`);
};
mapEventManager.on("imageOverlayClick", callback1);
mapEventManager.on("imageOverlayClick", callback2);
mapEventManager.on("imageOverlayClick", callback3);

[h2]off(type: 'imageOverlayClick')

off(type: 'imageOverlayClick', callback?: Callback<ImageOverlay>): void

取消监听覆盖物点击事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'imageOverlayClick'：监听覆盖物点击事件。

callback

Callback<ImageOverlay>

否

回调函数，返回ImageOverlay，取消监听覆盖物点击事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

let callback1 = (imageOverlay: map.ImageOverlay) => {
  console.info("imageOverlayClick", `callback1 imageOverlay`);
};
let callback2 = (imageOverlay: map.ImageOverlay) => {
  console.info("imageOverlayClick", `callback2 imageOverlay`);
};
let callback3 = (imageOverlay: map.ImageOverlay) => {
  console.info("imageOverlayClick", `callback3 imageOverlay`);
};
mapEventManager.on("imageOverlayClick", callback1);
mapEventManager.on("imageOverlayClick", callback2);
mapEventManager.on("imageOverlayClick", callback3);

// 只取消callback1对象的事件响应，当imageOverlayClick事件发生时，callback2和callback3会正常被调用
mapEventManager.off('imageOverlayClick', callback1);
// 取消全部imageOverlayClick事件响应
mapEventManager.off('imageOverlayClick');

[h2]on(type: 'error')

on(type: 'error', callback: ErrorCallback): void

监听异常事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
type	string	是	'error'：监听异常事件。
callback	ErrorCallback	是	回调函数，返回ErrorCallback，监听异常事件。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let callback1 = (error: BusinessError) => {
  console.info("error", `callback1 code: ${error.code}, message: ${error.message}`);
};
let callback2 = (error: BusinessError) => {
  console.info("error", `callback2 code: ${error.code}, message: ${error.message}`);
};
let callback3 = (error: BusinessError) => {
  console.info("error", `callback3 code: ${error.code}, message: ${error.message}`);
};
mapEventManager.on("error", callback1);
mapEventManager.on("error", callback2);
mapEventManager.on("error", callback3);

[h2]off(type: 'error')

off(type: 'error', callback?: ErrorCallback): void

取消监听异常事件。支持传递多个callback异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名

类型

必填

说明

type

string

是

'error'：监听异常事件。

callback

ErrorCallback

否

回调函数，返回ErrorCallback，取消监听异常事件。

callback为空：取消所有callback回调。
callback非空：取消指定的callback回调。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let callback1 = (error: BusinessError) => {
  console.info("error", `callback1`);
};
let callback2 = (error: BusinessError) => {
  console.info("error", `callback2`);
};
let callback3 = (error: BusinessError) => {
  console.info("error", `callback3`);
};
mapEventManager.on("error", callback1);
mapEventManager.on("error", callback2);
mapEventManager.on("error", callback3);

// 只取消callback1对象的事件响应，当error事件发生时，callback2和callback3会正常被调用
mapEventManager.off('error', callback1);
// 取消全部error事件响应
mapEventManager.off('error');

AnimationFillMode

动画执行完成后的状态。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

名称	值	说明
FORWARDS	0	动画执行后保持在最后一帧。
BACKWARDS	1	动画执行后保持在第一帧。

AnimationRepeatMode

重复执行的模式。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

名称	值	说明
RESTART	0	动画结束后从头播放。
REVERSE	1	动画结束后从尾倒放。

newCameraPosition

newCameraPosition(cameraPosition: mapCommon.CameraPosition): CameraUpdate

创建CameraUpdate对象，更新地图状态。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
cameraPosition	mapCommon.CameraPosition	是	新的地图状态。

返回值：

类型	说明
CameraUpdate	描述地图状态将要发生的变化。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.

示例：

let target: mapCommon.LatLng = {
  latitude: 39.9,
  longitude: 116.4
};
let cameraPosition: mapCommon.CameraPosition = {
  target: target,
  zoom: 10
};
let cameraUpdate: map.CameraUpdate = map.newCameraPosition(cameraPosition);

newLatLng

newLatLng(latLng: mapCommon.LatLng, zoom?: number): CameraUpdate

设置地图的中心点和缩放层级。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
latLng	mapCommon.LatLng	是	经纬度。
zoom	number	否	缩放层级。

返回值：

类型	说明
CameraUpdate	描述地图状态将要发生的变化。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.

示例：

let latLng: mapCommon.LatLng = {
  latitude: 39.9,
  longitude: 116.4
};
let cameraUpdate: map.CameraUpdate = map.newLatLng(latLng);

newLatLngBounds

newLatLngBounds(bounds: mapCommon.LatLngBounds, padding?: number): CameraUpdate

设置地图经纬度范围；设置地图区域和边界之间的距离。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
bounds	mapCommon.LatLngBounds	是	地图显示经纬度范围。
padding	number	否	地图区域和边界之间的距离，单位：px，默认值为0。

返回值：

类型	说明
CameraUpdate	描述地图状态将要发生的变化。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.

示例：

let bounds: mapCommon.LatLngBounds = {
  northeast: {
    latitude: 33,
    longitude: 118
  },
  southwest: {
    latitude: 32,
    longitude: 119
  }
};
let cameraUpdate: map.CameraUpdate = map.newLatLngBounds(bounds, 5);

newLatLngBounds

newLatLngBounds(bounds: mapCommon.LatLngBounds, width: number, height: number, padding: number): CameraUpdate

设置地图经纬度范围、经纬度矩形范围的屏幕高宽、地图区域和边界之间的距离。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
bounds	mapCommon.LatLngBounds	是	地图显示经纬度范围。
width	number	是	经纬度矩形范围的屏幕宽，单位：px，取值范围：大于等于0。
height	number	是	经纬度矩形范围的屏幕高，单位：px，取值范围：大于等于0。
padding	number	是	地图区域和边界之间的距离，单位：px，默认值为0。

返回值：

类型	说明
CameraUpdate	描述地图状态将要发生的变化。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.

示例：

let bounds: mapCommon.LatLngBounds = {
  northeast: {
    latitude: 31,
    longitude: 118
  },
  southwest: {
    latitude: 30.5,
    longitude: 123
  }
};
// 设置地图显示经纬度范围，设置经纬度矩形范围的宽为1000像素，设置经纬度矩形范围的高为1000像素，设置地图区域和边界之间的距离为100像素
let cameraUpdate: map.CameraUpdate = map.newLatLngBounds(bounds, 1000, 1000, 100);

scrollBy

scrollBy(x: number, y: number): CameraUpdate

按像素移动地图中心点。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
x	number	是	水平移动的像素数。正值代表可视区域向右移动，负值代表可视区域向左移动。
y	number	是	竖直移动的像素数。正值代表可视区域向下移动，负值代表可视区域向上移动。

返回值：

类型	说明
CameraUpdate	描述地图状态将要发生的变化。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.

示例：

let cameraUpdate: map.CameraUpdate = map.scrollBy(100, 200);

zoomBy

zoomBy(amount: number, focus?: mapCommon.MapPoint): CameraUpdate

根据给定增量并以给定的屏幕像素点为中心点缩放地图级别。

以屏幕左顶点为（0, 0）点，focus.positionX正值代表可视区域向右移动，负值代表可视区域向左移动。focus.positionY正值代表可视区域向下移动，负值代表可视区域向上移动。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
amount	number	是	地图缩放级别增量。
focus	mapCommon.MapPoint	否	地图缩放中心点对应的屏幕坐标。

返回值：

类型	说明
CameraUpdate	描述地图状态将要发生的变化。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.

示例：

let focus: mapCommon.MapPoint = {
  positionX: 100,
  positionY: 200
};
let cameraUpdate: map.CameraUpdate = map.zoomBy(10, focus);

zoomIn

zoomIn(): CameraUpdate

放大地图缩放级别，在当前地图显示的级别基础上加1。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
CameraUpdate	描述地图状态将要发生的变化。

示例：

let cameraUpdate: map.CameraUpdate = map.zoomIn();

zoomOut

zoomOut(): CameraUpdate

缩小地图缩放级别，在当前地图显示的级别基础上减1。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

返回值：

类型	说明
CameraUpdate	描述地图状态将要发生的变化。

示例：

let cameraUpdate: map.CameraUpdate = map.zoomOut();

zoomTo

zoomTo(zoom: number): CameraUpdate

设置地图缩放级别。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
zoom	number	是	地图缩放级别，取值范围为[2, 20]。

返回值：

类型	说明
CameraUpdate	描述地图状态将要发生的变化。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.

示例：

let cameraUpdate: map.CameraUpdate = map.zoomTo(10);

calculateDistance

calculateDistance(from: mapCommon.LatLng, to: mapCommon.LatLng): number

计算坐标点之间的距离。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
from	mapCommon.LatLng	是	起点坐标。
to	mapCommon.LatLng	是	终点坐标。

返回值：

类型

说明

number

两个坐标点之间的距离，单位：米。

对异常值进行处理，返回0。

示例：

let fromLatLng: mapCommon.LatLng = {
  latitude: 38,
  longitude: 118
};
let toLatLng: mapCommon.LatLng = {
  latitude: 39,
  longitude: 119
};

let distance = map.calculateDistance(fromLatLng, toLatLng);

convertCoordinate

convertCoordinate(fromType: mapCommon.CoordinateType, toType: mapCommon.CoordinateType, location: mapCommon.LatLng): Promise<mapCommon.LatLng>

坐标系转换。当前仅支持WGS84坐标系转GCJ02坐标系。使用Promise异步回调。

建议使用convertCoordinateSync。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本4.1.0(11)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：4.1.0(11)

参数：

参数名	类型	必填	说明
fromType	mapCommon.CoordinateType	是	转换前坐标类型，当前仅支持WGS84。
toType	mapCommon.CoordinateType	是	转换后坐标类型，当前仅支持GCJ02。
location	mapCommon.LatLng	是	待转换坐标。

返回值：

类型	说明
Promise<mapCommon.LatLng>	Promise对象，返回mapCommon.LatLng。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.

示例：

let wgs84Position: mapCommon.LatLng = { 
  latitude: 30, 
  longitude: 118 
};
let gcj02Position: mapCommon.LatLng = await map.convertCoordinate(mapCommon.CoordinateType.WGS84, mapCommon.CoordinateType.GCJ02, wgs84Position);

convertCoordinateSync

convertCoordinateSync(fromType: mapCommon.CoordinateType, toType: mapCommon.CoordinateType, location: mapCommon.LatLng): mapCommon.LatLng

坐标系转换。当前仅支持WGS84坐标系转GCJ02坐标系。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
fromType	mapCommon.CoordinateType	是	转换前坐标类型，当前仅支持WGS84。
toType	mapCommon.CoordinateType	是	转换后坐标类型，当前仅支持GCJ02。
location	mapCommon.LatLng	是	待转换坐标。

返回值：

类型	说明
mapCommon.LatLng	Promise对象，返回mapCommon.LatLng。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.

示例：

let wgs84Position: mapCommon.LatLng = {
  latitude: 30,
  longitude: 118
};
// 转换经纬度坐标
let gcj02Position: mapCommon.LatLng =
  map.convertCoordinateSync(mapCommon.CoordinateType.WGS84, mapCommon.CoordinateType.GCJ02, wgs84Position);

rectifyCoordinate

rectifyCoordinate(context: common.Context, locations: Array<mapCommon.CoordinateLatLng>): Promise<Array<mapCommon.CoordinateLatLng>>

根据用户输入的坐标系和坐标以及获取当前的路由地，判断是否需要修正坐标。如果需要修正，则返回修正后的坐标系和坐标。该接口仅为处理原始坐标与华为地图展示偏转的场景。使用Promise异步回调。

规则如下：

输入的坐标系是GCJ02，当前路由地是中国大陆。
检查传入的坐标是否在大陆/港澳地区，如果不在，返回WGS84坐标系和输入的原始坐标，否则返回GCJ02坐标系和输入的原始坐标。
输入的坐标系是GCJ02，当前路由地不是中国大陆。
返回WGS84坐标系和输入的原始坐标。
输入的坐标系是WGS84，当前路由地是中国大陆。
检查传入的坐标是否在大陆/港澳地区，如果在，返回GCJ02坐标系和转换后的坐标，否则返回WGS84坐标系和输入的原始坐标。
输入的坐标系是WGS84，当前路由地不是中国大陆。
返回WGS84坐标系和输入的原始坐标。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.Map.Core

起始版本：5.0.0(12)

参数：

参数名	类型	必填	说明
context	common.Context	是	Context上下文。
locations	Array<mapCommon.CoordinateLatLng>	是	输入坐标系和坐标。

返回值：

类型	说明
Promise<Array<mapCommon.CoordinateLatLng>>	Promise对象，返回修正后的坐标系和坐标。

错误码：

以下错误码的详细介绍请参见地图服务错误码。

错误码ID	错误信息
401	Invalid input parameter.
1002600013	The current routing location is unknown. Try again later.

示例：

let locations: Array<mapCommon.CoordinateLatLng> = [
  {
    // 输入巴黎坐标和GCJ02坐标系，返回WGS84坐标系和输入的巴黎坐标
    coordinateType: mapCommon.CoordinateType.GCJ02,
    location: { latitude: 42.860000, longitude: 2.340000 }
  },
  {
    // 输入香港坐标和GCJ02坐标系，返回GCJ02坐标系和输入的香港坐标
    coordinateType: mapCommon.CoordinateType.GCJ02,
    location: { latitude: 22.280556, longitude: 114.984000 }
  },
  {
    // 输入香港坐标和WGS84坐标系，若当前地图站点使用GCJ02坐标系，返回GCJ02坐标系和转换后的香港坐标，
    // 若当前地图站点使用WGS84坐标系，返回WGS84坐标系和原香港坐标
    coordinateType: mapCommon.CoordinateType.WGS84,
    location: { latitude: 22.280556, longitude: 114.984000 }
  },
  {
    // 输入巴黎坐标和WGS84坐标系，返回WGS84坐标系和输入的巴黎坐标
    coordinateType: mapCommon.CoordinateType.WGS84,
    location: { latitude: 42.860000, longitude: 2.340000 }
  }
];
let arr: Array<mapCommon.CoordinateLatLng> = await map.rectifyCoordinate(getContext(), locations);

目录

map（地图显示功能）

导入模块

MapComponentController

[h2]animateCamera

[h2]animateCameraStatus

[h2]animateCameraWithMarker

[h2]animateCameraWithMarkers

[h2]stopAnimation

[h2]clear

[h2]moveCamera

[h2]getCameraPosition

[h2]setLatLngBounds

[h2]setPointToCenter

[h2]setMaxZoom

[h2]setMinZoom

[h2]getMaxZoom

[h2]getMinZoom

[h2]setTrafficEnabled

[h2]isTrafficEnabled

[h2]setBuildingEnabled

[h2]isBuildingEnabled

[h2]setMyLocationEnabled

[h2]setMyLocation

[h2]setMyLocationStyle

[h2]isMyLocationEnabled

[h2]setZoomGesturesEnabled

[h2]isZoomGesturesEnabled

[h2]setScrollGesturesEnabled

[h2]isScrollGesturesEnabled

[h2]setRotateGesturesEnabled

[h2]isRotateGesturesEnabled

[h2]setTiltGesturesEnabled

[h2]isTiltGesturesEnabled

[h2]setZoomControlsEnabled

[h2]isZoomControlsEnabled

[h2]setMyLocationControlsEnabled

[h2]isMyLocationControlsEnabled

[h2]setScaleControlsEnabled

[h2]isScaleControlsEnabled

[h2]setCompassControlsEnabled

[h2]isCompassControlsEnabled

[h2]setGestureScaleByMapCenter

[h2]isGestureScaleByMapCenter

[h2]setLogoAlignment

[h2]setLogoPadding

[h2]getScalePerPixel

[h2]addMarker

[h2]addCircle

[h2]addPolyline

[h2]addPolygon

[h2]addPointAnnotation

[h2]addBubble

[h2]setPadding

[h2]getProjection

[h2]setCustomMapStyle

[h2]getDayNightMode

[h2]setDayNightMode

[h2]getMapType

[h2]setMapType

[h2]setScalePosition

[h2]getScaleLevel

[h2]setCompassPosition

[h2]setAllGesturesEnabled

[h2]getScaleControlsHeight

[h2]getScaleControlsWidth

[h2]setAlwaysShowScaleEnabled

[h2]isAlwaysShowScaleEnabled

[h2]addClusterOverlay

[h2]addImageOverlay

[h2]snapshot

[h2]addBuildingOverlay

[h2]addTraceOverlay

[h2]addArc

[h2]show

[h2]hide

[h2]getEventManager

[h2]setDisplayOrder

[h2]on(type: 'cameraChange')

[h2]off(type: 'cameraChange')