Constructs a Group layer to manage an OpenLayer Group Layer.
The OpenLayer group layer.
The layer configuration.
Indicates if the layer has become in loaded status at least once already
Gets the attributions for the layer by calling the overridable function 'onGetAttributions'. When the layer is a GVLayer, its layer attributions are returned. When the layer is a GVGroup, all layers attributions in the group are returned.
The layer attributions.
Gets the bounds for the layer in the given projection. When the layer is a GVLayer, its layer bounds are returned. When the layer is a GVGroup, an Extent union of all layers bounds in the group is returned.
The projection to get the bounds into
The number of stops to use to generate the extent
A promise that resolves with the layer bounding box or undefined when not found
A quick getter to help identify which layer class the current instance is coming from.
The name of the class
Returns the extent of the layer or undefined if it will be visible regardless of extent. The layer extent is an array of numbers representing an extent: [minx, miny, maxx, maxy]. The extent is used to clip the data displayed on the map.
The layer extent.
Gets the Geoview layer id.
The geoview layer id
Gets the geoview layer name.
The layer name
Overrides the parent class's getter to provide a more specific return type (covariant return).
The strongly-typed layer configuration specific to this group layer.
Gets the layer name or falls back on the layer name in the layer configuration.
The layer name
Gets the layer path associated with the layer.
The layer path
Returns all layers contained within this group, including nested layers.
This method performs a depth-first traversal of the group hierarchy,
collecting all child layers recursively. If a filter function is provided,
it is applied to each layer before inclusion in the result.
Both GVGroupLayer instances and concrete layer types may be returned,
depending on the filter criteria.
Optionalfilter: (layer: AbstractBaseGVLayer) => booleanOptional predicate function used to filter the returned layers
A flattened array of all descendant layers (including group layers), optionally filtered
Returns all leaf layers (non-group layers) contained within this group, including those nested in child groups.
This is a convenience method that retrieves all descendant layers and
filters them to include only concrete AbstractGVLayer instances
(i.e., excluding GVGroupLayer containers).
The returned collection is flattened and traversed depth-first.
An array of AbstractGVLayer instances representing all
leaf layers in the group hierarchy
Gets the layer status
The layer status
Gets the max zoom of the layer.
The max zoom of the layer.
Gets the min zoom of the layer.
The min zoom of the layer.
Overrides the parent method to return a more specific OpenLayers layer type (covariant return).
The OpenLayers generic type for groups.
Gets the opacity of the layer (between 0 and 1).
The opacity of the layer.
Returns the direct parent GVGroupLayer of this layer, if any.
This method searches through the provided root group layer collection to determine which group directly contains this layer. If the layer is nested within multiple groups, only the immediate parent group is returned.
The direct parent group layer, or undefined if this layer is not
contained within any group.
Returns the top-most (root) GVGroupLayer ancestor of this layer, if any.
The highest ancestor group layer in the hierarchy, or undefined
if this layer does not belong to any group.
Retrieves all parent group layers of this layer in hierarchical order.
The returned array starts with the immediate parent and continues up the hierarchy until the root group layer is reached or a group has already been visited (not supposed to happen).
This method traverses upward through the parent chain starting from the immediate parent of this layer. A protection mechanism prevents infinite loops in case of circular parent references.
An array of parent GVGroupLayer instances, ordered from the immediate parent to the top-most ancestor. Returns an empty array if the layer has no parent.
Gets the visibility of the layer (true or false).
The visibility of the layer.
Determines whether this layer is visible, taking into account the visibility of all its parent groups. A layer is considered visible only if:
false immediately if any parent is not visible.true if this layer and all its parent groups are visible;
otherwise false.
Checks if layer is visible at the given zoom level.
Zoom level to be compared
If the layer is visible at this zoom level
Unregisters a layer added event handler.
The callback to stop being called whenever the event is emitted
Unregisters a layer name changed event handler.
The callback to stop being called whenever the event is emitted
Unregisters an opacity changed event handler.
The callback to stop being called whenever the event is emitted
Unregisters a layer removed event handler.
The callback to stop being called whenever the event is emitted
Unregisters a visible changed event handler.
The callback to stop being called whenever the event is emitted
Unregisters a z-index changed event handler.
The callback to stop being called whenever the event is emitted
Overrides the way the attributions are retrieved.
The layer attributions
Overrides the way to get the bounds for this layer type.
The projection to get the bounds into
The number of stops to use to generate the extent
A promise that resolves with the layer bounding box or undefined when not found
Registers a layer added event handler.
The callback to be executed whenever the event is emitted
Registers a layer name changed event handler.
The callback to be executed whenever the event is emitted
The registered callback, which can be used to unregister the event handler later
Registers an opacity changed event handler.
The callback to be executed whenever the event is emitted
The registered callback, which can be used to unregister the event handler later
Registers a layer removed event handler.
The callback to be executed whenever the event is emitted
Registers a visible changed event handler.
The callback to be executed whenever the event is emitted
The registered callback, which can be used to unregister the event handler later
Registers a z-index changed event handler.
The callback to be executed whenever the event is emitted
The registered callback, which can be used to unregister the event handler later
Overrides the refresh function to refresh each layer in the group.
Optional projection to refresh to
ProtectedonOverrides the set opacity function to set the opacity to all the children as well.
The desired opacity for the layer, typically between 0 (fully transparent)
and 1 (fully opaque).
Optional, whether to emit a layer opacity change event after updating the opacity. Defaults to true.
ProtectedonOverridable method to set the visibility of the layer.
The desired visibility for the layer.
ProtectedonOverridable method to set the z-index of the layer.
The desired z-index for the layer.
Optional, whether to emit a z-index changed event after updating the z-index. Defaults to true.
Refreshes the layer by calling the overridable function 'onRefresh'.
When the layer is a GVLayer its layer source is refreshed. When the layer is a GVGroup, all layers in the group are refreshed.
Optional projection to refresh to
Removes a layer from the group layer.
The layer to remove.
Sets the extent of the layer. Use undefined if it will be visible regardless of extent. The layer extent is an array of numbers representing an extent: [minx, miny, maxx, maxy].
The extent to assign to the layer.
Sets the layer name
The layer name
Sets the max zoom of the layer.
The max zoom of the layer.
Sets the min zoom of the layer.
The min zoom of the layer.
ProtectedsetSets the OpenLayers Layer
The OpenLayers Layer
Sets the opacity of the layer while ensuring it does not exceed the opacity of its parent layer.
If the layer has a parent, the provided opacity is clamped so that it cannot be greater than the parent's opacity. The resulting opacity is applied to the underlying OpenLayers layer.
If the layer is a GVGroupLayer, the computed opacity is recursively applied to all child layers to maintain consistency within the layer hierarchy.
Optionally emits a layer opacity change event.
The desired opacity for the layer, typically between 0 (fully transparent)
and 1 (fully opaque).
Optional, whether to emit a layer opacity change event after updating the opacity. Defaults to true.
Sets the parent layer
The parent layer for the current layer if any.
Sets the visibility of the layer (true or false).
The visibility of the layer.
Sets the z-index of the layer.
The z-index of the layer.
Optional, whether to emit a z-index changed event after updating the z-index. Defaults to true.
StaticgetRecursively searches the layer tree to find the parent GVGroupLayer of a given layer.
The search begins from the provided list of layers, which should represent the root-level layer collection. This method walks top-down through all nested GVGroupLayers until it finds the group whose children contain the specified layer. It proceeds this way, because OpenLayers doesn't have a way to start from a leaf - have to start from the root.
The layer for which the parent group is being searched.
The list of layers to search within. Typically this is the root layer group of the map.
The parent group layer if found,
otherwise undefined if the layer has no parent.
Manages a Group Layer.