搜索服务 最后更新时间: 2021年01月22日
名称 | 说明 | 是否插件 |
---|---|---|
输入提示,根据输入关键字提示匹配信息 | 是 | |
地点搜索服务插件,提供某一特定地区的位置查询服务 | 是 | |
行政区查询服务,提供行政区相关信息 | 是 | |
公交路线服务,提供公交路线相关信息查询服务 | 是 | |
公交站点查询服务,提供途经公交线路、站点经纬度等信息 | 是 |
AMap.plugin
方法,加载需要的服务。同时JavaScript API将原有的通过事件监听获得服务查询结果,修改为通过方法的回调函数获得服务查询结果。注:
1. 依赖地图加载搜索服务插件方式可以继续使用,但鼓励使用新的加载方式。
2. JavaScript API兼容原有的通过监听事件返回服务结果,但鼓励开发者使用通过方法回调获取结果的方式。
方法 | 说明 |
---|---|
| 服务加载方法,参数service可以为服务插件中的一个或多个 |
AMap.Autocomplete
AMap.Autocomplete根据输入关键字提示匹配信息,可将Poi类型和城市作为输入提示的限制条件。用户可以通过自定义回调函数取回并显示查询结果。若服务请求失败,系统将返回错误信息。最多支持10条建议,不可翻页。
构造函数 | 说明 |
---|---|
| 构造函数,提供输入提示功能 |
AutocompleteOptions | 类型 | 说明 |
---|---|---|
|
| 输入提示时限定POI类型,多个类型用“|”分隔,POI相关类型请在网站“相关下载”处下载 目前只支持Poi类型编码如“050000” 默认值:所有类别 |
|
| 输入提示时限定城市。 可选值:城市名(中文或中文全拼)、citycode、adcode; 默认值:“全国” |
|
| 返回的数据类型 可选值:all-返回所有数据类型、poi-返回POI数据类型、bus-返回公交站点数据类型、busline-返回公交线路数据类型 目前暂时不支持多种类型 |
|
| 是否强制限制在设置的城市内搜索,默认值为:false true:强制限制设定城市,false:不强制限制设定城市 |
|
| 可选参数,用来指定一个input输入框,设定之后,在input输入文字将自动生成下拉选择列表。支持传入输入框DOM对象的id值,或直接传入输入框的DOM对象。 |
|
| 可选参数,指定一个现有的div的id或者元素,作为展示提示结果的容器,当指定了input的时候有效,缺省的时候将自动创建一个显示结果面板 |
|
| 默认为true,表示是否在input位于页面较下方的时候自动将输入面板显示在input上方以避免被遮挡 |
方法 | 返回值 | 说明 |
---|---|---|
| 根据输入关键字提示匹配信息,支持中文、拼音 当status为complete时,result为AutocompleteResult; 当status为error时,result为错误信息info; 当status为no_data时,代表检索返回0结果 | |
| 设置提示Poi类型,多个类型用“|”分隔,POI相关类型请在网站“相关下载”处下载 目前只支持Poi类型编码如“050000” 默认值:所有类别 | |
| 设置城市 | |
| 设置是否强制限制城市 |
事件 | 参数 | 说明 |
---|---|---|
| 当查询成功时触发此事件 | |
| 当查询失败时触发此事件 | |
| 鼠标点击或者回车选中某个POI信息时触发此事件 | |
| 鼠标或者键盘上下键选择POI信息时触发此事件 |
AutocompleteResult 对象
属性 | 类型 | 说明 |
---|---|---|
|
| 查询状态说明 |
|
| 输入提示条数 |
|
| 输入提示列表 |
Tip 对象
属性 | 类型 | 说明 |
---|---|---|
|
| 名称 |
|
| 所属区域 |
|
| 区域编码 |
AMap.PlaceSearch
地点搜索服务,提供某一特定地区的位置查询服务。PlaceSearch构造函数的参数为可选,表达为参数对象PlaceSearchOptions。PlaceSearchOptions允许设置搜索城市、搜索数据类别、搜索结果详略、搜索结果排序规则等。用户可以通过自定义回调函数取回并显示查询结果。若服务请求失败,系统将返回错误信息。
构造函数 | 说明 |
---|---|
| 创建地点查询类的实例 |
PlaceSearchOptions | 类型 | 说明 |
---|---|---|
|
| 兴趣点城市 可选值:城市名(中文或中文全拼)、citycode、adcode 默认值:“全国” |
|
| 是否强制限制在设置的城市内搜索,默认值为:false true:强制限制设定城市,false:不强制限制设定城市 |
|
| 是否按照层级展示子POI数据,默认0 children=1,展示子节点POI数据,children=0,不展示子节点数据 |
|
| 兴趣点类别,多个类别用“|”分割,如“餐饮|酒店|电影院” POI搜索类型共分为以下20种: 汽车服务|汽车销售|汽车维修|摩托车服务|餐饮服务|购物服务|生活服务|体育休闲服务| 医疗保健服务|住宿服务|风景名胜|商务住宅|政府机构及社会团体|科教文化服务| 交通设施服务|金融保险服务|公司企业|道路附属设施|地名地址信息|公共设施 默认值:餐饮服务、商务住宅、生活服务 |
|
| 检索语言类型 可选值:zh_cn:中文简体,en:英文 默认为: zh_cn:中文简体 |
|
| 单页显示结果条数 默认值:10 取值范围:1-50,超出取值范围按最大值返回 |
|
| 页码。(如pageIndex为2,pageSize为10,那么显示的应是第11-20条返回结果) 默认值:1 取值范围:1-100,超过实际页数不返回poi |
|
| 此项默认值:base,返回基本地址信息 取值:all,返回基本+详细信息 |
| AMap.Map对象, 展现结果的地图实例。当指定此参数后,搜索结果的标注、线路等均会自动添加到此地图上。可选值 | |
|
| 结果列表的HTML容器id或容器元素,提供此参数后,结果列表将在此容器中进行展示。可选值 |
|
| 在使用map属性时,是否在地图上显示周边搜索的圆或者范围搜索的多边形,默认为true |
|
| 如使用了map或panel属性,renderStyle可以用来设定绘制的UI风格,缺省为'newpc' 可选值:'newpc'或'default','newpc'为带图片展示的新样式,'default'为原有简单样式。 |
|
| 用于控制在搜索结束后,是否自动调整地图视野使绘制的Marker点都处于视口的可见范围 |
方法 | 返回值 | 说明 |
---|---|---|
| 根据关键字搜索,关键字支持中文|中文全拼、繁体、英文 当status为complete时,result为SearchResult; 当status为error时,result为错误信息info; 当status为no_data时,代表检索返回0结果 相关示例 | |
| 根据中心点经纬度、半径以及关键字进行周边查询 radius取值范围:0-50000 status说明同上 相关示例 | |
| 根据范围和关键词进行范围查询 status说明同上相关示例 | |
| 根据POIID 查询POI 详细信息 status说明同上 相关示例 | |
| 设置查询类别,多个类别用“|”分割 默认值:所有类别 | |
| 设置是否强制限制城市 | |
| 设置查询结果特定页数 默认值:1 取值范围:1-100,超过实际页数不返回poi | |
| 设置查询单页结果数 默认值:10 取值范围:1-50,超出取值范围按最大值返回 | |
| 设置查询城市 支持cityname(中文或中文全拼)、citycode、adcode | |
|
| 设置检索语言类型 |
|
| 获取placeSearch检索语言类型 (自v1.3 新增) |
| 清除搜索结果 | |
| 唤起高德地图客户端marker页 Object参数形如: { id: "B000A7BD6C",POIID name:String, 必要参数 location:LngLat|position属性 必须参数 } | |
| 唤起高德地图客户端POI详情页 Object参数形如: { id: "B000A7BD6C",POIID name:String, 必要参数 location:LngLat|position属性 必须参数 } |
事件 | 参数 | 说明 |
---|---|---|
| 当查询成功时触发此事件 | |
| 当查询失败时触发此事件 | |
| 使用map、panel属性后,选中的POI改变时触发 | |
| 使用map、panel属性后,结果面板中POI对应的列表项被点击时触发 | |
| 使用map、panel属性后,POI在地图中对应的Marker被点击时触发 |
SelectChangeEvent对象
属性 | 类型 | 说明 |
---|---|---|
|
| 事件类别 |
|
| 当前选中的POI的ID |
|
| 当前选中的POI对应的在地图中的Marker对象 |
|
| 当前选中的POI在结果面板中对应的列表项 |
| 当前选中的POI的信息 |
SearchResult 对象
PoiList 对象
属性 | 类型 | 说明 |
---|---|---|
|
| Poi列表 |
|
| 页码 |
|
| 单页结果数 |
|
| 查询结果总数 |
CityInfo 对象
属性 | 类型 | 说明 |
---|---|---|
|
| 建议城市名称 |
|
| 城市编码 |
|
| 行政区编码 |
|
| 该城市的建议结果数目 |
Poi 对象
Poi 基本信息
属性 | 类型 | 说明 |
---|---|---|
|
| 全局唯一ID |
|
| 名称 |
|
| 兴趣点类型 |
| 兴趣点经纬度 | |
|
| 地址 |
|
| 离中心点距离,仅周边查询返回 |
|
| 电话 |
Poi 详细信息
属性 | 类型 | 说明 |
---|---|---|
|
| 网址 |
|
| poi所在省份编码 |
|
| poi所在城市编码 |
|
| poi所在区域编码 |
|
| 邮编 |
|
| poi所在省份 |
|
| poi所在城市名称 |
|
| poi所在行政区名称 |
|
| 电子邮箱 |
| 入口经纬度,POI点有出入口信息时返回,否则返回空字符串 | |
| 出口经纬度,POI点有出入口信息时返回,否则返回空字符串 | |
|
| poi是否有团购信息,true为存在团购信息(此字段逐渐废弃) |
|
| poi是否有优惠信息,true为存在优惠信息(此字段逐渐废弃) |
Poi 深度扩展信息
Discount 对象
属性 | 类型 | 说明 |
---|---|---|
|
| 优惠标题 |
|
| 优惠详情 |
|
| 开始时间 |
|
| 结束时间 |
|
| 已卖出数量 |
|
| 已卖出数量 |
| String | 来源url |
| String | 来源标识 |
Groupbuy 对象
属性 | 类型 | 说明 |
---|---|---|
|
| 团购标题 |
|
| 团购分类代码 |
|
| 团购分类 |
|
| 团购详情 |
|
| 团购开始时间 |
|
| 团购结束时间 |
|
| 团购总量 |
| Number | 已卖出数量 |
| Number | 原价 |
| Number | 折扣价 |
| Number | 折扣 |
| String | 取票地址 |
| String | 取票电话 |
| Array.<Photo> | 图片信息 |
| String | 来源url |
| String | 来源标识 |
Dining 对象
属性 | 类型 | 说明 |
---|---|---|
|
| 菜系 |
|
| 标签 |
|
| 简介 |
|
| 综合评分 |
|
| 但数据源的评分 |
|
| 信息来源 |
| String | 口味评分 |
| String | 环境评分 |
| String | 服务评分 |
| String | 人均消费 |
| String | 特色菜 |
| String | 氛围 |
| String | 订餐wap链接 |
| String | 订餐web链接 |
| String | 订餐APP URL |
| String | 规范格式的营业时间 |
| String | 非规范格式的营业时间 |
| String | 餐厅特色 |
| Array.<Photo> | 图片信息列表 |
Hotel 对象
属性 | 类型 | 说明 |
---|---|---|
|
| 综合评分 |
|
| 星级 |
|
| 简介 |
|
| 最低房价 |
|
| 设施评分 |
|
| 卫生评分 |
| String | 环境评分 |
| String | 服务评分 |
| String | 交通提示 |
| String | 特色服务 |
| String | 信息来源 |
| Array.<Photo> | 图片信息列表 |
Cinema 对象
属性 | 类型 | 说明 |
---|---|---|
|
| 简介 |
|
| 综合评分 |
|
| 信息来源 |
|
| 停车场设施 |
| String | 规范格式的营业时间 |
| String | 非规范格式的营业时间 |
| Array.<Photo> | 图片信息列表 |
Scenic 对象
属性 | 类型 | 说明 |
---|---|---|
|
| 简介 |
|
| 综合评分 |
|
| 信息来源 |
|
| 景区国标级别 |
| String | 门票价格 |
| String | 适合游玩的季节 |
| String | 推荐景点 |
| String | 景区主题 |
| String | wap购票链接 |
| String | wab购票链接 |
| String | 规范格式的营业时间 |
| String | 非规范格式的营业时间 |
| Array.<Photo> | 图片信息列表 |
Photo 对象
属性 | 类型 | 说明 |
---|---|---|
|
| 图片名称 |
|
| 图片url |
Content 对象
属性 | 类型 | 说明 |
---|---|---|
|
| POI的唯一标识 |
|
| POI名称 |
AMap.DistrictSearch
AMap.DistrictSearch。
构造函数 | 说明 |
---|---|
| 构造函数,实例化一个行政区查询实例 |
DistrictSearchOptions | 类型 | 说明 |
---|---|---|
|
| 关键字对应的行政区级别或商圈,可选值: country:国家 province:省/直辖市 city:市 district:区/县 biz_area:商圈 |
|
| 是否显示商圈,默认值true 可选为true/false,为了能够精准的定位到街道,特别是在快递、物流、送餐等场景下,强烈建议将此设置为false |
|
| 是否返回行政区边界坐标点 默认值:base,不返回行政区边界坐标点 取值:all,返回完整行政区边界坐标点 |
|
| 显示下级行政区级数(行政区级别包括:国家、省/直辖市、市、区/县4个级别),商圈为区/县下一级 可选值:0、1、2、3 0:不返回下级行政区 1:返回下一级行政区 2:返回下两级行政区 3:返回下三级行政区 默认值:1 |
方法 | 返回值 | 说明 |
---|---|---|
| 根据关键字查询行政区或商圈信息 关键字支持:行政区名、citycode、adcode、商圈名 默认值:“全国” 当status为complete时,result为DistrictSearchResult; 当status为error时,result为错误信息info; 当status为no_data时,代表检索返回0结果 | |
| 设置关键字对应的行政区级别或商圈,可选值: country:国家 province:省/直辖市 city:市 district:区/县 biz_area:商圈 | |
| 设置下级行政区级数(行政区级别包括:国家、省/直辖市、市、区/县4个级别),商圈为区/县下一级,默认值:1 可选值:0、1、2、3 0:不返回下级行政区; 1:返回下一级行政区; 2:返回下两级行政区; 3:返回下三级行政区; |
事件 | 参数 | 说明 |
---|---|---|
| 查询成功时触发此事件 | |
| 当查询失败时触发此事件 |
DistrictSearchResult 对象
属性 | 类型 | 说明 |
---|---|---|
|
| 成功状态文字描述 |
|
| 根据查询条件返回行政区划列表 |
District 对象
AMap.StationSearch
AMap.StationSearch 公交站点查询服务,根据输入关键字、ID查询公交站点信息。用户可以通过自定义回调函数取回并显示查询结果。若服务请求失败,系统将返回错误信息。
构造函数 | 说明 |
---|---|
| 构造一个公交站点查询实例 |
StationSearchOptions | 类型 | 说明 |
---|---|---|
|
| 页码(如pageIndex为2,pageSize为10,那么显示的应是第11-20条返回结果) 默认值:1 取值范围:1-100,超过取值范围按默认,超出实际页数按最大值返回 |
|
| 单页显示结果条数,默认值:20 取值范围:1-100,超过取值范围按默认 |
|
| 公交站点所在城市,默认值:“全国” 可选值:cityname(中文或中文全拼)、citycode、adcode |
方法 | 返回值 | 说明 |
---|---|---|
| 根据给定的公交站点id进行公交站点详情检索,id是公交站点的唯一标识 当status为complete时,result为StationSearchResult; 当status为error时,result为错误信息info; 当status为no_data时,代表检索返回0结果 | |
| 根据给定公交站点名称进行公交站点详情查询,多个关键字用"|"分割 status说明同上 相关示例 | |
| 设置查询结果页码,默认值:1 取值范围:1-100,超过取值范围按默认 | |
| 设置单页显示结果条数,默认值:20 取值范围:1-100,超过取值范围按默认 | |
| 设置查询城市,默认值:“全国” 可选值:cityname(中文或中文全拼)、citycode、adcode |
事件 | 参数 | 说明 |
---|---|---|
| 当查询成功时触发此事件 | |
| 当查询失败时触发此事件 |
StationSearchResult 对象
属性 | 类型 | 说明 |
---|---|---|
|
| 成功状态文字描述 |
|
| 根据查询条件返回公交站点信息 |
|
| 查无此公交站时,返回的建议关键字列表,可根据建议关键字查询 |
|
| 查该城市无此公交站时,返回的建议城市列表 |
StationInfo 对象
Busline 对象
属性 | 类型 | 说明 |
---|---|---|
|
| 公交线路id,该id是唯一标识 |
|
| 公交线路名称 |
| 公交线路途经此站的经纬度 | |
|
| 首发站 |
|
| 终点站 |
AMap.LineSearch
AMap.LineSearch 公交路线查询类,通过extensions属性控制返回信息详略。公交线路信息包括起、终点、途径站点,首、末班车时间等信息。用户可以通过自定义回调函数取回并显示查询结果。若服务请求失败,系统将返回错误信息。
构造函数 | 说明 |
---|---|
| 构造一个公交线路查询实例 |
LineSearchOptions | 类型 | 说明 |
---|---|---|
|
| 页码(如pageIndex为2,pageSize为10,那么显示的应是第11-20条返回结果) 默认值:1 取值范围:1-100,超过取值范围按默认,超出实际页数按最大值返回 |
|
| 单页显示结果条数,默认值:20 取值范围:1-100,超过取值范围按默认 |
|
| 公交线路所在城市,默认值:“全国” 可选值:cityname(中文或中文全拼)、citycode、adcode |
|
| 此项仅公交路线查询时有效,默认值:base,返回公交路线基本信息,当取值为:all,返回公交路线基本信息+详细信息 |
方法 | 返回值 | 说明 |
---|---|---|
| 根据给定的公交线路id进行公交站点详情检索,id是公交线路的唯一标识 当status为complete时,result为LineSearchResult; 当status为error时,result为错误信息info; 当status为no_data时,代表检索返回0结果 | |
| 根据给定公交线路名称进行公交线路详情查询 status说明同上 相关示例 | |
| 设置查询结果页码,默认值:1 取值范围:1-100,超过取值范围按默认 | |
| 设置单页显示结果条数,默认值:20 取值范围:1-100,超过取值范围按默认 | |
| 设置查询城市,默认值:“全国” 可选值:cityname(中文或中文全拼)、citycode、adcode |
事件 | 参数 | 说明 |
---|---|---|
| 当查询成功时触发此事件 | |
| 当查询失败时触发此事件 |
LineSearchResult 对象
LineInfo 对象(基础信息)
属性 | 类型 | 说明 |
---|---|---|
|
| 公交线路id,该id是唯一标识 |
|
| 公交线路名称 |
|
| 公交线路经纬度 |
|
| 公交线路所在城市的城市编码 |
|
| 公交类型列表 |
|
| 公交类型列表 |
|
| 首发站 |
|
| 终点站 |
LineInfo 对象(详细信息)
属性 | 类型 | 说明 |
---|---|---|
|
| 首班车时间 |
|
| 末班车时间 |
|
| 起步票价,单位:元 |
|
| 全程票价,单位:元 |
|
| 途径站,包括首发站和终点站 |
|
| 全程距离,单位:千米 |
| 此公交路线的地理范围 | |
|
| 所属公交公司 |