uexGaodeMap查看3.0文档

• １、简介
• ２、API概览
• 2.1、地图基础方法
• 2.2、标注和覆盖物
• 2.3、兴趣点搜索
• 2.4、地理编码
• 2.5、定位
• 2.6、自定义按钮
• ３、扩展功能
• 3.1、离线地图
• 3.2、线路规划
• 4、附录
• 5、更新历史

接入指引部分：

• 6、高德地图开放平台创建应用
• 7、打包集成高德地图插件使用
• 8、附录
• 9、常见问题

1、简介

高德地图插件

1.1、说明

封装高德地图相关功能,包括放大缩小、移动和旋转等基本操作;标注;圆形、矩形和多边形覆盖物;定位、搜索、地理编码、离线地图等功能.

注意: 　　申请的插件appkey需要通过config.xml文件配置自定义参数的方法,可直接在官网公共插件里直接勾选使用,详见附录.IDE插件因为涉及到高德地图方面的ID与Key暂时无法正常使用.具体操作见『手册』

1.2、开源源码

自定义插件下载:点击此处(插件测试用例与插件包已经提供)

1.3、 UI展示

1.4.1 Download Status

1.4.2 cbDownload Status

1.5、平台版本支持

本插件的所有API默认支持Android4.3+和iOS10.0+操作系统.

有特殊版本要求的API会在文档中额外说明.

1.6、接口有效性

本插件所有API默认在插件版本4.0.0+可用.

在后续版本中新添加的接口会在文档中额外说明.

2、API概述

2.1、//地图基础方法

open //打开地图

uexGaodeMap.open(json)

说明:

打开地图.

参数:

var json = {
    left:,
    top:,
    width:,
    height:,
    isScrollWithWeb:,
    longitude:,
    latitude:,
    APIKey:
}

各字段含义:

示例:

    var json = {
        left:0,
        top:0,
        width:800,
        height:800,
        isScrollWithWeb:true,
        longitude:114.402815,
        latitude:30.475798
    };
    uexGaodeMap.open(JSON.stringify(json));

close //关闭地图

uexGaodeMap.close()

参数:

无

示例:

    uexGaodeMap.close();

setMapType //设置地图类型

uexGaodeMap.setMapType(json)

说明

设置地图类型

参数:

var json = {
    type:
}

各字段含义:

示例:

var json = {
    type:1
};
uexGaodeMap.setMapType(JSON.stringify(json));

setTrafficEnabled //开启或关闭实时路况

uexGaodeMap.setTrafficEnabled(json)

参数:

var json = {
    type:
}

各字段含义:

示例:

    var json = {
        type:1
    };
    uexGaodeMap.setTrafficEnabled(JSON.stringify(json));

setCenter //设置地图中心点

uexGaodeMap.setCenter(json)

参数:

var json = {
    longitude:,
    latitude:
}

各字段含义:

示例:

    var json = {
        longitude:114.402815,
        latitude:30.475798
    };
    uexGaodeMap.setCenter(JSON.stringify(json));

setZoomLevel //设置地图缩放级别

uexGaodeMap.setZoomLevel(json)

参数:

var json = {
    level:
}

各字段含义:

示例:

    var json = {
        level:15
    };
    uexGaodeMap.setZoomLevel(JSON.stringify(json));

zoomIn //放大一个地图级别

uexGaodeMap.zoomIn()

参数:

无

示例:

    uexGaodeMap.zoomIn();

zoomOut //缩小一个地图级别

uexGaodeMap.zoomOut()

参数:

无

示例:

uexGaodeMap.zoomOut();

rotate //旋转地图

uexGaodeMap.rotate(json)

参数:

var json = {
    angle:
}

各字段含义:

示例:

    var json = {
        angle:90
    };
    uexGaodeMap.rotate(JSON.stringify(json));

overlook //倾斜地图

uexGaodeMap.overlook(json)

参数:

var json = {
    angle:
}

各字段含义:

示例:

    var json = {
        angle:23
    };
    uexGaodeMap.overlook(JSON.stringify(json));

setZoomEnable //开启或关闭手势缩放

uexGaodeMap.setZoomEnable(json)

参数:

var json = {
    type://(必选) 0-关闭,1-开启
}

示例:

    var json = {
        type:1
    };
    uexGaodeMap.setZoomEnable(JSON.stringify(json));

setRotateEnable //开启或关闭手势旋转及手势倾斜

uexGaodeMap.setRotateEnable(json)

参数:

var json = {
    type:
}

各字段含义:

示例:

    var json = {
        type:1
    };
    uexGaodeMap.setRotateEnable(JSON.stringify(json));

setCompassEnable //开启或关闭指南针

uexGaodeMap.setCompassEnable(json)

参数:

var json = {
    type:
}

各字段含义:

示例:

    var json = {
        type:1
    };
    uexGaodeMap.setCompassEnable(JSON.stringify(json));

setScrollEnable //开启或关闭手势移动

uexGaodeMap.setScrollEnable(json)

参数:

var json = {
    type:
}

各字段含义:

示例:

    var json = {
        type:1
    };
    uexGaodeMap.setScrollEnable(JSON.stringify(json));

2.2、标注和覆盖物

addMarkersOverlay //添加标注

uexGaodeMap.addMarkersOverlay(json)

参数:

var json = [
    {
        id:,
        longitude:,
        latitude:,
        icon:,
        bubble:{
                title:,
                subTitle:
        }
    }
]

各字段含义:

示例:

    var json = [
        {
            id:10001,
            longitude:114.402965,
            latitude:30.475845,
            icon:"http://www.iconpng.com/png/mapmarkers/marker_inside_azure.png",
            bubble:{
                title:"title1",
                subTitle:"subTitle1"
            }
        },
        {
            id:10002,
            longitude:114.409308,
            latitude:30.476229,
            bubble:{
                title:"title2",
                subTitle:"subTitle2"
            }
        }
    ];
    uexGaodeMap.addMarkersOverlay(JSON.stringify(json));

setMarkerOverlay //修改标注

uexGaodeMap.setMarkerOverlay(json)

参数:

var json = {
    id:,
    longitude:,
    latitude:,
    icon:,
    bubble:{
        title:,
        subTitle:
    }
}

