JavaScript API支持搜索服务脱离地图使用,即使用搜索服务不再需要先实例化地图。您可通AMap.plugin
方法,加载需要的服务。同时JavaScript API将原有的通过事件监听获得服务查询结果,修改为通过方法的回调函数获得服务查询结果。
注:
1. 依赖地图加载搜索服务插件方式可以继续使用,但鼓励使用新的加载方式。
2. JavaScript API兼容原有的通过监听事件返回服务结果,但鼓励开发者使用通过方法回调获取结果的方式。
方法 | 说明 |
---|
AMap.plugin(serviceNames:Array.<serviceName>,callback:function) | 服务加载方法,参数service可以为服务插件中的一个或多个 |
AMap.Autocomplete
AMap.Autocomplete根据输入关键字提示匹配信息,可将Poi类型和城市作为输入提示的限制条件。用户可以通过自定义回调函数取回并显示查询结果。若服务请求失败,系统将返回错误信息。最多支持10条建议,不可翻页。
相关示例
AutocompleteOptions | 类型 | 说明 |
---|
type | String | 输入提示时限定POI类型,多个类型用“|”分隔,POI相关类型请在网站“相关下载”处下载目前只支持Poi类型编码如“050000”默认值:所有类别 |
city | String | 输入提示时限定城市。可选值:城市名(中文或中文全拼)、citycode、adcode;默认值:“全国” |
datatype | String | 返回的数据类型可选值:all-返回所有数据类型、poi-返回POI数据类型、bus-返回公交站点数据类型、busline-返回公交线路数据类型目前暂时不支持多种类型 |
citylimit | Boolean | 是否强制限制在设置的城市内搜索,默认值为:falsetrue:强制限制设定城市,false:不强制限制设定城市 |
input | String/HTMLInputElement | 可选参数,用来指定一个input输入框,设定之后,在input输入文字将自动生成下拉选择列表。支持传入输入框DOM对象的id值,或直接传入输入框的DOM对象。 |
output | String/HTMLDivElement | 可选参数,指定一个现有的div的id或者元素,作为展示提示结果的容器,当指定了input的时候有效,缺省的时候将自动创建一个显示结果面板 |
outPutDirAuto | Boolean | 默认为true,表示是否在input位于页面较下方的时候自动将输入面板显示在input上方以避免被遮挡 |
方法 | 返回值 | 说明 |
---|
search(keyword:String, callback:function(status:String,result:info/ AutocompleteResult )) |
| 根据输入关键字提示匹配信息,支持中文、拼音当status为complete时,result为AutocompleteResult;当status为error时,result为错误信息info;当status为no_data时,代表检索返回0结果 |
setType(type:String) |
| 设置提示Poi类型,多个类型用“|”分隔,POI相关类型请在网站“相关下载”处下载目前只支持Poi类型编码如“050000”默认值:所有类别 |
setCity(city:String) |
| 设置城市 |
setCityLimit(Boolean) |
| 设置是否强制限制城市 |
事件 | 参数 | 说明 |
---|
complete | AutocompleteResult | 当查询成功时触发此事件 |
error | ErrorStatus | 当查询失败时触发此事件 |
select | {id,name,adcode,district,location,type} | 鼠标点击或者回车选中某个POI信息时触发此事件 |
choose | {id,name,adcode,district,location,type} | 鼠标或者键盘上下键选择POI信息时触发此事件 |
属性 | 类型 | 说明 |
---|
info | String | 查询状态说明 |
count | Number | 输入提示条数 |
tips | Array.< Tip > | 输入提示列表 |
属性 | 类型 | 说明 |
---|
name | String | 名称 |
district | String | 所属区域 |
adcode | String | 区域编码 |
AMap.PlaceSearch
地点搜索服务,提供某一特定地区的位置查询服务。PlaceSearch构造函数的参数为可选,表达为参数对象PlaceSearchOptions。PlaceSearchOptions允许设置搜索城市、搜索数据类别、搜索结果详略、搜索结果排序规则等。用户可以通过自定义回调函数取回并显示查询结果。若服务请求失败,系统将返回错误信息。
PlaceSearchOptions | 类型 | 说明 |
---|
city | String | 兴趣点城市可选值:城市名(中文或中文全拼)、citycode、adcode默认值:“全国” |
citylimit | Boolean | 是否强制限制在设置的城市内搜索,默认值为:falsetrue:强制限制设定城市,false:不强制限制设定城市 |
children | Number | 是否按照层级展示子POI数据,默认0children=1,展示子节点POI数据,children=0,不展示子节点数据 |
type | String | 兴趣点类别,多个类别用“|”分割,如“餐饮|酒店|电影院”POI搜索类型共分为以下20种:汽车服务|汽车销售|汽车维修|摩托车服务|餐饮服务|购物服务|生活服务|体育休闲服务|医疗保健服务|住宿服务|风景名胜|商务住宅|政府机构及社会团体|科教文化服务|交通设施服务|金融保险服务|公司企业|道路附属设施|地名地址信息|公共设施默认值:餐饮服务、商务住宅、生活服务 |
lang | String | 检索语言类型可选值:zh_cn:中文简体,en:英文默认为: zh_cn:中文简体 |
pageSize | Number | 单页显示结果条数默认值:10取值范围:1-50,超出取值范围按最大值返回 |
pageIndex | Number | 页码。(如pageIndex为2,pageSize为10,那么显示的应是第11-20条返回结果)默认值:1取值范围:1-100,超过实际页数不返回poi |
extensions | String | 此项默认值:base,返回基本地址信息取值:all,返回基本+详细信息 |
map | Map | AMap.Map对象, 展现结果的地图实例。当指定此参数后,搜索结果的标注、线路等均会自动添加到此地图上。可选值 |
panel | String|HTMLElement | 结果列表的HTML容器id或容器元素,提供此参数后,结果列表将在此容器中进行展示。可选值 |
showCover | Boolean | 在使用map属性时,是否在地图上显示周边搜索的圆或者范围搜索的多边形,默认为true |
renderStyle | String | 如使用了map或panel属性,renderStyle可以用来设定绘制的UI风格,缺省为’newpc’可选值:’newpc’或’default’,’newpc’为带图片展示的新样式,’default’为原有简单样式。 |
autoFitView | Boolean | 用于控制在搜索结束后,是否自动调整地图视野使绘制的Marker点都处于视口的可见范围 |
方法 | 返回值 | 说明 |
---|
search(keyword:String, callback:function(status:String,result:info/ SearchResult )) |
| 根据关键字搜索,关键字支持中文|中文全拼、繁体、英文当status为complete时,result为SearchResult;当status为error时,result为错误信息info;当status为no_data时,代表检索返回0结果 相关示例 |
searchNearBy(keyword:String,center: LngLat ,radius:Number, callback:function(status:String,result:info/ SearchResult )) |
| 根据中心点经纬度、半径以及关键字进行周边查询radius取值范围:0-50000status说明同上 相关示例 |
searchInBounds(keyword:String,bounds: Bounds | Polygon , callback:function(status:String,result:info/ SearchResult )) |
| 根据范围和关键词进行范围查询status说明同上相关示例 |
getDetails(POIID:String, callback:function(status:String,result:info/ SearchResult )) |
| 根据POIID 查询POI 详细信息status说明同上 相关示例 |
setType(type:String) |
| 设置查询类别,多个类别用“|”分割默认值:所有类别 |
setCityLimit(Boolean) |
| 设置是否强制限制城市 |
setPageIndex(pageIndex:Number) |
| 设置查询结果特定页数默认值:1取值范围:1-100,超过实际页数不返回poi |
setPageSize(setPageSize:Number) |
| 设置查询单页结果数默认值:10取值范围:1-50,超出取值范围按最大值返回 |
setCity(city:String) |
| 设置查询城市支持cityname(中文或中文全拼)、citycode、adcode |
setLang(lang:String) | String | 设置检索语言类型 |
|
|
|
getLang( ) | String | 获取placeSearch检索语言类型(自v1.3 新增) |
clear() |
| 清除搜索结果 |
poiOnAMAP(obj:Object) |
| 唤起高德地图客户端marker页Object参数形如:{ id: “B000A7BD6C”,POIIDname:String, 必要参数location:LngLat|position属性 必须参数} |
detailOnAMAP(obj:Object) |
| 唤起高德地图客户端POI详情页Object参数形如:{ id: “B000A7BD6C”,POIIDname:String, 必要参数location:LngLat|position属性 必须参数} |
属性 | 类型 | 说明 |
---|
type | String | 事件类别 |
id | String | 当前选中的POI的ID |
marker | Marker | 当前选中的POI对应的在地图中的Marker对象 |
listElement | HTMLLIElement | 当前选中的POI在结果面板中对应的列表项 |
data | Poi | 当前选中的POI的信息 |
属性 | 类型 | 说明 |
---|
info | String | 成功状态说明 |
poiList | PoiList | 发生事件时返回兴趣点列表 |
keywordList | Array.<keyword> | 发生事件且查无此关键字时,返回建议关键字列表,可根据建议关键字查询 |
cityList | Array.< CityInfo > | 发生事件且查无此关键字且 city 为“全国”时,返回城市建议列表,该列表中每个城市包含一个或多个相关Poi点信息 |
属性 | 类型 | 说明 |
---|
pois | Array.< Poi > | Poi列表 |
pageIndex | Number | 页码 |
pageSize | Number | 单页结果数 |
count | Number | 查询结果总数 |
属性 | 类型 | 说明 |
---|
name | String | 建议城市名称 |
citycode | String | 城市编码 |
adcode | String | 行政区编码 |
count | Number | 该城市的建议结果数目 |
Poi 基本信息
属性 | 类型 | 说明 |
---|
id | String | 全局唯一ID |
name | String | 名称 |
type | String | 兴趣点类型 |
location | LngLat | 兴趣点经纬度 |
address | String | 地址 |
distance | Number | 离中心点距离,仅周边查询返回 |
tel | String | 电话 |
Poi 详细信息
属性 | 类型 | 说明 |
---|
website | String | 网址 |
pcode | String | poi所在省份编码 |
citycode | String | poi所在城市编码 |
adcode | String | poi所在区域编码 |
postcode | String | 邮编 |
pname | String | poi所在省份 |
cityname | String | poi所在城市名称 |
adname | String | poi所在行政区名称 |
email | String | 电子邮箱 |
entr_location | LngLat | 入口经纬度,POI点有出入口信息时返回,否则返回空字符串 |
exit_location | LngLat | 出口经纬度,POI点有出入口信息时返回,否则返回空字符串 |
groupbuy | Boolean | poi是否有团购信息,true为存在团购信息(此字段逐渐废弃) |
discount | Boolean | poi是否有优惠信息,true为存在优惠信息(此字段逐渐废弃) |
Poi 深度扩展信息
属性 | 类型 | 说明 |
---|
groupbuys | Array.< Groupbuy > | 团购信息(此字段逐渐废弃) |
discounts | Array.< Discount > | 优惠信息(此字段逐渐废弃) |
deep_type | String | 深度信息类型(此字段逐渐废弃),返回值为以下中的一个:DINING:餐饮深度信息类型HOTEL:酒店深度信息类型CINEMA:影院深度信息类型SCENIC:景点深度信息类型 |
dining | Dining | 餐饮类深度信息(此字段逐渐废弃) |
hotel | Hotel | 酒店类深度信息(此字段逐渐废弃) |
cinema | Cinema | 影院类深度信息(此字段逐渐废弃) |
scenic | Scenic | 景点类深度信息(此字段逐渐废弃) |
属性 | 类型 | 说明 |
---|
title | String | 优惠标题 |
detail | String | 优惠详情 |
start_time | String | 开始时间 |
end_time | String | 结束时间 |
sold_num | Number | 已卖出数量 |
photos | Array.< Photo > | 已卖出数量 |
url | String | 来源url |
provider | String | 来源标识 |
属性 | 类型 | 说明 |
---|
title | String | 团购标题 |
type_code | String | 团购分类代码 |
type | String | 团购分类 |
detail | String | 团购详情 |
stime | String | 团购开始时间 |
etime | String | 团购结束时间 |
count | Number | 团购总量 |
sold_num | Number | 已卖出数量 |
original_price | Number | 原价 |
groupbuy_price | Number | 折扣价 |
discount | Number | 折扣 |
ticket_address | String | 取票地址 |
ticket_tel | String | 取票电话 |
photos | Array.<Photo> | 图片信息 |
url | String | 来源url |
provider | String | 来源标识 |
属性 | 类型 | 说明 |
---|
cuisines | String | 菜系 |
tag | String | 标签 |
intro | String | 简介 |
rating | String | 综合评分 |
cp_rating | String | 但数据源的评分 |
deep_src | String | 信息来源 |
taste_rating | String | 口味评分 |
environment_rating | String | 环境评分 |
service_rating | String | 服务评分 |
cost | String | 人均消费 |
recommend | String | 特色菜 |
atmosphere | String | 氛围 |
ordering_wap_url | String | 订餐wap链接 |
ordering_web_url | String | 订餐web链接 |
ordering_app_url | String | 订餐APP URL |
opentime_GDF | String | 规范格式的营业时间 |
opentime | String | 非规范格式的营业时间 |
addition | String | 餐厅特色 |
photos | Array.<Photo> | 图片信息列表 |
属性 | 类型 | 说明 |
---|
rating | String | 综合评分 |
star | String | 星级 |
intro | String | 简介 |
lowest_price | String | 最低房价 |
faci_rating | String | 设施评分 |
health_rating | String | 卫生评分 |
environment_rating | String | 环境评分 |
service_rating | String | 服务评分 |
traffic | String | 交通提示 |
addition | String | 特色服务 |
deep_src | String | 信息来源 |
photos | Array.<Photo> | 图片信息列表 |
属性 | 类型 | 说明 |
---|
intro | String | 简介 |
rating | String | 综合评分 |
deep_src | String | 信息来源 |
parking | String | 停车场设施 |
opentime_GDF | String | 规范格式的营业时间 |
openingtime | String | 非规范格式的营业时间 |
photos | Array.<Photo> | 图片信息列表 |
属性 | 类型 | 说明 |
---|
intro | String | 简介 |
rating | String | 综合评分 |
deep_src | String | 信息来源 |
level | String | 景区国标级别 |
price | String | 门票价格 |
season | String | 适合游玩的季节 |
recommened | String | 推荐景点 |
theme | String | 景区主题 |
ordering_wap_url | String | wap购票链接 |
ordering_web_url | String | wab购票链接 |
opentime_GDF | String | 规范格式的营业时间 |
opentime | String | 非规范格式的营业时间 |
photos | Array.<Photo> | 图片信息列表 |
属性 | 类型 | 说明 |
---|
title | String | 图片名称 |
url | String | 图片url |
属性 | 类型 | 说明 |
---|
id | String | POI的唯一标识 |
name | String | POI名称 |
AMap.DistrictSearch
AMap.DistrictSearch。
DistrictSearchOptions | 类型 | 说明 |
---|
level | String | 关键字对应的行政区级别或商圈,可选值:country:国家province:省/直辖市city:市district:区/县biz_area:商圈 |
showbiz | Boolean | 是否显示商圈,默认值true可选为true/false,为了能够精准的定位到街道,特别是在快递、物流、送餐等场景下,强烈建议将此设置为false |
extensions | String | 是否返回行政区边界坐标点默认值:base,不返回行政区边界坐标点取值:all,返回完整行政区边界坐标点 |
subdistrict | Number | 显示下级行政区级数(行政区级别包括:国家、省/直辖市、市、区/县4个级别),商圈为区/县下一级 可选值:0、1、2、30:不返回下级行政区1:返回下一级行政区2:返回下两级行政区3:返回下三级行政区默认值:1 |
方法 | 返回值 | 说明 |
---|
search(keywords:String, callback:function(status:String,result:info/ DistrictSearchResult ), opts: DistrictSearchOptions ) |
| 根据关键字查询行政区或商圈信息 关键字支持:行政区名、citycode、adcode、商圈名默认值:“全国”当status为complete时,result为DistrictSearchResult;当status为error时,result为错误信息info;当status为no_data时,代表检索返回0结果 |
setLevel(level:String) |
| 设置关键字对应的行政区级别或商圈,可选值:country:国家province:省/直辖市city:市district:区/县biz_area:商圈 |
setSubdistrict(district:Number) |
| 设置下级行政区级数(行政区级别包括:国家、省/直辖市、市、区/县4个级别),商圈为区/县下一级,默认值:1可选值:0、1、2、30:不返回下级行政区;1:返回下一级行政区;2:返回下两级行政区;3:返回下三级行政区; |
属性 | 类型 | 说明 |
---|
info | String | 成功状态文字描述 |
districtList | Array.< District > | 根据查询条件返回行政区划列表 |
属性 | 类型 | 说明 |
---|
name | String | 行政区名称 |
center | LngLat | 城市中心点经纬度坐标 |
citycode | String | 城市编码 |
adcode | String | 区域编码 |
level | String | 行政区划级别 |
boundaries | Array.< LngLat > | extensions为“all”时,返回行政区的边界坐标集合,为经纬度的二维数组若行政区包含多个区面,则二维数组中包含多个经纬度路径的元素 |
districtList | Array.< District > | 下级行政区信息列表subdistrict 为0时,不返回该对象 |
AMap.StationSearch
AMap.StationSearch 公交站点查询服务,根据输入关键字、ID查询公交站点信息。用户可以通过自定义回调函数取回并显示查询结果。若服务请求失败,系统将返回错误信息。
StationSearchOptions | 类型 | 说明 |
---|
pageIndex | Number | 页码(如pageIndex为2,pageSize为10,那么显示的应是第11-20条返回结果)默认值:1取值范围:1-100,超过取值范围按默认,超出实际页数按最大值返回 |
pageSize | Number | 单页显示结果条数,默认值:20取值范围:1-100,超过取值范围按默认 |
city | String | 公交站点所在城市,默认值:“全国”可选值:cityname(中文或中文全拼)、citycode、adcode |
方法 | 返回值 | 说明 |
---|
searchById(id:String, callback:function(status:String,result:info/ StationSearchResult )) |
| 根据给定的公交站点id进行公交站点详情检索,id是公交站点的唯一标识当status为complete时,result为StationSearchResult;当status为error时,result为错误信息info;当status为no_data时,代表检索返回0结果 |
search(keyword:String, callback:function(status:String,result:info/ StationSearchResult )) |
| 根据给定公交站点名称进行公交站点详情查询,多个关键字用”|”分割status说明同上 相关示例 |
setPageIndex(pageIndex:Number) |
| 设置查询结果页码,默认值:1取值范围:1-100,超过取值范围按默认 |
setPageSize(pageSize:Number) |
| 设置单页显示结果条数,默认值:20取值范围:1-100,超过取值范围按默认 |
setCity(city:String) |
| 设置查询城市,默认值:“全国”可选值:cityname(中文或中文全拼)、citycode、adcode |
属性 | 类型 | 说明 |
---|
info | String | 成功状态文字描述 |
stationInfo | Array.< StationInfo > | 根据查询条件返回公交站点信息 |
keywordList | Array.<keyword> | 查无此公交站时,返回的建议关键字列表,可根据建议关键字查询 |
cityList | Array.< CityInfo > | 查该城市无此公交站时,返回的建议城市列表 |
属性 | 类型 | 说明 |
---|
id | String | 公交站点id,该id是唯一标识 |
name | String | 公交站点名称 |
location | LngLat | 公交站点经纬度 |
adcode | String | 区域编码 |
citycode | String | 城市编码 |
buslines | Array.< Busline > | 途经此站点的公交路线列表 |
属性 | 类型 | 说明 |
---|
id | String | 公交线路id,该id是唯一标识 |
name | String | 公交线路名称 |
location | LngLat | 公交线路途经此站的经纬度 |
start_stop | String | 首发站 |
end_stop | String | 终点站 |
AMap.LineSearch
AMap.LineSearch 公交路线查询类,通过extensions属性控制返回信息详略。公交线路信息包括起、终点、途径站点,首、末班车时间等信息。用户可以通过自定义回调函数取回并显示查询结果。若服务请求失败,系统将返回错误信息。
LineSearchOptions | 类型 | 说明 |
---|
pageIndex | Number | 页码(如pageIndex为2,pageSize为10,那么显示的应是第11-20条返回结果)默认值:1取值范围:1-100,超过取值范围按默认,超出实际页数按最大值返回 |
pageSize | Number | 单页显示结果条数,默认值:20取值范围:1-100,超过取值范围按默认 |
city | String | 公交线路所在城市,默认值:“全国”可选值:cityname(中文或中文全拼)、citycode、adcode |
extensions | String | 此项仅公交路线查询时有效,默认值:base,返回公交路线基本信息,当取值为:all,返回公交路线基本信息+详细信息 |
方法 | 返回值 | 说明 |
---|
searchById(id:String, callback:function(status:String,result:info/ LineSearchResult )) |
| 根据给定的公交线路id进行公交站点详情检索,id是公交线路的唯一标识当status为complete时,result为LineSearchResult;当status为error时,result为错误信息info;当status为no_data时,代表检索返回0结果 |
search(keyword:String, callback:function(status:String,result:info/ LineSearchResult )) |
| 根据给定公交线路名称进行公交线路详情查询status说明同上 相关示例 |
setPageIndex(pageIndex:Number) |
| 设置查询结果页码,默认值:1取值范围:1-100,超过取值范围按默认 |
setPageSize(pageSize:Number) |
| 设置单页显示结果条数,默认值:20取值范围:1-100,超过取值范围按默认 |
setCity(city:String) |
| 设置查询城市,默认值:“全国”可选值:cityname(中文或中文全拼)、citycode、adcode |
属性 | 类型 | 说明 |
---|
info | String | 成功状态文字描述 |
LineInfo | Array.< LineInfo > | 根据查询条件返回公交路线信息 |
keywordList | Array.<keyword> | 查无此公交站时,返回的建议关键字列表,可根据建议关键字查询 |
cityList | Array.< CityInfo > | 查该城市无此公交站时,返回的建议城市列表 |
属性 | 类型 | 说明 |
---|
id | String | 公交线路id,该id是唯一标识 |
name | String | 公交线路名称 |
path | Array.< LngLat > | 公交线路经纬度 |
citycode | String | 公交线路所在城市的城市编码 |
type | String | 公交类型列表 |
type | String | 公交类型列表 |
start_stop | String | 首发站 |
end_stop | String | 终点站 |
属性 | 类型 | 说明 |
---|
stime | String | 首班车时间 |
etime | String | 末班车时间 |
basic_price | String | 起步票价,单位:元 |
total_price | String | 全程票价,单位:元 |
via_stops | Array | 途径站,包括首发站和终点站 |
distance | Number | 全程距离,单位:千米 |
bounds | Bounds | 此公交路线的地理范围 |
company | String | 所属公交公司 |