Interface GroupLayerCollection

Contains Layer instances that belong to a GroupLayer

interface GroupLayerCollection {
    destroy(): void;
    getItems(options?: LayerRetrievalOptions): Layer[];
    getLayers(options?: LayerRetrievalOptions): Layer[];
    getRecursiveLayers(options?: RecursiveRetrievalOptions): AnyLayer[];
}

Implements

ChildrenCollection<Layer>

Index

Methods

destroy getItems getLayers getRecursiveLayers

Methods

destroy

destroy(): void
Destroys this collection, all contained layers are detached from their parent group layer

Returns void
- Defined in src/packages/map/layers/group/GroupLayerCollection.ts:51

getItems

getItems(options?: LayerRetrievalOptions): Layer[]
Returns the items in this collection.
Parameters
- Optionaloptions: LayerRetrievalOptions
Returns Layer[]
Implementation of ChildrenCollection.getItems
- Defined in src/packages/map/layers/group/GroupLayerCollection.ts:60

getLayers

getLayers(options?: LayerRetrievalOptions): Layer[]
Returns all layers in this collection
Parameters
- Optionaloptions: LayerRetrievalOptions
Returns Layer[]
- Defined in src/packages/map/layers/group/GroupLayerCollection.ts:67

getRecursiveLayers

getRecursiveLayers(options?: RecursiveRetrievalOptions): AnyLayer[]
Returns a list of all layers in the collection, including all children (recursively).

Note: This includes base layers by default (see options.filter). Use the "base" or "operational" short hand values to filter by base layer or operational layers.

If the group contains many, deeply nested sub groups, this function could potentially be expensive.
Parameters
- Optionaloptions: RecursiveRetrievalOptions
Returns AnyLayer[]
- Defined in src/packages/map/layers/group/GroupLayerCollection.ts:86