各字段含义:

示例:

    var json = {
        id:10002,
        bubble:{
            title:"change-title",
            subTitle:"change-subTitle"
        }
    };
    uexGaodeMap.setMarkerOverlay(JSON.stringify(json));

addMultiInfoWindow //添加多个文本信息窗

uexGaodeMap.addMultiInfoWindow(data)

参数:

var json = {
    id:,
    longitude:,
    latitude:,
    title:,
    titleSize:,
    titleColor:,
    subTitle:,
    subTitleSize:,
    subTitleColor: 
}

各字段含义:

示例:

var param = [
    {
        id:11002,
        longitude:114.409308,
        latitude:30.476229,
        title:"国创光谷上城",
        titleSize: 32,
        titleColor: "#DC143C",
        subTitle:"90000",
        subTitleColor: "#555555",
        subTitleSize: 28
    },
    {
        id:11004,
        longitude:114.402965,
        latitude:30.475845,
        title:"国创光谷上城",
        titleSize: 32,
        titleColor: "#3e3e3e",
        subTitle:"7888",
        subTitleColor: "#DC143C",
        subTitleSize: 28
    },
    {
        id:11006,
        longitude:114.405065,
        latitude:30.475845,
        title:"清江山水"
    }
    ];
var data = JSON.stringify(param);
uexGaodeMap.addMultiInfoWindow(data);

removeMarkersOverlays //移除标注

uexGaodeMap.removeMarkersOverlays(json)

参数:

var json = [];

示例:

    var json = [151,152];
    uexGaodeMap.removeMarkersOverlays(JSON.stringify(json));

addPolylineOverlay //添加折线覆盖物

uexGaodeMap.addPolylineOverlay(json)

参数:

var json = {
    id:,
    fillColor:,
    lineWidth:,
    property:[
        {
            longitude:,
            latitude:
        }
    ]
}

各字段含义:

示例:

    var json = {
        id:151,
        fillColor:"#f00",
        lineWidth:10.0,
        property:[
            {
                longitude:114.402965,
                latitude:30.475845
            },
            {
                longitude:114.502965,
                latitude:30.475845
            },
            {
                longitude:114.402965,
                latitude:30.375845
            }
        ]
    };
    uexGaodeMap.addPolylineOverlay(JSON.stringify(json));

addArcOverlay //添加弧形覆盖物,仅Android支持

uexGaodeMap.addArcOverlay(json)

参数:

var json = {
    id:,
    strokeColor:,
    lineWidth:,
    start:{
        longitude:,
        latitude:
    },
    center:{
        longitude:,
        latitude:
    },
    end:{
        longitude:,
        latitude:
    }
}

各字段含义:

平台支持:

Android 4.3+

示例:

    var json = {
        id:152,
        strokeColor:"#f00",
        lineWidth:12.0,
        start:{
            longitude:114.402965,
            latitude:30.475845
        },
        center:{
            longitude:114.502965,
            latitude:30.475845
        },
        end:{
            longitude:114.402965,
            latitude:30.375845
        }
    };
    uexGaodeMap.addArcOverlay(JSON.stringify(json));

addCircleOverlay //添加圆形覆盖物

uexGaodeMap.addCircleOverlay(json)

参数:

var json = {
    id:,//(必选) 唯一标识符
    longitude:,//(必选) 圆心经度
    latitude:,//(必选) 圆心纬度
    radius:,//(必选) 半径
    fillColor:,//(可选) 填充颜色
    strokeColor:,//(可选) 边框颜色
    lineWidth://(可选) 边框线宽
}

各字段含义:

示例:

    var json = {
        id:153,
        longitude:114.402965,
        latitude:30.375845,
        radius:1000,
        fillColor:"#4169E1",
        strokeColor:"#990033",
        lineWidth:4
    };
    uexGaodeMap.addCircleOverlay(JSON.stringify(json));

addPolygonOverlay //添加多边形覆盖物

uexGaodeMap.addPolygonOverlay(json)

参数:

var json = {
    id:,//(必选) 唯一标识符
    fillColor:,//(可选) 填充颜色
    strokeColor:,//(可选) 边框颜色
    lineWidth:,//(可选) 边框线宽
    property:[//(必选) 数据
        {
            longitude:,//(必选) 顶点经度
            latitude://(必选) 顶点纬度
        }
    ]
}

各字段含义:

示例:

    var json = {
        id:154,
        fillColor:"#990033",
        strokeColor:"#990033",
        lineWidth:2.0,
        property:[
            {
                longitude:114.402965,
                latitude:30.375845
            },
            {
                longitude:115.402965,
                latitude:30.375845
            },
            {
                longitude:114.402965,
                latitude:31.375845
            },
            {
                longitude:114.402965,
                latitude:30.375845
            }
        ]
    };
    var overlay = uexGaodeMap.addPolygonOverlay(JSON.stringify(json));

addGroundOverlay //添加图片覆盖物

uexGaodeMap.addGroundOverlay(json)

参数:

var json = {
    id:,//(必选) 唯一标识符
    imageUrl:,//(必选) 图片地址
    transparency:,//(可选) 图片透明度(仅Android支持该参数)
    property:[//(必选) 数据,数组长度为2,第一个元素表示西南角的经纬度,第二个表示东北角的经纬度;
        {
            longitude:,//(必选) 顶点经度
            latitude://(必选) 顶点纬度
        }
    ]
}

各字段含义:

示例:

    var json = {
        id:155,
        imageUrl:"http://img0.bdstatic.com/img/image/9baf75d938553886ce515def29441ed31409109131.jpg",
        transparency:0.5,
        property:[
            {
                longitude:114.402165,
                latitude:30.374845
            },
            {
                longitude:114.502165,
                latitude:30.474845
            }
        ]
    };
    uexGaodeMap.addGroundOverlay(JSON.stringify(json));

removeOverlays //移除覆盖物

uexGaodeMap.removeOverlays(json)

参数:

var json = [];

示例:

     var params = [151,152];
    var json = JSON.stringify(params);
    uexGaodeMap.removeOverlays(json);

clear //清除地图上所有的标注和覆盖物

