Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LayerGroup<L>

Type parameters

  • L = any

Hierarchy

Index

Constructors

Methods

Constructors

constructor

  • new LayerGroup<L>(layers: L | L[]): LayerGroup<L>

  • 图层集合

    Type parameters

    • L = any

    Parameters

    • layers: L | L[]

      集合中的图层

    Returns LayerGroup<L>

Methods

addLayer

  • 添加单个图层到集合中，不支持添加重复的图层

    Parameters

    • layer: L | L[]

      图层

    Returns LayerGroup<L>

addLayers

  • 添加图层数组到集合中，不支持添加重复的图层

    Parameters

    • layers: L | L[]

      图层数组

    Returns LayerGroup<L>

clearLayers

  • 清空集合

    Returns LayerGroup<L>

eachLayer

  • eachLayer<C>(iterator: (layer: L, index: number, list: L[]) => void, context?: C): void

  • 对集合中的图层做迭代操作

    Type parameters

    • C = L

    Parameters

    • iterator: (layer: L, index: number, list: L[]) => void

      迭代回调

        • (layer: L, index: number, list: L[]): void

        • Parameters

          • layer: L
          • index: number
          • list: L[]

          Returns void

    • Optional context: C

      执行上下文

    Returns void

emit

  • emit(eventName: string, data?: any): LayerGroup<L>

  • 触发事件

    Parameters

    • eventName: string

      事件名称

    • Optional data: any

      事件数据

    Returns LayerGroup<L>

getContainer

  • getContainer(): HTMLDivElement

  • 图层获取DOM节点

    Returns HTMLDivElement

getLayer

  • getLayer(finder: (item: L, index: number, list: L[]) => boolean): L

  • Parameters

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

        • Parameters

          • item: L
          • index: number
          • list: L[]

          Returns boolean

    Returns L

getLayers

  • getLayers(): L[]

  • 返回当前集合中所有的图层

    Returns L[]

getMap

  • getMap(): Map

  • 获取图层所属地图

    Returns Map

getOpacity

  • getOpacity(): number

  • 设置透明度

    Returns number

getZooms

  • getZooms(): [number, number]

  • 获取图层缩放范围

    Returns [number, number]

getzIndex

  • getzIndex(): number

  • 获取图层的层级

    Returns number

hasLayer

  • hasLayer(layer: L | ((item: L, index: number, list: L[]) => boolean)): boolean

  • 判断传入的图层实例是否在集合中

    Parameters

    • layer: L | ((item: L, index: number, list: L[]) => boolean)

      目标图层

    Returns boolean

hide

  • 隐藏图层

    Returns LayerGroup<L>

off

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

  • 移除事件绑定

    Type parameters

    Parameters

    • eventName: string

      事件名称

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

      事件功能函数

    • Optional context: C

      事件上下文

    Returns LayerGroup<L>

on

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

  • 注册事件

    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 LayerGroup<L>

reload

  • Returns LayerGroup<L>

removeLayer

  • 从集合中删除传入的图层实例

    Parameters

    • layer: L | L[]

      图层

    Returns LayerGroup<L>

removeLayers

  • 从集合中删除传入的图层实例数组

    Parameters

    • layers: L | L[]

      图层数组

    Returns LayerGroup<L>

setMap

  • 设置图层所属地图

    Parameters

    • Optional map: Map

    Returns LayerGroup<L>

setOpacity

  • setOpacity(alpha: number): void

  • 设置透明度

    Parameters

    • alpha: number

      透明度

    Returns void

setOptions

  • Parameters

    • options: any

    Returns LayerGroup<L>

setzIndex

  • setzIndex(index: number): void

  • 设置图层的层级

    Parameters

    • index: number

      层级

    Returns void

show

  • 显示图层

    Returns LayerGroup<L>

Generated using TypeDoc