Skip to content

Latest commit

 

History

History
181 lines (132 loc) · 9.75 KB

README.md

File metadata and controls

181 lines (132 loc) · 9.75 KB

百度地图微信小程序JS API v1.1

相关链接

百度地图开放平台
百度地图微信小程序JSAPI服务

更新日志

  • 2017.01.11:发布v1.0版本,支持search、suggestion、regeocoding和weather四种接口。

  • 2017.02.15:修复location参数无效的bug。

  • 2019.07.03:发布v1.1版本,增加geocoding接口,支持地址信息到经纬度的转换。

  • 2020.09:由于ak鉴权限制,小程序端jsapi暂不支持天气服务,可以通过webAPI天气服务调用。

概述

百度地图微信小程序JavaScript API(下文简称小程序JSAPI),对百度地图Web服务API中的部分lbs接口,按照微信小程序的规范进行了前端JS封装,以方便微信小程序开发者的调用。

部分接口对返回的POI等数据按照微信小程序的数据格式进行了处理,可直接用于小程序的map中。

目前开放的小程序JSAPI接口和调用的WebAPI接口对应关系为:

小程序JSAPI Web服务API
search Place API的周边检索部分
suggestion Place Suggestion API
regeocoding Geocoding API的逆地址解析部分
geocoding Geocoding API的正地址解析部分

目录结构

demo ------------- 小程序JSAPI完整DEMO
src --------------- 小程序JSAPI源码

类参考

BMapWX

此类是小程序JSAPI的核心类。

构造函数:

构造函数 描述
BMapWX(ak: string) 创建 BMapWX对象时,必须要传入ak

方法:

方法名 返回值 描述
search(searchParam: Object) none 进行search检索,检索周边POI信息
suggestion(suggestionParam: Object) none 进行suggestion检索,根据内容进行模糊检索匹配,输入补全
regeocoding(regeocodingParam: Object) none 进行regeocoding检索,根据经纬度获得对应的地理描述信息
geocoding(geocodingParam: Object) none 进行geocoding检索,根据经纬度获得对应的地理描述信息

参数:

searchParam: Object

search检索参数对象结构
属性名 类型 是否必须 描述
location string 经纬度例如:39.915,116.404 默认值为当前定位点
iconPath string 小程序marker图标
iconTapPath string 小程序点击后图标
width number marker宽,默认为图片宽度
height number marker高,默认为图片高度
alpha number marker透明度,默认为1
query string 检索关键字,默认为生活服务、美食、酒店
success Function(searchSuccess) 检索成功后回调回调函数
fail Function(searchFail) 检索失败后回调函数

其他参数和Place API请求参数一致。

searchSuccess: Object

search检索成功回调函数的参数
属性名 类型 是否必须 描述
wxMarkerData Array 小程序格式的marker对象数组,参考微信文档
originalData Object Place API请求返回全部原始数据

searchFail: Object

search检索失败回调函数的参数
属性名 类型 是否必须 描述
errMsg string 错误信息
statusCode number 错误状态码

suggestionParam: Object

suggestion检索参数对象结构
属性名 类型 是否必须 描述
success Function(suggestionSuccess) 检索成功后回调函数
fail Function(suggestionFail) 检索失败后回调函数

其他参数和Place Suggestion API请求参数一致。

suggestionSuccess: Object

suggestion检索成功回调函数的参数
属性名 类型 是否必须 描述
originalData Object Place Suggestion API请求返回全部原始数据

suggestionFail: Object

suggestion检索失败回调函数的参数
属性名 类型 是否必须 描述
errMsg string 错误信息
statusCode number 错误状态码

regeocodingParam: Object

regeocoding检索参数对象结构
属性名 类型 是否必须 描述
location string 要解析的经纬度例如:39.915,116.404 默认值为当前定位点
iconPath string 小程序marker图标
iconTapPath string 小程序点击后图标
width number marker宽,默认为图片宽度
height number marker高,默认为图片高度
alpha number marker透明度,默认为1
success Function(regeocodingSuccess) 检索成功后回调函数
fail Function(regeocodingFail) 检索失败后回调函数

其他参数和Geocoding请求参数一致。

regeocodingSuccess: Object

regeocoding检索成功回调函数的参数
属性名 类型 是否必须 描述
wxMarkerData Array 小程序格式的marker对象数组,参考微信文档
originalData Object Geocoding API请求返回全部原始数据

regeocodingFail: Object

regeocoding检索失败回调函数的参数
属性名 类型 是否必须 描述
errMsg string 错误信息
statusCode number 错误状态码

geocodingParam: Object

geocoding检索参数对象结构
属性名 类型 是否必须 描述
address string 待解析地址,如"北京市海淀区上地十街10号"
iconPath string 小程序marker图标
iconTapPath string 小程序点击后图标
width number marker宽,默认为图片宽度
height number marker高,默认为图片高度
alpha number marker透明度,默认为1
success Function(geocodingSuccess) 检索成功后回调函数
fail Function(geocodingFail) 检索失败后回调函数

其他参数和Geocoding请求参数一致。

geocodingSuccess: Object

geocoding检索成功回调函数的参数
属性名 类型 是否必须 描述
wxMarkerData Array 小程序格式的marker对象数组,参考微信文档
originalData Object Geocoding API请求返回全部原始数据

geocodingFail: Object

geocoding检索失败回调函数的参数
属性名 类型 是否必须 描述
errMsg string 错误信息
statusCode number 错误状态码