uexGaodeMap.clear()

参数:

无

示例:

    uexGaodeMap.clear();

queryProcessedTrace //轨迹纠偏

uexGaodeMap.queryProcessedTrace(json,callback)

参数:

var json = {
    traceList: [
        {
               longitude: ,
            time: ,
            speed: ,
            bearing: ,
            latitude: 
        }
    ],
      coordinateType:
}

json各字段含义:

轨迹点参数表：

回调参数:

var callback = function(error,data){
      //error， Number类型，为0表示成功，其他表示失败
      //失败时,data为String类型,表示失败的原因
      //成功时,data为Object类型,各字段详情见下
}

data各字段如下：

var data = {
    distance: 318,
    linePoints: [
      {
        latitude: 39.995995,
        longitude: 116.47695
      },
      {
        latitude: 39.99593,
        longitude: 116.47705
      }
    ]
}

示例:

var params = {
    traceList: [
        {
            longitude: 116.47676009385665,
            time: 1470212510269,
            speed: 10.471948623657227,
            bearing: 44.10205841064453,
            latitude: 39.995825200614696
        },
        {
            longitude: 116.4779446327818,
            time: 1470212512259,
            speed: 8.426321029663086,
            bearing: 32.86181640625,
            latitude: 39.99609261805374
        }
    ],
    coordinateType: 1
};
uexGaodeMap.queryProcessedTrace(params, function (error, data) {
    alert(JSON.stringify(data));
});

2.3、//兴趣点搜索

poiSearch //兴趣点搜索

uexGaodeMap.poiSearch(json,callBackFunction)

参数:

传入参数格式为:

var json = {
    searchKey:,//(可选) 搜索关键字
    poiTypeSet:,//(可选) Poi兴趣点,searchKey和poiTypeSet必须至少包含其中的一个
    city:,//(可选) 城市,不传时表示全国范围内(iOS无效,默认全国范围内搜索)
    pageNum:,//(可选) 搜索结果页索引,默认为0
    searchBound://(可选) 区域搜索,city和searchBound必须至少包含其中的一个.以下的三个类别有且只有一种.
    {
        type:"circle",//(必选) 圆形区域搜索
        dataInfo:{
            center:{//(必选) 圆心
                longitude:,//(必选) 经度
                latitude://(必选) 纬度
            },
            radius:,//(必选) 半径
            isDistanceSort://(可选) 是否按距离由小到大排序,默认true
        }
    }
    {
        type:"rectangle",//(必选) 矩形区域搜索
        dataInfo:{
            lowerLeft:{//(必选) 左下角
                longitude:,//(必选) 经度
                latitude://(必选) 纬度
            },
            upperRight:{//(必选) 右上角
                longitude:,//(必选) 经度
                latitude://(必选) 纬度
            }
        }
    }
    {
        type:"polygon",//(必选) 多边形区域搜索
        dataInfo:[//(必选) 顶点集合
            {
                longitude:,//(必选) 顶点经度
                latitude://(必选) 顶点纬度
            }
        ]
    }
}

回调参数:

   var data = [//搜索结果集合
        {
            address:,//地址详情
            cityCode:,//城市编码
            cityName:,//城市名称
            website:,//网址
            email:,//邮箱
            id:,//poiId
            point: {//位置坐标
                latitude:,//经度
                longitude://纬度
            },
            postcode:,//邮编
            provinceCode:,//省/自治区/直辖市/特别行政区编码
            provinceName:,//省/自治区/直辖市/特别行政区名称
            tel:,//电话号码
            title:,//名称
            typeDes:,//类型描述
            distance://距离中心点的距离
        },
        ...
    ]

示例:

    示例1:
    var json = {
        city:"武汉",
        searchKey:"加油站"
    };
    uexGaodeMap.poiSearch(JSON.stringify(json),function(error,data){
      if(!error){
           alert("callback:" + JSON.stringify(data));
        }else{
          alert("搜索失败");
          }
    });

    示例2:
    var json = {
        city:"武汉",
        poiTypeSet:"加油站",
        searchBound:{
            type:"circle",
            dataInfo:{
                center:{
                    longitude:114.402815,
                    latitude:30.475798
                },
                radius:3000,
                isDistanceSort:true
            }
        }
    };
    uexGaodeMap.poiSearch(JSON.stringify(json),function(error,data){
        if(!error){
           alert("callback:" + JSON.stringify(data));
        }else{
          alert("搜索失败");
          }

    });

    示例3:
    var json = {
        poiTypeSet:"加油站",
        searchBound:{
            type:"rectangle",
            dataInfo:{
                lowerLeft:{
                    longitude:114.402815,
                    latitude:30.475798
                },
                upperRight:{
                    longitude:114.513855,
                    latitude:30.586848
                }
            }
        }
    };
    uexGaodeMap.poiSearch(JSON.stringify(json),function(data){
      if(!error){
           alert("callback:" + JSON.stringify(data));
        }else{
          alert("搜索失败");
          }
    });

    示例4:
    var json = {
        poiTypeSet:"加油站",
        searchBound:{
            type:"polygon",
            dataInfo:[
                {
                    longitude:"114.402965",
                    latitude:"30.375845"
                },
                {
                    longitude:"115.402965",
                    latitude:"30.375845"
                },
                {
                    longitude:"114.402965",
                    latitude:"31.375845"
                },
                {
                    longitude:"114.402965",
                    latitude:"30.375845"
                }
            ]
        }
    };
    uexGaodeMap.poiSearch(JSON.stringify(json),function(error,data){
      if(!error){
           alert("callback:" + JSON.stringify(data));
        }else{
          alert("搜索失败");
          }
    });

2.4、地理编码

geocode //地理编码,通过地址获得经纬度信息

uexGaodeMap.geocode(json,callBackFunction)

参数:

var json = {
    city:,
    address:
}

各字段含义如下:

回调参数:

var data = {
    longitude:,//当前位置经度
    latitude:,//当前位置纬度
    address:,//String  搜索的地址
    city://String 搜索所在的城市
}

