Additional attributes associated with this layer.
NOTE: Do not modify vis this getter. Use updateAttributes or deleteAttribute instead.
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.
The human-readable description of this layer. May be empty.
Emits an event when the layer is destroyed.
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.
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.
True if this layer is a base layer.
Only one base layer can be visible at a time.
True if the layer has been destroyed.
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.
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.
The load state of a layer.
The map this layer belongs to.
NOTE: Throws if the layer is not part of a map.
The maximum resolution (exclusive) below which this layer will be visible.
The maximum view zoom level (inclusive) at which this layer will be visible.
The minimum resolution (inclusive) at which this layer will be visible.
The minimum view zoom level (exclusive) above which this layer will be visible.
The map this layer belongs to, or undefined if the layer is not part of a map.
The raw OpenLayers layer.
The direct parent of this layer instance, used for sublayers or for layers in a group layer.
The property shall be undefined if the layer is not a sublayer or member of a group layer.
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.
The human-readable title of this layer.
Identifies the type of this layer.
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.
Whether the layer is visible in the current map scale or not.
Prefer using LayerFactory.create instead of calling the constructor directly
Deletes the attribute of this layer.
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.
Updates the description of this layer.
Updates the internal property of this layer to the new value.
The maximum resolution (exclusive) below which this layer will be visible.
The maximum view zoom level (inclusive) at which this layer will be visible.
The minimum resolution (inclusive) at which this layer will be visible.
The minimum view zoom level (exclusive) above which this layer will be visible.
Updates the title of this layer.
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.
Updates the attributes of this layer.
Values in newAttributes will override existing values with the same key.
A simple layer that accepts a custom OpenLayers layer instance.
Any kind of open layers can be made to work with the map package using this class. Some API features (such as sublayers) may not be available.