Interface SublayerBaseType

Represents a sublayer of another layer.

interface SublayerBaseType {
    get attributes(): Record<string | symbol, unknown>;
    get children(): ChildrenCollection<AnyLayer> | undefined;
    deleteAttribute(deleteAttribute: string | symbol): void;
    get description(): string;
    destroy(): void;
    get destroyed(): EventSource<void>;
    get id(): string;
    get internal(): boolean;
    get isDestroyed(): boolean;
    get layers(): GroupLayerCollection | undefined;
    get legend(): string | undefined;
    get map(): MapModel;
    get nullableMap(): MapModel | undefined;
    parent: AnyLayer;
    parentLayer: Layer;
    setDescription(newDescription: string): void;
    setInternal(newIsInternal: boolean): void;
    setTitle(newTitle: string): void;
    setVisible(newVisibility: boolean): void;
    get sublayers(): SublayersCollection<WMSSublayer> | undefined;
    get title(): string;
    type: "wms-sublayer";
    updateAttributes(newAttributes: Record<string | symbol, unknown>): void;
    get visible(): boolean;
}

Hierarchy (View Summary)

AnyLayerBaseType
- SublayerBaseType

Implemented by

WMSSublayer

Index

Accessors

attributes

get attributes(): Record<string | symbol, unknown>
Additional attributes associated with this layer.

NOTE: Do not modify vis this getter. Use updateAttributes or deleteAttribute instead.

Returns Record<string | symbol, unknown>
Inherited from AbstractLayerBase.attributes
- Defined in src/packages/map/layers/AbstractLayerBase.ts:137

children

get children(): ChildrenCollection<AnyLayer> | undefined
The direct children of this layer.

The children may either be a set of operational layers (e.g. for a group layer) or a set of sublayers, or undefined.

See also layers and sublayers.

Returns ChildrenCollection<AnyLayer> | undefined
Inherited from AbstractLayerBase.children
- Defined in src/packages/map/layers/AbstractLayerBase.ts:177

description

get description(): string
The human-readable description of this layer. May be empty.

Returns string
Inherited from AbstractLayerBase.description
- Defined in src/packages/map/layers/AbstractLayerBase.ts:117

destroyed

get destroyed(): EventSource<void>
Emits an event when the layer is destroyed.

Returns EventSource<void>
Inherited from AbstractLayerBase.destroyed
- Defined in src/packages/map/layers/AbstractLayerBase.ts:97

id

get id(): string
The unique id of this layer within its map model.

NOTE: layer ids may not be globally unique: layers that belong to different map models may have the same id.

Returns string
Inherited from AbstractLayerBase.id
- Defined in src/packages/map/layers/AbstractLayerBase.ts:107

internal

get internal(): boolean
Property that specifies if the layer is an "internal" layer. Internal layers are not considered by any UI widget (e.g. Toc or Legend). The internal state is independent of the layer's visibility which is determined by visible

NOTE: Some UI widgets might use component specific attributes or props that have precedence over the internal property.

Returns boolean
Inherited from AbstractLayerBase.internal
- Defined in src/packages/map/layers/AbstractLayerBase.ts:127

isDestroyed

get isDestroyed(): boolean
True if the layer has been destroyed.

Returns boolean
Inherited from AbstractLayerBase.isDestroyed
- Defined in src/packages/map/layers/AbstractLayerBase.ts:90

`Abstract`layers

get layers(): GroupLayerCollection | undefined
If this layer is a group layer this property contains a collection of all layers that are members of the group.

The property shall be undefined if it is not a group layer.

The properties layers and sublayers are mutually exclusive.

Returns GroupLayerCollection | undefined
Inherited from AbstractLayerBase.layers
- Defined in src/packages/map/layers/AbstractLayerBase.ts:201

`Abstract`legend

get legend(): string | undefined
Legend URL from the service capabilities, if available.

Note: this property may be expanded upon in the future, e.g. to support more variants than just image URLs.

Returns string | undefined
Inherited from AbstractLayerBase.legend
- Defined in src/packages/map/layers/AbstractLayerBase.ts:217

map

get map(): MapModel
The map this layer belongs to.

NOTE: Throws if the layer is not part of a map.

Returns MapModel
Inherited from AbstractLayerBase.map
- Defined in src/packages/map/layers/AbstractLayerBase.ts:146

nullableMap

get nullableMap(): MapModel | undefined
The map this layer belongs to, or undefined if the layer is not part of a map.

Returns MapModel | undefined
Inherited from AbstractLayerBase.nullableMap
- Defined in src/packages/map/layers/AbstractLayerBase.ts:157

`Abstract`sublayers

get sublayers(): SublayersCollection<WMSSublayer> | undefined
The collection of child sublayers for this layer. Sublayers are layers that cannot exist without an appropriate parent layer.

