Interface SublayersCollection<SublayerType>

Contains the sublayers that belong to a Layer or Sublayer.

interface SublayersCollection<SublayerType = Sublayer> {
    getItems(options?: LayerRetrievalOptions): SublayerType[];
    getRecursiveLayers(options?: RecursiveRetrievalOptions): WMSSublayer[];
    getSublayers(options?: LayerRetrievalOptions): SublayerType[];
}

Type Parameters

SublayerType = Sublayer

Hierarchy (View Summary)

ChildrenCollection<SublayerType>
- SublayersCollection

Index

Methods

getItems getRecursiveLayers getSublayers

Methods

getItems

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

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 api/layers/base.ts:270

getSublayers

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