aMap

open show setRect stopLocation getNameFromCoords showUserLocation setCenter setZoomLevel setMapAttr getRotation getOverlook getRegion setCompass takeSnapshotInRect isCircleContainsPoint addEventListener setMapLanguage

室内地图

showsIndoorMap showsIndoorMapControl setIndoorMapControlOrigin clearIndoorMapCache

标注、气泡类

cancelAnnotationSelected setAnnotationCoords setBubble closeBubble addWebBoard removeWebBoardListener moveAnnotation setWebBubble removeWebBubbleListener cancelMoveAnimation

覆盖物类

addHeatMap addMultiPoint addCircle addImg removeOverlay

搜索类

drawRoute searchBusRoute removeBusRoute searchNearby
autocomplete

weatherSearch

离线地图类

getCitiesByProvince getNationWide getVersion isDownloading cancelAllDownload
checkNewestVersion

经纬度坐标转换、轨迹纠偏

convertCoordinate cancelProcessedTrace

论坛示例

为帮助用户更好更快的使用模块，论坛维护了一个，示例中包含示例代码、知识点讲解、注意事项等，供您参考。

概述

高德地图简介

高德地图 是国内一流的免费地图导航产品，也是基于位置的生活服务功能最全面、信息最丰富的手机地图，由国内最大的电子地图、导航和LBS服务解决方案提供商高德软件（纳斯达克AaMap）提供。高德地图采用领先的技术为用户打造了最好用的“活地图”，不管在哪、去哪、找哪、怎么去、想干什么一图在手，统统搞定，省电省流量更省钱，堪称最完美的生活出行软件。地图数据覆盖中国大陆及香港澳门,遍及337个地级2857个县级以上行政区划单位；导航支持GPS、基站、网络等多种方式一键定位。美食、酒店、演出、商场等各种深度POI点达2600多万条，衣食住行吃喝玩乐全方位海量生活信息可供搜索查询。自动生成“最短”“最快”“最省钱”等多种路线规划以供选择，可根据实时路况选择最优公交/驾车出行路线。

高德地图特色功能

动态导航

交通路况实时播报，智能计算到达目的地所需的时间，避堵路线方案规划

离线下载

3D离线地图，分地区下载地图包，全国地图包、全国概要图

地图搜索

热门地点、线路搜索，公交、自驾出行线路规划，公交、火车、天气查询服务

全新引擎

最新3D版本，360度旋转视角，矢量数据传送，观看更流畅、更清晰。

兴趣点

餐饮、住宿、优惠、演出、团购全覆盖，海量兴趣点随意搜

模块概述

aMap 模块封装了高德地图的原生 SDK，集成了高德地图常用基本接口；手机版原生地图，不同于 js 地图，相对于js地图而言，本模块封装的原生手机地图更加流畅迅速、动画效果更加逼真。使用此模块可轻松把高德地图集成到自己的app内，实现高德地图常用的定位、关键字搜索、周边搜索、自定义标注及气泡、查公交路线等各种功能；另外本模块已支持高德地图离线版本。

若某些带UI的接口不能满足开发设计需求，开发者（借助于原生开发者）可在本模块基础上修改少量原生代码，随心所欲的自定义高德地图所具有的原生功能，简单、轻松、快捷、高效、迅速集成高德地图，将自己的 app 和高德地图实现无缝链接。模块原生代码开源地址为：https://github.com/apicloudcom/moduleCode/aMap

模块使用攻略

注意事项

本模块内带动画效果的接口不可同时调用（两个以上），需要设置延迟（）处理。

需要在APICloud 网站控制台编译界面选择定位权限。凡是需要使用定位功能的模块，请先选择定位权限

不能同时添加的模块：aMapLocation, baiduLocation

使用此模块之前必须先配置 config 文件，配置方法如下：

• 名称：aMap
• 参数：android_api_key、ios_api_key
• 备注：同一个 App 需要同时支持 iOS 和 Android 平台，必须单独申请各自的 apiKey，并同时配置在 config 文件中
• 配置示例:

• 字段描述:

  android_api_key：在高德地图开放平台申请的 Android 端 AK

  ios_api_key：在高德地图开放平台申请的 iOS 端 AK

用户在使用本模块之前需要获取高德地图API Key，Key 申请的具体流程请参照 。本模块需要的 key 可以和 aMapLBS、 、aMapNavigation 、 模块的 key 共用（即相关key配置一个即可）。

注意：在 iOS 上版本使用定位功能，需要在云编译时勾选 定位（使用期间） 和 定位服务（始终）

模块接口

open

打开高德地图

open({params}, callback(ret))

params

rect：

• 类型：JSON 对象
• 描述：（可选项）模块的位置及尺寸
• 内部字段：

{
    x: 0,   //（可选项）数字类型；地图左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认：0
    y: 0,   //（可选项）数字类型；地图左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认：0
    w: 320, //（可选项）数字类型；地图的宽度；默认：'auto'
    h: 480  //（可选项）数字类型；地图的高度；默认：'auto'
}

center：

• 类型：数字
• 描述：（可选项）打开地图时设置的中心点经纬度，若不传则默认打开北京市为中心的地图
• 内部字段：

{
    lon: 116.213,       //数字类型；打开地图时设置的中心点经度
    lat: 39.213         //数字类型；打开地图时设置的中心点纬度
}

zoomLevel：

• 类型：数字
• 描述：（可选项）设置高德地图缩放等级，取值范围：3-18级
• 默认值：10

showUserLocation：

• 类型：布尔
• 描述：（可选项）是否在地图上显示用户位置
• 默认值：true

userLocationCanShowCallout：

• 类型：布尔
• 描述：（可选项）地图上显示用户位置时，是否支持点击位置弹出提示，只支持iOS端
• 默认值：true

showsAccuracyRing：

• 类型：布尔
• 描述：（可选项）是否在地图上显示用户位置的精度圈儿
• 默认值：true
• 注意：若open时本参数为false 则 showUserLocation 接口传 true 也无法显示精度圈儿

isGestureScaleByMapCenter:

• 类型：布尔
• 描述：(可选项) 设置是否以地图中心点缩放 (ios不支持)
• 默认值：false

fixedOn：

• 类型：字符串类型
• 描述：（可选项）模块视图添加到指定 frame 的名字（只指 frame，传 window 无效）
• 默认：模块依附于当前 window

fixed:

• 类型：布尔
• 描述：（可选项）模块是否随所属 window 或 frame 滚动
• 默认值：true（不随之滚动）

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status: true     //布尔型；true||false
}

示例代码

