Global

Members

constantAXIOS_NOT_RESPONSEstring

Maps Errors messages

AutomaticLinkingStatus

Status of the automatic linking process

readonlyErrorSeveritystring

Error severities strings

readonlyErrorTypenumber

Error types strings

constantGENERIC_ERRORS_EVALstring

Generic Errors messages

GeoJSONFeature

Domain entity representing the state of a map renderer.

GoIndexTypestring

Enum for Geographic Index Types.

GoRSEvents

Defines a style range for an index visualization (e.g., NDVI, NDMI, NDWI). Each range maps a minimum and maximum value to an RGBA color.

GoRSUIIdsstring

Enum for defining various UI element identifiers in the RSUI.

GoTocState

Represents the data for a layer in the TOC.

IDataLayerTypes

Types of data layers.

constantINTERNAL_DONT_CORRESPOND_APLY_DEFAULT_STYLESstring

Internal Errors messages

LayerCreator

LayerOptionsSetter is a class for setting options on a TileLayer instance.

LayerOptionsSetter

LayerManager provides functionalities for managing a single TileLayer, including visibility and __query state.

LayerRegistry

Converts boolean properties in an object to strings for Mapbox style compatibility. Boolean true becomes "true" and false becomes "false".

LinkingEvents

Events emitted during the automatic linking process

constantMAPS_ERROR_CLOSETOOL_ALREADY_EXISTstring

Maps Errors messages

MbLayerType

Supported Mapbox layer types for style conversion.

constantNDMIStyleOwn

Defines the style settings for Normalized Difference Moisture Index (NDMI) visualization. Similar to NDVI, but represents moisture content instead of vegetation.

constantNDVIStyleOwnArray.<IndexStyleRange>

Defines the style settings for Normalized Difference Vegetation Index (NDVI) visualization. Each object in the array represents a range of NDVI values and their corresponding RGBA color values. The RGBA values are used to visually represent different ranges of NDVI on a map or image.

constantNDWIStyleOwn

Defines the style settings for Normalized Difference Water Index (NDWI) visualization. This array contains objects that map NDWI value ranges to corresponding RGBA color values. The color mappings are used to visually differentiate between various water content levels in the data.

constantNETWORK_ERRORS_400string

Network Errors messages

RSUIStateActionTypesstring

Enum for action types used in RSUI state management.

RSUIThemeTypestring

Enum for RSUI theme types.

RendererTypes

Types of renderers supported.

constantSTATIC_TRUCK_ICON_PARAMStypes.ISVGIcon

Static SVG icon parameters for truck icons.

constantSTYLES_ERROR_CANT_LOADstring

Styles Errors messages

UIStateActionTypesstring

Enum for action types used in RSUI state management.

UIThemeTypestring

Enum for RSUI theme types.

UIVRSIdsstring

Enum for defining various UI element identifiers in the RSUI.

UIWLSIdsstring

Enum for defining various UI element identifiers in the RSUI.

UIWLStateActionTypesstring

Enum for action types used in RSUI state management.

readonlyaxiosErrorsstring

Maps Errors strings

constantcontainer

Dependency Injection Container for MapboxViewer.

readonlygenericErrorsstring

Generic Errors strings

getDensityLayer

Removes the density layer from a specific map.

readonlyinternalErrorsstring

Internal Errors strings

readonlymapsErrorsstring

Maps Errors strings

readonlynetworkErrorsstring

Network Errors strings

constantpanelsRegistry

Global registry to keep track of all UILeftPanel instances. Ensures that panels can be managed collectively (e.g., close all, toggle layout).

readonlystylesErrorsstring

Styles Errors strings

validateArray

Validate type array of numbers

Methods

GoEditFeatures(payload, geom_code){string}

Interactions/Features/interact/GoEditFeatures.ts, line 162

Check and replace geometry field

Name	Type	Description
payload	string	Payload to send to geoserver
geom_code	string	Geometry code

Returns:

Type	Description
string	Return the replaced geometry field

addDensityLayer(params){GoDensityTool}

Interactions/Analysis/interact/DensityTools/densityLayer.methods.ts, line 10

Name	Type	Description
params	object	Parameters object. Name Type Default Description idMap string The identifier of the map to which the layer will be added. idDensityTool string The identifier of the density tool. type densityToolType The type of density tool. layer string optional The name of the layer, optional. field string optional The field to be used in the density tool, optional. breaks Array.<number> optional An array of numeric values defining breaks, optional. hexCase HexConditions optional Hexadecimal conditions, optional. resize boolean true optional Whether to resize the layer, defaults to true. hexStyleColors hexStyleColors optional Color Style optional.

Returns:

Type	Description
GoDensityTool	The density tool created and associated with the map.

addDrawSelectByPolygon(params){Map.<string, GoDrawSelectByPolygon>|GoDrawSelectByPolygon|undefined}

Interactions/Selection/interact/SelectByPolygon/selectByPolygon.methods.ts, line 14

Adds a Draw Select By Polygon interaction to a map.

Name	Type	Description
params	Object	Parameters for adding the Draw Select By Polygon. Name Type Description idMap string The ID of the map where the interaction will be added. idDrawSelectByPolygon string The unique ID for the Draw Select By Polygon interaction. callback function Callback invoked when a polygon is drawn with the selected feature. Receives feature: Feature as parameter. layers Array.<string> optional Optional list of layer IDs to restrict selectable features. style types.styleFromUser optional Optional custom style for the drawing interaction. clickFinish boolean optional Optional flag to finalize drawing on single click.

Returns:

Type	Description
Map.<string, GoDrawSelectByPolygon> | GoDrawSelectByPolygon | undefined	Returns: The Map of all DrawSelectByPolygon for the map (if it's the first interaction), The existing DrawSelectByPolygon object if it already exists, Undefined if the map does not exist.

addDrawSelectByPolygonInCluster(params){Map.<string, GoDrawSelectByPolygonInCluster>|undefined}

Interactions/Selection/interact/SelectByPolygon/selectByPolygon.methods.ts, line 230

Adds a new draw select by polygon in a cluster to the specified map.

Name	Type	Description
params	object	Parameters object. Name Type Description idMap string The ID of the map. idDrawSelectByPolygonInCluster string The ID of the draw select by polygon in cluster. callback function Callback function to be called with the drawn feature. layers Array.<string> optional Optional array of layer IDs to restrict the drawing to specific layers. style types.styleFromUser optional Optional style configuration for the drawn polygon. clickFinish boolean optional Optional flag indicating whether the drawing should finish on click.

Returns:

Type	Description
Map.<string, GoDrawSelectByPolygonInCluster> | undefined	The map of draw select by polygon in cluster objects for the specified map, or undefined if the map does not exist.

addError(errorInfo)

Utils/classes/GoConfigValidator/functions/addError.ts, line 8

Add error to the log

Name	Type	Description
errorInfo	string	string,
	boolean	isError

Returns:

A error log entry.

addFullScreen(idMap){GoFullScreen}

Interactions/Views/interact/FullScreen/fullscreen.methods.ts, line 37

Adds a fullscreen control to the specified map.

Name	Type	Description
idMap	string	The ID of the map to which the fullscreen control will be added.

Returns:

Type	Description
GoFullScreen	The created GoFullScreen instance if the control was added successfully;

addLogEntry(logEntry){void}

Utils/classes/GoError/functions/addLogEntryFun.ts, line 16

This function is used for add a new error to the log

Name	Type	Description
logEntry	module:types~ErrorsLogEntry	The error log entry

Returns:

Type	Description
void	Return nothing

addMeasure(params){GoMeasure|undefined}

Interactions/Analysis/interact/Measure/measure.methods.ts, line 11

Adds a new measurement tool to the map.

Name	Type	Description
params	types.AddMeasureParams	Parameters object.

Returns:

Type	Description
GoMeasure | undefined	The created GoMeasure instance or undefined if the map does not exist.

addMouseRotation(olMap){MouseEventInteraction}

Interactions/Views/interact/Rotation/rotation.methods.ts, line 147

Adds a mouse rotation interaction to the specified map.

Name	Type	Description
olMap	OlMap	The OpenLayers map instance.

Returns:

Type	Description
MouseEventInteraction	The mouse event interaction instance added to the map.

addOverlay(params){GoOverlay|undefined}

Interactions/Views/interact/Overlay/overlay.methods.ts, line 8

Adds an overlay to the specified map.

Name	Type	Description
params	Object	Parameters object. Name Type Description idMap string The ID of the map to which the overlay will be added. idOverlay string The ID of the overlay to be added. overlayData types.overlayData The data used to configure the overlay.

Returns:

Type	Description
GoOverlay | undefined	The created GoOverlay instance if the overlay was added successfully; otherwise, undefined.

addPrint(idMap, idPrint, name, author, date){GoPrint|undefined}

Interactions/Views/interact/Print/print.methods.ts, line 41

Adds a new print configuration to a given map.

Name	Type	Description
idMap	string	The ID of the map.
idPrint	string	The ID of the new print configuration.
name	string	optional Optional name for the print configuration.
author	string	optional Optional author for the print configuration.
date	string	optional Optional date for the print configuration.

Returns:

Type	Description
GoPrint | undefined	The created print configuration, or undefined if the print already exists.

addRotation(idMap, idRotation)

Interactions/Views/interact/Rotation/rotation.methods.ts, line 50

Adds a new rotation to the specified map. If the rotation already exists, it triggers an error handler with a warning.

Name	Type	Description
idMap	string	The ID of the map.
idRotation	string	The ID of the rotation.

asyncaddRoutingHERE(params){Promise.<any>}

Interactions/ExternalsConnections/interact/Geocoding/routing.methods.ts, line 6

Adds a routing operation using the HERE service with specified parameters.

Name	Type	Description
params	object	Parameters object. Name Type Description idMap string The ID of the map where routing is to be added. routingID string The ID for the routing operation. transportMode string The mode of transport (e.g., car, pedestrian, bike). points Array.<geodesicCoordinates> An array of geodesic coordinates representing the route. lang string optional The language for the routing instructions (optional).

Throws:

If HERE API key is not found or other errors occur during the routing operation.

Type

Error

Returns:

Type	Description
Promise.<any>	A promise that resolves to the routing result from HERE.

addSelectByPolygon(params){GoSelectByPolygon|undefined}

Interactions/Selection/interact/SelectByPolygon/selectByPolygon.methods.ts, line 147

Adds a new select by polygon to the specified map.

Name	Type	Description
params	object	Parameters object. Name Type Description idMap string The ID of the map. idSelectByPolygon string The ID of the select by polygon. geometryPolygon Feature.<Polygon> The polygon feature to be selected. callback function Callback function to be called with the selected feature. layers Array.<string> optional Optional array of layer IDs to restrict the selection to specific layers.

Returns:

Type	Description
GoSelectByPolygon | undefined	The select by polygon object for the specified ID, or undefined if the map does not exist.

addSelectByPolygonInCluster(idMap, idSelectByPolygonInCluster, geometryPolygon, callback, layers){GoSelectByPolygon|undefined}

Interactions/Selection/interact/SelectByPolygon/selectByPolygon.methods.ts, line 390

Adds a new select by polygon in cluster to the specified map.

Name	Type	Description
idMap	string	The ID of the map.
idSelectByPolygonInCluster	string	The ID of the select by polygon in cluster.
geometryPolygon	Feature.<Polygon>	The polygon feature to be selected.
callback	function	Callback function to be called with the selected feature.
layers	Array.<string>	optional Optional array of layer IDs to restrict the selection to specific layers.

Returns:

Type	Description
GoSelectByPolygon | undefined	The select by polygon in cluster object for the specified ID, or undefined if the map does not exist.

addThematicMap(params){void}

Interactions/thematicMap/thematicMap.method.ts, line 9

Adds a thematic map to the specified map. If the map does not exist, an error is triggered. If the thematic map already exists, a warning is issued.

Name	Type	Description
params	Object	Parameters for adding a thematic map. Name Type Description mapId string The ID of the map. thematicMapId string The ID of the thematic map. layerGroupIA LayerGroupIA The layer group IA for the thematic map.

Returns:

Type	Description
void

asyncaddWMSGetFeatureInfo(params){Promise.<GoWMSGetFeatureInfo>}

Interactions/ExternalsConnections/interact/WMS/wmsFeatureInfo.methods.ts, line 11

Adds a WMS GetFeatureInfo interaction to the map.

Name	Type	Description
params	Object	Parameters object. Name Type Description idMap string The ID of the map. idWMSGetFeatureInfo string The ID for the WMS GetFeatureInfo interaction. layers Array.<string> An array of layer names for which to perform the GetFeatureInfo request. coordinates olCoordinate.Coordinate The coordinates where the GetFeatureInfo request is performed.

Throws:

Will log a warning if the interaction already exists for the given map and ID.

Returns:

Type	Description
Promise.<GoWMSGetFeatureInfo>	A promise that resolves to the added GoWMSGetFeatureInfo instance.

anyPanelOpen(){boolean}

UIMap/UIDisplay/UILeftPanel/index.ts, line 9

Checks if any panel is currently open.

Returns:

Type	Description
boolean	True if at least one panel is open, otherwise false.

asyncautoSuggestAddress(param0){Promise.<any>}

Interactions/ExternalsConnections/interact/Geocoding/geocoding.methods.ts, line 125

Auto Suggests addresses based on the input parameters using HERE geocoding service.

Name	Type	Description
param0	Object	The parameters object. Name Type Description params HERESuggestParams The parameters for address suggestion including query and location context.

Returns:

Type	Description
Promise.<any>	A promise that resolves to a list of suggested addresses.

axiosErrorsSet(errorSeverity, errorType, errorMsg, errorObj){void}

Utils/classes/GoError/setters/AxiosErrorsSet.ts, line 19

Add a new entry to the log of the current class and print the error in the console.

Name	Type	Description
errorSeverity	module:types~ErrorSeverity	The error severity
errorType	module:types~genericErrors	The error type
errorMsg	string	The error message
errorObj	object	The error object

Returns:

Type	Description
void	Return nothing

blobToDataURL(blob)

Utils/functions/blobToDataURL.ts, line 1

Converts a Blob to a data URL string. This is CSP-compliant and avoids the need for blob URLs.

Name	Type	Description
blob		The Blob object to convert.

Returns:

A Promise that resolves to a data URL string.

calculateBoundsArea(bounds)

MapboxViewer/shared/sync-test-utils.ts, line 8

Calculates the area of a bounds in square degrees

Name	Type	Description
bounds		[west, south, east, north] in EPSG:4326

Returns:

Area in square degrees

calculateBoundsOverlap(bounds1, bounds2)

MapboxViewer/shared/sync-test-utils.ts, line 22

Calculates the overlap percentage between two bounds

Name	Type	Description
bounds1		First bounds [west, south, east, north]
bounds2		Second bounds [west, south, east, north]

Returns:

Overlap percentage (0-100)

calculateCenterDifference(bounds1, bounds2)

MapboxViewer/shared/sync-test-utils.ts, line 57

Calculates the difference in center points between two bounds

Name	Type	Description
bounds1		First bounds
bounds2		Second bounds

Returns:

Distance in degrees (approximate)

clearMeasure(params)

Interactions/Analysis/interact/Measure/measure.methods.ts, line 103

Clears the measurement results and tooltips from the specified measurement tool on the map.

Name	Type	Description
params	object	Parameters object. Name Type Description idMap string The ID of the map containing the measurement tool. idMeasure string The ID of the measurement tool.

closeAllExcept(except)

UIMap/UIDisplay/UILeftPanel/index.ts, line 61

Closes all panels except the one provided.

Name	Type	Description
except	module:UIMap/UIDisplay/UILeftPanel/index.ts~UILeftPanel	optional Panel to keep open (optional).

closeAllPanels()

UIMap/UIDisplay/UILeftPanel/index.ts, line 39

Closes all panels currently registered.

asynccreateAsset(assets){Promise.<AxiosResponse>}

Services/GoDMD/functions/generics.ts, line 6

Return the characteristics of the DMD

Name	Type	Description
assets	Array.<DMDAsset>	An array of DMDAsset objects to be created.

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

createDMD(params){GoDMD}

Interactions/ExternalsConnections/interact/DMD/dmd.methods.ts, line 3

Creates a new GoDMD instance and stores it with the given ID.

Name	Type	Description
params	Object	The parameters object. Name Type Description dmdId string The unique identifier for the GoDMD instance.

Returns:

Type	Description
GoDMD	The created GoDMD instance.

asynccreateHierarchy(hierarchy){Promise.<unknown>}

Services/GoDMD/functions/generics.ts, line 59

Create a new hierarchy

Name	Type	Description
hierarchy	unknown	The hierarchy data to be created.

Returns:

Type	Description
Promise.<unknown>	A promise that resolves with the response from the POST request.

createHierarchyItem(hierarchyItem){Promise.<unknown>}

Services/GoDMD/functions/generics.ts, line 97

Create a new hierarchy item

Name	Type	Description
hierarchyItem	unknown	The hierarchy item data to be created.

Returns:

Type	Description
Promise.<unknown>	A promise that resolves with the response from the POST request.

createHierarchyItemsList(hierarchyItems){Promise.<unknown>}

Services/GoDMD/functions/generics.ts, line 138

Create new hierarchy items in batches

Name	Type	Description
hierarchyItems	Array.<unknown>	An array of hierarchy items to be created.

Returns:

Type	Description
Promise.<unknown>	A promise that resolves with the response from the POST request.

asynccreateIFC(props){Promise.<GoIFCComponents>}

Interactions/IFC/ifc.methods.ts, line 6

Asynchronously creates and initializes a new GoIFC instance for a specific map and IFC model. It checks for the existence of the map and the uniqueness of the IFC model before creation. An optional callback can be provided to track loading progress.

Name	Type	Description
props	IFCConfig	Configuration object for creating the IFC model, including:

Throws:

Throws an error if the map does not exist or the IFC model already exists.

Type

GoError

Returns:

Type	Description
Promise.<GoIFCComponents>	A promise that resolves to the newly created GoIFC instance.

createTooltip(targetElement, tooltipContent){HTMLDivElement}

Layers/GoRemoteSensing/clases/UI/utils/functions/index.ts, line 1

Creates a tooltip element and attaches it to a specified target element. The tooltip appears when the mouse hovers over the target element and disappears when the mouse leaves.

Name	Type	Description
targetElement	HTMLElement	The element to which the tooltip will be attached.
tooltipContent	string	The HTML content to be displayed inside the tooltip.

Returns:

Type	Description
HTMLDivElement	The created tooltip element.

asyncdeleteAssetById(assetID){Promise.<AxiosResponse>}

Services/GoDMD/functions/generics.ts, line 43

Deletes an asset by its ID.

Name	Type	Description
assetID	number	The ID of the asset to be deleted.

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

deleteHierachyById(hierarchyId){Promise.<unknown>}

Services/GoDMD/functions/generics.ts, line 85

Delete a hierarchy

Name	Type	Description
hierarchyId	number	The ID of the hierarchy to be deleted.

Returns:

Type	Description
Promise.<unknown>	A promise that resolves with the response from the DELETE request

deleteHierarchyItem(hierarchyItemIds){Promise.<unknown>}

Services/GoDMD/functions/generics.ts, line 123

Delete hierarchy items

Name	Type	Description
hierarchyItemIds	Array.<unknown>	An array of IDs representing the hierarchy items to be deleted.

Returns:

Type	Description
Promise.<unknown>	A promise that resolves with the response from the DELETE request.

disableRotation(idMap)

Interactions/Views/interact/Rotation/rotation.methods.ts, line 82

Disables all rotation interactions and controls on the specified map.

Name	Type	Description
idMap	string	The ID of the map.

dmdMultiTenantCommonCall(params){CancelablePromise.<any>}

Services/GoDMD/functions/common.ts, line 8

Makes a POST request to the multi-tenant common endpoint with the specified method, URL, and data.

Name	Type	Description
params	Object	The parameters for the request. Name Type Default Description method string The HTTP method to use for the request (e.g., "POST"). url string The URL endpoint for the request. data unknown {} optional Optional data to send with the request. Defaults to an empty object.

Returns:

Type	Description
CancelablePromise.<any>	A CancelablePromise that resolves with the response data or rejects with an error.

evaluateCondition(condition){boolean}

Utils/eval-function/index.ts, line 1

This function allow to evaluate a string and return the result.

Name	Type	Description
condition	string	The condition to evaluate.

Returns:

Type	Description
boolean	Return the result of the evaluation.

evaluateCondition(obj){void}

Utils/eval-function/index.ts, line 17

MThis function allow to evaluate a string and return the result.

Name	Type	Description
obj	string	The object to evaluate.

Returns:

Type	Description
void	Return nothing

formatBounds(bounds)

MapboxViewer/shared/sync-test-utils.ts, line 83

Formats bounds for display

Name	Type	Description
bounds		Bounds to format

Returns:

Formatted string

formatFilter(filter){string}

Layers/GoLayer/index.ts, line 335

This function allow to format the filter.

Name	Type	Description
filter	string	The filter to format.

Returns:

Type	Description
string	Return the formatted filter.

genericErrorsSet(errorSeverity, errorType, errorMsg, errorObj){void}

Utils/classes/GoError/setters/GenericErrorsSet.ts, line 19

Add a new entry to the log of the current class and print the error in the console.

Name	Type	Description
errorSeverity	module:types~ErrorSeverity	The error severity
errorType	module:types~genericErrors	The error type
errorMsg	string	The error message
errorObj	object	The error object

Returns:

Type	Description
void	Return nothing

asyncgetAllsensorsFromNexus(params){Promise.<any>}

Interactions/ExternalsConnections/interact/Nexus/nexus.methods.ts, line 3

Retrieves all sensors from Nexus based on a specific location.

Name	Type	Description
params	Object	The parameters object. Name Type Description location string The location identifier to retrieve sensors from. token string The authentication token required for accessing Nexus services. bindingUrl string The URL binding to connect with Nexus API.

Throws:

Will return undefined if backend features are not enabled or if the location is empty.

Returns:

Type	Description
Promise.<any>	A promise that resolves to the list of sensors from the specified location in Nexus.

getAssetById(assetID){Promise.<AxiosResponse>}

Services/GoDMD/functions/getters.ts, line 12

Return the Assets by id of the DMD

Name	Type	Description
assetID	number	The ID of the asset to retrieve.

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

getAssetDescFilters(){Promise.<AxiosResponse>}

Services/GoDMD/functions/getters.ts, line 35

Find search criteria filters documentation.

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

getAssetDescUpdateById(assetId){Promise.<AxiosResponse>}

Services/GoDMD/functions/getters.ts, line 46

Find api asset description by asset id to update assets

Name	Type	Description
assetId	number	The ID of the asset to retrieve the description for.

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

getAssets(){Promise.<AxiosResponse>}

Services/GoDMD/functions/getters.ts, line 24

Retrive Assets by custom fielters built with parameters

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

getAssetsByHierarchyId(hierarchyId){Promise.<AxiosResponse>}

Services/GoDMD/functions/getters.ts, line 69

Find assets by ids of hierarchies

Name	Type	Description
hierarchyId	number	The ID of the hierarchy to retrieve assets for.

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

getAssetsByTemplateId(templateId){Promise.<AxiosResponse>}

Services/GoDMD/functions/getters.ts, line 106

Retrieve Api Assets by template id

Name	Type	Description
templateId	number	The ID of the template to retrieve assets for.

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

getAssetsFiltered(){Promise.<AxiosResponse>}

Services/GoDMD/functions/getters.ts, line 58

Retrieve all Api Assets filtered

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

getAssetsHierarchiesChildrems(hierarchyItemId){Promise.<AxiosResponse>}

Services/GoDMD/functions/getters.ts, line 92

Find assets children of hierarchy item

Name	Type	Description
hierarchyItemId	number	The ID of the hierarchy item to retrieve children assets for.

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

getAssetsModifiedSinceByTemplateId(templateId, date){Promise.<AxiosResponse>}

Services/GoDMD/functions/getters.ts, line 118

Retrieve Api Assets by template id

Name	Type	Description
templateId	number	The ID of the template to retrieve assets for.
date	Date	The date to filter assets modified since.

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

getAssetsModifiedSinceByTemplateName(templateName){Promise.<AxiosResponse>}

Services/GoDMD/functions/getters.ts, line 134

Retrieve Api Assets by template name

Name	Type	Description
templateName	string	The name of the template to retrieve assets for.

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

getBoundindBox(featureCollection){Array.<number>}

Interactions/Analysis/interact/TurfTools.ts, line 5

This function allow to obtain the bounding box.

Name	Type	Description
featureCollection	any	The feature collection to obtain the bounding box.

Returns:

Type	Description
Array.<number>	Return the bounding box.

getBoundindBox(featureCollection, isFromLayer){Array.<number>}

Interactions/Analysis/interact/TurfTools.ts, line 16

This function allow to get the converted Hull data.

Name	Type	Description
featureCollection	any	The feature collection to obtain the convex hull.
isFromLayer	boolean	The boolean to know if the hull is from a layer or not.

Returns:

Type	Description
Array.<number>	Return the convex hull.

getCallBackUrl(baseUrl, templateId, feature){string}

Services/GoDMD/functions/getters.ts, line 306

Return the callback url for the asset creation

Name	Type	Description
baseUrl	string	The base URL for the callback.
templateId	number	The ID of the template to be used.
feature	Feature	The feature to be included in the callback URL.

Returns:

Type	Description
string	The constructed callback URL.

asyncgetCoordinatesFromDirection(params){Promise.<any>}

Interactions/ExternalsConnections/interact/Geocoding/geocoding.methods.ts, line 80

Retrieves the coordinates from a given address using the default geocoding service.

Name	Type	Description
params	Object	The parameters object. Name Type Description direction string The address to geocode.

Returns:

Type	Description
Promise.<any>	A promise that resolves to the coordinates of the address.

asyncgetCoordinatesFromDirectionHERE(params){Promise.<any>}

Interactions/ExternalsConnections/interact/Geocoding/geocoding.methods.ts, line 95

Retrieves the coordinates from a given address using HERE geocoding service.

Name	Type	Description
params	Object	The parameters object. Name Type Description direction string The address to geocode.

Returns:

Type	Description
Promise.<any>	A promise that resolves to the coordinates of the address from HERE.

asyncgetCoordinatesFromDirectionProperties(params){Promise.<any>}

Interactions/ExternalsConnections/interact/Geocoding/geocoding.methods.ts, line 161

Retrieves detailed coordinates properties from a given address using HERE geocoding service.

Name	Type	Description
params	Object	The parameters object. Name Type Description direction string The address to retrieve properties for.

Returns:

Type	Description
Promise.<any>	A promise that resolves to the detailed coordinates properties from HERE.

getDMD(params){GoDMD}

Interactions/ExternalsConnections/interact/DMD/dmd.methods.ts, line 15

Retrieves a GoDMD instance by its ID.

Name	Type	Description
params	Object	The parameters object. Name Type Description dmdId string The unique identifier of the GoDMD instance.

Returns:

Type	Description
GoDMD	The GoDMD instance associated with the given ID.

getDMDs(){Array}

Interactions/ExternalsConnections/interact/DMD/dmd.methods.ts, line 36

Retrieves all stored GoDMD instances as an array of objects with name and value pairs.

Returns:

Type	Description
Array	An array of objects, each containing the name (ID) and value (GoDMD instance).

getDensityLayer(params){GoDensityTool|false}

Interactions/Analysis/interact/DensityTools/densityLayer.methods.ts, line 111

Get the density layer associated with a specific map and density tool.

Name	Type	Description
params	Object	Parameters object. Name Type Description idMap string The identifier of the map. idDensityTool string The identifier of the density tool.

Returns:

Type	Description
GoDensityTool | false	The density tool if it exists, or false if it doesn't.

asyncgetDirectionFromCoordinates(lat, lng){Promise.<any>}

Interactions/ExternalsConnections/interact/Geocoding/geocoding.methods.ts, line 45

Retrieves the address from the given coordinates using the default geocoding service.

Name	Type	Description
lat	number	The latitude of the location.
lng	number	The longitude of the location.

Returns:

Type	Description
Promise.<any>	A promise that resolves to the address information.

asyncgetDirectionFromCoordinatesHERE(params){Promise.<any>}

Interactions/ExternalsConnections/interact/Geocoding/geocoding.methods.ts, line 62

Retrieves the address from the given coordinates using HERE geocoding service.

Name	Type	Description
params	Object	The parameters object. Name Type Description lat number The latitude of the location. lng number The longitude of the location.

Returns:

Type	Description
Promise.<any>	A promise that resolves to the address information from HERE.

asyncgetDirectionFromCoordinatesProperties(params){Promise.<any>}

Interactions/ExternalsConnections/interact/Geocoding/geocoding.methods.ts, line 140

Retrieves detailed address properties from the given coordinates using HERE geocoding service.

Name	Type	Description
params	Object	The parameters object. Name Type Description lat number The latitude of the location. lng number The longitude of the location.

Returns:

Type	Description
Promise.<any>	A promise that resolves to the detailed address properties from HERE.

getFeatures(geoServerConfig){CancelablePromise.<unknown>}

Services/GoDMD/functions/getters.ts, line 262

Return the features from the GEOSERVER

Name	Type	Description
geoServerConfig	DMDGeoServerConfig	The configuration for the GeoServer, including URL, service type, version, request type, layer name, and other parameters.

Returns:

Type	Description
CancelablePromise.<unknown>	A CancelablePromise that resolves to the features data from the GeoServer or rejects with an error message.

getFullScreen(params){GoFullScreen}

Interactions/Views/interact/FullScreen/fullscreen.methods.ts, line 70

Retrieves the fullscreen control for the specified map.

Returns the GoFullScreen instance associated with the map. Logs a warning if the control does not exist.

Name	Type	Description
params	Object	The parameters object. Name Type Description idMap string The ID of the map for which to retrieve the fullscreen control.

Returns:

Type	Description
GoFullScreen

getHierarchies(){Promise.<AxiosResponse>}

Services/GoDMD/functions/getters.ts, line 186

Return the hierachies of the DMD

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

getHierarchiesItemsMain(){Promise.<AxiosResponse>}

Services/GoDMD/functions/getters.ts, line 81

Retrieve all hierarchy items that are parents of main hierarchy

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

getHierarchyById(hierarchyId){Promise.<AxiosResponse>}

Services/GoDMD/functions/getters.ts, line 209

Retrieve hierarchy by id

Name	Type	Description
hierarchyId	number	The ID of the hierarchy to retrieve.

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

getHierarchyItemById(hierarchyItemId){Promise.<AxiosResponse>}

Services/GoDMD/functions/getters.ts, line 232

Retrieve hierarchy item by id

Name	Type	Description
hierarchyItemId	number	The ID of the hierarchy item to retrieve.

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

getHierarchyItemByParentId(hierarchyItemParentId){Promise.<AxiosResponse>}

Services/GoDMD/functions/getters.ts, line 246

Retrieve hierarchy item by parent id

Name	Type	Description
hierarchyItemParentId	number	The parent ID of the hierarchy items to retrieve.

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

getHierarchyItems(){Promise.<AxiosResponse>}

Services/GoDMD/functions/getters.ts, line 221

Retrieve all hierarchyItems available

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

getHierarchyItemsById(hierarchyId){Promise.<AxiosResponse>}

Services/GoDMD/functions/getters.ts, line 197

Retrieve all hierarchy items available by hierarchy id and asset id

Name	Type	Description
hierarchyId	number	The ID of the hierarchy to retrieve items for.

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

asyncgetHistoricInfoFromNexus(params){Promise.<any>}

Interactions/ExternalsConnections/interact/Nexus/nexus.methods.ts, line 35

Retrieves historical data from Nexus for a specific sensor.

Name	Type	Description
params	Object	Parameters object. Name Type Description sensorUID string The unique identifier of the sensor to retrieve historical data for. token string The authentication token required for accessing Nexus services. bindingUrl string The URL binding to connect with Nexus API.

Throws:

Will return undefined if backend features are not enabled or if the sensor UID is not provided.

Returns:

Type	Description
Promise.<any>	A promise that resolves to the historical data of the specified sensor from Nexus.

getMultiExtent(params){null|Array.<number>}

Interactions/Selection/interact/selection.methods.ts, line 6

Retrieves the maximum extent that encompasses all specified layers within a map.

Name	Type	Description
params	Object	The parameters object. Name Type Description idMap string The ID of the map. idLayers Array.<string> optional Optional array of layer IDs to consider. If not provided, all layers are considered.

Returns:

Type	Description
null | Array.<number>	The extent of the combined layers as [minX, minY, maxX, maxY], or null if no valid layers are found.

getPrint(idMap, idPrint){GoPrint|undefined}

Interactions/Views/interact/Print/print.methods.ts, line 86

Retrieves a print configuration for a given map ID and print ID.

Name	Type	Description
idMap	string	The ID of the map.
idPrint	string	The ID of the print configuration.

Returns:

Type	Description
GoPrint | undefined	The print configuration, or undefined if it does not exist.

getRotation(params){GoRotation}

Interactions/Views/interact/Rotation/rotation.methods.ts, line 111

Retrieves the rotation instance for the specified map and rotation ID.

Name	Type	Description
params	object	The parameters object. Name Type Description idMap string The ID of the map. idRotation string The ID of the rotation.

Returns:

Type	Description
GoRotation	The rotation instance if found, otherwise undefined.

getTemplateById(templateId){Promise.<AxiosResponse>}

Services/GoDMD/functions/getters.ts, line 160

Return the Template by ID

Name	Type	Description
templateId	string	The ID of the template to retrieve.

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

getTemplateDescById(templateId){Promise.<AxiosResponse>}

Services/GoDMD/functions/getters.ts, line 172

Return the Template by ID

Name	Type	Description
templateId	number	The ID of the template to retrieve the description for.

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

getTemplates(){Promise.<AxiosResponse>}

Services/GoDMD/functions/getters.ts, line 149

Return the Templates of the DMD

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

getThematicMap(params){LayerGroupIA}

Interactions/thematicMap/thematicMap.method.ts, line 82

Retrieves a thematic map for a given map. If the map or thematic map does not exist, a warning is triggered.

Name	Type	Description
params	Object	Parameters for getting a thematic map. Name Type Description mapId string The ID of the map. thematicMapId string The ID of the thematic map.

Returns:

Type	Description
LayerGroupIA	The layer group IA of the thematic map, or an empty array if not found.

getWMSGetFeatureInfo(params){GoWMSGetFeatureInfo|undefined}

Interactions/ExternalsConnections/interact/WMS/wmsFeatureInfo.methods.ts, line 90

Retrieves a WMS GetFeatureInfo interaction from the map.

Name	Type	Description
params	Object	Parameters object. Name Type Description idMap string The ID of the map. idWMSGetFeatureInfo string The ID of the WMS GetFeatureInfo interaction.

Returns:

Type	Description
GoWMSGetFeatureInfo | undefined	The GoWMSGetFeatureInfo instance if exists; otherwise, undefined.

hasDMD(params){boolean}

Interactions/ExternalsConnections/interact/DMD/dmd.methods.ts, line 45

Checks if a GoDMD instance exists by its ID.

Name	Type	Description
params	Object	The parameters object. Name Type Description dmdId string The unique identifier for the GoDMD instance.

Returns:

Type	Description
boolean	True if the GoDMD instance exists, false otherwise.

hasDensityLayer(params){boolean}

Interactions/Analysis/interact/DensityTools/densityLayer.methods.ts, line 90

Checks if a density layer exists on the map.

Name	Type	Description
params	object	The parameters object. Name Type Description idMap string The identifier of the map. idDensityTool string The identifier of the density tool.

Returns:

Type	Description
boolean	Returns true if the density layer exists, otherwise false.

hasDrawSelectByPolygon(params){boolean}

Interactions/Selection/interact/SelectByPolygon/selectByPolygon.methods.ts, line 81

Checks if a draw select by polygon exists for the specified map and ID.

Name	Type	Description
params	Object	The parameters object.

Returns:

Type	Description
boolean	True if the draw select by polygon exists, false otherwise.

hasDrawSelectByPolygonInCluster(params){boolean}

Interactions/Selection/interact/SelectByPolygon/selectByPolygon.methods.ts, line 310

Checks if a draw select by polygon in a cluster exists for the specified map and ID.

Name	Type	Description
params	Object	The parameters object.

Returns:

Type	Description
boolean	True if the draw select by polygon in cluster exists, false otherwise.

hasFullScreen(params){boolean}

Interactions/Views/interact/FullScreen/fullscreen.methods.ts, line 10

Checks if a fullscreen control is currently active for the specified map.

Name	Type	Description
params	Object	The parameters object. Name Type Description idMap string The ID of the map to check.

Returns:

Type	Description
boolean	true if the fullscreen control exists for the map; otherwise, false.

hasIFCModel(params){boolean}

Interactions/IFC/ifc.methods.ts, line 39

Checks whether a specific IFC model exists within a given map.

Name	Type	Description
params	object	The parameters object. Name Type Description idMap string The unique identifier for the map. idIFCModel string The unique identifier for the IFC model to check.

Returns:

Type	Description
boolean	Returns true if the IFC model exists in the specified map, false otherwise.

hasMeasure(params){boolean}

Interactions/Analysis/interact/Measure/measure.methods.ts, line 63

Checks if a measurement tool exists on the specified map.

Name	Type	Description
params	object	Parameters object. Name Type Description idMap string The ID of the map to check. idMeasure string The ID of the measurement tool to check.

Returns:

Type	Description
boolean	True if the measurement exists, false otherwise.

hasOverlay(params){boolean}

Interactions/Views/interact/Overlay/overlay.methods.ts, line 58

Checks if an overlay exists on the specified map.

Name	Type	Description
params	Object	Parameters object. Name Type Description idMap string The ID of the map to check. idOverlay string The ID of the overlay to check.

Returns:

Type	Description
boolean	true if the overlay exists on the map; otherwise, false.

hasPrint(idMap, idPrint){boolean}

Interactions/Views/interact/Print/print.methods.ts, line 7

Checks if a print configuration exists for a given map ID and print ID.

Name	Type	Description
idMap	string	The ID of the map.
idPrint	string	The ID of the print configuration.

Returns:

Type	Description
boolean	True if the print configuration exists, false otherwise.

hasRotation(params){boolean}

Interactions/Views/interact/Rotation/rotation.methods.ts, line 14

Checks if a rotation exists for the specified map and rotation ID.

Name	Type	Description
params	object	Parameters object. Name Type Description idMap string The ID of the map. idRotation string The ID of the rotation.

Returns:

Type	Description
boolean	True if the rotation exists, false otherwise.

hasSelectByPolygon(params){boolean}

Interactions/Selection/interact/SelectByPolygon/selectByPolygon.methods.ts, line 191

Checks if a select by polygon exists for the specified map and ID.

Name	Type	Description
params	Object	The parameters object.

Returns:

Type	Description
boolean	True if the select by polygon exists, false otherwise.

hasSelectByPolygonInCluster(params){boolean}

Interactions/Selection/interact/SelectByPolygon/selectByPolygon.methods.ts, line 442

Checks if a select by polygon in cluster exists for the specified map and ID.

Name	Type	Description
params	object	Parameters object. Name Type Description idMap string The ID of the map. idSelectByPolygonInCluster string The ID of the select by polygon in cluster.

Returns:

Type	Description
boolean	True if the select by polygon in cluster exists, false otherwise.

hasThematicMap(params){boolean}

Interactions/thematicMap/thematicMap.method.ts, line 61

Checks whether a thematic map exists for a given map.

Name	Type	Description
params	Object	Parameters for checking a thematic map. Name Type Description mapId string The ID of the map. thematicMapId string The ID of the thematic map.

Returns:

Type	Description
boolean	True if the thematic map exists, otherwise false.

hasWMSGetFeatureInfo(params){boolean}

Interactions/ExternalsConnections/interact/WMS/wmsFeatureInfo.methods.ts, line 69

Checks if a WMS GetFeatureInfo interaction exists for a given map and ID.

Name	Type	Description
params	Object	Parameters object. Name Type Description idMap string The ID of the map. idWMSGetFeatureInfo string The ID of the WMS GetFeatureInfo interaction.

Returns:

Type	Description
boolean	True if the interaction exists, false otherwise.

logSynchronizationResults(results)

MapboxViewer/shared/sync-test-utils.ts, line 164

Logs synchronization test results to console

Name	Type	Description
results		Test results from testSynchronizationPrecision

mapboxZoomToOLResolution(zoom, projectionCode)

MapboxViewer/shared/utils.ts, line 4

Converts Mapbox zoom level to OpenLayers resolution.

Name	Type	Default	Description
zoom			The zoom level.
projectionCode		EPSG:3857	The projection code.

Returns:

The resolution.

mapsErrorsSet(errorSeverity, errorType, errorMsg, errorObj){void}

Utils/classes/GoError/setters/MapsErrorsSet.ts, line 19

Add a new entry to the log of the current class and print the error in the console.

Name	Type	Description
errorSeverity	module:types~ErrorSeverity	The error severity
errorType	module:types~genericErrors	The error type
errorMsg	string	The error message
errorObj	object	The error object

Returns:

Type	Description
void	Return nothing

networkErrorsSet(errorSeverity, errorType, errorMsg, errorObj){void}

Utils/classes/GoError/setters/NetworkErrorsSet.ts, line 19

Add a new entry to the log of the current class and print the error in the console.

Name	Type	Description
errorSeverity	module:types~ErrorSeverity	The error severity
errorType	module:types~genericErrors	The error type
errorMsg	string	The error message
errorObj	object	The error object

Returns:

Type	Description
void	Return nothing

olResolutionToMapboxZoom(resolution, projectionCode)

MapboxViewer/shared/utils.ts, line 20

Converts OpenLayers resolution to Mapbox zoom level.

Name	Type	Default	Description
resolution			The resolution.
projectionCode		EPSG:3857	The projection code.

Returns:

The zoom level.

onFullScreenEnter(params){void}

Interactions/Views/interact/FullScreen/fullscreen.methods.ts, line 103

Registers a callback function to be executed when entering fullscreen mode on the specified map.

Name	Type	Description
params	Object	The parameters object. Name Type Description idMap string The ID of the map to which the fullscreen control belongs. callBack function The callback function to execute when entering fullscreen.

Returns:

Type	Description
void

onFullScreenExit(params){void}

Interactions/Views/interact/FullScreen/fullscreen.methods.ts, line 123

Registers a callback function to be executed when exiting fullscreen mode on the specified map.

Name	Type	Description
params	Object	The parameters object. Name Type Description idMap string The ID of the map to which the fullscreen control belongs. callBack function The callback function to execute when exiting fullscreen.

Returns:

Type	Description
void

rasterStyleFunction(pixels, data){string|number|Array.<number>|Object}

Layers/GoRemoteSensing/rasterStyle.ts, line 5

A style function for raster layers in a GIS application. It determines the style for a given pixel based on its value. The function examines the pixel value (in grayscale from 0 to 255) and matches it to a corresponding style defined in an index array provided in the data argument.

Name	Type	Description
pixels	Array.<Array.<number>>	An array representing the pixel data. Each pixel is an array of [R, G, B, A] values.
data	Object	An object containing styling information, including an indexArray which maps value ranges to styles.

Returns:

Type	Description
string | number | Array.<number> | Object	The style to be applied to the pixel. This could be a color string, number, array, or object, depending on the application's requirements.

refresh(){void}

Layers/GoGeoJsonLayer/index.ts, line 180

This function alloow to refresh the layer

Returns:

Type	Description
void	Return nothing

registerGeocodingHERE(params){CancelablePromise.<void>}

Interactions/ExternalsConnections/interact/Geocoding/geocoding.methods.ts, line 10

This function allows to register the geocoding service.

Name	Type	Description
params	types.HEREParams	The environment, appID, clientID and APIKey.

Returns:

Type	Description
CancelablePromise.<void>	Returns an empty promise.

removeDMD(params)

Interactions/ExternalsConnections/interact/DMD/dmd.methods.ts, line 26

Removes the GoDMD instance associated with the given ID.

Name	Type	Description
params	Object	The parameters object. Name Type Description dmdId string The unique identifier for the GoDMD instance.

removeDrawSelectByPolygon(params)

Interactions/Selection/interact/SelectByPolygon/selectByPolygon.methods.ts, line 123

Removes a draw select by polygon from the specified map.

Name	Type	Description
params	Object	The parameters object.

removeDrawSelectByPolygonInCluster(params)

Interactions/Selection/interact/SelectByPolygon/selectByPolygon.methods.ts, line 357

Removes a draw select by polygon in cluster from the specified map.

Name	Type	Description
params	Object	The parameters object.

removeFullScreen(params){void}

Interactions/Views/interact/FullScreen/fullscreen.methods.ts, line 21

Removes the fullscreen control from the specified map.

If a fullscreen control exists for the map, it will be destroyed and removed.

Name	Type	Description
params	Object	The parameters object. Name Type Description idMap string The ID of the map from which to remove the fullscreen control.

Returns:

Type	Description
void

removeIFCModel(idMap, idIFCModel)

Interactions/IFC/ifc.methods.ts, line 57

Removes a specific IFC model from a given map if it exists.

Name	Type	Description
idMap	string	The unique identifier for the map.
idIFCModel	string	The unique identifier for the IFC model to be removed.

removeMeasure(params)

Interactions/Analysis/interact/Measure/measure.methods.ts, line 136

Removes a measurement tool from the specified map.

Name	Type	Description
params	object	Parameters object. Name Type Description idMap string The ID of the map to remove the measurement from. idMeasure string The ID of the measurement tool to remove.

removeOverlay(params){void}

Interactions/Views/interact/Overlay/overlay.methods.ts, line 76

Removes an overlay from the specified map.

This function first checks if the map and the overlay exist before attempting to remove the overlay from the map. If the overlay exists, it is removed, and the overlay entry is deleted.

Name	Type	Description
params	Object	Parameters object. Name Type Description idMap string The ID of the map from which the overlay will be removed. idOverlay string The ID of the overlay to be removed.

Returns:

Type	Description
void

removePrint(idMap, idPrint){void}

Interactions/Views/interact/Print/print.methods.ts, line 23

Removes a print configuration from a given map by its print ID.

Name	Type	Description
idMap	string	The ID of the map.
idPrint	string	The ID of the print configuration to be removed.

Returns:

Type	Description
void

removeRotation(idMap, idRotation)

Interactions/Views/interact/Rotation/rotation.methods.ts, line 31

Removes a rotation from the specified map and rotation ID.

Name	Type	Description
idMap	string	The ID of the map.
idRotation	string	The ID of the rotation.

removeSelectByPolygon(params)

Interactions/Selection/interact/SelectByPolygon/selectByPolygon.methods.ts, line 209

Removes a select by polygon from the specified map.

Name	Type	Description
params	Object	The parameters object.

removeSelectByPolygonInCluster(params)

Interactions/Selection/interact/SelectByPolygon/selectByPolygon.methods.ts, line 462

Removes a select by polygon in cluster from the specified map.

Name	Type	Description
params	object	Parameters object. Name Type Description idMap string The ID of the map. idSelectByPolygonInCluster string The ID of the select by polygon in cluster.

removeThematicMap(params){void}

Interactions/thematicMap/thematicMap.method.ts, line 126

Removes a thematic map from a given map. If the map or thematic map does not exist, an warning is triggered.

Name	Type	Description
params	Object	Parameters for removing a thematic map. Name Type Description mapId string The ID of the map. thematicMapId string The ID of the thematic map.

Returns:

Type	Description
void

removeWMSGetFeatureInfo(params){void}

Interactions/ExternalsConnections/interact/WMS/wmsFeatureInfo.methods.ts, line 123

Removes a WMS GetFeatureInfo interaction from the map.

Name	Type	Description
params	Object	Parameters object. Name Type Description idMap string The ID of the map. idWMSGetFeatureInfo string The ID of the WMS GetFeatureInfo interaction.

Throws:

Will log an error if the interaction does not exist for the given map and ID.

Returns:

Type	Description
void

resetRotation(view)

MapboxViewer/application/use-cases/ToggleRenderer.ts, line 7

Resets rotation and pitch for OpenLayers compatibility.

Name	Type	Description
view		The view state to reset.

Returns:

Updated view state with rotation reset.

restoreStyle(){void}

Layers/GoStyledLayer/index.ts, line 159

This function allows to restore the initial style of layer

Returns:

Type	Description
void	Return nothing

sendRequestFun(axiosObj){CancelablePromise.<AxiosResponse>}

Services/GoAxiosServices/functions/sendRequestFun.ts, line 27

This function allow to access to the axios services.

Name	Type	Description
axiosObj	module:types~AxiosRequestConfig	The axios configuration object.

Returns:

Type	Description
CancelablePromise.<AxiosResponse>	Return promise of Axios.

setActiveDrawSelectByPolygon(params)

Interactions/Selection/interact/SelectByPolygon/selectByPolygon.methods.ts, line 99

Activates or deactivates the draw select by polygon for the specified map and ID.

Name	Type	Description
params	Object	The parameters object.

setActiveDrawSelectByPolygonInCluster(params)

Interactions/Selection/interact/SelectByPolygon/selectByPolygon.methods.ts, line 330

Activates or deactivates the draw select by polygon in cluster for the specified map and ID.

Name	Type	Description
params	Object	The parameters object.

setActiveMeasure(params)

Interactions/Analysis/interact/Measure/measure.methods.ts, line 81

Activates or deactivates a measurement tool on the specified map.

Name	Type	Description
params	object	Parameters object. Name Type Description idMap string The ID of the map containing the measurement tool. idMeasure string The ID of the measurement tool. active boolean True to activate, false to deactivate.

setInitialStyle(styles){void}

Layers/GOVectorTileOwn/index.ts, line 236

This function allow to set the initial style from the config file.

Name	Type	Description
styles	string	The initStyle of the layer.

Returns:

Type	Description
void	Return nothing

showErrorFun(logEntry){void}

Utils/classes/GoError/functions/showErrorFun.ts, line 14

Show a types of error based on the ErrorSeverity

Name	Type	Description
logEntry	module:types~ErrorsLogEntry	The error log entry

Returns:

Type	Description
void	Return nothing

showNetworkErrorFun(serverError, error){void}

Services/GoAxiosServices/functions/showNetworkErrorFun.ts, line 18

This function allow to show the error messages.

Name	Type	Description
serverError	module:types~ServerError	The server error.
error	any	The error object.

Returns:

Type	Description
void	Return nothing

stylesErrorsSet(errorSeverity, errorType, errorMsg, errorObj){void}

Utils/classes/GoError/setters/StylesErrorsSet.ts, line 19

Add a new entry to the log of the current class and print the error in the console.

Name	Type	Description
errorSeverity	module:types~ErrorSeverity	The error severity
errorType	module:types~genericErrors	The error type
errorMsg	string	The error message
errorObj	object	The error object

Returns:

Type	Description
void	Return nothing

asyncsuggestAddress(param0){Promise.<any>}

Interactions/ExternalsConnections/interact/Geocoding/geocoding.methods.ts, line 110

Suggests addresses based on the input parameters using HERE geocoding service.

Name	Type	Description
param0	Object	The parameters object. Name Type Description params HERESuggestParams The parameters for address suggestion including query and location context.

Returns:

Type	Description
Promise.<any>	A promise that resolves to a list of suggested addresses.

syncGlobalLayout()

UIMap/UIDisplay/UILeftPanel/index.ts, line 21

Synchronizes global layout classes based on whether any panel is open. Adds or removes CSS classes on main layout containers.

testSynchronizationPrecision(viewBefore, viewAfter)

MapboxViewer/shared/sync-test-utils.ts, line 95

Test synchronization precision between two view states

Name	Type	Description
viewBefore		View state before toggle
viewAfter		View state after toggle

Returns:

Test results with metrics

asynctoggleRendererUseCase(params)

MapboxViewer/application/use-cases/ToggleRenderer.ts, line 17

Toggles the active renderer between Mapbox and OpenLayers for all maps. Uses bounds-based synchronization for precise view state transfer.

Name	Type	Description
params		Object containing renderers by map and active type.

Returns:

The new active renderer type.

trowErrorHandlerFun(errorType, errorMsg, errorObj){void}

Services/GoAxiosServices/functions/trowErrorHandlerFun.ts, line 18

This function allow to handle the network errors.

Name	Type	Description
errorType	module:types~networkErrors	The error type.
errorMsg	string	The error message.
errorObj	object	The error object.

Returns:

Type	Description
void	Return nothing

asyncupdateAsset(asset){Promise.<AxiosResponse>}

Services/GoDMD/functions/generics.ts, line 19

Return the characteristics of the DMD

Name	Type	Description
asset	DMDAsset	The DMDAsset object to be updated.

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

asyncupdateHierarchy(hierarchy){Promise.<unknown>}

Services/GoDMD/functions/generics.ts, line 72

update a hierarchy

Name	Type	Description
hierarchy	unknown	The updated hierarchy data.

Returns:

Type	Description
Promise.<unknown>	A promise that resolves with the response from the PUT request.

updateHierarchyItem(hierarchyItem){Promise.<unknown>}

Services/GoDMD/functions/generics.ts, line 110

Update a hierarchy item

Name	Type	Description
hierarchyItem	unknown	The updated hierarchy item data.

Returns:

Type	Description
Promise.<unknown>	A promise that resolves with the response from the PUT request.

asyncupdateMultiplesAssets(){Promise.<AxiosResponse>}

Services/GoDMD/functions/generics.ts, line 32

Update assets by Api Asset

Returns:

Type	Description
Promise.<AxiosResponse>	A Promise that resolves to an AxiosResponse object containing the result of the API call.

validateArray(array)

Utils/classes/GoConfigValidator/validators/primitivesValidators.ts, line 1

Validate type Array

Name	Type	Description
array		Array

Returns:

boolean - true if the array is valid, false otherwise.

Type Definitions

Coordinate

Properties:

Type	Description
Array.<number>	Coordinates [x,y] or [lat,long]

GO_CONFIG

The configuration for the external requests

Properties:

Name	Type	Description
GO_AIGUA_WEB	string	https://gateway-proxy-gis-devtools.go-aigua.com
GO_AIGUA_PRE	string	https://gateway-proxy-dev.go-aigua.com
GO_AIGUA_DEV_GIS	string	https://gateway-proxy-dev-gis.go-aigua.com/
GOOGLE_MAPS_API	string	https://maps.googleapis.com/maps/api/geocode/json
SVG_URL	string	https://goaiguagisapi.blob.core.windows.net/go-gis-api-dev/fw/svg/
REGION_ENVIROMENTS:	string	EUROPE | AMERICA | ASIA
SERVICES	string	ICON_GENERATOR | ICON_GENERATOR_WEBGL | ICON_GENERATOR_SPRITE | ICON_GENERATOR_DEFAULT_URL

Interface Definitions

UIVRSEvents

Interface for the response structure of Rs1 API call.