Interface GroupLayerCollection

Contains Layer instances that belong to a GroupLayer

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

Hierarchy (View Summary)

ChildrenCollection<Layer>
- GroupLayerCollection

Index

Methods

getItems getLayers getRecursiveLayers

Methods

getItems

getItems(options?: LayerRetrievalOptions): Layer[]
Returns the items in this collection.
Parameters
- Optionaloptions: LayerRetrievalOptions
Returns Layer[]
Inherited from ChildrenCollection.getItems
- Defined in api/layers/base.ts:249

getLayers

getLayers(options?: LayerRetrievalOptions): Layer[]
Returns all layers in this collection
Parameters
- Optionaloptions: LayerRetrievalOptions
Returns Layer[]
- Defined in api/layers/GroupLayer.ts:52

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 api/layers/GroupLayer.ts:62