文档管理中心

petalMaps(拉起地图应用)

本模块提供拉起地图应用功能。

起始版本: 5.0.3(15)

导入模块

PhonePC/2in1TabletWearable
收起
自动换行
深色代码主题
复制
  1. import { petalMaps } from '@kit.MapKit';

openMapHomePage

PhonePC/2in1TabletWearable

openMapHomePage(context: common.Context): Promise<void>

打开地图应用首页。使用Promise异步回调。

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

系统能力: SystemCapability.Map.Core

设备行为差异: 对于5.1.1(19)及之前的版本,该接口在phone、tablet中可正常使用,在其他设备中返回801错误码。在6.0.0(20)及之后版本该接口在phone、tablet、PC/2in1均可正常使用,在其他设备中返回801错误码。

起始版本: 5.0.3(15)

参数:

展开
参数名 类型 必填 说明
context common.Context Context上下文。

返回值:

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

错误码:

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

展开
错误码ID 错误信息
401 Invalid input parameter.
1002600014 Failed to start the map app.
801

Capability not supported. Failed to call the API due to limited device capabilities.

适用版本:5.1.0(18)+

示例:

收起
自动换行
深色代码主题
复制
  1. await petalMaps.openMapHomePage(this.getUIContext().getHostContext());

openMapPoiDetail

PhonePC/2in1TabletWearable

openMapPoiDetail(context: common.Context, poiDetailParams: PoiDetailParams): Promise<void>

应用的POI详情页面。使用Promise异步回调。

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

系统能力: SystemCapability.Map.Core

设备行为差异: 对于5.1.1(19)及之前的版本,该接口在phone、tablet中可正常使用,在其他设备中返回801错误码。在6.0.0(20)及之后版本该接口在phone、tablet、PC/2in1均可正常使用,在其他设备中返回801错误码。

起始版本: 5.0.3(15)

参数:

展开
参数名 类型 必填 说明
context common.Context Context上下文。
poiDetailParams PoiDetailParams POI详情的参数。

返回值:

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

错误码:

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

展开
错误码ID 错误信息
401 Invalid input parameter.
1002600014 Failed to start the map app.
801

Capability not supported. Failed to call the API due to limited device capabilities.

适用版本:5.1.0(18)+

示例:

收起
自动换行
深色代码主题
复制
  1. let params: petalMaps.PoiDetailParams = {
  2. destinationPosition: {
  3. latitude: 30.983015468224288,
  4. longitude: 118.78058590757131
  5. }
  6. };
  7. await petalMaps.openMapPoiDetail(this.getUIContext().getHostContext(), params);

openMapTextSearch

PhonePC/2in1TabletWearable

openMapTextSearch(context: common.Context, textSearchParams: TextSearchParams): Promise<void>

打开地图应用的文本搜索页面。使用Promise异步回调。

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

系统能力: SystemCapability.Map.Core

设备行为差异: 对于5.1.1(19)及之前的版本,该接口在phone、tablet中可正常使用,在其他设备中返回801错误码。在6.0.0(20)及之后版本该接口在phone、tablet、PC/2in1均可正常使用,在其他设备中返回801错误码。

起始版本: 5.0.3(15)

参数:

展开
参数名 类型 必填 说明
context common.Context Context上下文。
textSearchParams TextSearchParams 文本搜索的参数。

返回值:

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

错误码:

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

展开
错误码ID 错误信息
401 Invalid input parameter.
1002600014 Failed to start the map app.
801

Capability not supported. Failed to call the API due to limited device capabilities.

适用版本:5.1.0(18)+

示例:

收起
自动换行
深色代码主题
复制
  1. let params: petalMaps.TextSearchParams = {
  2. destinationName: '云谷'
  3. };
  4. await petalMaps.openMapTextSearch(this.getUIContext().getHostContext(), params);

openMapRoutePlan

PhonePC/2in1TabletWearable

openMapRoutePlan(context: common.Context, routePlanParams: RoutePlanParams): Promise<void>

打开地图应用的路线规划页面。使用Promise异步回调。

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

系统能力: SystemCapability.Map.Core

设备行为差异: 对于5.1.1(19)及之前的版本,该接口在phone、tablet中可正常使用,在其他设备中返回801错误码。在6.0.0(20)及之后版本该接口在phone、tablet、PC/2in1均可正常使用,在其他设备中返回801错误码。

起始版本: 5.0.3(15)

参数:

展开
参数名 类型 必填 说明
context common.Context Context上下文。
routePlanParams RoutePlanParams 路线规划的参数。

