Interface SublayersCollection<SublayerType>

Contains the sublayers that belong to a Layer or Sublayer.

interface SublayersCollection<SublayerType extends SublayerBaseType> {
    destroy(): void;
    getItems(options?: LayerRetrievalOptions): SublayerType[];
    getRecursiveLayers(options?: RecursiveRetrievalOptions): WMSSublayer[];
    getSublayers(options?: LayerRetrievalOptions): SublayerType[];
}

Type Parameters

SublayerType extends SublayerBaseType

Implements

ChildrenCollection<SublayerType>

Index

Methods

destroy getItems getRecursiveLayers getSublayers

Methods

destroy

destroy(): void
Returns void
- Defined in layers/shared/SublayersCollection.ts:31

getItems

getItems(options?: LayerRetrievalOptions): SublayerType[]
Returns the items in this collection.
Parameters
- Optionaloptions: LayerRetrievalOptions
Returns SublayerType[]
Implementation of ChildrenCollection.getItems
- Defined in layers/shared/SublayersCollection.ts:39

getRecursiveLayers

getRecursiveLayers(options?: RecursiveRetrievalOptions): WMSSublayer[]
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 collection contains many, deeply nested sublayers, this function could potentially be expensive.
Parameters
- Optionaloptions: RecursiveRetrievalOptions
Returns WMSSublayer[]
- Defined in layers/shared/SublayersCollection.ts:65

getSublayers

getSublayers(options?: LayerRetrievalOptions): SublayerType[]
Returns the child sublayers in this collection.
Parameters
- Optionaloptions: LayerRetrievalOptions
Returns SublayerType[]
- Defined in layers/shared/SublayersCollection.ts:46