示例:

    var json = {
        city:"武汉",
        address:"光谷软件园C6栋"
    };
    uexGaodeMap.geocode(JSON.stringify(json),function(error,data){
                if(!error){
                     alert("callback:" + JSON.stringify(data));
                 }else{
                     alert("地理编码失败");
                  }

    });

reverseGeocode //反地理编码,将经纬度转换为地址信息

uexGaodeMap.reverseGeocode(json,callBackFunction)

参数:

var json = {
    longitude:,
    latitude:
}

各字段含义如下:

回调参数:

var data = {
    address:,//具体地址
    latitude:,//Number 搜索的纬度
    longitude://Number 搜索的经度
}

示例:

    var json = {
        longitude:114.402815,
        latitude:30.475798
    };
    uexGaodeMap.reverseGeocode(JSON.stringify(json),function(error,data){
         if(!error){
                    alert("callback:" + JSON.stringify(data));
                }else{
                     alert("反地理编码失败");
                }
    });

2.5、定位

getCurrentLocation //获取当前位置

uexGaodeMap.getCurrentLocation(callBackFunction)

参数:

回调参数:

var data = {
    longitude:,//当前位置经度
    latitude:,//当前位置纬度
    timestamp://时间戳
}

示例:

    uexGaodeMap.getCurrentLocation(function(error,data){
        if(!error){
                    alert("callback:" + JSON.stringify(data));
                }else{
                     alert("获取当前位置失败");
                }

    });

startLocation //开始连续定位

uexGaodeMap.startLocation(json)

参数:

var json = {
    minTime:,
    minDistance:
}

各字段含义如下:

示例:

    var json = {
        minTime:3000,
        minDistance:10
    };
    uexGaodeMap.startLocation(json);

stopLocation //停止连续定位

uexGaodeMap.stopLocation()

参数:

无

示例:

    uexGaodeMap.stopLocation();

setMyLocationEnable //显示或隐藏我的位置

uexGaodeMap.setMyLocationEnable(json)

参数:

var json = {
    type:
}

各字段含义如下:

示例:

    var json = {
        type:1
    }
    uexGaodeMap.setMyLocationEnable(JSON.stringify(json));

setUserTrackingMode //设置连续定位模式

uexGaodeMap.setUserTrackingMode(json)

参数:

var json = {
    type:
}

各字段含义如下:

示例:

    var json = {
        type:1
    }
    uexGaodeMap.setUserTrackingMode(JSON.stringify(json));

setScaleVisible //设置地图是否显示比例尺

uexGaodeMap.setScaleVisible(json)

参数:

var json = {
    visible: 
}

各字段含义如下:

示例:

  var json = {
        visible:true
    }
    uexGaodeMap.setScaleVisible(JSON.stringify(json));

setMyLocationButtonVisible //设置是否显示回到我的位置按钮,仅支持Android

设置是否显示回到我的位置按钮,注意回到我的位置按钮点击生效的前提条件是开启定位.

uexGaodeMap.setMyLocationButtonVisible(json)

参数:

var json = {
    visible:
}

各字段含义如下:

平台支持:

Android 4.3+

示例:

    var json = {
        visible:true
    }
    uexGaodeMap.setMyLocationButtonVisible(JSON.stringify(json));

setZoomVisible //设置是否显示放大缩小按钮,仅支持Android

uexGaodeMap.setZoomVisible(json)

参数:

var json = {
    visible:
}

各字段含义如下:

平台支持:

Android 4.3+

示例:

   var json = {
        visible:true
    }
    uexGaodeMap.setZoomVisible(JSON.stringify(json));

2.6、自定义按钮

setCustomButton //设置自定义按钮

uexGaodeMap.setCustomButton(json)

参数:

var json = {
   id:,
    x:,
    y:,
    width:, 
    height:, 
    bgImage:,  
    title:, 
    titleColor:, 
    titleSize: 
}

各字段含义如下:

说明:

• 设置自定义按钮是全局的,设置之后在各个页面均可以直接调用showCustomButtons
• 每次地图重新open时,不会显示任何按钮,需要用户手动调用showCustomButtons
• x,y,width,height都是参考以地图左上角为原点的坐标系 单位为px

返回值:

返回自定义按钮对象,如果设置失败返回null

示例:

var json = {
   id:11,
    bgImage:"res://button1.png",
    title:"title",
    titleColor:"#F00",
    x:50,
    y:50,
    width:35,
    height:16
}
uexGaodeMap.setCustomButton(JSON.stringify(json));

showCustomButtons //显示自定义按钮

var data = uexGaodeMap.showCustomButtons(json)

参数:

返回值

Object类型，显示结果数据，形式见下:

var data = {
    successfulIds:,//list<string> 显示成功的按钮的唯一标识符数组
    failedIds://list<string> 显示失败的按钮的唯一标识符数组
}

说明:

• 点击被显示的按钮会触发监听onCustomButtonClick
• 显示id不存在的按钮会失败
• 显示已经显示的按钮会失败

示例:

var json =[11,12];
var data = uexGaodeMap.showCustomButtons(JSON.stringify(json));
alert("callback:" + JSON.stringify(data));

hideCustomButtons //隐藏自定义按钮

var data = uexGaodeMap.hideCustomButtons(json)

参数:

返回值:

Object类型，隐藏结果数据，形式见下:

var data = {
    successfulIds:,//list<string> 隐藏成功的按钮的唯一标识符数组
    failedIds:,//list<string> 隐藏失败的按钮的唯一标识符数组
}

说明:

• json不传时,会尝试隐藏所有自定义按钮
• 隐藏不存在的按钮会失败
• 隐藏已经隐藏的按钮会失败

示例:

var json =[11,12];
var data = uexGaodeMap.hideCustomButtons(JSON.stringify(json));
alert("callback:" + JSON.stringify(data));

deleteCustomButton //删除自定义按钮

var result = uexGaodeMap.deleteCustomButton(id)

参数:

说明:

• 删除自定义按钮是全局的
• 如果被删除的按钮已经被显示,会先隐藏按钮再删除

返回值: Boolean类型，删除结果，true为删除成功,false为删除失败

示例:

var result = uexGaodeMap.deleteCustomButton(id);

2.7、 //监听方法

onMapLoadedListener //地图加载完成的监听方法

uexGaodeMap.onMapLoadedListener();