返回值:

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

错误码:

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

展开
错误码ID 错误信息
401 Invalid input parameter.
1002600014 Failed to start the map app.
801

Capability not supported. Failed to call the API due to limited device capabilities.

适用版本:5.1.0(18)+

示例:

收起
自动换行
深色代码主题
复制
  1. let params: petalMaps.RoutePlanParams = {
  2. destinationPosition: {
  3. latitude: 31.983015468224288,
  4. longitude: 118.78058590757131
  5. }
  6. };
  7. await petalMaps.openMapRoutePlan(this.getUIContext().getHostContext(), params);

openMapNavi

PhonePC/2in1TabletWearable

openMapNavi(context: common.Context, naviParams: NaviParams): Promise<void>

打开地图应用的导航页面。使用Promise异步回调。

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

系统能力: SystemCapability.Map.Core

设备行为差异: 对于5.1.1(19)及之前的版本,该接口在phone、tablet中可正常使用,在其他设备中返回801错误码。在6.0.0(20)及之后版本该接口在phone、tablet、PC/2in1均可正常使用,在其他设备中返回801错误码。

起始版本: 5.0.3(15)

参数:

展开
参数名 类型 必填 说明
context common.Context Context上下文。
naviParams NaviParams 导航的参数。

返回值:

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

错误码:

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

展开
错误码ID 错误信息
401 Invalid input parameter.
1002600014 Failed to start the map app.
801

Capability not supported. Failed to call the API due to limited device capabilities.

适用版本:5.1.0(18)+

示例:

收起
自动换行
深色代码主题
复制
  1. let params: petalMaps.NaviParams = {
  2. destinationPosition: {
  3. latitude: 31.983015468224288,
  4. longitude: 118.78058590757131
  5. }
  6. };
  7. await petalMaps.openMapNavi(this.getUIContext().getHostContext(), params);

openMapTaxi

PhonePC/2in1TabletWearable

openMapTaxi(context: common.Context, taxiParams: TaxiParams): Promise<void>

打开地图应用的打车页面。使用Promise异步回调。

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

系统能力: SystemCapability.Map.Core

设备行为差异: 在6.0.1(21)及之后版本该接口在phone和tablet均可正常使用,在其他设备中返回801错误码。

起始版本: 6.0.1(21)

参数:

展开
参数名 类型 必填 说明
context common.Context Context上下文。
taxiParams TaxiParams 打车的参数。

返回值:

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

错误码:

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

展开
错误码ID 错误信息
1002600014 Failed to start the map app.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. let params: petalMaps.TaxiParams = {
  2. destinationPosition: {
  3. latitude: 31.983015468224288,
  4. longitude: 118.78058590757131
  5. }
  6. };
  7. await petalMaps.openMapTaxi(this.getUIContext().getHostContext(), params);

openMapOfflineDataManagement

PhonePC/2in1TabletWearable

openMapOfflineDataManagement(context: common.Context, offlineDataParams: OfflineDataParams): Promise<void>

打开地图应用的离线地图管理页面。使用Promise异步回调。

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

系统能力: SystemCapability.Map.Core

设备行为差异: 在6.1.1(24)及之后版本该接口在phone、tablet、PC/2in1均可正常使用,在其他设备中返回801错误码。

起始版本: 6.1.1(24)

参数:

展开
参数名 类型 必填 说明
context common.Context Context上下文。
offlineDataParams OfflineDataParams 离线地图管理参数。

返回值:

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

错误码:

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

展开
错误码ID 错误信息
1002600014 Failed to start the map app.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. let params: petalMaps.OfflineDataParams = {
  2. scenarios: 'PHONE'
  3. };
  4. await petalMaps.openMapOfflineDataManagement(this.getUIContext().getHostContext(), params);

PoiDetailParams

PhonePC/2in1TabletWearable

POI详情的参数。

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

系统能力: SystemCapability.Map.Core

设备行为差异: 对于5.1.1(19)及之前的版本,该接口在phone、tablet中可正常使用,在其他设备中返回801错误码。在6.0.0(20)及之后版本该接口在phone、tablet、PC/2in1均可正常使用,在其他设备中返回801错误码。

起始版本: 5.0.3(15)

展开
名称 类型 只读 可选 说明
destinationPosition mapCommon.LatLng

POI的坐标。

取值范围:经度[-180, 180),纬度[-85.2, 85.2]。对异常值进行处理,返回错误码401。

