Interface (Marker)

导入模块

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

Marker

标记，继承BaseOverlay。在调用map.MapComponentController类的addMarker方法时会返回该类型的实例。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 4.1.0(11)

示例：

let markerOptions: mapCommon.MarkerOptions = {
  position: {
    latitude: 39.9,
    longitude: 116.4
  }
};
let marker: map.Marker = await this.mapController.addMarker(markerOptions);

getTitle

getTitle(): string

返回信息窗的标题。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 4.1.0(11)

返回值：

示例：

let title: string = marker.getTitle();

getSnippet

getSnippet(): string

返回信息窗的子标题。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 4.1.0(11)

返回值：

示例：

let snippet: string = marker.getSnippet();

getAlpha

getAlpha(): number

获取标记的透明度。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 4.1.0(11)

返回值：

示例：

let alpha: number = marker.getAlpha();

getPosition

getPosition(): mapCommon.LatLng

获取标记的位置。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 4.1.0(11)

返回值：

示例：

let position: mapCommon.LatLng = marker.getPosition();

getRotation

getRotation(): number

获取标记的旋转角度。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 4.1.0(11)

返回值：

示例：

let rotation: number = marker.getRotation();

isClickable

isClickable(): boolean

获取标记是否可以点击。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 4.1.0(11)

返回值：

示例：

let isClickable: boolean = marker.isClickable();

isDraggable

isDraggable(): boolean

获取标记是否可以通过长按来拖拽。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 4.1.0(11)

返回值：

示例：

let isDraggable: boolean = marker.isDraggable();

isFlat

isFlat(): boolean

获取标记是否平贴地图。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 4.1.0(11)

返回值：

示例：

let isFlat: boolean = marker.isFlat();

setAlpha

setAlpha(alpha: number): void

设置标记的透明度属性。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 4.1.0(11)

参数：

示例：

marker.setAlpha(0.5);

setClickable

setClickable(clickable: boolean): void

设置标记是否可以点击。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 4.1.0(11)

参数：

示例：

marker.setClickable(true);

setDraggable

setDraggable(draggable: boolean): void

设置标记是否可以长按拖拽。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 4.1.0(11)

参数：

示例：

marker.setDraggable(true);

setFlat

setFlat(flat: boolean): void

设置标记是否平贴地图。如果标记平贴地图，则在相机旋转和倾斜时，标记仍将停留在地图上，它将保持与照相机缩放时相同的大小。 如果标记面对相机，它将始终面向相机绘制，并随相机旋转和倾斜。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 4.1.0(11)

参数：

示例：

marker.setFlat(true);

setIcon

setIcon(icon: string | image.PixelMap | Resource): Promise<void>

设置标记的图标。使用Promise异步回调。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 4.1.0(11)

参数：

返回值：

示例：

// 图标需存放在resources/rawfile目录下
await marker.setIcon('icon/test.png');

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)

参数：

示例：

marker.setMarkerAnchor(1.0, 1.0);

setPosition

setPosition(latLng: mapCommon.LatLng): void

设置标记的位置坐标。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 4.1.0(11)

参数：

示例：

let position: mapCommon.LatLng = {
  latitude: 39.9,
  longitude: 116.4
};
marker.setPosition(position);

setRotation

setRotation(rotation: number): void

设置标记的旋转角度，即标记围绕标记锚点顺时针旋转的角度，旋转轴垂直于标记。默认旋转角度为0，默认位置为北对齐。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 4.1.0(11)

参数：

示例：

marker.setRotation(30);

setTitle

setTitle(title: string): void

设置信息窗的标题。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 4.1.0(11)

参数：

示例：

marker.setTitle("title");

setSnippet

setSnippet(snippet: string): void

设置信息窗口的子标题。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 4.1.0(11)

参数：

示例：

marker.setSnippet("su");

setInfoWindowAnchor

setInfoWindowAnchor(anchorU: number, anchorV: number): void

设置信息窗的锚点位置。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 4.1.0(11)

参数：

示例：

marker.setInfoWindowAnchor(0.5, 0.5);

setInfoWindowVisible

setInfoWindowVisible(visible: boolean): void

设置信息窗是否可见。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 4.1.0(11)

参数：

示例：

marker.setInfoWindowVisible(true);

isInfoWindowVisible

isInfoWindowVisible(): boolean

返回信息窗是否可见。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 4.1.0(11)

返回值：

示例：

let visible: boolean = marker.isInfoWindowVisible();

setAnimation

setAnimation(animation: Animation): void

设置标记的动画，不支持FontSizeAnimation。

模型约束： 此接口仅可在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);

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();

clearAnimation

clearAnimation(): void

清除标记的动画。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 4.1.0(11)

示例：

marker.clearAnimation();

getAltitude

getAltitude(): number

获取相对于地面的高度。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 5.0.0(12)

返回值：

示例：

let altitude: number = marker.getAltitude();

setAltitude

setAltitude(altitude: number): void

设置相对于地面的高度。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 5.0.0(12)

参数：

示例：

marker.setAltitude(500);

setAnnotationVisible

setAnnotationVisible(visible: boolean): void

设置标记是否显示文本。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 5.1.1(19)

参数：

示例：

marker.setAnnotationVisible(true);

isAnnotationVisible

isAnnotationVisible(): boolean

返回标记文本是否可见。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 5.1.1(19)

返回值：

示例：

let isVisible = marker.isAnnotationVisible();

setPriority

setPriority(priority: number): void

设置标记碰撞优先级。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 6.1.0(23)

参数：

示例：

marker.setPriority(50);

getPriority

getPriority(): number

获取标记冲突优先级。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 6.1.0(23)

返回值：

示例：

let priority: number = marker.getPriority();

setIconBuilder

setIconBuilder(iconBuilder: CustomBuilder): Promise<void>

设置生成标记图标的自定义组件。使用Promise异步回调。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 6.0.0(20)

参数：

返回值：

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

示例：

@Builder
renderBuilder() {
  Stack({ alignContent: Alignment.Center }) {
    Text('Test Icon Builder')
  }
  .height(50)
  .width(200)
}
// 设置自定义组件
try {
  await this.marker?.setIconBuilder(() => {
    this.renderBuilder();
  })
} catch (error) {
  let err = error as BusinessError;
  console.error('Marker icon builder test error code' + err.code + 'message:' + err.message);
}

setOffset

setOffset(x: number, y: number): void

设置标记图标的偏移量。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 6.0.2(22)

参数：

示例：

marker.setOffset(20, 20);

getOffsetX

getOffsetX(): number

获取标记图标在X轴方向的偏移量。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 6.0.2(22)

返回值：

示例：

let X: number = marker.getOffsetX();

getOffsetY

getOffsetY(): number

获取标记图标在Y轴方向的偏移量。

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

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

系统能力： SystemCapability.Map.Core

起始版本： 6.0.2(22)

返回值：

示例：

let Y: number = marker.getOffsetY();