Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OverlayGroup<O, ExtraData>

Type parameters

Hierarchy

Index

Constructors

Methods

Constructors

constructor

  • new OverlayGroup<O, ExtraData>(overlays?: O | O[]): OverlayGroup<O, ExtraData>

  • 覆盖物集合

    Type parameters

    Parameters

    • Optional overlays: O | O[]

      覆盖物

    Returns OverlayGroup<O, ExtraData>

Methods

addOverlay

  • 添加单个覆盖物到集合中，不支持添加重复的覆盖物

    Parameters

    • overlay: O | O[]

      覆盖物

    Returns OverlayGroup<O, ExtraData>

addOverlays

  • 添加覆盖物数组到集合中，不支持添加重复的覆盖物

    Parameters

    • overlay: O | O[]

      覆盖物数组

    Returns OverlayGroup<O, ExtraData>

clearOverlays

  • 清空集合

    Returns OverlayGroup<O, ExtraData>

eachOverlay

  • eachOverlay<C>(iterator: (overlay: O, index: number, overlays: O[]) => void, context?: C): OverlayGroup<O, ExtraData>

  • 对集合中的覆盖物做迭代操作

    Type parameters

    • C = O

    Parameters

    • iterator: (overlay: O, index: number, overlays: O[]) => void

      迭代回调

        • (overlay: O, index: number, overlays: O[]): void

        • Parameters

          • overlay: O
          • index: number
          • overlays: O[]

          Returns void

    • Optional context: C

      执行上下文

    Returns OverlayGroup<O, ExtraData>

emit

  • emit(eventName: string, data?: any): OverlayGroup<O, ExtraData>

  • 触发事件

    Parameters

    • eventName: string

      事件名称

    • Optional data: any

      事件数据

    Returns OverlayGroup<O, ExtraData>

getExtData

  • getExtData(): {} | ExtraData

  • 获取自定义数据

    Returns {} | ExtraData

getHeight

  • getHeight(): string | number

  • Returns string | number

getMap

  • getMap(): Map

  • 获取所属地图

    Returns Map

getOverlay

  • getOverlay(finder: O | ((item: O, index: number, list: O[]) => boolean)): O

  • 查找集合中的覆盖物

    Parameters

    • finder: O | ((item: O, index: number, list: O[]) => boolean)

      查找回调

    Returns O

getOverlays

  • getOverlays(): O[]

  • 返回当前集合中所有的覆盖物

    Returns O[]

hasOverlay

  • hasOverlay(overlay: O | ((item: O, index: number, list: O[]) => boolean)): boolean

  • 判断传入的覆盖物实例是否在集合中

    Parameters

    • overlay: O | ((item: O, index: number, list: O[]) => boolean)

      覆盖物

    Returns boolean

hide

  • 在地图上隐藏集合中覆盖物

    Returns OverlayGroup<O, ExtraData>

off

  • off<C>(eventName: string, handler: "mv" | ((event: any) => void), context?: C): OverlayGroup<O, ExtraData>

  • 移除事件绑定

    Type parameters

    Parameters

    • eventName: string

      事件名称

    • handler: "mv" | ((event: any) => void)

      事件功能函数

    • Optional context: C

      事件上下文

    Returns OverlayGroup<O, ExtraData>

on

  • on<C>(eventName: string, handler: (event: any) => void, context?: C, once?: boolean, unshift?: boolean): OverlayGroup<O, ExtraData>

  • 注册事件

    Type parameters

    Parameters

    • eventName: string

      事件名称

    • handler: (event: any) => void

      事件回调函数

        • (event: any): void

        • Parameters

          • event: any

          Returns void

    • Optional context: C

      事件回调中的上下文

    • Optional once: boolean

      触发一次

    • Optional unshift: boolean

      更改事件顺序

    Returns OverlayGroup<O, ExtraData>

removeOverlay

  • removeOverlay(overlay: O | O[]): OverlayGroup<O, ExtraData>

  • 从集合中删除传入的覆盖物实例

    Parameters

    • overlay: O | O[]

      覆盖物

    Returns OverlayGroup<O, ExtraData>

removeOverlays

  • removeOverlays(overlay: O | O[]): OverlayGroup<O, ExtraData>
  • 从集合中删除传入的覆盖物实例数组

    Parameters

    • overlay: O | O[]

      覆盖物数组

    Returns OverlayGroup<O, ExtraData>

setExtData

  • setExtData(extData: ExtraData): void

  • 设置自定义数据

    Parameters

    • extData: ExtraData

      自定义数据

    Returns void

setHeight

  • setHeight(height?: string | number): void

  • Parameters

    • Optional height: string | number

    Returns void

setMap

  • 指定集合中里覆盖物的显示地图

    Parameters

    • map: Map

      地图

    Returns OverlayGroup<O, ExtraData>

setOptions

  • setOptions(options: ReferOverlayOptions<O>): OverlayGroup<O, ExtraData>

  • 修改覆盖物属性

    Parameters

    • options: ReferOverlayOptions<O>

      属性

    Returns OverlayGroup<O, ExtraData>

show

  • 在地图上显示集合中覆盖物

    Returns OverlayGroup<O, ExtraData>

Generated using TypeDoc