destinationName string POI的名称,名称超出单行时,以省略号"..."截断显示。
destinationPoiId string

POI ID。

POI ID和经纬度都作为入参时,POI ID具有更高优先级。

zoom number

地图缩放级别。取值范围:[3, 20],默认值:17,异常值按照默认值处理。

说明:

当传入destinationPoiId时zoom层级不支持自定义。

起始版本: 6.0.1(21)

coordinateType mapCommon.CoordinateType

地图坐标系类型。默认值mapCommon.CoordinateType.GCJ02,异常值按照默认值处理。

起始版本: 6.0.1(21)

destinationAddress string

POI的描述,默认值和异常值会通过逆地理自动获取对应的描述。

起始版本: 6.1.1(24)

示例:

收起
自动换行
深色代码主题
复制
  1. let params: petalMaps.PoiDetailParams = {
  2. destinationPosition: {
  3. latitude: 31.968789,
  4. longitude: 118.798537
  5. },
  6. destinationName: '标记点',
  7. zoom: 17,
  8. coordinateType: mapCommon.CoordinateType.GCJ02,
  9. destinationAddress: '这是我选择的演示名称'
  10. };

TextSearchParams

PhonePC/2in1TabletWearable

文本搜索的参数。

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

系统能力: SystemCapability.Map.Core

设备行为差异: 对于5.1.1(19)及之前的版本,该接口在phone、tablet中可正常使用,在其他设备中返回801错误码。在6.0.0(20)及之后版本该接口在phone、tablet、PC/2in1均可正常使用,在其他设备中返回801错误码。

起始版本: 5.0.3(15)

展开
名称 类型 只读 可选 说明
destinationName string 终点的名称,名称超出单行时,以省略号"..."截断显示。

示例:

收起
自动换行
深色代码主题
复制
  1. let params: petalMaps.TextSearchParams = {
  2. destinationName: '云谷'
  3. };

RoutePlanParams

PhonePC/2in1TabletWearable

路线规划的参数。

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

系统能力: SystemCapability.Map.Core

设备行为差异: 对于5.1.1(19)及之前的版本,该接口在phone、tablet中可正常使用,在其他设备中返回801错误码。在6.0.0(20)及之后版本该接口在phone、tablet、PC/2in1均可正常使用,在其他设备中返回801错误码。

起始版本: 5.0.3(15)

展开
名称 类型 只读 可选 说明
originPosition mapCommon.LatLng

起点的坐标。默认值为用户当前坐标。

取值范围:经度[-180, 180),纬度[-85.2, 85.2]。对异常值进行处理,返回错误码401。

originName string 起点的名称,名称超出单行时,以省略号"..."截断显示。
originPoiId string

起点的POI ID。

POI ID和经纬度都入参时,POI ID具有更高优先级。

destinationPosition mapCommon.LatLng

终点的坐标。

取值范围:经度[-180, 180),纬度[-85.2, 85.2]。对异常值进行处理,返回错误码401。

destinationName string 终点的名称,名称超出单行时,以省略号"..."截断显示。
destinationPoiId string

终点的POI ID。

POI ID和经纬度都入参时,POI ID具有更高优先级。

vehicleType VehicleType

出行方式。

默认值为VehicleType.DRIVING,异常值按默认值处理。

coordinateType mapCommon.CoordinateType

地图坐标系类型。默认值mapCommon.CoordinateType.GCJ02,异常值按照默认值处理。

起始版本: 6.0.1(21)

示例:

收起
自动换行
深色代码主题
复制
  1. let params: petalMaps.RoutePlanParams = {
  2. destinationPosition: {
  3. latitude: 31.983015468224288,
  4. longitude: 118.78058590757131
  5. }
  6. };
PhonePC/2in1TabletWearable

导航的参数。

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

系统能力: SystemCapability.Map.Core

设备行为差异: 对于5.1.1(19)及之前的版本,该接口在phone、tablet中可正常使用,在其他设备中返回801错误码。在6.0.0(20)及之后版本该接口在phone、tablet、PC/2in1均可正常使用,在其他设备中返回801错误码。

起始版本: 5.0.3(15)

展开
名称 类型 只读 可选 说明
destinationPosition mapCommon.LatLng

终点的坐标。

取值范围:经度[-180, 180),纬度[-85.2, 85.2]。对异常值进行处理,返回错误码401。

destinationName string 终点名称,名称超出单行时,以省略号"..."截断显示。
destinationPoiId string

终点的POI ID。

POI ID和经纬度都入参时,POI ID具有更高优先级。

vehicleType VehicleType

出行方式。

默认值为VehicleType.DRIVING,异常值按默认值处理。

originPosition mapCommon.LatLng

起点的坐标。默认值为用户当前坐标。

取值范围:经度[-180, 180),纬度[-85.2, 85.2]。对异常值进行处理,返回错误码401。

起始版本: 6.0.1(21)

originName string

起点的名称,名称超出单行时,以省略号"..."截断显示。

起始版本: 6.0.1(21)

originPoiId string

起点的POI ID。

POI ID和经纬度都入参时,POI ID具有更高优先级。

起始版本: 6.0.1(21)

coordinateType mapCommon.CoordinateType

地图坐标系类型。默认值mapCommon.CoordinateType.GCJ02,异常值按照默认值处理。

起始版本: 6.0.1(21)

示例:

收起
自动换行
深色代码主题
复制
  1. let params: petalMaps.NaviParams = {
  2. destinationPosition: {
  3. latitude: 31.983015468224288,
  4. longitude: 118.78058590757131
  5. }
  6. };

OfflineDataParams

PhonePC/2in1TabletWearable

离线地图管理参数。

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

系统能力: SystemCapability.Map.Core

设备行为差异: 在6.1.1(24)及之后版本该接口在phone、tablet、PC/2in1均可正常使用,在其他设备中返回801错误码。

起始版本: 6.1.1(24)

展开
名称 类型 只读 可选 说明
scenarios string

场景描述。

说明:

目前场景仅支持'WATCH'、'PHONE'、'TABLET'、'PC'、'VOICE',且可适配大写及小写字符串。

WATCH:打开手表离线地图管理页,管理手表离线地图。

PHONE:打开地图资源管理页,管理设备本地离线地图。

TABLET:打开地图资源管理页,管理设备本地离线地图。

PC:打开地图资源管理页,管理设备本地离线地图。

VOICE:打开导航语音页,管理设备本地离线导航语音。

recommendedRegionIds string[] 推荐下载离线地图的地区集合,最大长度为20,异常值返回401。

示例:

收起
自动换行
深色代码主题
复制
  1. let params: petalMaps.OfflineDataParams = {
  2. scenarios: 'PHONE'
  3. };

VehicleType

PhonePC/2in1TabletWearable

出行方式。地图应用侧目前出行方式暂时仅支持驾车、步行、骑行、公交。

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

系统能力: SystemCapability.Map.Core

设备行为差异: 对于5.1.1(19)及之前的版本,该接口在phone、tablet中可正常使用,在其他设备中返回801错误码。在6.0.0(20)及之后版本该接口在phone、tablet、PC/2in1均可正常使用,在其他设备中返回801错误码。

起始版本: 5.0.3(15)

展开
名称 说明
DRIVING 0 驾车。
WALKING 1 步行。
CYCLING 2 骑行。
TRANSIT 3

公交。

起始版本: 6.0.1(21)

TaxiParams

PhonePC/2in1TabletWearable

打车的参数。

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

系统能力: SystemCapability.Map.Core

设备行为差异: 在6.0.1(21)及之后版本该接口在phone、tablet均可正常使用,在其他设备中返回801错误码。

起始版本: 6.0.1(21)

展开
名称 类型 只读 可选 说明
destinationPosition mapCommon.LatLng

终点的坐标。

取值范围:经度[-180, 180),纬度[-85.2, 85.2]。对异常值进行处理,返回错误码401。

destinationName string 终点名称,名称超出单行时,以省略号"..."截断显示。
destinationPoiId string

终点的POI ID。

POI ID和经纬度都入参时,POI ID具有更高优先级。

originPosition mapCommon.LatLng

起点的坐标。默认值为用户当前坐标。

取值范围:经度[-180, 180),纬度[-85.2, 85.2]。对异常值进行处理,返回错误码401。

originName string 起点的名称,名称超出单行时,以省略号"..."截断显示。
originPoiId string

起点的POI ID。

POI ID和经纬度都入参时,POI ID具有更高优先级。

coordinateType mapCommon.CoordinateType 地图坐标系类型。默认值mapCommon.CoordinateType.GCJ02,异常值按照默认值处理。

示例:

收起
自动换行
深色代码主题
复制
  1. let params: petalMaps.TaxiParams = {
  2. destinationPosition: {
  3. latitude: 31.983015468224288,
  4. longitude: 118.78058590757131
  5. }
  6. };
在 API参考 中进行搜索
请输入您想要搜索的关键词