Layers that can never have any sublayers may not have a sublayers collection.

The properties layers and sublayers are mutually exclusive.

Returns SublayersCollection<WMSSublayer> | undefined
Inherited from AbstractLayerBase.sublayers
- Defined in src/packages/map/layers/AbstractLayerBase.ts:210

title

get title(): string
The human-readable title of this layer.

Returns string
Inherited from AbstractLayerBase.title
- Defined in src/packages/map/layers/AbstractLayerBase.ts:112

`Abstract`visible

get visible(): boolean
Whether the layer is visible or not.

NOTE: The model's visible state may do more than influence the raw OpenLayers's visibility property. Future versions may completely remove invisible layers from the OpenLayer's map under some circumstances.

Returns boolean
Inherited from AbstractLayerBase.visible
- Defined in src/packages/map/layers/AbstractLayerBase.ts:192

Methods

deleteAttribute

deleteAttribute(deleteAttribute: string | symbol): void
Deletes the attribute of this layer.
Parameters
- deleteAttribute: string | symbol
Returns void
Inherited from AnyLayerBaseType.deleteAttribute
- Defined in src/packages/map/layers/AbstractLayerBase.ts:305

destroy

destroy(): void
Destroys the layer and everything owned by it.

NOTE: Layers that are part of the map will be destroyed automatically when that map is being destroyed.

Returns void
Inherited from AnyLayerBaseType.destroy
- Defined in src/packages/map/layers/AbstractLayerBase.ts:76

setDescription

setDescription(newDescription: string): void
Updates the description of this layer.
Parameters
- newDescription: string
Returns void
Inherited from AnyLayerBaseType.setDescription
- Defined in src/packages/map/layers/AbstractLayerBase.ts:278

setInternal

setInternal(newIsInternal: boolean): void
Updates the internal property of this layer to the new value.
Parameters
- newIsInternal: boolean
Returns void
Inherited from AnyLayerBaseType.setInternal
- Defined in src/packages/map/layers/AbstractLayerBase.ts:285

setTitle

setTitle(newTitle: string): void
Updates the title of this layer.
Parameters
- newTitle: string
Returns void
Inherited from AnyLayerBaseType.setTitle
- Defined in src/packages/map/layers/AbstractLayerBase.ts:271

`Abstract`setVisible

setVisible(newVisibility: boolean): void
Updates the visibility of this layer to the new value.

NOTE: The visibility of base layers cannot be changed through this method. Call LayerCollection.activateBaseLayer instead.
Parameters
- newVisibility: boolean
Returns void
Inherited from AnyLayerBaseType.setVisible
- Defined in src/packages/map/layers/AbstractLayerBase.ts:315

updateAttributes

updateAttributes(newAttributes: Record<string | symbol, unknown>): void
Updates the attributes of this layer. Values in newAttributes will override existing values with the same key.
Parameters
- newAttributes: Record<string | symbol, unknown>
Returns void
Inherited from AnyLayerBaseType.updateAttributes
- Defined in src/packages/map/layers/AbstractLayerBase.ts:293

Properties

`Readonly`parent

parent: AnyLayer

The direct parent of this layer instance. This can either be the parent layer or another sublayer.

`Readonly`parentLayer

parentLayer: Layer

The parent layer that owns this sublayer.

`Readonly`type

type: "wms-sublayer"

Identifies the type of this sublayer.

Interface SublayerBaseType

Hierarchy (View Summary)

Implemented by

Index

Accessors

Methods

Properties

Accessors

attributes

Returns Record<string | symbol, unknown>

children

Returns ChildrenCollection<AnyLayer> | undefined

description

Returns string

destroyed

Returns EventSource<void>

id

Returns string

internal

Returns boolean

isDestroyed

Returns boolean

Abstractlayers

Returns GroupLayerCollection | undefined

Abstractlegend

Returns string | undefined

map

Returns MapModel

nullableMap

Returns MapModel | undefined

Abstractsublayers

Returns SublayersCollection<WMSSublayer> | undefined

title

Returns string

Abstractvisible

Returns boolean

Methods

deleteAttribute

Parameters

Returns void

destroy

Returns void

setDescription

Parameters

Returns void

setInternal

Parameters

Returns void

setTitle

Parameters

Returns void

AbstractsetVisible

Parameters

Returns void

updateAttributes

Parameters

Returns void

Properties

Readonlyparent

ReadonlyparentLayer

Readonlytype

Settings

On This Page

`Abstract`layers

`Abstract`legend

`Abstract`sublayers

`Abstract`visible

`Abstract`setVisible

`Readonly`parent

`Readonly`parentLayer

`Readonly`type