51ditu Search API 类参考文档2008-6-10 [更新到1]

本文档是灵图提供的51ditu Search api的类参考文档,用来实现本地搜索的功能,更多详细的使用范例和说明请访问51ditu API开发文档页面,API使用交流清访问51ditu产品论坛

类列表:
LTLocalSearch  LTLocalSearchResult  LTLocalSearchPoint 

类 LTLocalSearch

51ditu Search API之中的搜索类,这也是Search API的最主要的类,用来进行搜索操作,需要注意的是,因为搜索过程采用的是异步操作,因此运行搜索之后并不能立即得到搜索结果,而是传递一个[搜索结果处理函数]给搜索类,在搜索结果得到后,搜索类会自动的运行该[搜索结果处理函数]并将搜索结果作为参数传递,这样用户就可以得到并处理搜索结果。
构造函数:
函数名称最后更新版本返回值类型说明
LTLocalSearch(handle) LTLocalSearch创建一个搜索类,一个页面上可以根据需求创建多个搜索类
  • 范例:分页查找
  • 范例:拉框查找
  • 范例:基本搜索范例
  • 范例:点图查找
  • 范例:显示中心点
  • 范例:在地图上显示搜索结果
  • 范例:使用多个搜索结果
  • 范例:周边查找
  • 方法:
    函数名称最后更新版本返回值类型说明
    setCity(city) 设置搜索城市,如果不先指定搜索的城市,将不会开始搜索
    search(words,area?,start?) 用指定的关键词运行搜索,注意该函数并不能直接返回搜索结果(必须先指定城市)
    searchPage(page) Bool向服务器搜索指定页的结果,该函数必须在search方法运行过并且已经返回了搜索结果之后才能运行(否则无法知道搜索结果一共有多少页),将以search方法之中指定的关键词进行搜索,因此不需要再次指定关键字,注意该函数并不能直接返回搜索结果,而是返回该操作是否成功的指示,如果该页不存在或者不知道该次搜索的总页数,则会返回false,否则返回true
    firstPage() Bool向服务器搜索第一页的搜索结果,类似于searchPage方法。
    nextPage() Bool向服务器搜索下一页的搜索结果,类似于searchPage方法。
    previousPage() Bool向服务器搜索上一页的搜索结果,类似于searchPage方法。
    lastPage() Bool向服务器搜索最后一页的搜索结果,类似于searchPage方法。
    searchRadius(radius) 0.7Bool向服务器搜索指定半径的搜索结果,只在周边查找之中有用,类似于searchPage方法。
    getTotalNumber() Number获取总的搜索结果数目
    getTotalPage() Number获取总的搜索结果页数
    属性:
    属性名称最后更新版本值类型说明
    modeaNumber 0或1,代表中心点的匹配模式,0代表模糊匹配,1代表精确匹配,默认值为0
    modeNumber 0或1,代表关键词的匹配模式,0代表模糊匹配,1代表精确匹配,默认值为0
    areaNumNumber 1-10,代表中心点的匹配数目,如果中心点area有多个匹配,该项指定返回多少个中心点的匹配,默认值为1
    pagecapNumber 1-100,代表每一页搜索的结果数,默认值为10
    radiusNumber 搜索范围半径,以米为单位,默认为5000(5千米)
    事件:
    事件名称最后更新版本参数说明
    loadend (searchResult) 在每次获得搜索结果时触发,将会把搜索结果类作为事件参数返回,使用此事件可以不必在LTLocalSearch的构造函数之中传递参数,而且可以实现多个搜索结果处理函数,因此具有更大的灵活性
    返回顶部

    类 LTLocalSearchResult

    搜索结果对象,将返回给用户处理,包含所有的搜索结果信息,没有构造函数。
    方法:
    函数名称最后更新版本返回值类型说明
    getPageIndex() Number返回当前对象是第几页的搜索结果
    getSearchPointsNumber() Number返回本页搜索结果的数目
    addSearchPoint(poi) 向搜索结果添加一条自己创建的的LTLocalSearchPoint数据
    属性:
    属性名称最后更新版本值类型说明
    errorNumber 是否在查询过程之中出错,为0代表正常,其他值代表出错,这种情况下,就可能没有搜索结果
    searchPointsPOILTLocalSearchPoint数组 包含关键词搜索结果的数组
    centerPointsPOILTLocalSearchPoint数组 包含中心点搜索结果的数组
    返回顶部

    类 LTLocalSearchPoint

    搜索结果POI对象,代表搜索结果之中的一条记录,可以构造该类并添加到搜索结果之中
    构造函数:
    函数名称最后更新版本返回值类型说明
    LTLocalSearchPoint(point) LTLocalSearchPoint创建一个POI对象
    属性:
    属性名称最后更新版本值类型说明
    pointArray 该POI的NTU坐标,point[0]是NTU经度坐标,point[1]是NTU纬度坐标
    idNumber 该POI点在搜索结果之中的序号,如果有分页,这是所有结果之中的序号
    nameString POI名称,如'北京灵图软件技术有限公司'
    urlString 包含该点详细信息的网址,如"http://detail.51ditu.com/html/11/1/479009793.html"
    返回顶部