Class LayerGroup

constructor

• new LayerGroup(map: Map): LayerGroup

  Parameters

  • map: Map

  Returns LayerGroup

on

once

un

addLayer

• addLayer(layer: BaseLayer, layerUid: string): void

  Add a single layer at the end of the layer group.

  Parameters

  • layer: BaseLayer

    Ol layer.

  • layerUid: string

    id of the layer.

  Returns void

clearAll

• clearAll(): void

  Remove all layers from the map and clear the layer group.

  Returns void

dispatchLayerAffected

• dispatchLayerAffected(layerUid: string, reason: string): void

  Fires an "affected" layer event.

  Parameters

  • layerUid: string
  • reason: string

  Returns void

dispatchLayerPropertyChanged

• dispatchLayerPropertyChanged(layerUid: string, propertyKey: string): void

  Fires a "LayerPropertyChanged" and call a "changed" event on the matching OL layer.

  Parameters

  • layerUid: string
  • propertyKey: string

  Returns void

findLayer

• findLayer(layerUid: string): BaseLayer<{ [x: string]: any }> | null

  Retrieve a layer currently in the layer group.

  Parameters

  • layerUid: string

  Returns BaseLayer<{ [x: string]: any }> | null

  The matching layer or null.

findLayersStartsWith

• findLayersStartsWith(layerUidPrefix: string): BaseLayer<{ [x: string]: any }>[]

  Retrieve all layers currently in the layer group that start with a specific UID.

  Parameters

  • layerUidPrefix: string

  Returns BaseLayer<{ [x: string]: any }>[]

  An array of matching layers.

getAllSources

• getAllSources(): Source[]

  Returns Source[]

  Every source from layers having sources in the layer group.

getAttributions

• getAttributions(): string[]

  Returns string[]

  The attribution of all visible layers.

getLayerGroup

• getLayerGroup(): LayerGroup

  Returns LayerGroup

  the layer group of this instance.

refreshSource

• refreshSource(): void

  Refresh the source of every layer with a source in the layer group.

  Returns void

setLayerProperty

• setLayerProperty(layerUid: string, propertyKey: string, value: unknown): void

  Set a property of a layer and fires a "LayerPropertyChanged" event if the value has changed.

  Parameters

  • layerUid: string
  • propertyKey: string
  • value: unknown

  Returns void