我要地图-地图API-搜索接口-类参考

地图接口

搜索接口

标注接口

IP定位接口

| LTLocalSearchResult

| LTLocalSearchPoint

类 LTLocalSearch

51ditu Search API之中的搜索类，这也是Search API的最主要的类，用来进行搜索操作，需要注意的是，因为搜索过程采用的是异步操作，因此运行搜索之后并不能立即得到搜索结果，而是传递一个[搜索结果处理函数]给搜索类，在搜索结果得到后，搜索类会自动的运行该[搜索结果处理函数]并将搜索结果作为参数传递，这样用户就可以得到并处理搜索结果。

构建函数

函数名称	最后更新版本	返回值类型	说明
LTLocalSearch(handle 说　明：用来处理搜索结果的函数类　型：Function )		LTLocalSearch	创建一个搜索类，一个页面上可以根据需求创建多个搜索类范例：分页查找范例：拉框查找范例：基本搜索范例范例：点图查找范例：显示中心点范例：在地图上显示搜索结果范例：使用多个搜索结果范例：周边查找范例：视野内查找范例：道路周边搜索范例：圆形搜索

方法

函数名称	最后更新版本	返回值类型	说明
setCity(city 说　明：城市名称，如："北京"(注：拼音无效) 类　型：String )		无	设置搜索城市,如果不先指定搜索的城市，将不会开始搜索
search(words 说　明：搜索关键字,如：“饭店” 类　型：String ,area? 说　明：指定在某地方周边搜索，如“中关村”，默认不指定，即在整个城市搜索；可以为如下几种值： 1.搜索关键词，字符串 2.一个LTPoint点,该对象在51ditu maps api里面定义，使用LTPoint会在该点附近搜索 3.一个LTBounds区域,该对象在51ditu maps api里面定义，使用LTBounds会在该区域内搜索，而忽略radius属性的值类　型：String 或 LTPoint 或 LTBounds 默认值："" ,start? 说　明：搜索结果从第几页开始类　型：Number 默认值：1 )		无	用指定的关键词运行搜索，注意该函数并不能直接返回搜索结果（必须先指定城市）
searchPage(page 说　明：指定获取第几页的搜索结果类　型：Number )		Bool	向服务器搜索指定页的结果，该函数必须在search方法运行过并且已经返回了搜索结果之后才能运行(否则无法知道搜索结果一共有多少页)，将以search方法之中指定的关键词进行搜索，因此不需要再次指定关键字，注意该函数并不能直接返回搜索结果，而是返回该操作是否成功的指示，如果该页不存在或者不知道该次搜索的总页数，则会返回false,否则返回true
firstPage()		Bool	向服务器搜索第一页的搜索结果，类似于searchPage方法。
nextPage()		Bool	向服务器搜索下一页的搜索结果，类似于searchPage方法。
previousPage()		Bool	向服务器搜索上一页的搜索结果，类似于searchPage方法。
lastPage()		Bool	向服务器搜索最后一页的搜索结果，类似于searchPage方法。
searchRadius(radius 说　明：指定的搜索半径，单位为米类　型：Number )	0.7	Bool	向服务器搜索指定半径的搜索结果，只在周边查找之中有用，类似于searchPage方法。
getTotalNumber()		Number	获取总的搜索结果数目
getTotalPage()		Number	获取总的搜索结果页数
setWords(word 说　明：关键词类　型：String )		无	设置关键词
setArea(area 说　明：area的值由setAreaType定义的的值有关联，请参考setAreaType方法说明 )		无	设置空间搜索内容
setCirclerRadius(radius 说　明：圆搜索的半径，半径单位米类　型：Number )		无	当setAreaType方法的输入值为CIRCLE时，此方法有效，设置圆形搜索的半径
setAreaType(type 说　明：搜索类型，类型分别为WORD关键字搜索,POINT点搜索，LINESTRING道路搜索，CIRCLE圆形搜索，RECT矩形搜索，POLYGON面搜索类　型：String )		无	当使用setAreaType方法定义类型后，在调用search方法时，不需要传入任何参数，否则不会有任何返回值。当使用setAreaType方法定义类型后，setArea方法输入的参数与setAreaType方法定义类型有关联，关联如下： 1、输入类型为WORD，传入参数为关键词。 2、输入类型为POINT，传入参数为经纬度或数组（数组下标0表示经度，1表示纬度）。 3、输入类型为LINESTRING，传入参数为数组（装载LTPoint对象的数组）。 4、输入类型为CIRCLE，传入参数为中心点经纬度或传入参数为数组，数组下标0表示经度，1表示纬度（通过setCirclerRadius方法设置半径。注：此时radius属性失效）。 5、输入类型为RECT，传入参数为数组，数组下标0为左下角坐标经度、1为左下角坐标纬度、2为左下角坐标经度、3为左下角坐标纬度或输入的参数为LTBounds对象（注：此时radius属性失效）。 6、输入类型为POLYGON，传入参数为数组（装载LTPoint对象的数组。注：此时radius属性失效）。注：只要search方法在使用时，有参数传入，setAreaType、setWords、setArea、setCirclerRadius等方法无法使用。