var aMap = api.require('aMap');
aMap.open({
    rect: {
        x: 0,
        y: 0,
        w: 320,
        h: 300
    },
    showUserLocation: true,
    zoomLevel: 11,
    center: {
        lon: 116.4021310000,
        lat: 39.9994480000
    },
    fixedOn: api.frameName,
    fixed: true
}, function(ret, err) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

close

关闭高德地图

close()

示例代码

var aMap = api.require('aMap');
aMap.close();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

show

显示高德地图

show()

示例代码

var aMap = api.require('aMap');
aMap.show();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

hide

隐藏高德地图

hide()

示例代码

var aMap = api.require('aMap');
aMap.hide();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setRect

重设地图的显示区域

setRect({params})

params

rect：

• 类型：JSON 对象
• 描述：（可选项）模块的位置及尺寸
• 内部字段：

{
    x: 0,   //（可选项）数字类型；地图左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认：原值
    y: 0,   //（可选项）数字类型；地图左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认：原值
    w: 320, //（可选项）数字类型；地图的宽度；默认：原值
    h: 480  //（可选项）数字类型；地图的高度；默认：原值
}

示例代码

var aMap = api.require('aMap');
aMap.setRect({
    rect: {
        x: 0,
        y: 0,
        w: 320,
        h: 300
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getLocation

获取当前位置信息，若要支持后台定位需配置 文件 location 字段。iOS上调用本接口需先 open，在iOS 平台上 showUserLocation 为 false 时此接口不可用

注：根据高德地图技术回复，在有的手机上及时拒绝手机定位权限，依然可以获取到位置信息

getLocation({params}, callback(ret, err))

params

autoStop：

• 类型：布尔
• 描述：（可选项）获取到位置信息后是否自动停止定位
• 默认值：true

enableLocInForeground：

• 类型：布尔类型
• 描述：(可选项) 开发者应用如果有后台定位需求，在退到后台的时候，为了保证定位可以在后台一直运行，可以设置为true，适配android 8后台无法定位问题；注：单次定位(autoStop为true时)无效(ios不支持)
• 默认值：false

notification:

• 类型：JSON对象
• 描述：(必选项) 通知栏的提示，此字段只有在enableLocInForeground设置为true时有效。(ios不支持)

内部字段：

{
    title :  //(可选项) 字符串类型；标题； 默认值：应用名称
    content:    //(可选项) 字符串类型；内容； 默认值：正在后台运行
}

callback(ret, err)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status: true,               //布尔型；true||false
    lon: 116.213,               //数字类型；经度
    lat: 39.213,                //数字类型；纬度
    accuracy: 65,               //数字类型；本次定位的精度
    timestamp: 1396068155591,   //数字类型；时间戳
    heading:200,                //数字类型；设备方向，取值范围：0.0（正北） - 359.9 
    altitude: 200               //数字类型；当前设备所处的海拔信息
    verticalAccuracy: 10               //数字类型；垂直位置精度，无效时为负数 (android不支持)
    horizontalAccuracy: 20               //数字类型；平面位置精度，无效时为负数(android不支持)
    course: 200               //数字类型；偏离正北方向的角度，无效时为负数，范围 0.0 - 359.9
    speed: 200               //数字类型；速度，无效时为负数，单位：m/s
    floor: 2               //数字类型；在建筑物的第几层，无效时不返回
}

示例代码

var aMap = api.require('aMap');
aMap.getLocation(function(ret, err) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

stopLocation

停止定位

stopLocation()

示例代码

var aMap = api.require('aMap');
aMap.stopLocation();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getCoordsFromName

根据地址查找经纬度，无需调用 open 接口即可使用

getCoordsFromName({params}, callback(ret, err))

params

city：

• 类型：字符串
• 描述：（可选项）所要搜索的地址所在的城市，cityname（中文或中文全拼）、citycode、adcode
• 注意：如果address是完整的地址，本参数可不传。若传必须传城市，不可带省，如：济南；不能传山东济南

address：

• 类型：字符串
• 描述：完整的地址信息

callback(ret, err)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status: true,        //布尔型；true||false
    lon: 116.351,        //数字类型；地址所在经度
    lat: 39.283          //数字类型；地址所在纬度
}

err：

• 类型：JSON 对象
• 内部字段：

{
    code: 1           //数字类型；错误码
    msg:              //字符串类型；错误描述
}

示例代码

var aMap = api.require('aMap');
aMap.getCoordsFromName({
    city: '济南',
    address: '济南市市中区趵突泉南路1号趵突泉公园内'
}, function(ret, err) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getNameFromCoords

根据经纬度查找地址信息，无需调用 open 接口即可使用

getNameFromCoords({params}, callback(ret))

params

lon：

• 类型：数字
• 描述：经度

lat：

• 类型：数字
• 描述：纬度

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status: true,              //布尔型；true||false
    address: '',               //字符串类型；地址信息
    state: '',                 //字符串类型；省份
    city: '',                  //字符串类型；城市
    district: '',              //字符串类型；县区
    street: '',                //字符串类型；街道名
    number: '',                //字符串类型；门牌号
    thoroughfare: '',          //字符串类型；社区
    township: '',              //字符串类型；乡镇
    building: '',              //字符串类型；建筑
    adcode: '',                //字符串类型；地址编号
    citycode: ''               //字符串类型；城市编号
}

示例代码

var aMap = api.require('aMap');
aMap.getNameFromCoords({
    lon: 116.384767,
    lat: 39.989539
}, function(ret, err) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getDistance

获取地图两点之间的距离，无需调用 open 接口即可使用

getDistance({params}, callback(ret))

params

start：

• 类型：JSON 对象
• 描述：起点经纬度
• 内部字段：

{
    lon: 106.486654,    //数字类型；起点的经度
    lat: 29.490295      //数字类型；起点的纬度
}

end：

• 类型：JSON 对象
• 描述：终点经纬度
• 内部字段：

{
    lon: 106.581515,    //数字类型；终点的经度
    lat: 29.615467      //数字类型；终点的纬度
}

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status: true,              //布尔型；true||false
    distance: 16670.90         //数字类型；两点之间的距离，单位：米
}

示例代码

var aMap = api.require('aMap');
aMap.getDistance({
    start: {
        lon: 106.486654,
        lat: 29.490295
    },
    end: {
        lon: 106.581515,
        lat: 29.615467
    }
}, function(ret, err) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

showUserLocation

是否在地图上显示用户位置

showUserLocation({params})

params

isShow：

• 类型：布尔
• 描述：（可选项）是否显示用户位置
• 默认值：true

imagePath:

• 类型：字符串
• 描述：(可选项)当前位置显示图标的图片，要求本地路径支持fs,widget
• 默认值：高德地图默认当前位置图标

imageSize:

• 类型：JSON 对象
• 描述：(可选项)设置的当前位置显示图标的大小，当imagePath 为空时，本参数无意义。
• 默认值：原图宽高的一半
• 内部字段：

{
    w:,         //(可选项)数字类型；图标宽度；默认：原图宽的一半
    h:          //(可选项)数字类型；图标高度度；默认：原图高的一半
}

showsAccuracyRing：

• 类型：布尔
• 描述：（可选项）精度圈是否显示
• 默认值：true
• 注意：若 open 时 showsAccuracyRing 为false 则本接口的此参数传 true 也无法显示精度圈儿

showsHeadingIndicator：

• 类型：布尔
• 描述：（可选项）是否显示方向指示(setTrackingMode接口heading模式开启)
• 默认值：true

enablePulseAnnimation：

• 类型：布尔
• 描述：（可选项）内部蓝色圆点是否使用律动效果(android不支持)
• 默认值：true

fillColor：

• 类型：字符串
• 描述：（可选项）精度圈 填充颜色
• 默认值：系统默认色

strokeColor：

• 类型：字符串
• 描述：（可选项）精度圈 边线颜色
• 默认值：系统默认色

dotBgColor：

• 类型：字符串
• 描述：（可选项）定位点背景色(android不支持)
• 默认值：白色

dotFillColor：

• 类型：字符串
• 描述：（可选项）定位点蓝色圆点颜色(android不支持)
• 默认值：蓝色

lineWidth：

• 类型：数字
• 描述：（可选项）精度圈 边线宽度
• 默认值：0

示例代码

var aMap = api.require('aMap');
aMap.showUserLocation({
    isShow: true
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setTrackingMode

设置跟踪类型

setTrackingMode({params})

params

trackingMode：

• 类型：字符串
• 描述：（可选项）用户当前位置显示形式
• 默认值：none
• 取值范围：
  • none（不追踪用户的 location 更新）
  • follow（追踪用户的 location 更新）
  • heading（追踪用户的 location 与 heading 更新）

animation：

• 类型：布尔类型
• 描述：（可选项）设置地图的当前位置标记的追踪状态时，是否带动画效果，暂仅支持 iOS 平台
• 默认：true

示例代码

var aMap = api.require('aMap');
aMap.setTrackingMode({
    animation: false,
    trackingMode: 'none'
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setCenter

根据经纬度设置高德地图中心点

setCenter({params})

params

coords：

• 类型：JSON 对象
• 描述：（可选项）中心点的经纬度
• 内部字段：

{
    lon: 116.404,       //（可选项）数字类型；设置中心点的经度
    lat: 39.915         //（可选项）数字类型；设置中心点的纬度
}

animation：

• 类型：布尔类型
• 描述：（可选项）设置地图的中心点时，是否带动画效果
• 默认：true

示例代码

var aMap = api.require('aMap');
aMap.setCenter({
    coords: {
        lon: 116.404,
        lat: 39.915
    },
    animation: false
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getCenter

获取高德地图中心点坐标

getCenter(callback(ret, err))

callback(ret, err)

ret：

• 类型：JSON 对象
• 内部字段：

{
    lon: 116.404,       //数字类型；地图中心点的经度
    lat: 39.915         //数字类型；地图中心点的纬度
}

示例代码

var aMap = api.require('aMap');
aMap.getCenter(function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setZoomLevel

设置高德地图缩放等级

setZoomLevel({params})

params

level：

• 类型：数字
• 描述：（可选项）地图比例尺级别，取值范围：0.01-20
• 默认值：10

animation：

• 类型：布尔类型
• 描述：（可选项）地图缩放时，是否带动画效果
• 默认：true

示例代码

var aMap = api.require('aMap');
aMap.setZoomLevel({
    level: 10,
    animation: true
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getZoomLevel

获取地图缩放级别（0.01-20）

getZoomLevel(callback(ret, err))

callback

ret：

• 类型：JSON 对象
• 内部字段：

{
    level: 11           //数字类型；地图当前缩放级别
}

示例代码

var aMap = api.require('aMap');
aMap.getZoomLevel(function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setMapAttr

设置高德地图相关属性

setMapAttr({params})

params

type:

• 类型：字符串
• 描述：（可选项）设置地图类型
• 默认值：’standard’
• 取值范围：
  • standard（标准地图）
  • satellite（卫星地图）
  • night（夜间模式）

trafficOn：

• 类型：布尔
• 描述：（可选项）是否打开实时路况
• 默认值：false

zoomEnable：

• 类型：布尔
• 描述：（可选项）捏合手势是否可以缩放地图
• 默认值：true

scrollEnable：

• 类型：布尔
• 描述：（可选项）拖动手势是否可以移动地图
• 默认值：ture

overlookEnabled：

• 类型：布尔
• 描述：（可选项）是否支持俯视旋转
• 默认值：ture

rotateEnabled：

• 类型：布尔
• 描述：（可选项）是否支持平面旋转
• 默认值：ture

building：

• 类型：布尔
• 描述：（可选项）是否隐藏楼块，俯视角度不为零时的楼快效果，Android 平台上默认打开状态，且不可改变
• 默认值：false

示例代码

var aMap = api.require('aMap');
aMap.setMapAttr({
    type: 'standard',
    trafficOn: true,
    zoomEnable: false,
    scrollEnable: false,
    building: true,
    overlookEnabled: false,
    rotateEnabled: false
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setRotation

设置高德地图旋转角度(逆时针为正向)

setRotation({params})

params

degree：

• 类型：数字
• 描述：（可选项）地图旋转角度，取值范围：-180° - 180°
• 默认值：0

animation：

• 类型：布尔
• 描述：（可选项）地图旋转时，是否带动画效果
• 默认：true

duration：

• 类型：数字
• 描述：（可选项）地图旋转动画时长，单位秒（s）
• 默认：0.3

示例代码

var aMap = api.require('aMap');
aMap.setRotation({
    degree: 30,
    animation: true,
    duration: 0.3
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getRotation

获取地图当前旋转角度

getRotation(callback(ret, err))

callback

ret：

• 类型：JSON 对象
• 内部字段：

{
    rotation: 11           //数字类型；地图当前旋转角度
}

示例代码

var aMap = api.require('aMap');
aMap.getRotation(function(ret) {
    alert(JSON.stringify(ret.level));
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setOverlook

设置地图俯视角度(范围为[0.f, 60.f])

setOverlook({params})

params

degree：

• 类型：数字
• 描述：（可选项）地图俯视角度，取值范围：0° - 60°
• 默认值：0

animation：

• 类型：布尔
• 描述：（可选项）地图俯视角度转动时，是否带动画效果
• 默认：true

duration：

• 类型：数字
• 描述：（可选项）地图俯视角度转动动画时长，单位秒（s）
• 默认：0.3

示例代码

var aMap = api.require('aMap');
aMap.setOverlook({
    degree: 30,
    animation: true,
    duration: 0.3
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getOverlook

获取地图当前俯视角度

getOverlook(callback(ret, err))

callback

ret：

• 类型：JSON 对象
• 内部字段：

{
    overlook: 11           //数字类型；地图当前俯视角度
}

示例代码

var aMap = api.require('aMap');
aMap.getOverlook(function(ret) {
    alert(JSON.stringify(ret.level));
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setRegion

设置地图显示范围（矩形区域）

setRegion({params})

params

lbLon：

• 类型：数字
• 描述：矩形区域左下角的经度

lbLat：

• 类型：数字
• 描述：矩形区域左下角的纬度

rtLon：

• 类型：数字
• 描述：矩形区域右上角的经度

rtLat：

• 类型：数字
• 描述：矩形区域右上角的纬度

animation：

• 类型：布尔类型
• 描述：（可选项）设置地图的区域时，是否带动画效果
• 默认：true

示例代码

var aMap = api.require('aMap');
aMap.setRegion({
    lbLon: 116.027143, 
    lbLat: 39.772348, 
    rtLon: 116.832025, 
    rtLat: 40.126349,
    animation: true
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getRegion

获取地图显示范围（矩形区域）

getRegion(callback(ret, err))

callback

ret：

• 类型：JSON 对象
• 内部字段：

{
    status: true,                //布尔型；true||false
    lbLon: 116.027143,           //数字类型；矩形区域左下角的经度
    lbLat: 39.772348,            //数字类型；矩形区域左下角的纬度
    rtLon: 116.832025,           //数字类型；矩形区域右上角的经度
    rtLat: 40.126349             //数字类型；矩形区域右上角的纬度  
}

示例代码

var aMap = api.require('aMap');
aMap.getRegion(function(ret) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setScaleBar

设置高德地图比例尺

setScaleBar({params})

params

show：

• 类型：布尔
• 描述：（可选项）是否显示比例尺
• 默认值：false

position：

• 类型：JSON 对象
• 描述：（可选项）比例尺的位置，设定坐标以地图左上角为原点，在 Android 平台上为固定位置，本参数无效

• 内部字段：

  { 
    x: 0,   //（可选项）数字类型；比例尺左上角的 x 坐标（相对于地图）；默认：0
    y: 0    //（可选项）数字类型；比例尺左上角的 y 坐标（相对于地图）；默认：0
  }

示例代码

var aMap = api.require('aMap');
aMap.setScaleBar({
    show: true,
    position: {
      x:100,
      y:100
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setCompass

设置高德地图指南针

setCompass({params})

params

show：

• 类型：布尔
• 描述：（可选项）是否显示指南针
• 默认值：false

position：

• 类型：JSON 对象
• 描述：（可选项）指南针的位置，设定坐标以地图左上角为原点，在 Android 平台上为固定位置，本参数无效

• 内部字段：

  { 
    x: 0,   //（可选项）数字类型；指南针左上角的 x 坐标（相对于地图）；默认：0
    y: 0    //（可选项）数字类型；指南针左上角的 y 坐标（相对于地图）；默认：0
  }

img：

• 类型：布尔
• 描述：（可选项）自定义指南针图标图片路径，要求本地路径（fs://、widget://），Android 平台上忽略本参数
• 默认值：高德地图默认图标

示例代码

var aMap = api.require('aMap');
aMap.setCompass({
    show: true,
    img: 'widget://res/compass.png',
    position: {
      x:100,
      y:100
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setLogo

设置高德地图 logo 的位置

setLogo({params})

params

position：

• 类型：字符串
• 默认：right
• 描述：（可选项）高德地图 logo 的位置，取值范围如下：
  • left：地图左下角
  • center：地图底部居中
  • right：地图右下角

示例代码

var aMap = api.require('aMap');
aMap.setLogo({
    position: 'right'
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

isPolygonContainsPoint

判断已知点是否在指定的多边形区域内

isPolygonContainsPoint({params}, callback(ret, err))

params

point：

• 类型：JSON 对象
• 描述：已知点的地理坐标
• 内部字段：

{
    lon: 116.297,      //数字类型；经度
    lat: 40.109        //数字类型；纬度
}

points：

• 类型：数组
• 描述：多边形的各个点组成的数组
• 内部字段：

[{
    lon: 116.297,      //数字类型；经度
    lat: 40.109        //数字类型；纬度
}]

params

ret：

• 类型：JSON 对象
• 内部字段：

{
    status: true      //布尔类型；目标点是否在指定区域内，true || false      
}

示例代码

var aMap = api.require('aMap');
aMap.isPolygonContainsPoint({
    point: {
        lon: 116.39432327,
        lat: 39.98963192
    },
    points: [{
        lon: 116.39432327,
        lat: 39.98963192
    }, {
        lon: 116.49432328,
        lat: 39.98963192
    }, {
        lon: 116.39432327,
        lat: 39.88933191
    }]
}, function(ret) {
    alert(ret.status);
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

isCircleContainsPoint

判断已知点是否在指定的圆形区域内

isCircleContainsPoint({params}, callback(ret, err))

params

point：

• 描述：已知点的地理坐标
• 内部字段：

{
    lon: 116.297,      //数字类型；经度
    lat: 40.109        //数字类型；纬度
}

circle：

• 类型：JSON
• 描述：圆形信息
• 内部字段：

{
    center: {           //JSON对象；圆心信息
       lon: 116.297,    //数字类型；经度
       lat: 40.109      //数字类型；纬度
    },
    radius: 100         //（可选项）数字类型；半径，单位米（m）；默认：100
}

params

ret：

• 类型：JSON 对象
• 内部字段：

{
    status: true      //布尔类型；目标点是否在指定区域内，true || false      
}

示例代码

var aMap = api.require('aMap');
aMap.isCircleContainsPoint({
    point: {
        lon: 116.39432327,
        lat: 39.98963192
    },
    circle: {
       center: {           
         lon: 116.297,    
         lat: 40.109      
       },
       radius: 100
    }
}, function(ret) {
    alert(ret.status);
});

可用性

iOS系统，Android系统

可提供的1.1.9及更高版本

interconvertCoords

经纬度坐标与地图容器像素坐标相互转换，经纬度和x，y值传一种即可。

interconvertCoords({params}, callback(ret, err))

params

lon：

• 类型：数字
• 描述：（可选项）原始地理坐标经度

lat：

• 类型：数字
• 描述：（可选项）原始地理坐标纬度

x：

• 类型：数字
• 描述：（可选项）地图容器的 x 坐标

• 类型：数字
• 描述：（可选项）地图容器的 y 坐标

callback(ret, err)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status: true,           //布尔型；true||false
    x: 334.00004622221184,  //数字类型；传经纬度时，返回转换后的地图容器x坐标
    y: 207.00000925440887,  //数字类型；传经纬度时，返回转换后的地图容器y坐标
    lon: 116.213,           //数字类型；传x，y值时，返回转换后的地理坐标经度
    lat: 39.213             //数字类型；传x，y值时，返回转换后的地理坐标纬度
}

示例代码

var aMap = api.require('aMap');
aMap.interconvertCoords({
    lon: 116.351,
    lat: 39.283
}, function(ret, err) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

takeSnapshotInRect

在指定区域内截图(默认会包含该区域内的标注)

takeSnapshotInRect({params}, callback(ret))

params

rect：

• 类型：JSON 对象
• 描述：（可选项）所截取区域的位置和大小（相对于地图区域）
• 内部字段：

{
    x: 0,   //（可选项）数字类型；地图左上角的 x 坐标（相对于地图所在的区域）；默认：0
    y: 0,   //（可选项）数字类型；地图左上角的 y 坐标（相对于地图所在的区域）；默认：0
    w: 320, //（可选项）数字类型；地图的宽度；默认：地图的宽
    h: 480  //（可选项）数字类型；地图的高度；默认：地图的高
}

path：

• 类型：字符串
• 描述：截图保存路径，要求本地路径（fs://），如：fs://aMap/Snapshot.png

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{ 
    status: true, //布尔类型；是否截图成功
    realPath: ''     //字符串类型；截图的绝对路径
}

示例代码

var aMap = api.require('aMap');
aMap.takeSnapshotInRect({
    rect: {
        x: 0,
        y: 0,
        w: 320,
        h: 300
    },
    path: 'fs://aMap/123.png'
}, function(ret) {
        alert(JSON.stringify(ret));
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

addEventListener

监听地图相关事件

addEventListener({params}, callback(ret))

params

name:

• 类型：字符串
• 描述：地图相关事件名称
• 取值范围：
  • longPress（长按事件）
  • viewChange（视角改变事件）
  • click（单击事件）
  • trackingMode（userTrackingMode 改变事件，暂仅支持 iOS 平台）
  • zoom（放大缩小事件）

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status: true,           //布尔型；true||false
    lon: 116.351,           //数字类型；触发事件的地点的经度（longPress，click），地图中心的经度（viewChange，trackingMode，zoom）
    lat: 39.283,            //数字类型；触发事件的地点的纬度（longPress，click），地图中心的纬度（viewChange，trackingMode，zoom）
    zoom: 11,               //数字类型；地图缩放角度
    rotate: 30,             //数字类型；地图旋转角度
    overlook: 30,           //数字类型；视角倾斜度
    trackingMode:follow     //字符串类型；当前位置标注图标显示的跟踪类型（trackingMode）
-                             取值范围：
                               none（不追踪用户的 location 更新）
                               follow（追踪用户的 location 更新）
                               heading（追踪用户的 location 与 heading 更新）
    zoomType: 'zoomIn'      //字符串类型；zoomIn 放大，zoomOut缩小；name为zoom时有值，iOS平台无此参数
}

示例代码

var aMap = api.require('aMap');
aMap.addEventListener({
    name: 'longPress'
}, function(ret) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

removeEventListener

停止监听地图相关事件

removeEventListener({params})

params

name:

• 类型：字符串
• 描述：地图相关事件名称
• 取值范围：
  • longPress（长按事件）
  • viewChange（视角改变事件）
  • click（单击事件）
  • trackingMode（userTrackingMode 改变事件）
  • zoom（放大缩小事件）

示例代码

var aMap = api.require('aMap');
aMap.removeEventListener({
    name: 'longPress'
});

iOS系统，Android系统

可提供的1.0.0及更高版本

isShowsIndoorMap

是否为显示室内地图状态

isShowsIndoorMap(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status: false      //布尔类型；是否为显示室内地图状态
}

示例代码

var aMap = api.require('aMap');
aMap.isShowsIndoorMap(function(ret){
   alert(JSON.stringify(ret));
});

可用性

iOS系统，Android系统

可提供的1.1.3及更高版本

showsIndoorMap

设置是否显示室内地图

showsIndoorMap({params})

params

isShows:

• 类型：布尔
• 描述：（可选项）是否显示室内地图
• 默认：false

示例代码

var aMap = api.require('aMap');
aMap.showsIndoorMap({
    isShows: true
});

可用性

iOS系统，Android系统

可提供的1.1.3及更高版本

isShowsIndoorMapControl

是否为显示室内地图默认控件

isShowsIndoorMapControl(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

示例代码

var aMap = api.require('aMap');
aMap.isShowsIndoorMapControl(function(ret){
   alert(JSON.stringify(ret));
});

可用性

iOS系统

可提供的1.1.3及更高版本

showsIndoorMapControl

设置是否显示室内地图默认控件

showsIndoorMapControl({params})

params

isShows:

• 类型：布尔
• 描述：（可选项）是否显示室内地图默认控件
• 默认：false

示例代码

var aMap = api.require('aMap');
aMap.showsIndoorMapControl({
    isShows: true
});

可用性

iOS系统

可提供的1.1.3及更高版本

indoorMapControlSize

获取默认室内地图控件的最大宽高

indoorMapControlSize(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    size:{          //JSON对象；默认室内地图控件的最大宽高
       width:,      //数字类型；默认室内地图控件的最大宽
       height:      //数字类型；默认室内地图控件的最大高
    }
}

示例代码

var aMap = api.require('aMap');
aMap.indoorMapControlSize(function(ret){
   alert(JSON.stringify(ret));
});

可用性

iOS系统

可提供的1.1.3及更高版本

setIndoorMapControlOrigin

设置默认室内地图控件位置

setIndoorMapControlOrigin({params})

params

point:

• 类型：JSON对象
• 描述：（可选项）左上角点位置
• 内部字段：

{
  x:0,    //数字类型；
  y:0     //数字类型；
}

示例代码

var aMap = api.require('aMap');
aMap.setIndoorMapControlOrigin({
    point: {
       x:10,
       y:10
    }
});

可用性

iOS系统

可提供的1.1.3及更高版本

setCurrentIndoorMapFloorIndex

设置当前室内地图楼层数

setCurrentIndoorMapFloorIndex({params})

params

floorIndex:

• 类型：数字
• 描述：（可选项）要设置的楼层数
• 默认：0

示例代码

var aMap = api.require('aMap');
aMap.setCurrentIndoorMapFloorIndex({
    floorIndex: 2
});

可用性

iOS系统

可提供的1.1.3及更高版本

clearIndoorMapCache

清空室内地图缓存

clearIndoorMapCache()

示例代码

var aMap = api.require('aMap');
aMap.clearIndoorMapCache();

可用性

iOS系统

可提供的1.1.3及更高版本

addAnnotations

在地图上添加标注信息，标注大小默认为 icons 内第一张图片大小的二分之一。图标中轴线的下边缘点为坐标基准点

addAnnotations({params}, callback(ret, err))

params

annotations：

• 类型：数组
• 描述：图标标注信息组成的数组
• 内部字段：

[{
    id: 1,                     //数字类型；图标标注的唯一标识
    lon: 116.233,              //数字类型；图标标注所在位置的经度
    lat: 39.134,               //数字类型；图标标注所在位置的纬度
    icons: 'widget://',        //（可选项）数组类型；指定的标注图标路径组成的数组，若包含多张图片，则此标注显示为多图联动的 gif 动画效果，要求本地路径（fs://、widget://），若不传则显示公用的 icons 图标
    selectedIcons:             // (可选项) 数组类型；点击标注后的图标路径，若包含多张图片，则此标注显示为多图联动的 gif 动画效果，要求本地路径（fs://、widget://），若不传则显示公用的selectedIcons，如果公用的selectedIcons也不传，则点击时不切换图标
    draggable: true            //（可选项）布尔类型；所添加的标注是否可被拖动，若不传则以公用的 draggable 为准
    w: 30,               //数字类型；图标标注宽度；默认值：icons或selectedIcons内第一张图片宽度的二分之一 （android不根据图片大小，传多少是多少）   
    h: 30,               //数字类型；图标标注高度；默认值：icons或selectedIcons内第一张图片高度的二分之一 （android不根据图片大小，传多少是多少） 
    locked: false,        //（可选项）布尔类型；是否固定在屏幕一点, 注意，拖动或者手动改变经纬度，都会导致设置失效。如果为true，设置lon和lat会失效，需要设置lockedX和lockedY；默认：false
    lockedX: 100,               //数字类型；固定屏幕点的X坐标，locked为true时设置；默认值：地图视图中间
    lockedY: 100,               //数字类型；固定屏幕点的Y坐标，locked为true时设置；默认值：地图视图中间
}]

icons：

• 类型：数组
• 描述：（可选项）指定的标注图标路径组成的数组，若包含多张图片，则此标注显示为多图联动的 gif ，要求本地路径（fs://、widget://）
• 默认值：红色大头针
• 注：android上如果填写此选项，并有多张图片时，请尽量保证图片的大小是一致的；

selectedIcons：

• 类型：数组
• 描述：(可选项) 指定的标注图标路径组成的数组，若包含多张图片，则此标注显示为多图联动的 gif ，要求本地路径（fs://、widget://），

draggable：

• 类型：布尔
• 描述：（可选项）所添加的标注是否可被拖动
• 默认值：false

timeInterval：

• 类型：数字
• 描述：（可选项）若添加的标注为动态图，则本参数表示动态图循环播放一次的时间，单位为秒（s），否则本参数无效
• 默认值：3.0

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    id: 10                      //数字类型；相应事件的标注的
    eventType: 'click',         //字符串类型；交互事件类型
                                //取值范围：
                                //click（用户点击标注事件）
                                //drag（用户拖动标注事件）
    dragState: 'starting'       //字符串类型；标注被拖动的状态，当 eventType 为 drag 时本字段有值，
                                //取值范围：
                                //starting（开始拖动）
                                //dragging （拖动中）
                                //ending （拖动结束）
                                //none （静止状态），Android平台不支持
                                //canceling （取消拖动），Android平台不支持
     longitude:,        //小数类型；经度  dragState 为ending时返回
     latitude:,           //小数类型；纬度 dragState 为ending时返回
}

示例代码

var aMap = api.require('aMap');
aMap.addAnnotations({
    annotations: [{
        id: 1,
        lon: 116.297,
        lat: 40.109
    }, {
        id: 2,
        lon: 116.29,
        lat: 40.109
    }, {
        id: 3,
        lon: 116.298,
        lat: 40.11
    }],
    icons: ['widget://'],
    draggable: true,
    timeInterval: 2.0
}, function(ret) {
    if (ret.eventType == 'click') {
        alert(ret.id);
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

cancelAnnotationSelected

取消标注选中状态

cancelAnnotationSelected({params})

params

id：

• 类型：数字
• 描述：指定的标注 id（仅iOS支持，android仅一个为选中状态 调用此接口取消当前选中标注选中状态）

示例代码

var aMap = api.require('aMap');
aMap.cancelAnnotationSelected({
    id: 1
});

可用性

iOS系统，Android系统

可提供的1.2.7及更高版本

getAnnotationCoords

获取指定标注的经纬度

getAnnotationCoords({params}, callback(ret))

params

id：

• 类型：数字
• 描述：指定的标注 id

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    lon: 116.213,      //数字类型；标注的经度
    lat: 39.213        //数字类型；标注的纬度
}

示例代码

var aMap = api.require('aMap');
aMap.getAnnotationCoords({
    id: 2
}, function(ret) {
    if (ret) {
        api.alert({ msg: JSON.stringify(ret) });
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setAnnotationCoords

设置某个已添加标注的经纬度

setAnnotationCoords(callback(ret, err))

params

id：

• 类型：数字
• 描述：指定的标注 id

lon：

• 类型：数字
• 描述：设置的经度

lat：

• 类型：数字
• 描述：设置的纬度

示例代码

var aMap = api.require('aMap');
aMap.setAnnotationCoords({
    id: 2,
    lon: 116.39,
    lat: 40.209
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

annotationExist

判断标注是否存在

annotationExist({params}, callback(ret, err))

params

id：

• 类型：数字
• 描述：指定的标注 id

callback(ret, err)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status: true      //布尔类型；标注是否存在，true || false
}

示例代码

var aMap = api.require('aMap');
aMap.annotationExist({
    id: 2
}, function(ret) {
    if (ret.status) {
        api.alert({ msg: '存在' });
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setBubble

设置点击标注时弹出的气泡信息

setBubble({params}, callback(ret, err))

params

id：

• 类型：数字
• 描述：要设置气泡的标注 id

bgImg：

• 类型：字符串
• 描述：（可选项）弹出气泡的背景图片，要求本地路径（fs://、widget://），中轴线下边缘点为气泡弹出点
• 默认值：默认气泡背景图片

content：

• 类型：JSON 对象
• 描述：弹出气泡的内容
• 内部字段：

{
    title: '',             //字符串类型；弹出气泡的标题
    subTitle: '',          //（可选项）字符串类型；弹出气泡的概述内容，若不传则 title 在上下位置居中显示
    illus: ''              //（可选项）字符串类型；弹出气泡的配图（30*40规格），支持http://、https://、widget://、fs://等协议，若不传则不显示插图，标题和子标题忽略插图显示
}

styles：

• 类型：JSON 对象
• 描述：弹出气泡的样式
• 内部字段：

{
    titleColor: '#000',             //（可选项）字符串类型；气泡标题的文字颜色，支持 rgb、rgba、#；默认：'#000'
    titleSize: 16,                  //（可选项）数字类型；气泡标题的文字大小；默认：16
    subTitleColor: '#000',          //（可选项）字符串类型；气泡概述内容的文字颜色，支持 rgb、rgba、#；默认：'#000'
    subTitleSize: 14,               //（可选项）数字类型；气泡概述内容的文字大小；默认：14
    illusAlign: 'left'              //（可选项）字符串类型；气泡配图的显示位置；默认：'left'
                                    //取值范围：
                                    //left（图片居左）
                                    //right（图片居右）
    w: 160,                 //（可选项）数字类型；气泡的宽；默认：bgImg有值时，为160；bgImg为默认值时，为title的长度，并且不会超过地图视图的宽度-64，不会小于160
    h: 90,                 //（可选项）数字类型；气泡的高；默认：90
}

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    id: 10,                     //数字类型；用户点击气泡返回的id
    eventType: 'clickContent',  //字符串类型；交互事件类型
                                //取值范围：
                                //clickContent（点击气泡文本内容）
                                //clickIllus（点击配图）
}

示例代码

var aMap = api.require('aMap');
aMap.setBubble({
    id: 2,
    bgImg: 'widget://res/bubble_bg.png',
    content: {
        title: '大标题',
        subTitle: '概述内容',
        illus: 'http://ico.ooopic.com/ajax/iconpng/?id=145044.png'
    },
    styles: {
        titleColor: '#000',
        titleSize: 16,
        subTitleColor: '#999',
        subTitleSize: 12,
        illusAlign: 'left'
    }
}, function(ret) {
        alert(JSON.stringify(ret));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setWebBubble

设置点击标注时弹出的气泡信息

setWebBubble({params})

params

id：

• 类型：数字
• 描述：要设置气泡的标注 id

url：

• 类型：字符串
• 描述：（可选项）弹出气泡的网页地址，用户点击标注时，模块在标注上弹出窗口（类似open一个frame，模块会用webview去加载此url的网页显示出来）,当data参数不为空时，url将做为baseUrl，data中的html引用的资源文件根路径以该url为基础。

data：

• 类型：字符串
• 描述：（可选项）页面加载的数据内容，可以为html片段或者整张html文件的数据,当data为空或者不传的时候， 会将url地址作为整个加载进去

size：

• 类型：JSON对象
• 描述：（可选项）气泡的大小配置
• 内部字段

{
      width: 50,     //（可选项）数字类型；气泡的宽；默认：50
      height: 50     //（可选项）数字类型；气泡的高；默认：50
}

bg：

• 类型：字符串
• 描述：（可选项）弹出气泡的背景设置，支持rgb、rgba、#、img（要求本地路径，如：widget://、fs://）
• 默认：rgba(0,0,0,0)

示例代码

    var map = api.require('aMap');
    map.setWebBubble({
        id:1,
        size : {
            width:100,        
            height:100        
        },            
        bg:'rgba(0,0,0,0.6)',
        url:'http://img6.ph.126.net',
        data:'漂亮MM <img src="hBiG96B8egigBULxUWcOpA==/109212290980771276.jpg">'
    });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

addWebBubbleListener

添加网页气泡点击监听

addWebBubbleListener(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    id: 1               //数字类型；用户点击气泡返回的id
}

示例代码

    var map = api.require('aMap');
    map.addWebBubbleListener(function(ret){
        api.alert({msg:JSON.stringify(ret)});
    });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

removeWebBubbleListener

移除网页气泡点击监听

removeWebBubbleListener(callback(ret))

示例代码

    var map = api.require('aMap');
    map.removeWebBubbleListener();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

popupBubble

弹出指定标注的气泡

popupBubble({params})

params

id：

• 类型：数字
• 描述：气泡的 id

示例代码

var aMap = api.require('aMap');
aMap.popupBubble({
    id: 2
}, function(ret){
            alert(JSON.stringify(ret));
        });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

closeBubble

关闭已弹出的气泡

closeBubble({params})

params

id：

• 类型：数字
• 描述：气泡的 id

示例代码

var aMap = api.require('aMap');
aMap.closeBubble({
    id: 2
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

addBillboard

在地图上添加布告牌，布告牌图标中轴线的下边缘点为坐标基准点

addBillboard({params})

params

id：

• 类型：数字
• 描述：布告牌的 id，注意：本 id 不可与 addAnnotations 接口内的 id 相同

coords：

• 类型：JSON 对象
• 描述：布告牌所在位置的坐标
• 内部字段：

{
    lon: 116.233,            //数字类型；布告牌所在位置的经度
    lat: 39.134              //数字类型；布告牌所在位置的纬度
}

bgImg：

• 类型：字符串
• 描述：布告牌的背景图片，要求本地路径（fs://、widget://）

content：

• 类型：JSON 对象
• 描述：布告牌的内容
• 内部字段：

{
    title: '',             //（可选项）字符串类型；布告牌的标题
    subTitle: '',          //（可选项）字符串类型；布告牌的概述内容 
    illus: ''              //（可选项）字符串类型；布告牌的配图，支持http://、https://、widget://、fs://等协议
}

draggable：

• 类型：布尔
• 描述：（可选项）所添加的布告牌是否可被拖动
• 默认值：false

styles：

• 类型：JSON 对象
• 描述：布告牌的样式
• 内部字段：

{
    size: {                         //（可选项）JSON对象；布告牌大小配置，若不传则取默认值
        width: 160,                 //（可选项）数组类型；布告牌的宽；默认：160
        height: 75                  //（可选项）数组类型；布告牌的高；默认：75
    },
    illusRect: {                    //（可选项）JSON对象；插图大小配置，与 illusAlign 同时存在时以本参数为准
        x: ,                        //（可选项）数字类型；插图左上角x坐标，相对布告牌坐标系；默认：10
        y: ,                        //（可选项）数字类型；插图左上角y坐标，相对布告牌坐标系；默认：5
        w: ,                        //（可选项）数字类型；插图的宽；默认：35
        h:                          //（可选项）数字类型；插图的高；默认：50
    },
    marginT: 10,                    //（可选项）数字类型；标题距布告牌顶端的距离，默认：10  
    titleMarginLeft:10,        //(可选项) 数字类型；标题的左边距；默认：10
     titleMarginRight:10,        //(可选项) 数字类型；标题的右边距；默认：10
    marginB: 15,                    //（可选项）数字类型；子标题距布告牌低端的距离，默认：15
    subTitleMarginLeft:10,        //(可选项) 数字类型；子标题的左边距；默认：10
    subTitleMarginRight:10,        //(可选项) 数字类型；子标题的右边距；默认：10
    alignment: 'left',              //（可选项）字符串类型；标题和子标题的对齐方式：left（水平居左）、center（水平居中）、right（水平居右）；默认：left
    titleColor: '#000',             //（可选项）字符串类型；布告牌标题的文字颜色，支持 rgb、rgba、#；默认：'#000'
    titleSize: 14,                  //（可选项）数字类型；布告牌标题的文字大小；默认：16
    subTitleColor: '#000',          //（可选项）字符串类型；布告牌概述内容的文字颜色，支持 rgb、rgba、#；默认：'#000'
    subTitleSize: 12,               //（可选项）数字类型；布告牌概述内容的文字大小；默认：16
    titleMaxLines:1,             // （可选项） 数字类型；标题最大行数，超过一行自动换行，换行规则与原生一致；默认：1
    subTitleMaxLines:1,      // （可选项）数字类型 ；子标题最大行数，超过一行自动换行，换行规则与原生一致；默认：1
    illusAlign: 'left',              //（可选项）字符串类型；布告牌配图的显示位置，与 illusRect 同时存在时忽略本参数；默认：'left'
                                    //取值范围：
                                    //left（图片居左）
                                    //right（图片居右）
}

selectedStyles：

• 类型：JSON 对象
• 描述：布告牌选中后的样式
• 内部字段：

{
    bgImg:'',                       //（可选项）字符串类型；选中后的布告牌背景图片，要求本地路径（fs://、widget：//）；默认：同未选中时值相同
    titleColor: '#000',             //（可选项）字符串类型；选中后的布告牌标题的文字颜色，支持 rgb、rgba、#；默认：同未选中时值相同
    subTitleColor: '#000',          //（可选项）字符串类型；选中后的布告牌概述内容的文字颜色，支持 rgb、rgba、#；默认：同未选中时值相同
    illus: ''                       //（可选项）字符串类型；选中后的布告牌的配图；默认：同未选中时值相同
}

useIllusPoint：

• 类型：布尔类型
• 描述：（可选项）是否以插图中轴线底部为基准点，此参数设置为true背景设置无效。此参数为true需要styles.size.height 等于styles.illusRect.h + styles.illusRect.y
• 默认值：false

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    id: 4,                     //数字类型；用户点击布告牌返回的id
    eventType: 'click',        //字符串类型；交互事件类型
                                //取值范围：
                                //click（用户点击布告牌事件）
                                //drag（用户拖动布告牌事件）
    dragState: 'starting'       //字符串类型；布告牌被拖动的状态，当 eventType 为 drag 时本字段有值，
                                //取值范围：
                                //starting（开始拖动）
                                //dragging （拖动中）
                                //ending （拖动结束）
}

示例代码

var aMap = api.require('aMap');
aMap.addBillboard({
    id: 4,
    draggable: true,
    coords: {
        lon: 116.233,
        lat: 39.134
    },
    bgImg: 'widget://image/aMapTest.png',
    content: {
        title: '大标题大标题大标题大标题',
        subTitle: '概述内容概述内容概述内容',
        illus: 'http://ico.ooopic.com/ajax/iconpng/?id=145044.png'
    },
    styles: {
        titleColor: '#000',
        titleSize: 16,
        subTitleColor: '#999',
        subTitleSize: 12,
        illusAlign: 'left'
    }
}, function(ret) {
    if (ret) {
        alert(JSON.stringify(ret));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

addWebBoard

在地图上添加网页布告牌，布告牌图标中轴线的下边缘点为坐标基准点

addWebBoard({params})

params

id：

• 类型：数字
• 描述：布告牌的 id，注意：本 id 不可与 addAnnotations 接口内的 id 相同

coords：

• 类型：JSON 对象
• 描述：布告牌所在位置的坐标
• 内部字段：

{
lon: 116.233,            //数字类型；布告牌所在位置的经度
lat: 39.134              //数字类型；布告牌所在位置的纬度
}

bg：

• 类型：字符串
• 描述：布告牌的背景图片，要求本地路径（fs://、widget://）（仅ios支持）

url：

• 类型：字符串
• 描述：（可选项）网页布告牌的网页地址,当data参数不为空时，url将做为baseUrl，data中的html引用的资源文件根路径以该url为基础。

data：

• 类型：字符串
• 描述：（可选项）页面加载的数据内容，可以为html片段或者整张html文件的数据,当data为空或者不传的时候， 会将url地址作为整个加载进去

size：

• 类型：JSON对象
• 描述：（可选项）气泡的大小配置
• 内部字段

{
      w: 50,     //（可选项）数字类型；气泡的宽；默认：50
      h: 50      //（可选项）数字类型；气泡的高；默认：50
}

示例代码

var map = api.require('aMap');
map.addWebBoard({
    id: 4,
    draggable: true,
    coords: {
        lon:116.29432327,
        lat:39.98963192
    },
    bg: 'widget://res/billboard.png',
    url:'./aMap-con.html',
    data:'',
    size:{
        w:100,
        h:100
    }
});

可用性

iOS系统

可提供的1.3.1及更高版本

addWebBoardListener

添加网页布告牌点击监听

addWebBoardListener(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    id: 1               //数字类型；用户点击布告牌返回的id
}

示例代码

var map = api.require('aMap');
map.addWebBoardListener(function(ret){
    api.alert({msg:'网页布告牌'+JSON.stringify(ret)});
});

可用性

iOS系统

可提供的1.3.1及更高版本

removeWebBoardListener

移除网页布告牌点击监听

removeWebBoardListener(callback(ret))

示例代码

    var map = api.require('aMap');
    map.removeWebBoardListener();

可用性

iOS系统

可提供的1.3.1及更高版本

addMobileAnnotations

在地图上添加可移动、旋转的标注图标，图标的中心点为坐标基准点

addMobileAnnotations({params}, callback(ret, err))

params

annotations：

• 类型：数组
• 描述：图标标注信息组成的数组
• 内部字段：

[{
    id: 10,                    //数字类型；图标标注的唯一标识，注意：本 id 不可与 addAnnotations、addBillboard 接口内的 id 相同
    lon: 116.233,              //数字类型；图标标注所在位置的经度
    lat: 39.134,               //数字类型；图标标注所在位置的纬度
    icon: 'widget://',          //字符串类型；指定的标注图标，要求本地路径（fs://、widget://），图标的锚点即是坐标点。
    draggable: true            //布尔类型；所添加的可移动的标注是否可被拖动；默认：false
}]

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    id: 4,                     //数字类型；交互标注对象的 id
    dragState: 'starting'       //字符串类型；标注被拖动的状态
                                //取值范围：
                                //starting（开始拖动）
                                //dragging （拖动中）
                                //ending （拖动结束）
}

示例代码

var aMap = api.require('aMap');
aMap.addMobileAnnotations({
    annotations: [{
        id: 10,
        lon: 116.297,
        lat: 40.109,
        icon: 'widget://image/aMap_car1.png',
        draggable: true
    }, {
        id: 11,
        lon: 116.98,
        lat: 40.109,
        icon: 'widget://image/aMap_car2.png',
        draggable: true
    }, {
        id: 12,
        lon: 115.30,
        lat: 40.109,
        icon: 'widget://image/aMap_car3.png',
        draggable: true
    }, {
        id: 13,
        lon: 116.297,
        lat: 39.109,
        icon: 'widget://image/aMap_car1.png',
        draggable: true
    }, {
        id: 14,
        lon: 116.98,
        lat: 39.109,
        icon: 'widget://image/aMap_car2.png',
        draggable: true
    }, {
        id: 15,
        lon: 115.30,
        lat: 39.109,
        icon: 'widget://image/aMap_car3.png',
        draggable: true
    }]
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

moveAnnotation

移动地图上已添加的可移动、旋转的标注图标，在移动动画开始前，会先做 0.3 秒的旋转动画，使所移动的图标中间轴线顶端对准终点坐标点。在 Android 平台上，如果标注添加到地图当前可视区域以外的区域，则不可以移动该标注

moveAnnotation({params}, callback(ret, err))

params

id：

• 类型：数字
• 描述：要移动的标注的 id

duration：

• 类型：数字
• 描述：（可选项）标注图标移动动画的时间，单位为秒（s），不包括旋转动画时间
• 默认值：1.0（s）

end：

• 类型：JSON 对象
• 描述：终点经纬度
• 内部字段：

{
    lon: 116.581515,    //数字类型；终点的经度
    lat: 29.615467      //数字类型；终点的纬度
}

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    id:         //数字类型；移动动画结束的标注的 id
}

示例代码

var aMap = api.require('aMap');
for (var i = 0; i < 6; i++) {
    aMap.moveAnnotation({
        id: 10 + i,
        duration: 6,
        end: {
            lon: 116.3843839609304,
            lat: 39.98964439091298
        }
    }, function(ret, err) {
        alert(ret.id + '移动结束')
    });
}

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

removeAnnotations

移除指定 id 的标注（可移动、不可移动）或布告牌

removeAnnotations({params})

params

ids：

• 类型：数组
• 描述：（可选项）要移除的标注或布告牌id（数字），若为空或不传，则移除所有标注

示例代码

var aMap = api.require('aMap');
aMap.removeAnnotations({
    ids: [1,3,5,7]
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

addMoveAnimation

给地图上的标注添加移动动画

注意：

第一个添加的动画以当前位置为起始点，沿传入的coordinates点移动，否则以上一个动画终点为起始点

params

id：

• 类型：数字
• 描述：要移动的标注的 id

duration：

• 类型：数字
• 描述：（可选项）移动动画的时间，单位为秒（s）
• 默认值：3.0（s）

coordinates：

• 类型：数组
• 描述：动画移动经过点坐标集合
• 内部字段：

{
    lon: 116.581515,    //数字类型；经度
    lat: 29.615467      //数字类型；纬度
}

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    isFinished: true        //布尔类型；是否结束
}

示例代码

var aMap = api.require('aMap');
aMap.addMoveAnimation({
    id: 10,
    duration: 6,
    coordinates: [{
        lon: 116.3843839609304,
        lat: 39.98964439091298
    }]
}, function(ret) {
    alert(ret.id + '移动结束')
});

可用性

iOS系统，Android系统

可提供的1.1.8及更高版本

cancelMoveAnimation