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

Accessors

Methods

addLayer clearAll getAllSources getAttributions getLayer getLayerGroup refreshSource 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:12

Accessors

layerAdded

get layerAdded(): Subject<BaseLayer>
Returns Subject<BaseLayer>
an observables that notify addition of layer in this group.
Inherited from LayerGroup.layerAdded
- Defined in layer/layer-group.ts:55

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:86

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:72

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:134

getAttributions

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

getLayer

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

getLayerGroup

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

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:127

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:22