属性

属性名称	最后更新版本	值类型	说明
modea		Number 类　型：Number 默认值：0	0或1，代表中心点的匹配模式，0代表模糊匹配，1代表精确匹配，默认值为0
mode		Number 类　型：Number 默认值：0	0或1，代表关键词的匹配模式，0代表模糊匹配，1代表精确匹配，默认值为0
areaNum		Number 类　型：Number 默认值：1	1-10，代表中心点的匹配数目，如果中心点area有多个匹配，该项指定返回多少个中心点的匹配，默认值为1
pagecap		Number 类　型：Number 默认值：1	1-100，代表每一页搜索的结果数，默认值为10
radius		Number 类　型：Number 默认值：5000	搜索范围半径，以米为单位，默认为5000(5千米)

事件

事件名称	最后更新版本	参数	说明
loadend		(searchResult 说　明：搜索结果类类　型：LTLocalSearchResult )	在每次获得搜索结果时触发，将会把搜索结果类作为事件参数返回，使用此事件可以不必在LTLocalSearch的构造函数之中传递参数，而且可以实现多个搜索结果处理函数，因此具有更大的灵活性

类 LTLocalSearchResult

搜索结果对象，将返回给用户处理，包含所有的搜索结果信息，没有构造函数。

方法

函数名称	最后更新版本	返回值类型	说明
getPageIndex()		Number	返回当前对象是第几页的搜索结果
getSearchPointsNumber()		Number	返回本页搜索结果的数目
addSearchPoint(poi 说　明：用户自定义的LTLocalSearchPoint数据类　型：LTLocalSearchPoint )		无	向搜索结果添加一条自己创建的的LTLocalSearchPoint数据

属性

属性名称	最后更新版本	值类型	说明
error		Number 类　型：Number 默认值：0	是否在查询过程之中出错，为0代表正常，其他值代表出错，这种情况下，就可能没有搜索结果
searchPoints		POILTLocalSearchPoint数组类　型：POILTLocalSearchPoint数组	包含关键词搜索结果的数组
centerPoints		POILTLocalSearchPoint数组类　型：POILTLocalSearchPoint数组	包含中心点搜索结果的数组

类 LTLocalSearchPoint

搜索结果POI对象，代表搜索结果之中的一条记录，可以构造该类并添加到搜索结果之中

构造函数

函数名称	最后更新版本	返回值类型	说明
LTLocalSearchPoint(point 说　明：该POI的地理位置,可以为数组或LTPoint对象，为数组时point[0]为NTU经度坐标，point[1]为纬度坐标类　型：Array 或 LTPoint )		LTLocalSearchPoint	创建一个POI对象

属性

属性名称	最后更新版本	值类型	说明
point		Array 类　型：Array	该POI的NTU坐标，point[0]是NTU经度坐标,point[1]是NTU纬度坐标
id		Number 类　型：Number	该POI点在搜索结果之中的序号，如果有分页，这是所有结果之中的序号
name		String 类　型：String	POI名称，如'北京灵图软件技术有限公司'