参数:

无

示例:

    uexGaodeMap.onMapLoadedListener = function() {
        alert("onMapLoadedListener");
    }

onMarkerClickListener //点击标注的监听方法

uexGaodeMap.onMarkerClickListener(json);

参数:

var json = {
    id://被点击的标注对象
}

示例:

    uexGaodeMap.onMarkerClickListener = function(json) {
        alert("onMarkerClickListener: "+json);
    }

onMarkerBubbleClickListener //点击气泡的监听方法,仅支持Android

uexGaodeMap.onMarkerBubbleClickListener(json);

参数:

var json = {
    id://被点击的气泡所属标注对象
}

平台支持: Android 4.3+

示例:

    uexGaodeMap.onMarkerBubbleClickListener = function(json) {
        alert("onMarkerBubbleClickListener: "+json);
    }

onReceiveLocation //位置变化的监听方法

uexGaodeMap.onReceiveLocation(json);

参数:

var json = {
    longitude:,//当前位置经度
    latitude:,//当前位置纬度
    timestamp://时间戳
}

示例:

    uexGaodeMap.onReceiveLocation = function(json) {
        alert("onReceiveLocation: "+json);
    }

onMapClickListener //点击地图的监听方法

uexGaodeMap.onMapClickListener(json);

参数:

var json = {
    longitude:,//被点击的位置经度
    latitude://被点击的位置纬度
}

示例:

    uexGaodeMap.onMapClickListener = function(json) {
        alert("onMapClickListener: "+json);
    }

onMapLongClickListener //长按地图的监听方法

uexGaodeMap.onMapLongClickListener(json);

参数:

var json = {
    longitude:,//长按的位置经度
    latitude://长按的位置纬度
}

示例:

    uexGaodeMap.onMapLongClickListener = function(json) {
        alert("onMapLongClickListener: "+json);
    }

onCustomButtonClick //自定义按钮被点击的监听方法

uexGaodeMap.onCustomButtonClick(button);

参数:

说明:

• 总是回调给调用showCustomButtons显示此按钮的页面(例如,用户在A页面调用显示按钮α,在B页面调用显示按钮β,那么α的回调给A,β的回调给B)
• 如果该页面已经被销毁,则回调不触发

示例:

uexGaodeMap.onCustomButtonClick = function(id) {
     alert("onCustomButtonClick:"+id);
}

3、扩展功能

3.1 离线地图

download //开始下载

uexGaodeMap.download(json,callBackFunction)

说明:

开始下载,当前如果有正在下载的任务,添加到正在下载列表中.

参数:

var json = [
    {
        city:,//(可选) 城市名称
        province://(可选) 省或直辖市名称
    }
]

各字段含义如下:

回调参数:

var data = {
    name:,//(必选) 省或城市名称
    errorStr://(可选) 错误描述,error非0时,该值有效.
}

注:errorStr详情参见附录cbDownload Status

示例:

    var params = [
        {
            city:'武汉'
        },
        {
            province:'广东省'
        }
    ];
    var json = JSON.stringify(params);
    uexGaodeMap.download(json,function(error,data){
      if(!error){
         alert("callback:" + JSON.stringify(data));
      }else{
         alert("加入列表失败");
      }

    });

onDownload //下载监听方法

uexGaodeMap.onDownload(json)

参数:

var json = {
    name:,//(必选) 省或城市名称
    completeCode:,//(必选) 进度百分比.
    status://(可选) 下载状态,具体请参考附录onDownload Status.
}

注:status下载状态参见附录Download Status

​

示例:

    uexGaodeMap.onDownload = function(json) {
        var data = JSON.parse(info);
        if(data.status == 0){
            uexWindow.toast(1,5,data.name + " 正在下载...",0);
        }
        if(data.status == 1){
            uexWindow.toast(1,5,data.name + " 正在解压...",0);
        }
        if(data.status == 4){
            uexWindow.closeToast();
            alert(data.name + " 离线地图下载成功!");
        }
        if(data.status == 3){
            uexWindow.toast(0,5,data.name + " 暂停下载...",2000);
        }
        if(data.status == -1){
            uexWindow.closeToast();
            alert(data.name + " 下载失败!");
        }
    }

pause //暂停下载

uexGaodeMap.pause(json)

参数:

var json = []//(必传) 省或城市名称数组

示例:

    var params = ["武汉","广东省"];
    var data = JSON.stringify(params);
    uexGaodeMap.pause(data);

restart //继续下载

uexGaodeMap.restart(json)

参数:

var json = []//(必传) 省或城市名称数组

示例:

    var params = ["武汉","广东省"];
    var data = JSON.stringify(params);
    uexGaodeMap.restart(data);

getAvailableCityList //获取可下载离线地图的城市列表

uexGaodeMap.getAvailableCityList(callBackFunction)

参数:

回调参数:

var data = [
    {
        city:,//(必选) 城市名称
        size:,//(必选) 包大小,单位字节
        completeCode:,//(必选) 进度百分比
    }
]

示例:

    uexGaodeMap.getAvailableCityList(function(error,data){
      if(!error){
         alert("callback:" + JSON.stringify(data));
      }else{
         alert("获取可下载离线地图的城市列表失败");
        }
    });

getAvailableProvinceList //获取可下载离线地图的省和城市列表

uexGaodeMap.getAvailableProvinceList(callBackFunction)

参数:

回调参数:

var data = [
    {
        cityList:[//(必选) 省包含的城市列表
            {
                city:,//(必选) 城市名称
                size:,//(必选) 包大小,单位字节
                completeCode:,//(必选) 进度百分比
                status://(可选) 下载状态
            }
        ],
        province:,//(必选) 省或直辖市名称
        size:,//(必选) 包大小,单位字节
        completeCode:,//(必选) 进度百分比

    }
]

示例:

    uexGaodeMap.getAvailableProvinceList(function(error,data){
        if(!error){
         alert("callback:" + JSON.stringify(data));
      }else{
         alert(" 获取可下载离线地图的省和城市列表失败");
        }
    });

getDownloadList //获取已下载列表

uexGaodeMap.getDownloadList(callBackFunction)

参数:

回调参数:

var data = [
    {
        name:,//(必选) 省或城市名称
        type:,//(必选) 类型,1-城市,2-省
        size:,//(必选) 包大小,单位字节
        completeCode:,//(必选) 进度百分比

    }
]

示例:

    uexGaodeMap.getDownloadList(function(error,data){
       if(!error){
         alert("callback:" + JSON.stringify(data));
      }else{
         alert(" 获取可下载离线地图的省和城市列表失败");
        }
    });

getDownloadingList //获取正在下载列表

uexGaodeMap.getDownloadingList(callBackFunction)

参数:

回调参数:

var data = [
    {
        name:,//(必选) 省或城市名称
        type:,//(必选) 类型,1-城市,2-省
        size:,//(必选) 包大小,单位字节
        completeCode:,//(必选) 进度百分比
    }
]

示例:

    uexGaodeMap.getDownloadingList(function(error,data){
       if(!error){
         alert("callback:" + JSON.stringify(data));
      }else{
         alert(" 获取可下载离线地图的省和城市列表失败");
        }
    });

isUpdate //检查已下载的离线地图数据是否需要更新

uexGaodeMap.isUpdate(json,callBackFunction)

参数:

var json = {
    city:,//(可选) 城市名称
    province://(可选) 省或直辖市名称
}

回调参数:

var data = {
    name:,//(必选) 省或城市名称
    result://(可选) 是否有更新,0-有更新,1-没有更新
}

示例:

    var params = 
        {
            city:'武汉'
        };

    var json = JSON.stringify(params);
    uexGaodeMap.isUpdate(json,function(error,data){
        if(!error){
         alert("callback:" + JSON.stringify(data));
      }else{
         alert("检查失败");
        }
    });

delete //删除已下载或者正在下载数据

uexGaodeMap.delete(json,callBackFunction)

参数:

var json = []//(可选,仅Android) 省或城市名称数组

回调参数:

var data = {
    name:,//(必选) 省或城市名称
    errorStr://(可选) 错误描述,errorCode非0时,该值有效.
}

注:

• json不传时会清除所有数据;
• 受iOS SDK所限制,iOS仅支持删除所有数据
• iOS系统下若有传入参数json,则插件不会作任何处理

示例:

Android:
    var params = ["武汉"];
    var json = JSON.stringify(params);
    uexGaodeMap.delete(json,function(error,data){
           if(!error){
         alert("callback:" + JSON.stringify(data));
      }else{
         alert("删除失败");
        }
    });

iOS:
    uexGaodeMap.delete();

3.2、路径规划

路径规划用到的基础数据结构

GaodeGeoPoint

/**
 * GaodeGeoPoint
 * 地理坐标 
 */

var GaodeGeoPoint = {
  latitude:,  //Number,纬度
  longitude:, //Number,经度
}

GaodeStep

/**
 * GaodeStep
 * 导航路段
 */

var GaodeStep = {
  distance:,// Number 路段长度(米)
  duration:,// Number 预计耗时(秒)
  instruction:, //String 行走提示
  orientation:, //String 方向
  road:,//String 道路名称
  tolls:,//Number 可选 收费(元)
  action:,//String 导航主要动作
  points:.//Array<GaodeGeoPoint> 途径点的坐标 (按起点至终点排序) 
}

GaodePath

/**
 * GaodePath  
 * 规划路径
 */

var GaodePath = {
  distance:,// Number 路程总长度(米)
  duration:,// Number 预计总耗时(秒)
  strategy:,// String 可选 导航策略
  tolls:, // Number 可选 总收费(元)
  steps:, // Array<GaodeStep> 规划的路段 (按起点至终点排序) 
}

GaodeBusline

/**
 * GaodeBusline 
 * 公交线路
 */

var GaodeBusline  = {
  uid:,           //String 公交线路id
  type:,          //String 公交类型
  name:,          //String 公交线路名称
  startStop,      //String 可选 首发站 
  endStop:,       //String 可选 终点站
  departureStop:, //String 启程站
  arrivalStop:,   //String 下车站
  viaStops:,      //Array<String> 途径公交站
  startTime:,     //String 首班车时间
  endTime:,       //String 末班车时间
  distance:,      //Number 预计乘坐距离(米)
  duration:,      //Number 预计乘坐时间(秒)
  price:,         //Number 可选 票价
}

GaodeSegment

/**
 * GaodeSegment
 * 公交换乘路段
 */

var GaodeSegment = {
  walking:{//Object 此换乘路段需要的的步行导航信息
    origin:, //GaodeGeoPoint 步行起始坐标
    destination:, //GaodeGeoPoint 步行终止坐标
    distance:, //Number 步行总距离(米)
    duration:, //Number 步行预计时间(秒)
    steps:, //Array<GaodeStep> 步行路段
  },
  buslines:,//Array<GaodeBusline> 可供选择的不同公交线路
  enterName:,//String 入口名称
  enterPoint:,//GaodePoint 入口坐标
  exitName:, //String 出口名称
  exitPoint:, //GaodePoint 出口坐标
}

GaodeTransit

/**
 * GaodeTransit
 * 公交换乘方案
 */

var GaodeTransit = {
  cost:, //Number 预计总花费(元)
  duration:, //Number 预计总耗时
  nightFlag:, //Boolean 是否是夜班车
  walkingDistance:, //Number 此方案的步行总距离(米)
  distance:, //Number 此方案的总距离
  segments:, //Array<GaodeSegment> 换乘路段
}

GaodeRouteResult

/**
 * 返回结果
 */

var GaodeRouteResult = {
  taxiCost:, //Number 预计总花费(元),驾车搜索时可能会用到.
  paths:, //Array 路径规划结果.当进行公交路径规划规划时,paths为GaodeTransit对象构成的数组;当进行其他种类路径规划时,paths为GaodePath对象构成的数组.
}

drivingRouteSearch //驾车路径规划

uexGaodeMap.drivingRouteSearch(info,callback)

参数:

var info = {
     origin:, //GaodePoint 起始地
     destination:,//GaodePoint 目的地
     strategy:,//Number 可选 路径规划策略,默认0.  0-速度优先（时间）1-费用优先（不走收费路段的最快道路）2-距离优先 3-不走快速路 4-结合实时交通（躲避拥堵）5-多策略（同时使用速度优先、费用优先、距离优先三个策略）6-不走高速 7-不走高速且避免收费 8-躲避收费和拥堵 9-不走高速且躲避收费和拥堵
     avoidRoad:,//String,可选,避让道路名
}

回调参数:

var callback = function(error,data){
    //error 非0表示失败 此时data为失败原因 String类型
    //error 为0表示成功 此时data为符合条件的路径 是GaodeRouteResult类型
    //data 可能为空数组,表示路径规划成功,但没有搜索到可以符合条件的路径
}

版本支持:

iOS 10.0+

Android 4.3+

示例:

uexGaodeMap.drivingRouteSearch({
    origin: {
         latitude: 39.910267,
         longitude: 116.370888
     },
      destination: {
          latitude:39.989872,
          longitude:116.481956
      },
      strategy: 5
 },function(error,data){
     if(!error){
          alert("路径规划结果: " + JSON.stringify(data));
     }else{
         alert("路径规划失败: " + data);
    }
 });

data 的数据结构如下：

{
  "paths": [
    {
      "distance": 20105.0,
      "duration": 4140,
      "steps": [
        {
          "action": "向右前方行驶",
          "distance": 303.0,
          "duration": 60.0,
          "instruction": "沿华远街向南行驶303米向右前方行驶",
          "orientation": "南",
          "points": [
            {
              "latitude": 39.910263,
              "longitude": 116.371178
            }
          ],
          "road": "华远街",
          "tolls": 0.0
        }
      ],
      "strategy": "距离最短",
      "tolls": 0.0
    }
  ],
  "taxiCost": 46.0579
}

walkingRouteSearch //步行路径规划

uexGaodeMap.walkingRouteSearch(info,callback)

参数:

var info = {
     origin:, //GaodePoint 起始地
     destination:,//GaodePoint 目的地
}

回调参数:

var callback = function(error,data){
    //error 非0表示失败 此时data为失败原因 String类型
    //error 为0表示成功 此时data为符合条件的路径 是GaodeRouteResult类型
    //data 可能为空数组,表示路径规划成功,但没有搜索到可以符合条件的路径
}

版本支持:

iOS 10.0+

Android 4.3+

示例:

uexGaodeMap.walkingRouteSearch({
    origin: {
         latitude: 39.910267,
         longitude: 116.370888
     },
      destination: {
          latitude:39.989872,
          longitude:116.481956
      }
 },function(error,data){
     if(!error){
          alert("路径规划结果: " + JSON.stringify(data));
     }else{
         alert("路径规划失败: " + data);
    }
 });

data 的数据结构如下：

{
  "paths": [
    {
      "distance": 15606.0,
      "duration": 11147,
      "steps": [
        {
          "action": "往前走",
          "distance": 113.0,
          "duration": 81.0,
          "instruction": "沿华远街向北步行113米往前走",
          "orientation": "北",
          "points": [
            {
              "latitude": 39.910591,
              "longitude": 116.371178
            }
          ],
          "road": "华远街",
          "tolls": 0.0
        }
      ],
      "tolls": 0.0
    }
  ]
}

ridingRouteSearch //骑行路径规划

uexGaodeMap.ridingRouteSearch(info,callback)

参数:

var info = {
     origin:, //GaodePoint 起始地
     destination:,//GaodePoint 目的地
}

回调参数:

var callback = function(error,data){
    //error 非0表示失败 此时data为失败原因 String类型
    //error 为0表示成功 此时data为符合条件的路径 是GaodeRouteResult类型
    //data 可能为空数组,表示路径规划成功,但没有搜索到可以符合条件的路径
}

版本支持:

iOS 10.0+

Android 4.3+

示例:

uexGaodeMap.ridingRouteSearch({
    origin: {
         latitude: 39.910267,
         longitude: 116.370888
     },
      destination: {
          latitude:39.989872,
          longitude:116.481956
      }
 },function(error,data){
     if(!error){
          alert("路径规划结果: " + JSON.stringify(data));
     }else{
         alert("路径规划失败: " + data);
    }
 });

data 的数据结构如下：

{
  "paths": [
    {
      "distance": 16846.0,
      "duration": 4043,
      "steps": [
        {
          "action": "直行",
          "distance": 166.0,
          "duration": 39.0,
          "instruction": "沿华远街向北骑行166米直行",
          "orientation": "北",
          "points": [
            {
              "latitude": 39.910103,
              "longitude": 116.371193
            }
          ],
          "road": "华远街",
          "tolls": 0.0
        }
      ],
      "tolls": 0.0
    }
  ]
}

transitRouteSearch //公交路径规划

uexGaodeMap.transitRouteSearch(info,callback)

参数:

var info = {
     origin:, //GaodePoint 起始地
     destination:,//GaodePoint 目的地
    city:, //String 当前城市
      nightFlag:,//Boolean 可选 是否包含夜班车  默认false
      strategy:, // Number 可选 公交换乘策略,默认0  0-最快捷模式；1-最经济模式；2-最少换乘模式；3-最少步行模式；4-最舒适模式；5-不乘地铁模式
}

回调参数:

var callback = function(error,data){
    //error 非0表示失败 此时data为失败原因 String类型
    //error 为0表示成功 此时data为符合条件的路径 是GaodeRouteResult类型
    //data 可能为空数组,表示路径规划成功,但没有搜索到可以符合条件的路径
}

版本支持:

iOS 10.0+

Android 4.3+

示例:

uexGaodeMap.transitRouteSearch({
    origin: {
         latitude: 39.910267,
         longitude: 116.370888
     },
      destination: {
          latitude:39.989872,
          longitude:116.481956
      },
      city: "北京市",
      strategy: 3,
 },function(error,data){
     if(!error){
          alert("路径规划结果: " + JSON.stringify(data));
     }else{
         alert("路径规划失败: " + data);
    }
 });

data 的数据结构如下：

