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
Order to load layers
Legends layer set associated to the map
Reference on the map viewer
Static ReadonlyMIN_A zoom level buffer to guarantee that the calculations being done via the resolutions, inches per meter, dpi are more strict than not enough
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 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 which resolves when done adding
Checks if the layer results sets are all greater than or equal to the provided status
OptionalcallbackNotGood: (layerConfig: ConfigBaseClass) => voidIndicates if all layers passed the callback and how many have passed the callback.
Clears all vector features from every layer in the All Feature Info Layer Set.
Clears any overridden CRS settings on all WMS layers in the map.
Iterates through all GeoView layers, identifies those that are instances of GVWMS,
and resets their override CRS to undefined, allowing them to use the default projection behavior.
Gets the max extent of all layers on the map, or of a provided subset of layers.
IDs or layerPaths of layers to get max extents from.
The overall extent.
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
The list of new Geoview Layers
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 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
Gets the Map Id.
The map id
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
Returns a Promise of an OpenLayer layer associated to the layer path.
Returns the OpenLayer instance associated with the layer path.
The layer path to the layer's configuration.
Returns the geoview instance associated to the layer path.
Highlights layer or sublayer on map
ID of layer to highlight
Verifies if a layer is registered. Returns true if registered.
The layer path to check.
Returns true if the layer configuration is registered.
Load layers that was passed in with the map config
An optional array containing layers passed within the map config
A Promise resolving when everything is done
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 added 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.
Registers the layer identifier.
The layer entry config to register
Refreshes GeoCore Layers
Attempt to reload a layer.
The path to the layer to reload
Removes all geoview layers from the map
Removes all layers in error from the map
Removes layer or sublayer highlight
Removes layer and feature highlights for a given layer.
The path of the layer to remove highlights from.
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
Repeats the last feature info query if any.
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[]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, updates the legend layers store
to reflect this change (used to avoid repeated rerenders when updating multiple items).
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 LegendEventProcessor.
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 LegendEventProcessor.
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 LegendEventProcessor.
The unique path identifying the layer.
The date format to apply for displaying date values associated with this layer.
Sets opacity for a layer.
The path of the layer.
The new opacity to use.
OptionalemitOpacityChange: booleanWhether to emit the event or not (false to avoid updating the legend layers)
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.
Show the errors that happened during layers loading. If it's an aggregate error, log and show all of them. If it's a regular error, log and show only that error.
The error to log and show.
The Geoview layer id for which the error happened.
Unregisters the layer in the LayerApi to stop managing it.
The layer entry config to unregister
Should it be unregistered from orderedLayerInfo
StaticconvertConverts a list of map configuration layer entries into an array of promises, each resolving to one or more GeoView layer configuration objects.
The unique identifier of the map instance this configuration applies to.
The language setting used for layer labels and metadata.
The array of layer entries to convert.
Callback invoked when an error occurs during layer processing.
An array of promises, each resolving to an array of TypeGeoviewLayerConfig objects.
StaticconvertConverts a map configuration layer entry into a promise of a GeoView layer configuration.
Depending on the type of the layer entry (e.g., GeoCore, GeoPackage, Shapefile, RCS, or standard GeoView),
this function processes each entry accordingly and wraps the result in a Promise.
Errors encountered during asynchronous operations are handled via a provided callback.
The unique identifier of the map instance this configuration applies to.
The language setting used for layer labels and metadata.
The array of layer entry to convert.
Callback invoked when an error occurs during layer processing.
The promise resolving to a TypeGeoviewLayerConfig object.
StaticcreateCreates an instance of a specific AbstractGeoViewLayer subclass based on the given GeoView layer configuration.
This function determines the correct layer type from the configuration and instantiates it accordingly.
The configuration object for the GeoView layer.
An instance of the corresponding AbstractGeoViewLayer subclass.
StaticgenerateGenerate an array of layer info for the orderedLayerList.
The config to get the info from.
The array of ordered layer info.
A class to get the layer from layer type. Layer type can be esriFeature, esriDynamic and ogcWMS
Exports
LayerApi