KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #claude-code #codex #typescript #ai-agents #deepseek-harness #mcp #cli #rust

wxapp-jsapi

★ 472 Open GitHub ↗

百度地图微信小程序jsapi

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

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

## 相关链接
[百度地图开放平台](https://lbs.baidu.com/)  
[百度地图微信小程序JSAPI服务](https://lbs.baidu.com/index.php?title=wxjsapi)

## 更新日志
* 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[天气服务](https://lbsyun.baidu.com/index.php?title=webapi/weather)调用。

## 概述
百度地图微信小程序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源码   
>

## 类参考
<h3>BMapWX</h3>
此类是小程序JSAPI的核心类。

### 构造函数:

构造函数                | 描述          
---------------------- | -------------
 BMapWX(ak: string)    | 创建 BMapWX对象时，必须要传入ak
 
 ### 方法:
 
  方法名                | 返回值              | 描述
---------------------- | -------------------| -----
 search([searchParam](#1.1): Object)| none          | 进行search检索，检索周边POI信息
 suggestion([suggestionParam](#2.1): Object)| none   | 进行suggestion检索，根据内容进行模糊检索匹配，输入补全
 regeocoding([regeocodingParam](#3.1): Object)| none | 进行regeocoding检索，根据经纬度获得对应的地理描述信息
 geocoding([geocodingParam](#5.1): Object)| none     | 进行geocoding检索，根据经纬度获得对应的地理描述信息
 
 ### 参数:
 
 <h4 id="1.1">searchParam: Object</h4>
 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](#1.2))|否   | 检索成功后回调回调函数
 fail                  | Function([searchFail](#1.3))|否      | 检索失败后回调函数
 
 其他参数和[Place API](http://lbsyun.baidu.com/index.php?title=webapi/guide/webservice-placeapi)请求参数一致。
 
 <h4 id="1.2">searchSuccess: Object</h4>
 search检索成功回调函数的参数 
   
 
  属性名                | 类型                | 是否必须| 描述
---------------------- | -------------------|--------| -----
 wxMarkerData          | Array              | 是      |小程序格式的marker对象数组，参考[微信文档](https://mp.weixin.qq.com/debug/wxadoc/dev/component/map.html?t=201715#markers)
 originalData          | Object             | 是      |Place API请求返回[全部原始数据](http://lbsyun.baidu.com/index.php?title=webapi/guide/webservice-placeapi)
 
 <h4 id="1.3">searchFail: Object</h4>
 search检索失败回调函数的参数  
 
  属性名                | 类型                | 是否必须| 描述
---------------------- | -------------------|--------| -----
 errMsg                | string             | 是     |错误信息
 statusCode            | number             | 是     |错误状态码
 
 
 <h4 id="2.1">suggestionParam: Object</h4>
 suggestion检索参数对象结构
 
  属性名                | 类型                | 是否必须| 描述
---------------------- | -------------------|--------| -----
 success               | Function([suggestionSuccess](#2.2))|否   | 检索成功后回调函数
 fail                  | Function([suggestionFail](#2.3))|否      | 检索失败后回调函数
 
 其他参数和[Place Suggestion API](http://lbsyun.baidu.com/index.php?title=webapi/place-suggestion-api)请求参数一致。
 
 <h4 id="2.2">suggestionSuccess: Object</h4>
 suggestion检索成功回调函数的参数  
 
  属性名                | 类型                | 是否必须| 描述
---------------------- | -------------------|--------| -----
 originalData          | Object             | 是      |Place Suggestion API请求返回[全部原始数据](http://lbsyun.baidu.com/index.php?title=webapi/place-suggestion-api)
 
 <h4 id="2.3">suggestionFail: Object</h4>
 suggestion检索失败回调函数的参数  
 
  属性名                | 类型                | 是否必须| 描述
---------------------- | -------------------|--------| -----
 errMsg                | string             | 是     |错误信息
 statusCode            | number             | 是     |错误状态码
 
 <h4 id="3.1">regeocodingParam: Object</h4>
 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](#3.2))|否   | 检索成功后回调函数
 fail                  | Function([regeocodingFail](#3.3))|否      | 检索失败后回调函数
 
 其他参数和[Geocoding](https://lbs.baidu.com/index.php?title=webapi/guide/webservice-geocoding-abroad)请求参数一致。
 
 <h4 id="3.2">regeocodingSuccess: Object</h4>
 regeocoding检索成功回调函数的参数  
 
  属性名                | 类型                | 是否必须| 描述
---------------------- | -------------------|--------| -----
 wxMarkerData          | Array              | 是      |小程序格式的marker对象数组，参考[微信文档](https://mp.weixin.qq.com/debug/wxadoc/dev/component/map.html?t=201715#markers)
 originalData          | Object             | 是      |Geocoding API请求返回[全部原始数据](http://lbs.baidu.com/index.php?title=webapi/guide/webservice-geocoding-abroad)
 
 <h4 id="3.3">regeocodingFail: Object</h4>
 regeocoding检索失败回调函数的参数  
 
  属性名                | 类型                | 是否必须| 描述
---------------------- | -------------------|--------| -----
 errMsg                | string             | 是     |错误信息
 statusCode            | number             | 是     |错误状态码
 
 <h4 id="5.1">geocodingParam: Object</h4>
 geocoding检索参数对象结构
 
  属性名                | 类型                | 是否必须| 描述
---------------------- | -------------------|--------| -----
 address               | string             | 是      |待解析地址，如"北京市海淀区上地十街10号"
 iconPath              | string             | 是      |小程序marker图标
 iconTapPath           | string             | 否      |小程序点击后图标
 width                 | number             | 否      |marker宽，默认为图片宽度 
 height                | number             | 否      |marker高，默认为图片高度 
 alpha                 | number             | 否      |marker透明度，默认为1
 success               | Function([geocodingSuccess](#5.2))|否   | 检索成功后回调函数
 fail                  | Function([geocodingFail](#5.3))|否      | 检索失败后回调函数
 
 其他参数和[Geocoding](https://lbs.baidu.com/index.php?title=webapi/guide/webservice-geocoding)请求参数一致。
 
 <h4 id="5.2">geocodingSuccess: Object</h4>
 geocoding检索成功回调函数的参数  
 
  属性名                | 类型                | 是否必须| 描述
---------------------- | -------------------|--------| -----
 wxMarkerData          | Array              | 是      |小程序格式的marker对象数组，参考[微信文档](https://mp.weixin.qq.com/debug/wxadoc/dev/component/map.html?t=201715#markers)
 originalData          | Object             | 是      |Geocoding API请求返回[全部原始数据](http://lbs.baidu.com/index.php?title=webapi/guide/webservice-geocoding)
 
 <h4 id="5.3">geocodingFail: Object</h4>
 geocoding检索失败回调函数的参数  
 
  属性名                | 类型                | 是否必须| 描述
---------------------- | -------------------|--------| -----
 errMsg                | string             | 是     |错误信息
 statusCode            | number             | 是     |错误状态码

wxapp-jsapi

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README