Class BackgroundLayerGroup

LayerGroup specialized to manage background layers (mostly tiled layers). Each instance must have a unique name (The default name will be valid for the first group). The default position is 0.

Hierarchy (View Summary)

LayerGroup
- BackgroundLayerGroup

Index

Constructors

Properties

Methods

addLayer clearAll dispatchLayerAffected dispatchLayerPropertyChanged getAllSources getAttributions getFirstVisible getLayer getLayerGroup refreshSource setLayerProperty toggleVisible

Constructors

constructor

new BackgroundLayerGroup(
map: Map,
options?: LayerGroupOptions,
): BackgroundLayerGroup
Parameters
- map: Map
- options: LayerGroupOptions = {}
Returns BackgroundLayerGroup
Overrides LayerGroup.constructor
- Defined in layer/background-layer-group.ts:14

Properties

on

on: LayerGroupOnSignature

once

once: LayerGroupOnSignature

un

un: LayerGroupOnSignature

Methods

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
Inherited from LayerGroup.addLayer
- Defined in layer/layer-group.ts:123

clearAll

clearAll(): void
Remove all layers from the map and clear the layer group.

Returns void
Inherited from LayerGroup.clearAll
- Defined in layer/layer-group.ts:109

dispatchLayerAffected

dispatchLayerAffected(layerUid: string, reason: string): void
Fires an "affected" layer event.
Parameters
- layerUid: string
- reason: string
Returns void
Inherited from LayerGroup.dispatchLayerAffected
- Defined in layer/layer-group.ts:191

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
Inherited from LayerGroup.dispatchLayerPropertyChanged
- Defined in layer/layer-group.ts:198

getAllSources

getAllSources(): Source[]
Returns Source[]
Every source from layers having sources in the layer group.
Inherited from LayerGroup.getAllSources
- Defined in layer/layer-group.ts:167

getAttributions

getAttributions(): string[]
Returns string[]
The attribution of all visible layers.
Inherited from LayerGroup.getAttributions
- Defined in layer/layer-group.ts:146

getFirstVisible

getFirstVisible(): BaseLayer | null
Returns BaseLayer | null
the first visible layer, or null if none is visible.
- Defined in layer/background-layer-group.ts:24

getLayer

getLayer(layerUid: string): BaseLayer | null
Retrieve a layer currently in the layer group.
Parameters
- layerUid: string
Returns BaseLayer | null
The matching layer or null.
Inherited from LayerGroup.getLayer
- Defined in layer/layer-group.ts:134

getLayerGroup

getLayerGroup(): LayerGroup
Returns LayerGroup
the layer group of this instance.
Inherited from LayerGroup.getLayerGroup
- Defined in layer/layer-group.ts:102

refreshSource

refreshSource(): void
Refresh the source of every layer with a source in the layer group.

Returns void
Inherited from LayerGroup.refreshSource
- Defined in layer/layer-group.ts:160

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
Inherited from LayerGroup.setLayerProperty
- Defined in layer/layer-group.ts:179

toggleVisible

toggleVisible(layerUid: string): void
Set one background layer as visible, all others as not visible.
Parameters
- layerUid: string
Returns void
- Defined in layer/background-layer-group.ts:36