Initializes the layer API and subscribes to domain and controller events.
The controller registry for accessing controllers
The layer domain for event subscriptions
The geometry API for creating and managing geometries
The feature highlight utility for feature and bounding box highlighting
All feature info layer set associated to the map
Used to access feature and bounding box highlighting
Feature info layer set associated to the map
Used to access geometry API to create and manage geometries
Hover feature info layer set associated to the map
Legends layer set associated to the map
Adds a layer to the map.
This is the main method to add a GeoView Layer on the map. It handles all the processing, including the validations, and makes sure to inform the layer sets about the layer. The result contains the instanciated GeoViewLayer along with a promise that will resolve when the layer will be officially on the map.
The geoview layer configuration to add.
OptionalabortSignal: AbortSignalOptional AbortSignal used to cancel the layer creation process.
The result of the addition of the geoview layer.
Adds a Geoview Layer by GeoCore UUID.
The GeoCore UUID to add to the map
OptionallayerEntryConfig: stringThe optional layer configuration
A promise that resolves with the added layer result or undefined when an error occurs
Returns the GeoView instance associated to the layer path.
The layer path
The new Geoview Layer
Gets the GeoView Layer Ids / UUIDs.
The ids of the layers
Returns the GeoView Layer instance associated to the layer path.
The layer path
The AbstractBaseGVLayer or undefined when not found
Gets the GeoView Layer Paths.
The layer paths of the GV Layers
Returns the AbstractGVLayer instance associated to the layer path.
This returns an actual AbstractGVLayer and throws a LayerWrongTypeError if the layerPath points to a GVGroupLayer object. An AbstractGVLayer is essentially a layer that's not a group layer.
The layer path
The new Geoview Layer
Returns the GeoView Layer instance associated to the layer path.
This returns an actual AbstractGVLayer (or undefined) and throws a LayerWrongTypeError if the layerPath points to a GVGroupLayer object. An AbstractGVLayer is essentially a layer that's not a group layer.
The layer path
The AbstractGVLayer or undefined when not found
Gets all GeoView layers that are group layers.
This method filters the list returned by getGeoviewLayers() and
returns only the layers that are instances of GVGroupLayer.
An array containing only the group layers from the current GeoView layer collection.
Gets all GeoView layers that are regular layers (not groups).
This method filters the list returned by getGeoviewLayers() and
returns only the layers that are instances of AbstractGVLayer.
An array containing only the regular layers from the current GeoView layer collection.
Gets all GeoView layers that are at the root.
An array containing only the layers at the root level of the registry.
Gets the layer configuration of a group layer (not a regular) at the specified layer path.
The layer path.
The layer configuration.
Gets the layer configuration of the specified layer path.
The layer path.
The layer configuration or undefined if not found.
Gets the layer configuration of a regular layer (not a group) at the specified layer path.
The layer path.
The layer configuration.
Gets the Layer Entry Configs.
The GeoView Layer Entry Configs
Gets the Layer Entry layer paths.
The GeoView Layer Paths
Asynchronously returns the OpenLayer layer associated to a specific layer path.
This function waits the timeout period before abandonning (or uses the default timeout when not provided). Note this function uses the 'Async' suffix to differentiate it from 'getOLLayer'.
The layer path to the layer's configuration.
Optionaltimeout: numberOptionally indicate the timeout after which time to abandon the promise
OptionalcheckFrequency: numberOptionally indicate the frequency at which to check for the condition on the layerabstract
A promise that resolves to an OpenLayer layer associated to the layer path.
Highlights all features of a layer on the map.
The path of the layer to highlight
Initializes the events on the domain to listen to changes and re-emit the events higher. This is a shortcut to not have the event from the domain have to go through the controller to be caught by the layer api.
The layer domain to listen on
Initializes events on the layer creator controller to relay layer lifecycle events.
Subscribes to layer config added, config error, config removed, and layer created events from the controller and re-emits them for external consumers.
The layer creator controller to listen on
The layer controller to listen on
Unregisters a layer all loaded/error event handler.
The callback to stop being called whenever the event is emitted
Unregisters a layer config added event handler.
The callback to stop being called whenever the event is emitted
Unregisters a layer config error 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 layer created event handler.
The callback to stop being called whenever the event is emitted
Unregisters a layer error event handler.
The callback to stop being called whenever the event is emitted
Unregisters a layer first loaded event handler.
The callback to stop being called whenever the event is emitted
Unregisters a layer item visibility toggled event handler.
The callback to stop being called whenever the event is emitted
Unregisters a layer loaded event handler.
The callback to stop being called whenever the event is emitted
Unregisters a layer loading event handler.
The callback to stop being called whenever the event is emitted
Unregisters a callback from being called whenever the layer status is updated.
The callback function to unregister
Unregisters a layer visibility toggled event handler.
The callback to stop being called whenever the event is emitted
Registers a layer all loaded/error event handler.
The callback to be executed whenever the event is emitted
Registers a layer config error event handler.
The callback to be executed whenever the event is emitted
Registers a layer removed event handler.
The callback to be executed whenever the event is emitted
Registers a layer created event handler.
The callback to be executed whenever the event is emitted
Registers a layer error event handler.
The callback to be executed whenever the event is emitted
Registers a layer first loaded event handler.
The callback to be executed whenever the event is emitted
Registers a layer item visibility toggled event handler.
The callback to be executed whenever the event is emitted
Registers a layer loaded event handler.
The callback to be executed whenever the event is emitted
Registers a layer loading event handler.
The callback to be executed whenever the event is emitted
Registers a callback to be executed whenever the layer status is updated.
The callback function
Registers a layer visibility toggled event handler.
The callback to be executed whenever the event is emitted
Redefine feature info fields.
The path of the layer.
The new field names to use.
The fields to change.
Loops through all geoview layers and refresh their respective source. Use this function on projection change or other viewer modification who may affect rendering.
Removes all GeoView layers from the map.
Removes all layer highlights from the map.
Removes highlights for a specific layer.
The path of the layer whose highlights to remove
Removes a layer from the map using its layer path. The path may point to the root geoview layer or a sub layer.
The path or ID of the layer to be removed
Replace outfield names, aliases and types with any number of new values, provided an identical count of each are supplied.
The path of the layer.
The new field types (TypeOutfieldsType) to use.
The new field names to use.
OptionalfieldAliases: string[]Optional, the new field aliases to use.
Sets the visibility of all geoview layers on the map.
The new visibility.
Changes a GeoJson Source of a GeoJSON layer at the given layer path.
The path of the layer.
The new geoJSON.
A promise that resolves when the geojson source has been set
Sets the visibility of a single legend item on a regular (non-group) layer.
This method updates the visibility of the specified item both in the underlying layer's style configuration and optionally in the legend store. It can also trigger the layer filters to be reapplied and optionally wait for the next render cycle before resolving. Finally, it emits an event indicating the visibility change.
The path identifying the target layer within the map.
The legend item whose visibility will be updated.
Whether the item should be visible.
If true, the promise resolves only after the
underlying layer has finished its next render cycle.
A promise that resolves once the visibility has been applied, optional legend store updated, filters applied, and render completed if requested
Sets the date temporal mode for the specific layer.
This updates the layer-level configuration used to control how date values are interpreted. The value is stored in the application state via the layerController.
The unique path identifying the layer.
The date format to apply for displaying date values associated with this layer.
Sets the date display format for a specific layer.
This updates the layer-level configuration used to control how date values are formatted when displayed (e.g., in legends, tooltips, or UI components). The value is stored in the application state via the layerController.
The unique path identifying the layer.
The date format to apply for displaying date values associated with this layer.
Sets the date display format (short) for a specific layer.
Short means the date should be displayed in a more compact format. This updates the layer-level configuration used to control how date values are formatted when displayed (e.g., in legends, tooltips, or UI components). The value is stored in the application state via the layerController.
The unique path identifying the layer.
The date format to apply for displaying date values associated with this layer.
Sets the mosaic rule for an ESRI Image layer.
The layer path
The mosaic rule to apply or undefined to remove it
Updates the raster function for an ESRI Image layer.
The path of the layer.
The raster function ID to apply or undefined to remove it.
Sets the WMS style for a WMS layer.
The layer path
The WMS style to apply
Sets or toggles the visibility of a layer within the current map.
Retrieves the current visibility of the layer, determines the resulting visibility
based on the optional newValue, and applies the change only if the visibility
actually differs. If newValue is provided, the visibility is set explicitly;
if omitted, the method toggles the current visibility.
The path of the layer whose visibility is being updated.
OptionalnewValue: booleanOptional. The new visibility value to apply. If omitted, the current visibility is toggled.
The resulting visibility state of the layer after the update
Public API facade for layer operations.
Provides external consumers with a stable entry point for layer management, querying, and event subscription. Internally delegates to controllers and domains, re-emitting domain events so that external code can subscribe without depending on internal architecture.