Class LayerGroup

Parent (abstract) class for a layer group. Helps to manipulate one layer group. The child class must start by setting the layerGroup.

Hierarchy (View Summary)

LayerGroup
- BackgroundLayerGroup
- OverlayLayerGroup

Index

Constructors

Accessors

Methods

addLayer clearAll getAllSources getAttributions getLayer getLayerGroup refreshSource

Constructors

constructor

new LayerGroup(map: Map, layerGroupUid: string): LayerGroup
Parameters
- map: Map
- layerGroupUid: string
Returns LayerGroup
- Defined in layer/layer-group.ts:47

Accessors

layerAdded

get layerAdded(): Subject<BaseLayer>
Returns Subject<BaseLayer>
an observables that notify addition of layer in this group.
- 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
- Defined in layer/layer-group.ts:86

clearAll

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

Returns void
- Defined in layer/layer-group.ts:72

getAllSources

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

getAttributions

getAttributions(): string[]
Returns string[]
The attribution of all visible layers.
- 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.
- Defined in layer/layer-group.ts:98

getLayerGroup

getLayerGroup(): LayerGroup
Returns LayerGroup
the layer group of this instance.
- 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
- Defined in layer/layer-group.ts:127