{
  "paths": [
    {
      "cost": 5.0,
      "distance": 28477.0,
      "duration": 3815,
      "nightFlag": false,
      "segments": [
        {
          "buslines": [
            {
              "distance": 4598.0,
              "duration": 528.0,
              "endTime": "2220",
              "name": "地铁4号线大兴线(安河桥北--天宫院)",
              "price": 0.0,
              "startTime": "0500",
              "type": "地铁线路",
              "uid": "110100023076",
              "viaStops": []
            }
          ],
          "enterName": "F1口",
          "enterPoint": {
            "latitude": 39.908047,
            "longitude": 116.373657
          },
          "walking": {
            "destination": {
              "latitude": 39.907387,
              "longitude": 116.374046
            },
            "distance": 522.0,
            "duration": 447,
            "origin": {
              "latitude": 39.910103,
              "longitude": 116.371193
            },
            "steps": [
              {
                "action": "左转",
                "distance": 146.0,
                "duration": 0.0,
                "instruction": "沿华远街步行146米左转",
                "orientation": "",
                "points": [
                  {
                    "latitude": 39.910103,
                    "longitude": 116.371193
                  }
                ],
                "road": "华远街",
                "tolls": 0.0
              }
            ]
          }
        }
      ],
      "walkingDistance": 2028.0
    }
  ]
}

4、附录

4.1、通过config.xml配置插件的方法

• 将配置代码添加到config.xml中即可完成插件配置,无需进行自定义插件相关步骤
• 详见打包服务器公测
• 该公测已完成,现在也支持正式版大众打包服务器

iOS

示例配置代码如下:

    <config desc="uexGaode" type="KEY" > 
        <param platform="iOS" name="$uexGaodeMap_APIKey$"  value="XXX"/>
    </config>

Android

示例配置代码如下:

    <config desc="uexGaode" type="KEY" > 
        <param platform="Android" name="$uexGaodeMap_APIKey$" value="XXX"/>
    </config>

或者Android和iOS合并写为:

    <config desc="uexGaode" type="KEY" > 
        <param platform="iOS" name="$uexGaodeMap_APIKey$"  value="XXX"/>
        <param platform="Android" name="$uexGaodeMap_APIKey$" value="XXX"/>
    </config>

用户需要将上面字段中的XXX替换为自己申请的对应平台的key,然后添加至config.xml中:即可完成相应key的配置

5、更新历史

iOS

API版本: uexGaodeMap-4.0.7

最近更新时间:2018-12-17

Android

API版本: uexGaodeMap-4.4.7

最近更新时间:2019-10-17

高德地图插件是基于高德地图API封装的AppCan平台的插件模块。开发者集成及使用此插件，需要到高德开放平台为应用申请相应的APIKey,并将APIKey配置到应用中。以下是具体步骤。

6、高德地图开放平台创建应用

申请成为开发者,访问http://lbs.amap.com/。 注册成功之后，点击成为开发者，如下：

填写完整具体的信息

申请成功之后，进入如下页面：

选择免费申请密钥 （图1）

（图2）

填写相应信息，若不知道安全码或者package，请点击图中的红色框框链接查看获取方法，也可参考签名信息获取工具使用文档

填写完成之后，点击获取KEY

其中的KEY值即是即将要用到的APIKey。

7、打包集成高德地图插件使用

把申请的APIKey写入config.xml文件，参考API附录

在线打包(以大众版在线打包为例)

7.1 插件选择

7.2 上传自定义证书

若apk的签名证书的SHA1码为49:3E:52:87:09:E1:B4:D2:B8:FF:12:6E:2C:C8:40:6D:3B:5E:4D:BB(即默认使用appcan证书打包的apk)可忽略此步骤。

7.3 云端打包

选择证书项：若签名证书的SHA1码为49:3E:52:87:09:E1:B4:D2:B8:FF:12:6E:2C:C8:40:6D:3B:5E:4D:BB，选择AppCan证书，否则选择自定义证书。

自定义包名项：填入在高德开放平台申请Key时对应的包名。

8、附录

8.1 通过config.xml配置插件的方法

• 将配置代码添加到config.xml中即可完成插件配置，无需进行自定义插件相关步骤
• 详见打包服务器公测
• 该公测已完成，现在也支持正式版大众打包服务器

iOS

示例配置代码如下：

    <config desc="uexGaode" type="KEY" > 
        <param platform="iOS" name="$uexGaodeMap_APIKey$"  value="XXX"/>
    </config>

Android

示例配置代码如下：

    <config desc="uexGaode" type="KEY" > 
        <param platform="Android" name="$uexGaodeMap_APIKey$" value="XXX"/>
    </config>

或者Android和iOS合并写为：

    <config desc="uexGaode" type="KEY" > 
        <param platform="iOS" name="$uexGaodeMap_APIKey$"  value="XXX"/>
        <param platform="Android" name="$uexGaodeMap_APIKey$" value="XXX"/>
    </config>

用户需要将上面字段中的XXX替换为自己申请的对应平台的key，然后添加至config.xml中：即可完成相应key的配置

9、常见问题

• Q 上传自定义插件时，提示“目录结构错误”

• A 先检查插件包目录结构，正确的目录结构如下： 再检查新增插件时填写的名称是否为uexGaodeMap。

• Q 打开地图之后，弹出“INVALID_USER_KEY”消息

• A 该问题产生的原因是上述配置有误，请仔细检查配置。

• Q 使用安卓uexGaodeMap 调用高德业务返回INVALID_USER_SCODE（errorcode）时怎么办？ 当返回INVALID_USER_SCODE（不是INVALID_USER_KEY哦），或错误码1008、32和7，可参考如下内容解决：

• A 该问题产生的原因是上述配置有误，请仔细检查配置。

• 首先，检查SHA1值，确保SHA1值一致，如不一致请调整一致；然后，检查核对包名，Key注册时填写的包名应该与打包使用的相一致，如不一致请调整。

• Q 使用iOSuexGaodeMap 调用高德业务返回INVALID_USER_SCODE时怎么办？ 请注意当发生INVALID_USER_SCODE （不是 INVALID_USER_KEY哦）错误时，可检查如下内容：

• A 请检查您申请Key时的Bundle Identifier与您打包时证书管理的Bundle Identifier一致，获取Bundle Identifier的方法请参考：如何获取 Bundle Identifier。