Class PlaceSearch

地点检索组件 支持关键字检索、周边检索、范围检索，结果以列表展示，可翻页；通过 on('load' | 'select') 监听结果与选中项。

Hierarchy

  • BaseWidget
    • PlaceSearch

Constructors

constructor

Properties

container root

Methods

search searchNearby searchInBounds prevPage nextPage goToPage on off destroy render getRoot emit

Constructors

constructor

  • new PlaceSearch(container, options): PlaceSearch

  • Parameters

    • container: string | HTMLElement

      挂载容器选择器或 DOM 元素

    • options: PlaceSearchOptions

      配置项，map 必传

    Returns PlaceSearch

Properties

Protectedcontainer

container: HTMLElement

Protectedroot

root: HTMLElement = null

Methods

search

  • search(keyword, option?): Promise<void>

  • 关键字检索

    Parameters

    • keyword: string

      检索关键词

    • Optionaloption: {
          city?: string;
      }

      可选，如 city 限定城市

      • Optionalcity?: string

    Returns Promise<void>

searchNearby

  • searchNearby(keyword, center, radius?): Promise<void>

  • 周边检索

    Parameters

    • keyword: string

      检索关键词

    • center: Point

      中心点坐标

    • Optionalradius: number

      半径（米），默认 2000

    Returns Promise<void>

searchInBounds

  • searchInBounds(keyword, bounds): Promise<void>

  • 范围检索（在指定矩形范围内检索）

    Parameters

    • keyword: string

      检索关键词

    • bounds: {
          sw: Point;
          ne: Point;
      }

      西南角 sw、东北角 ne 坐标

      • sw: Point
      • ne: Point

    Returns Promise<void>

prevPage

  • prevPage(): void

  • 上一页（仅在已有检索结果且当前页大于 1 时有效）

    Returns void

nextPage

  • nextPage(): void

  • 下一页（沿用上次检索条件请求下一页）

    Returns void

goToPage

  • goToPage(page): void

  • 跳转到指定页

    Parameters

    • page: number

      页码，从 1 开始

    Returns void

on

  • on(event, handler): this

  • 监听事件，支持 load、select 事件

    Parameters

    • event: "select" | "load"

      事件名

    • handler: EventHandler

      事件处理函数

    Returns this

    组件实例

off

  • off(event, handler?): this

  • 移除事件监听，支持 load、select 事件

    Parameters

    • event: "select" | "load"

      事件名

    • Optionalhandler: EventHandler

      可选，要移除的回调；不传则移除该事件的全部监听

    Returns this

    组件实例

destroy

  • destroy(): void

  • Returns void

Protectedrender

  • render(): void

  • Override in subclass to build DOM

    Returns void

ProtectedgetRoot

  • getRoot(): HTMLElement

  • Get or create root node

    Returns HTMLElement

Protectedemit

  • emit(event, ...args): void

  • Parameters

    • event: string
    • Rest...args: unknown[]

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods