您当前的位置: 首页> JavaScript API 通用版 > 类参考

Class:服务类/LocalSearch
构造函数
构造函数 描述
LocalSearch(location:Map|Point|KeyPoint|GbPoint|String[, opts:LocalSearchOptions]) 创建一个兴趣点搜索类实例,其中location表示检索区域,其类型可为地图实例、坐标点或城市名称。 (当参数为地图实例时,检索位置由当前地图中心点确定,且支持调整地图视野层级;当参数为坐标时,检索位置由该点所在位置确定;当参数为城市名称时,检索会在该城市内进行。)
LocalSearchOptions
属性 类型 描述
map Map 展现结果的地图实例。当指定此参数后,搜索结果的标注均会自动添加到此地图上。
selectFirstResult Boolean 是否选择第一个检索结果(默认关闭)。
autoViewport Boolean 检索结束后是否自动调整地图视野(默认开启)。
autoBoundary Boolean 检索结束后是否自动显示边界范围(仅限行政区关键字检索,默认关闭)。(自 1.1 新增)
onSearchComplete Function 检索完成后的回调函数。 参数:results: LocalResult。
onMarkersSet Function 标注添加完成后的回调函数。 参数: pois: Array, 通过marker属性可得到其对应的标注。
pageSize Number 设置每页条数。 取值范围:1–100,默认为10。
方法
方法 返回值 描述
setLocation(location: Map|Point|KeyPoint|GbPoint|String) none 设置检索范围,参数类型可以为地图实例、坐标点或城市名称。例:setLocation("深圳市")
setSearchCompleteCallback (callback:Function) none 设置检索结束后的回调函数。 参数:results: LocalResult。
search(keyword:String) none 根据检索词发起检索。
searchByTcode(types:Array< String >) none 根据POI分类发起检索。 (types为POI分类, POI分类编码详见附表)
searchInBounds(keyword:String, bounds:Bounds [,options: Object]) none 根据范围和检索词发起范围检索。 (option:{types:Array< String >} types为POI分类,0为全部、POI分类编码详见附表,默认为全部)。
searchNearby(keyword:String, center: Point|KeyPoint|GbPoint, radius:Number [,options: Object]) none 根据中心点、半径与检索词发起周边检索。 (option:{types:Array< String >} types为POI分类,0为全部、POI分类编码详见附表,默认为全部)。
getResults() LocalResult 返回最近一次检索的结果。
clearResults() none 清除最近一次检索的结果。
gotoPage(page:Number) none 检索指定页面的结果。 (page的序号从1开始,1代表第1页,序号不能超过总页数)。
setMarkersSetCallback(callback:Function) none 设置添加标注后的回调函数。 参数: pois: Array< LocalResultPoi >, 通过marker属性可得到其对应的标注。
setPageSize(size: Number) none 设置每页条数。 取值范围:1–100,默认为10。
getPageSize() none 返回每页条数。
enableAutoViewport() none 启用根据结果自动调整地图层级,当指定了搜索结果所展现的地图时有效。
disableAutoViewport() none 禁用根据结果自动调整地图层级。
enableFirstResultSelection() none 启用自动选择第一个检索结果。
disableFirstResultSelection() none 禁用自动选择第一个检索结果。
getStatus() Object 返回检索结果状态。返回对象包含如下属性: errcode:Number,errmsg:String。