Class AbstractBaseGVLayerAbstract

loadedOnce

getAttributions

• getAttributions(): string[]

  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.

  Returns string[]

  The layer attributions.

getBounds

• getBounds(projection: Projection, stops: number): Promise<Extent | undefined>

  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.

  Parameters

  • projection: Projection

    The projection to get the bounds into.

  • stops: number

    The number of stops to use to generate the extent.

  Returns Promise<Extent | undefined>

  A promise of layer bounding box.

getClassName

• getClassName(): string

  A quick getter to help identify which layer class the current instance is coming from.

  Returns string

getExtent

• getExtent(): Extent | undefined

  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.

  Returns Extent | undefined

  The layer extent.

getGeoviewLayerId

• getGeoviewLayerId(): string

  Gets the Geoview layer id.

  Returns string

  The geoview layer id

getGeoviewLayerName

• getGeoviewLayerName(): string | undefined

  Gets the geoview layer name.

  Returns string | undefined

  The layer name

getLayerConfig

• getLayerConfig(): ConfigBaseClass

  Gets the layer configuration associated with the layer.

  Returns ConfigBaseClass

  The layer configuration

getLayerName

• getLayerName(): string

  Gets the layer name or falls back on the layer name in the layer configuration.

  Returns string

  The layer name

getLayerPath

• getLayerPath(): string

  Gets the layer path associated with the layer.

  Returns string

  The layer path

getLayerStatus

• getLayerStatus(): TypeLayerStatus

  Gets the layer status

  Returns TypeLayerStatus

  The layer status

getMaxZoom

• getMaxZoom(): number

  Gets the max zoom of the layer.

  Returns number

  The max zoom of the layer.

getMinZoom

• getMinZoom(): number

  Gets the min zoom of the layer.

  Returns number

  The min zoom of the layer.

getOLLayer

• getOLLayer(): BaseLayer

  Gets the OpenLayers Layer

  Returns BaseLayer

  The OpenLayers Layer

getOpacity

• getOpacity(): number

  Gets the opacity of the layer (between 0 and 1).

  Returns number

  The opacity of the layer.

getParent

• getParent(): GVGroupLayer | undefined

  Returns the direct parent GVGroupLayer of this layer, if any.

  Returns GVGroupLayer | undefined

  The direct parent group layer, or undefined if this layer is not contained within any group.

  Description

  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.

getParentRoot

• getParentRoot(): GVGroupLayer | undefined

  Returns the top-most (root) GVGroupLayer ancestor of this layer, if any.

  Returns GVGroupLayer | undefined

  The highest ancestor group layer in the hierarchy, or undefined if this layer does not belong to any group.

getParents

• getParents(): GVGroupLayer[]

  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).

  Returns GVGroupLayer[]

  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.

  Description

  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.

getVisible

• getVisible(): boolean

  Gets the visibility of the layer (true or false).

  Returns boolean

  The visibility of the layer.

getVisibleIncludingParents

• getVisibleIncludingParents(): boolean

  Determines whether this layer is visible, taking into account the visibility of all its parent groups. A layer is considered visible only if:

  • the layer itself is visible, and
  • every parent GVGroupLayer up the hierarchy is also visible. This function walks upward through the group layer tree until it reaches the root, returning false immediately if any parent is not visible.

  Returns boolean

  true if this layer and all its parent groups are visible; otherwise false.

inVisibleRange

• inVisibleRange(zoom: number): boolean

  Checks if layer is visible at the given zoom

  Parameters

  • zoom: number

    Zoom level to be compared

  Returns boolean

  If the layer is visible at this zoom level

offLayerNameChanged

• offLayerNameChanged(callback: LayerNameChangedDelegate): void

  Unregisters a layer name changed event handler.

  Parameters

  • callback: LayerNameChangedDelegate

    The callback to stop being called whenever the event is emitted

  Returns void

offLayerOpacityChanged

• offLayerOpacityChanged(callback: LayerOpacityChangedDelegate): void

  Unregisters an opacity changed event handler.

  Parameters

  • callback: LayerOpacityChangedDelegate

    The callback to stop being called whenever the event is emitted

  Returns void

offVisibleChanged

• offVisibleChanged(callback: VisibleChangedDelegate): void

  Unregisters a visible changed event handler.

  Parameters

  • callback: VisibleChangedDelegate

    The callback to stop being called whenever the event is emitted

  Returns void

onLayerNameChanged

• onLayerNameChanged(callback: LayerNameChangedDelegate): void

  Registers a layer name changed event handler.

  Parameters

  • callback: LayerNameChangedDelegate

    The callback to be executed whenever the event is emitted

  Returns void

onLayerOpacityChanged

• onLayerOpacityChanged(callback: LayerOpacityChangedDelegate): void

  Registers an opacity changed event handler.

  Parameters

  • callback: LayerOpacityChangedDelegate

    The callback to be executed whenever the event is emitted

  Returns void

onVisibleChanged

• onVisibleChanged(callback: VisibleChangedDelegate): void

  Registers a visible changed event handler.

  Parameters

  • callback: VisibleChangedDelegate

    The callback to be executed whenever the event is emitted

  Returns void

refresh

• refresh(projection: Projection | undefined): void

  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.

  Parameters

  • projection: Projection | undefined

    Optional, the projection to refresh to.

  Returns void

setExtent

• setExtent(layerExtent: Extent): void

  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].

  Parameters

  • layerExtent: Extent

    The extent to assign to the layer.

  Returns void

setLayerName

• setLayerName(name: string | undefined): void

  Sets the layer name

  Parameters

  • name: string | undefined

    The layer name

  Returns void

setMaxZoom

• setMaxZoom(maxZoom: number): void

  Sets the max zoom of the layer.

  Parameters

  • maxZoom: number

    The max zoom of the layer.

  Returns void

setMinZoom

• setMinZoom(minZoom: number): void

  Sets the min zoom of the layer.

  Parameters

  • minZoom: number

    The min zoom of the layer.

  Returns void

setOpacity

• setOpacity(opacity: number, emitOpacityChanged?: boolean): void

  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.

  Parameters

  • opacity: number

    The desired opacity for the layer, typically between 0 (fully transparent) and 1 (fully opaque).

  • emitOpacityChanged: boolean = true

    Optional, whether to emit a layer opacity change event after updating the opacity. Defaults to true.

  Returns void

setParent

• setParent(parent: GVGroupLayer | undefined): void

  Sets the parent layer

  Parameters

  • parent: GVGroupLayer | undefined

    The parent layer for the current layer if any.

  Returns void

setVisible

• setVisible(layerVisibility: boolean): void

  Sets the visibility of the layer (true or false).

  Parameters

  • layerVisibility: boolean

    The visibility of the layer.

  Returns void