Class: GoInteractions

GoInteractions

This class allow to interact with the map.

new GoInteractions(stagingMap)

Interactions/index.ts, line 57
Name Type Description
stagingMap Map.<string, GOStagingMap>

The map of all layers.

Extends

Members

addThematicMap

Create thematicMap interaction

getThematicMap

get LayerGroupIA (array LayerIA) of thematicMap

hasThematicMap

return if exist thematicMap interaction

removeThematicMap

remove thematicMap interaction if exists

Methods

addBuffer(params){CancelablePromise.<any>}

Interactions/index.ts, line 1780

Add Buffer Interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

idBuffer string

The id of the tool

dataBuffer module:types~bufferParams

Array contain data and distance for buffering

style module:types~styleFromUser

The style we want to put on the buffer layer

Returns:
Type Description
CancelablePromise.<any> Return promise with the buffer.

addCloseTool(params){void}

Interactions/index.ts, line 838

This function allow to add the closetool feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idCloseTool string

The ID of the closetool.

id number

The ID of the feature.

tablePipe string

The table pipe.

tableValve string

The table valve.

userStyleValve module:types~styleFromUser

The valve style of the user.

userStylePipes module:types~styleFromUser

The pipes style of the user.

Returns:
Type Description
void Return nothing

addCtrlScrollZoom(params)

Interactions/index.ts, line 2862

This function allow to enable the custom zoom with ctrl + scroll

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

addCustomRotateCompass(params){HTMLElement}

Interactions/index.ts, line 2553

This method checks if print interaction exists

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

Returns:
Type Description
HTMLElement
  • Return HTMLElement or null

addCustomZoom(params)

Interactions/index.ts, line 2832

This function allow to add a custom zoom to the map

Name Type Description
params Object
Name Type Description
theme string

string to define if the theme is dark or light

idMap string

Id of the map

addDensityLayer(params){GoDensityTool}

Interactions/index.ts, line 1359

Interaction to transform a Point layer in density layer

Name Type Description
params Object
Name Type Description
idMap string

The id of the map

idDensityTool string

The id of the density tool

layer string

The layer to be transformed

type module:constants~densityToolType
Returns:
Type Description
GoDensityTool

addDrawSelectByPolygon(params){GoDrawSelectByPolygon}

Interactions/index.ts, line 1001

Interaction that allows a polygon to be drawn and everything that has intersected on it is obtained

Name Type Description
params Object
Name Type Description
idMap string
idDrawSelectByPolygon string
callback function
layers Array.<string>
style module:types~userStyle
clickFinish boolean
Returns:
Type Description
GoDrawSelectByPolygon

addDrawSelectByPolygonInCluster(params){GoDrawSelectByPolygon}

Interactions/index.ts, line 1077

Interaction that allows a polygon to be drawn and everything that has intersected on it is obtained

Name Type Description
params Object
Name Type Description
idMap string
idDrawSelectByPolygonInCluster string
callback function
layers Array.<string>
style module:types~userStyle
clickFinish boolean
Returns:
Type Description
GoDrawSelectByPolygon

addEditFeature(params){void}

Interactions/index.ts, line 2783

Interaction to edit feature geometry

Name Type Description
params Object
Name Type Description
idEditFeature string

The id of the edit feature

idMap string

The id of the map

idLayer string

The layer to be edited

Returns:
Type Description
void Return nothing

addExtraDataCloseToolInteractions(params)

Interactions/index.ts, line 2183

This function takes a CloseTool object and adds it to the closeToolData object.

Name Type Description
params Object
Name Type Description
data types.CloseTool

addExtraDataUpDownStreamInteractions(params)

Interactions/index.ts, line 2192

Allow to add upDownToolData to the interaction.

Name Type Description
params Object
Name Type Description
data types.UpDown

addFlowLines(params){GoflowLines}

Interactions/index.ts, line 2671

Interaction to transform a simple style in flow line style. This interactions is only for LineString Geometry

Name Type Description
params Object
Name Type Description
idMap string
idFlowLines string
idLayer string
Returns:
Type Description
GoflowLines

addFullScreen(params){void}

Interactions/index.ts, line 2072

Add new Full Screen interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

Id of the map

Returns:
Type Description
void
  • Return nothing

addHighlight(params){CancelablePromise.<GoHighlight>}

Interactions/index.ts, line 599

This function allow to add hightlight to the map.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHighlight string

The ID of the highlight.

featuresGeom Array.<Feature>

The features of the highlight.

style module:types~styleFromUser

The style of the highlight.

textFunction function

The function to get the text of the highlight.

zIndex number

zIndex of the highlight layer

Returns:
Type Description
CancelablePromise.<GoHighlight> Return the CancelablePromise.

addInterpolation(params){void}

Interactions/index.ts, line 3274

This method allows to create an interpolation interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we have the tool applied

idInterpolation string

The id of the tool

params types.interpolationParams

The id of the tool

Returns:
Type Description
void Return nothing

addIntersect(params){void}

Interactions/index.ts, line 2284

This function allow to add the intersect feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idIntersect string

The ID of the intersect.

intersectDataIn string

The layer for intersect.

intersectDataClip string

The layer to intersect.

Returns:
Type Description
void Return nothing

addIsolines(params){void}

Interactions/index.ts, line 3308

This method allows to create an isolines interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we have the tool applied

idIsolines string

The id of the tool

params types.isolinesParams

The params of the tool

Returns:
Type Description
void Return nothing

addMeasure(params){GoMeasure}

Interactions/index.ts, line 1271

Interaction for measure with line or polygon area

Name Type Description
params Object
Name Type Description
idMap string
idMeasure string
geometryType GeometryType
callbackStart function
callbackEnd function
style module:types~userStyle
defaultTooltip boolean
unitSystemSelected unitSystem
Returns:
Type Description
GoMeasure

addMouseRotation(params)

Interactions/index.ts, line 2544

Change perspective with right mouse button

Name Type Description
params Object
Name Type Default Description
olMap OlMap

the map object

sensibilityMultiplier number 2 optional

The higher the number, the more sensitive the mouse is.

addMultiRoutingHERE(params){void}

Interactions/index.ts, line 3501

This method allow to add a new event listener to the Full Screen interaction. To listenen when the screen is exit from full screen

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

routingID string

Id of the route

points Array.<types.geodesicCoordinates>

Start and end point

stops Array.<types.geodesicCoordinates>

Stops along the route

transportMode string

Transport mode

apiKey string

API key

Returns:
Type Description
void Return nothing

addNearData(params){CancelablePromise.<any>}

Interactions/index.ts, line 1714

Add Near Data Interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

idNearData string

The id from a tool

pointCoordinate Array.<number>

The coordinate data

lookingForData module:types~dataTools

The base layer to looking for near data

stylePoint module:types~ISVGIcon

The style we want to put on the Valves drawing layer

style module:types~styleFromUser

The style we want to put on the Valves drawing layer

Returns:
Type Description
CancelablePromise.<any> Return promise with the closest element.

addNearDataAttributes(params){CancelablePromise.<any>}

Interactions/index.ts, line 1748

Add Near Data Attributes Interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

idInteraction string

The id from a tool

pointCoordinate Array.<number>

The coordinate data

layer module:types~dataTools

The base layer to looking for near data attributes

stylePoint module:types~ISVGIcon

The style we want to put on the Valves drawing layer

style module:types~styleFromUser

The style we want to put on the Valves drawing layer

Returns:
Type Description
CancelablePromise.<any> Return promise with the closest element.

addOpticalFiber(params){void}

Interactions/index.ts, line 3240

This method allows to create an optical fiber segment interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we have the tool applied

idOpticalFiber string

The id of the tool

params types.opticalFiberParams

The id of the tool

Returns:
Type Description
void Return nothing

addOverlay(params){GoOverlay|undefined}

Interactions/index.ts, line 531

This function allow to add a overlay to the map.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idOverlay string

The ID of the overlay.

overlayData module:types~overlayData

The data of the overlay.

Returns:
Type Description
GoOverlay | undefined Return the overlay or undefined.

addPolygonSector(params){Promise.<any>}

Interactions/index.ts, line 1842

Add polygonSector Interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

polygonSectorId string

The id of the polygon sector interaction

polygonSectorData module:types~dataTools

Layer data

polygonSectorParams module:types~polygonSectorParams

Array contain the size of the grid

Returns:
Type Description
Promise.<any> Return promise with the polygon sector object.

addPrint(params){void}

Interactions/index.ts, line 2585

Adds a print interaction to the map.

Name Type Description
params Object

Parameters for the print interaction

Name Type Description
idMap string

The ID of the map

idPrint string

The ID for the print interaction

mapTitle string optional

Title of the map

name string optional

Name of the map

author string optional

Author of the map

date string optional

Date of the map

Returns:
Type Description
void Return nothing

addRotation(params){void}

Interactions/index.ts, line 2515

Interaction to rotate view

Name Type Description
params Object
Name Type Description
idMap string

The id of the map

idRotation string

The id of the rotation interaction

Returns:
Type Description
void Return nothing

addRoutingHERE(params){void}

Interactions/index.ts, line 3488

This method allow to add a new event listener to the Full Screen interaction. To listenen when the screen is exit from full screen

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

routingID string

Id of the route

transportMode string

Transport mode

points Array.<types.geodesicCoordinates>

Start and end point

lang string

Language code

Returns:
Type Description
void Return nothing

addSectorColor(params){CancelablePromise.<any>}

Interactions/index.ts, line 1810

Add SectorColor Interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

sectorColorId string

The id of the sector color interaction

sectorColorData module:types~dataTools

Layer data

sectorColorParams module:types~sectorColorParams

Array contain attribute and palette size

Returns:
Type Description
CancelablePromise.<any> Return promise with the sector color object.

addSelectByPolygon(params){GoDrawSelectByPolygon}

Interactions/index.ts, line 2377

Interaction that allows a polygon to be drawn and everything that has intersected on it is obtained

Name Type Description
params Object
Name Type Description
idMap string
idSelectByPolygon string
callback function
layers Array.<string>
Returns:
Type Description
GoDrawSelectByPolygon

addSelectByPolygonInCluster(params){GoDrawSelectByPolygon}

Interactions/index.ts, line 2460

Interaction that allows a polygon to be drawn and everything that has intersected on it is obtained

Name Type Description
params Object
Name Type Description
idMap string
idSelectByPolygonInCluster string
callback function
layers Array.<string>
Returns:
Type Description
GoDrawSelectByPolygon

addTooltipHoverFeature(params){void}

Interactions/index.ts, line 781

This function allow to add the tooltip feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID Of the map.

idHover string

The ID of the hover.

featuresGeom Feature.<Geometry>

The feature of the geometry.

style module:types~styleFromUser

The styles of the user.

Returns:
Type Description
void Return nothing

addUpDownStream(params){void}

Interactions/index.ts, line 911

This function allow to add the closetool feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idCloseTool string

The ID of the closetool.

id number

The ID of the feature.

tablePipe string

The table pipe.

tableValve string

The table valve.

userStyleValve module:types~styleFromUser

The valve style of the user.

userStylePipes module:types~styleFromUser

The pipes style of the user.

Returns:
Type Description
void Return nothing

addWMSGetFeatureInfo(params){CancelablePromise.<GoWMSGetFeatureInfo>}

Interactions/index.ts, line 1997

This function allow to add WMSGetFeatureInfo to the map.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idWMSGetFeatureInfo string

The ID of the WMSGetFeatureInfo.

featuresGeom Array.<Feature>

The features of the highlight.

Returns:
Type Description
CancelablePromise.<GoWMSGetFeatureInfo> Return a promise of GoWMSGetFeatureInfo

addWatershed(params){CancelablePromise.<any>}

Interactions/index.ts, line 1964

Add watershed Interaction

Name Type Description
params Object

Parameters object

Name Type Description
params module:types~watershedParams

Layer data

Returns:
Type Description
CancelablePromise.<any> Return promise with the watershed object.

autoSuggestAddress(params){CancelablePromise.<any>}

Interactions/index.ts, line 1805

This function auto suggest address while typing in the box. if an error exist, return {lat:0, lng:0}

Name Type Description
params Object
Name Type Description
textToSearch string

The string with the direction to get the coordinates.

Returns:
Type Description
CancelablePromise.<any>

changeHighlightZIndex(params){void}

Interactions/index.ts, line 1961

This function allow to change the zIndex of the highlight.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHighlight string

The ID of the highlight.

zIndex number

The zIndex of the highlight.

Returns:
Type Description
void Return nothing

changeHoverZIndex(params){void}

Interactions/index.ts, line 2145

This function allow to remove the tooltip feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHover string

The ID of the hover.

Returns:
Type Description
void Return nothing

changeStyleOfHighlight(params){void}

Interactions/index.ts, line 662

This function allow to change the highlight style if the highlight exists.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHighlight string

The ID of the highlight.

userStyle module:types~styleFromUser

The highlight style in json variable.

styleSVG module:types~ISVGIcon

The highlight style as SVG icon.

Returns:
Type Description
void

clearCloseTool(params){void}

Interactions/index.ts, line 2173

This function allow to clear the closetool feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idCloseTool string

The ID of the closetool.

Returns:
Type Description
void Return nothing

clearIntersect(params){void}

Interactions/index.ts, line 2306

This function allow to clear the intersect feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idIntersect string

The ID of the intersect.

Returns:
Type Description
void Return nothing

clearMeasure(params){void}

Interactions/index.ts, line 2649

Remove Measure Layer data

Name Type Description
params Object
Name Type Description
idMap string
idMeasure string
Returns:
Type Description
void Return nothing

clearUpDownStream(params){void}

Interactions/index.ts, line 2271

This function allow to clear the UpDown feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idUpDown string

The ID of the UpDown.

Returns:
Type Description
void Return nothing

createCadastre(params){GoCadastre}

Interactions/index.ts, line 2990

Create the Cadastre interaction

Name Type Description
params Object

Parameters object

Name Type Description
cadastreId string

The id of the Cadastre interaction

Returns:
Type Description
GoCadastre Return the Cadastre interaction

createDMD(params){GoDMD}

Interactions/index.ts, line 2946

Create the DMD interaction

Name Type Description
params Object

Parameters object

Name Type Description
dmdId string

The id of the DMD interaction

dmdToken string

The token of the DMD service

Returns:
Type Description
GoDMD Return the DMD interaction

createFeature(params)

Interactions/index.ts, line 2763

This function takes a GeoJSON object and returns an array of features.

Name Type Description
params Object
Name Type Description
feature *
Returns:
A GeoJSON object.

createIFC(props){Promise.<GoIFCComponents>}

Interactions/index.ts, line 2919

Interaction to transform a simple style in flow line style. This interactions is only for LineString Geometry

Name Type Description
props IFCConfig
Returns:
Type Description
Promise.<GoIFCComponents>

createStyle(style){Style}

Interactions/index.ts, line 383

This function allow to create the styles for the layers

Name Type Description
style module:types~styleFromUser

The style that you want to create

Returns:
Type Description
Style Return the style created

deleteFeatures(params){void}

Interactions/index.ts, line 2817

This Method allows to delete feature/s

Name Type Description
params Object
Name Type Description
idMap string

Id of the map that contains the feature/s that you want to delete

idLayer string

Id of the vector layer that contains the feature/s that you want to delete

feature Array.<Feature>

Array of feature/s you want to delete

user string

Geoserver username with permisssions to make the transaction

pass string

Geoserver password with permisssions to make the transaction

Returns:
Type Description
void Return nothing

disableDoubleClickZoom(params)

Interactions/index.ts, line 2891

This function allow to disable the zoom interaction

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

disableRotation(params){void}

Interactions/index.ts, line 2525

Interaction to disable rotate view

Name Type Description
params Object
Name Type Description
idMap string

The id of the map

Returns:
Type Description
void Return nothing

emit(event, data){void}

Interactions/index.ts, line 3420

This method allow to emit an event to the interactions.

Name Type Description
event string

The event name

data object

The data to send to the event

Returns:
Type Description
void Return nothing

enableDoubleClickZoom(params)

Interactions/index.ts, line 2900

This function allow to enable the zoom interaction

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

getAllFeaturesProperties(params){CancelablePromise.<GoHighlight>}

Interactions/index.ts, line 1895

This function allow to add hightlight to the map.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idInteraction string

The ID of the highlight.

Returns:
Type Description
CancelablePromise.<GoHighlight> Return the CancelablePromise.

getAllsensorsFromNexus(params){CancelablePromise.<any>}

Interactions/index.ts, line 1815

This function allow to get all the sensors from nexus.

Name Type Description
params Object
Name Type Description
location string

The location of the point.

token string

The token of the user.

bindingUrl string

The binding url.

Returns:
Type Description
CancelablePromise.<any> Return promise with the sensors.

getCadastre(params){GoCadastre}

Interactions/index.ts, line 2999

Get the Cadastre interaction

Name Type Description
params Object

Parameters object

Name Type Description
cadastreId string

The id of the Cadastre interaction

Returns:
Type Description
GoCadastre Return the Cadastre interaction

getCadastres(){Array.<GoCadastre>}

Interactions/index.ts, line 3008

Allow to get an array of the Cadastre interactions

Returns:
Type Description
Array.<GoCadastre> Return the Cadastre interaction

getCloseTool(params){GoCloseTools}

Interactions/index.ts, line 2211

This function allow to get the closetool feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idCloseTool string

The ID of the closetool.

Returns:
Type Description
GoCloseTools Return the closetool feature.

getCoordinatesFromDirection(params){Array.<any>}

Interactions/index.ts, line 1786

This function allow to get the coordinates from the address.

Name Type Description
params Object
Name Type Description
direction string

The direction of the point.

Returns:
Type Description
Array.<any> Return promise with the coordinates.

getCoordinatesFromDirectionHERE(params){Array.<any>}

Interactions/index.ts, line 1786

This function allow to get the coordinates from the address.

Name Type Description
params Object
Name Type Description
direction string

The direction of the point.

Returns:
Type Description
Array.<any> Return promise with the coordinates.

getCoordinatesFromDirectionProperties(params){CancelablePromise.<any>}

Interactions/index.ts, line 1776

This function allow to get the coordinates from the address.

Name Type Description
params Object
Name Type Description
direction string

The direction of the point.

Returns:
Type Description
CancelablePromise.<any> Return promise with the coordinates.

getDMD(params){GoDMD}

Interactions/index.ts, line 2956

Get the DMD interaction

Name Type Description
params Object

Parameters object

Name Type Description
dmdId string

The id of the DMD interaction

Returns:
Type Description
GoDMD Return the DMD interaction

getDMDs(){Array.<object>}

Interactions/index.ts, line 2965

Allow to get an array of the DMD interactions

Returns:
Type Description
Array.<object> Return the DMD interaction

getDensityLayer(params){GoDensityTool}

Interactions/index.ts, line 1381

Interaction to transform a Point layer in density layer

Name Type Description
params Object
Name Type Description
idMap string

The id of the map

idDensityTool string

The id of the density tool

type module:constants~densityToolType
Returns:
Type Description
GoDensityTool

getDirectionFromCoordinates(params){CancelablePromise.<any>}

Interactions/index.ts, line 1755

This function allow to get the direction from the coordinates.

Name Type Description
params Object
Name Type Description
lat number

The latitude of the point.

lng number

The longitude of the point.

Returns:
Type Description
CancelablePromise.<any> Return promise with the direction.

getDirectionFromCoordinatesHERE(params){CancelablePromise.<any>}

Interactions/index.ts, line 1755

This function allow to get the direction from the coordinates.

Name Type Description
params Object
Name Type Description
lat number

The latitude of the point.

lng number

The longitude of the point.

Returns:
Type Description
CancelablePromise.<any> Return promise with the direction.

getDirectionFromCoordinatesProperties(params){CancelablePromise.<any>}

Interactions/index.ts, line 1755

This function allow to get the direction from the coordinates.

Name Type Description
params Object
Name Type Description
lat number

The latitude of the point.

lng number

The longitude of the point.

Returns:
Type Description
CancelablePromise.<any> Return promise with the direction.

getEditFeatures(params){GoEditFeatures}

Interactions/index.ts, line 2794

Interaction for measure with line or polygon area

Name Type Description
params Object
Name Type Description
idMap string

Id of the map that contains the editable feature/s

idEditFeature string

Id of the edit interaction

Returns:
Type Description
GoEditFeatures
  • Return the edit feature

getEventHandlers(){object}

Interactions/index.ts, line 3413

This method allow to get all the event listeners of the interactions.

Returns:
Type Description
object Return an object with all the event listeners

getFeaturesByLayer(params){Promise.<types.GeoJSONFeatureCollection>}

Interactions/index.ts, line 1871

Retrieves features from a layer using authenticated GeoServer WFS requests. The layer must be defined in the map configuration.

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The ID of the map

layerId string

The ID of the layer from config (required)

cqlFilter string optional

Optional CQL filter expression

maxFeatures number optional

Maximum number of features to return (if not provided, returns all features)

propertyName Array.<string> optional

Specific properties to return (if not provided, returns all properties)

Returns:
Type Description
Promise.<types.GeoJSONFeatureCollection> Promise that resolves to a GeoJSON feature collection
Example
map.interactions.getFeaturesByLayer({
  idMap: "main",
  layerId: "valves",
  cqlFilter: "status='active'",
  maxFeatures: 100,
  propertyName: ["id", "name"]
});

getFullScreen(params){GoFullScreen}

Interactions/index.ts, line 3457

Get the Full Screen interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

Id of the map

Returns:
Type Description
GoFullScreen
  • Return the Full Screen interaction

getHighlight(params){GoHighlight}

Interactions/index.ts, line 1930

This function allow to get the highlight.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHighlight string

The ID of the highlight.

Returns:
Type Description
GoHighlight Return the highlight.

getHistoricInfoFromNexus(params){CancelablePromise.<any>}

Interactions/index.ts, line 1827

This function allow to get the historical data from nexus sensors.

Name Type Description
params Object
Name Type Description
sensorUID string

The sensor UID.

token string

The token of the user.

bindingUrl string

The binding url.

Returns:
Type Description
CancelablePromise.<any> Return promise with the historical data.

getLayerHover(params){GoHover}

Interactions/index.ts, line 2053

This function allow to get the hover feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHover string

The ID of the hover.

Returns:
Type Description
GoHover Return the hover feature.

getMultiExtent(params){void}

Interactions/index.ts, line 3368

This method allow to get the extend of multiple layers

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map

idLayers Array.<string>

Array of id layers

Returns:
Type Description
void Return null or the extend of the layers

getPrint(params){GoPrint}

Interactions/index.ts, line 2600

Get the print interaction

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

idPrint string

Id of the print interaction

Returns:
Type Description
GoPrint
  • Return the print interaction

getRotation(params){GoRotation}

Interactions/index.ts, line 2534

Get the rotation interaction

Name Type Description
params Object
Name Type Description
idMap string

Id of the map that contains the rotatable view

idRotation string

Id of the rotation interaction

Returns:
Type Description
GoRotation
  • Return the rotation interaction

getTooltipHoverFeature(params){GoHoverFeature}

Interactions/index.ts, line 2123

This function allow to get the tooltip feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHover string

The ID of the hover.

Returns:
Type Description
GoHoverFeature Return the tooltip feature.

getWMSGetFeatureInfo(params){GoWMSGetFeatureInfo}

Interactions/index.ts, line 2020

This function allow to get the WMSGetFeatureInfo.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idWMSGetFeatureInfo string

The ID of the WMSGetFeatureInfo.

Returns:
Type Description
GoWMSGetFeatureInfo Return the WMSGetFeatureInfo.

hasBuffer(idMap, idBuffer){Boolean}

Interactions/index.ts, line 3154

This method allows to know if the buffer interaction exists

Name Type Description
idMap string

The id of the map where we want to apply the tool

idBuffer string

The id of the tool

Returns:
Type Description
Boolean Return true|false

hasCadastre(params){GoCadastre}

Interactions/index.ts, line 3015

Allow to determine if the map has a Cadastre interaction by id

Name Type Description
params Object

Parameters object

Name Type Description
cadastreId string

The id of the Cadastre interaction

Returns:
Type Description
GoCadastre Return the Cadastre interaction

hasCloseTool(params){boolean}

Interactions/index.ts, line 2201

This function allow to determine if the closeTool feature exist.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idCloseTool string

The ID of the closetool.

Returns:
Type Description
boolean Return true if the closeTool feature exist, false otherwise.

hasCtrlScrollZoom(params)

Interactions/index.ts, line 2871

This function allow to determine if the custom zoom with ctrl + scroll is enabled on the map

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

hasDMD(params){GoDMD}

Interactions/index.ts, line 2972

Allow to determine if the map has a DMD interaction by id

Name Type Description
params Object

Parameters object

Name Type Description
dmdId string

The id of the DMD interaction

Returns:
Type Description
GoDMD Return the DMD interaction

hasDensityLayer(params){GoDensityTool}

Interactions/index.ts, line 1370

Interaction to transform a Point layer in density layer

Name Type Description
params Object
Name Type Description
idMap string

The id of the map

idDensityTool string

The id of the density tool

type module:constants~densityToolType
Returns:
Type Description
GoDensityTool

hasDisabledDoubleClickZoom(params)

Interactions/index.ts, line 2909

This function allow to determine if the zoom interaction is enabled

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

hasDrawSelectByPolygon(params){boolean}

Interactions/index.ts, line 2344

Method that returns if a select interaction exists

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idDrawSelectByPolygon string

The ID of the select interaction.

Returns:
Type Description
boolean

hasDrawSelectByPolygonInCluster(params){boolean}

Interactions/index.ts, line 2427

Method that returns if a select interaction exists

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idDrawSelectByPolygonInCluster string

The ID of the select interaction.

Returns:
Type Description
boolean

hasEditFeature(params){boolean}

Interactions/index.ts, line 2753

This method checks if any edit feature interaction exists

Name Type Description
params Object
Name Type Description
idMap string
idEditFeature string
Returns:
Type Description
boolean
  • Return true if the edit feature exists

hasEvent(event){boolean}

Interactions/index.ts, line 3405

This method allow to check if the interactions has an event listener.

Name Type Description
event string

The event name

Returns:
Type Description
boolean Return true if the event exists

hasFlowLines(params){boolean}

Interactions/index.ts, line 2682

Method that returns if a select interaction exists

Name Type Description
params Object
Name Type Description
idMap string
idFlowLines string
Returns:
Type Description
boolean

hasFullScreen(params){GoFullScreen}

Interactions/index.ts, line 3429

Get the Full Screen interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

Id of the map

Returns:
Type Description
GoFullScreen
  • Return the Full Screen interaction

hasGetFeature(params){boolean}

Interactions/index.ts, line 2090

This function allow to determine if the feature has the id of the map.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

Returns:
Type Description
boolean Return true if the feature exist.

hasHighlight(params){boolean}

Interactions/index.ts, line 1920

This function allow to determine if the highlight exist.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHighlight string

The ID of the highlight.

Returns:
Type Description
boolean Return true if the highlight exist.

hasHoverFeature(params){boolean}

Interactions/index.ts, line 2042

This functio determine if the map has hover feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHover string

The ID of the hover.

Returns:
Type Description
boolean Return true if the hover exist.

hasIFCModel(params){boolean}

Interactions/index.ts, line 2926

This method checks if any edit feature interaction exists

Name Type Description
params Object

Parameters object

Name Type Description
idMap string
idEditFeature string
Returns:
Type Description
boolean
  • Return true if the edit feature exists

hasInterpolation(params){Boolean}

Interactions/index.ts, line 3286

This method allows to know if the interpolation interaction exists

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

idInterpolation string

The id of the tool

Returns:
Type Description
Boolean Return true|false

hasIntersect(params){boolean}

Interactions/index.ts, line 2296

Determine if the intersect exists

Name Type Description
params Object
Name Type Description
idMap string

the id of the map

idIntersect string

The id of the intersect

Returns:
Type Description
boolean A boolean value.

hasIsolines(params){Boolean}

Interactions/index.ts, line 3319

This method allows to know if the isolines interaction exists

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

idIsolines string

The id of the tool

Returns:
Type Description
Boolean Return true|false

hasMeasure(params){boolean}

Interactions/index.ts, line 2628

Method that returns if a select interaction exists

Name Type Description
params Object
Name Type Description
idMap string
idMeasure string
Returns:
Type Description
boolean

hasNearData(params){Boolean}

Interactions/index.ts, line 3085

This method allows to know if the near data interaction exists

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

idNearData string

The id of the tool

Returns:
Type Description
Boolean Return true | false

hasNearDataAttributes(params){Boolean}

Interactions/index.ts, line 3120

This method allows to know if the near data Attributes interaction exists

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

idInteraction string

The id of the tool

Returns:
Type Description
Boolean Return true | false

hasOpticalFiber(params){Boolean}

Interactions/index.ts, line 3252

This method allows to know if the optical fiber segment interaction exists

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

idOpticalFiber string

The id of the tool

Returns:
Type Description
Boolean Return true|false

hasOverlay(params){boolean}

Interactions/index.ts, line 1850

This function allow to determine if the overlay exist.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idOverlay string

The ID of the overlay.

Returns:
Type Description
boolean Return true if the overlay exist.

hasPolygonSector(params){Boolean}

Interactions/index.ts, line 3218

This method allows to know if the polygon sector interaction exists

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

idPolygonSector string

The id of the tool

Returns:
Type Description
Boolean Return true|false

hasPrint(params){boolean}

Interactions/index.ts, line 2565

This method checks if print interaction exists

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

idPrint string

The id of the print interaction

Returns:
Type Description
boolean
  • Return true if print interaction exists

hasRotation(params){boolean}

Interactions/index.ts, line 2495

This method checks if rotation interaction exists

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

idRotation string

The id of the rotation interaction

Returns:
Type Description
boolean
  • Return true if rotation interaction exists

hasSectorColor(params){Boolean}

Interactions/index.ts, line 3184

This method allows to know if the sector color interaction exists

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

idSectorColor string

The id of the tool

Returns:
Type Description
Boolean Return true|false

hasSelectByPolygon(params){boolean}

Interactions/index.ts, line 2390

Method that returns if a select interaction exists

Name Type Description
params Object
Name Type Description
idMap string
idSelectByPolygon string
Returns:
Type Description
boolean

hasSelectByPolygonInCluster(params){boolean}

Interactions/index.ts, line 2473

Method that returns if a select interaction exists

Name Type Description
params Object
Name Type Description
idMap string
idSelectByPolygonInCluster string
Returns:
Type Description
boolean

hasToolTipHover(params){boolean}

Interactions/index.ts, line 2112

If the map has the key, and the value of the key is a map that has the key, then return true.

Name Type Description
params Object
Name Type Description
idMap string

The id of the map that the tooltip is on.

idHover string
Returns:
Type Description
boolean A boolean value.

hasUpDownStream(params){boolean}

Interactions/index.ts, line 2249

This function allow to determine if the UpDown feature exist.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idUpDown string

The ID of the UpDown.

Returns:
Type Description
boolean Return true if the UpDown feature exist, false otherwise.

hasWMSGetFeatureInfo(params){boolean}

Interactions/index.ts, line 2009

This function allow to determine if the WMSGetFeatureInfo exist.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idWMSGetFeatureInfo string

The ID of the WMSGetFeatureInfo.

Returns:
Type Description
boolean Return true if the WMSGetFeatureInfo exist.

hasWatershed(params){Boolean}

Interactions/index.ts, line 3348

This method allows to know if the watershed interaction exists

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

idWatershed string

The id of the tool

Returns:
Type Description
Boolean Return true|false

mouseHover(params){GoHover|void}

Interactions/index.ts, line 2063

Implements mouse hover interaction on map features.

Name Type Description
params Object

Configuration object for hover interaction.

Name Type Description
idHover string

The ID for the hover layer.

olMap OlMap

The OpenLayers map instance.

layer GOVectorLayer optional

Optional. Layer to apply the hover interaction.

style styleFromUser optional

Optional. Custom style to apply on hover.

callback function optional

Optional. Callback triggered when a feature is hovered. Receives feature: Feature as parameter.

styleSVG types.ISVGIcon optional

Optional. SVG-based icon style.

svgIcon string optional

Optional. Path or ID of the SVG icon as string.

zIndex number optional

Optional. z-index of the hover layer.

Returns:
Type Description
GoHover | void The hover interaction instance or nothing.

off(event, callback){void}

Interactions/index.ts, line 3387

This method allow to remove an event listener to the interactions.

Name Type Description
event string

The event name

callback function

The callback function

Returns:
Type Description
void Return nothing

on(event, callback){void}

Interactions/index.ts, line 3378

This method allow to add a new event listener to the interactions.

Name Type Description
event string

The event name

callback function

The callback function

Returns:
Type Description
void Return nothing

onFullScreenEnter(params){void}

Interactions/index.ts, line 3466

This method allow to add a new event listener to the Full Screen interaction. To listenen when the screen is in full screen

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

Id of the map

callback function

The callback function

Returns:
Type Description
void Return nothing

onFullScreenExit(params){void}

Interactions/index.ts, line 3477

This method allow to add a new event listener to the Full Screen interaction. To listenen when the screen is exit from full screen

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

Id of the map

callback function

The callback function

Returns:
Type Description
void Return nothing

once(event, callback){void}

Interactions/index.ts, line 3396

This method allow to add a event listeners to the interactions that will be executed only once.

Name Type Description
event string

The event name

callback function

The callback function

Returns:
Type Description
void Return nothing

registerGeocodingHERE(params){CancelablePromise.<void>}

Interactions/index.ts, line 1723

This function allow to register the geocoding service.

Name Type Description
params Object
Name Type Description
params types.HEREParams

The environment, appID, clientID and APIKey.

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

removeAllCustomZoom(params)

Interactions/index.ts, line 2851

This function allow to remove all the custom zooms of the map

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

removeBuffer(idMap, idBuffer){void}

Interactions/index.ts, line 3163

This method allows to remove the buffer interaction

Name Type Description
idMap string

The id of the map where we have the tool applied

idBuffer string

The id of the tool

Returns:
Type Description
void Return nothing

removeCadastre(params){boolean}

Interactions/index.ts, line 3024

Allow to remove the Cadastre interaction by id

Name Type Description
params Object

Parameters object

Name Type Description
cadastreId string

The id of the Cadastre interaction

Returns:
Type Description
boolean Return true if the Cadastre interaction was removed

removeCloseTool(params){void}

Interactions/index.ts, line 2221

This function allow to remove the closetool feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idCloseTool string

The ID of the closetool.

Returns:
Type Description
void Return nothing

removeCtrlScrollZoom(params)

Interactions/index.ts, line 2880

This function allow to disable the custom zoom with ctrl + scroll

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

removeCustomZoom(params)

Interactions/index.ts, line 2841

This function allow to remove a custom zoom to the map

Name Type Description
params Object
Name Type Description
theme string

string to define if the theme is dark or light

idMap string

Id of the map

removeDMD(params){boolean}

Interactions/index.ts, line 2981

Allow to remove the DMD interaction by id

Name Type Description
params Object

Parameters object

Name Type Description
dmdId string

The id of the DMD interaction

Returns:
Type Description
boolean Return true if the DMD interaction was removed

removeDensityLayer(params){void}

Interactions/index.ts, line 2741

This function allow to remove the density of the layer.

Name Type Description
params Object
Name Type Description
idMap string
idDensityTool string
Returns:
Type Description
void Return nothing

removeDrawSelectByPolygon(params){void}

Interactions/index.ts, line 2366

Remove Draw Select By Polygon Interaction

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idDrawSelectByPolygon string

The ID of the select interaction.

Returns:
Type Description
void Return nothing

removeDrawSelectByPolygonInCluster(params){void}

Interactions/index.ts, line 2449

Remove Draw Select By Polygon Interaction

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idDrawSelectByPolygonInCluster string

The ID of the select interaction.

Returns:
Type Description
void Return nothing

removeEditFeature(params){void}

Interactions/index.ts, line 2772

Remove Edit Feature Interaction

Name Type Description
params Object
Name Type Description
idMap string
idEditFeature string
Returns:
Type Description
void Return nothing

removeFlowLines(params){void}

Interactions/index.ts, line 2692

Remove Select By Polygon Interaction

Name Type Description
params Object
Name Type Description
idMap string

The id of the map

idFlowLines string

The id of the flowLines

Returns:
Type Description
void Return nothing

removeFullScreen(params){boolean}

Interactions/index.ts, line 2063

Remove the Full Screen interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

Id of the map

Returns:
Type Description
boolean
  • Return true if the Full Screen interaction was removed

removeHighlight(params){void}

Interactions/index.ts, line 1940

This function allow to remove the highlight.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHighlight string

The ID of the highlight.

Returns:
Type Description
void Return nothing

removeHighlightIfExist(params){void}

Interactions/index.ts, line 1950

This function allow to remove the highlight but only if the highlight exists.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHighlight string

The ID of the highlight.

Returns:
Type Description
void Return nothing

removeHover(params){void}

Interactions/index.ts, line 2080

This function allow to remove the hover feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHover string

The ID of the hover.

Returns:
Type Description
void Return nothing

removeIFCModel(params){void}

Interactions/index.ts, line 2936

Remove Edit Feature Interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string
idEditFeature string
Returns:
Type Description
void Return nothing

removeInterpolation(params){void}

Interactions/index.ts, line 3297

This method allows to remove the interpolation interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we have the tool applied

idInterpolation string

The id of the tool

Returns:
Type Description
void Return nothing

removeIntersect(params){void}

Interactions/index.ts, line 2316

This function allow to remove the intersect feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idIntersect string

The ID of the intersect.

Returns:
Type Description
void Return nothing

removeIsolines(params){void}

Interactions/index.ts, line 3329

This method allows to remove the isolines interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we have the tool applied

idIsolines string

The id of the tool

Returns:
Type Description
void Return nothing

removeMeasure(params){void}

Interactions/index.ts, line 2659

Remove Measure Interaction

Name Type Description
params Object
Name Type Description
idMap string

The id of the map

idMeasure string

The id of the measure

Returns:
Type Description
void Return nothing

removeNearData(params){void}

Interactions/index.ts, line 3095

This method allows to remove the near data interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we have the tool applied

idNearData string

The id of the tool

Returns:
Type Description
void Return nothing

removeNearDataAttributes(params){void}

Interactions/index.ts, line 3131

This method allows to remove the near data Attributes interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we have the tool applied

idInteraction string

The id of the tool

Returns:
Type Description
void Return nothing

removeOpticalFiber(params){void}

Interactions/index.ts, line 3263

This method allows to remove the optical fiber segment interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we have the tool applied

idOpticalFiber string

The id of the tool

Returns:
Type Description
void Return nothing

removeOverlay(params){void}

Interactions/index.ts, line 1860

This function allow to remove the overlay.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idOverlay string

The ID of the overlay.

Returns:
Type Description
void Return nothing

removePolygonSector(params){void}

Interactions/index.ts, line 3229

This method allows to remove the polygon sector interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we have the tool applied

idPolygonSector string

The id of the tool

Returns:
Type Description
void Return nothing

removePrint(params){void}

Interactions/index.ts, line 2575

Remove Print Interaction

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

idPrint string

The id of the print interaction

Returns:
Type Description
void Return nothing

removeRotation(params){void}

Interactions/index.ts, line 2505

Remove Rotation Interaction

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

idRotation string

The id of the rotation interaction

Returns:
Type Description
void Return nothing

removeSectorColor(params){void}

Interactions/index.ts, line 3194

This method allows to remove the sector color interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we have the tool applied

idSectorColor string

The id of the tool

Returns:
Type Description
void Return nothing

removeSelectByPolygon(params)

Interactions/index.ts, line 2401

Remove Select By Polygon Interaction

Name Type Description
params Object
Name Type Description
idMap string
idSelectByPolygon string

removeSelectByPolygonInCluster(params)

Interactions/index.ts, line 2484

Remove Select By Polygon Interaction

Name Type Description
params Object
Name Type Description
idMap string
idSelectByPolygonInCluster string

removeTooltipHoverFeature(params){void}

Interactions/index.ts, line 2145

This function allow to remove the tooltip feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHover string

The ID of the hover.

Returns:
Type Description
void Return nothing

removeUpDownStream(params){void}

Interactions/index.ts, line 2260

This function allow to remove the UpDown feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idUpDown string

The ID of the UpDown.

Returns:
Type Description
void Return nothing

removeWMSGetFeatureInfo(params){void}

Interactions/index.ts, line 2031

This function allow to remove the WMSGetFeatureInfo.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idWMSGetFeatureInfo string

The ID of the WMSGetFeatureInfo.

Returns:
Type Description
void Return nothing

removeWatershed(params){void}

Interactions/index.ts, line 3358

This method allows to remove the watershed interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we have the tool applied

idWatershed string

The id of the tool

Returns:
Type Description
void Return nothing

restoreHighlightStyles(params){void}

Interactions/index.ts, line 1986

This function allow to restore the highlight style.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHighlight string

The ID of the highlight.

Returns:
Type Description
void

saveEditFeatures(params){void}

Interactions/index.ts, line 2804

Interaction to edit feature geometry

Name Type Description
params Object
Name Type Description
idEditFeature string

Id of the edit interaction

idMap string

Id of the map that contains the editable feature/s

idLayer string

Id of the layer that contains the editable feature/s

user string

Geoserver username with permisssions to make the transaction

pass string

Geoserver password with permisssions to make the transaction

Returns:
Type Description
void Return nothing

setActiveDrawSelectByPolygon(params)

Interactions/index.ts, line 2355

Method to active or not active Interaction Select By Polygon

Name Type Description
params Object
Name Type Description
idMap string
idSelectByPolygon string
active boolean

setActiveDrawSelectByPolygonInCluster(params)

Interactions/index.ts, line 2438

Method to active or not active Interaction Select By Polygon

Name Type Description
params Object
Name Type Description
idMap string
idDrawSelectByPolygonInCluster string
active boolean

setActiveMeasure(params){void}

Interactions/index.ts, line 2638

Method to active or not active Interaction Measure

Name Type Description
params Object
Name Type Description
idMap string
idMeasure string
active boolean
Returns:
Type Description
void Return nothing

suggestAddress(params){CancelablePromise.<any>}

Interactions/index.ts, line 1796

This function suggest address while typing in the box. if an error exist, return {lat:0, lng:0}

Name Type Description
params Object
Name Type Description
textToSearch string

The string with the direction to get the coordinates.

Returns:
Type Description
CancelablePromise.<any>

transfromExtentCoordinates(extent, layer_projection_origin, layer_projection_destiny){module:types~Extent}

Interactions/index.ts, line 373

This function allow to transform to Extent coordinates.

Name Type Description
extent module:types~Extent

The extent.

layer_projection_origin string

The layer projection origin.

layer_projection_destiny string

The layer projection destiny.

Returns:
Type Description
module:types~Extent Return the extent transformed.

inherited typeLayerHidraulic(feature){string}

Interactions/utils/GoInteractionTool.ts, line 20

This function allow to create a style for the hidraulic layer.

Name Type Description
feature module:types~FeatureLike

The feature to style

Returns:
Type Description
string Return the new style of the feature.

GoInteractions

new GoInteractions(stagingMap)

Interactions/index.ts, line 70

Creates an instance of GoInteractions.

Name Type Description
stagingMap Map.<string, GOStagingMap>

The map of all layers.

Members

addThematicMap

Create thematicMap interaction

getThematicMap

get LayerGroupIA (array LayerIA) of thematicMap

hasThematicMap

return if exist thematicMap interaction

removeThematicMap

remove thematicMap interaction if exists

Methods

addBuffer(params){CancelablePromise.<any>}

Interactions/index.ts, line 1780

Add Buffer Interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

idBuffer string

The id of the tool

dataBuffer module:types~bufferParams

Array contain data and distance for buffering

style module:types~styleFromUser

The style we want to put on the buffer layer

Returns:
Type Description
CancelablePromise.<any> Return promise with the buffer.

addCloseTool(params){void}

Interactions/index.ts, line 838

This function allow to add the closetool feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idCloseTool string

The ID of the closetool.

id number

The ID of the feature.

tablePipe string

The table pipe.

tableValve string

The table valve.

userStyleValve module:types~styleFromUser

The valve style of the user.

userStylePipes module:types~styleFromUser

The pipes style of the user.

Returns:
Type Description
void Return nothing

addCtrlScrollZoom(params)

Interactions/index.ts, line 2862

This function allow to enable the custom zoom with ctrl + scroll

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

addCustomRotateCompass(params){HTMLElement}

Interactions/index.ts, line 2553

This method checks if print interaction exists

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

Returns:
Type Description
HTMLElement
  • Return HTMLElement or null

addCustomZoom(params)

Interactions/index.ts, line 2832

This function allow to add a custom zoom to the map

Name Type Description
params Object
Name Type Description
theme string

string to define if the theme is dark or light

idMap string

Id of the map

addDensityLayer(params){GoDensityTool}

Interactions/index.ts, line 1359

Interaction to transform a Point layer in density layer

Name Type Description
params Object
Name Type Description
idMap string

The id of the map

idDensityTool string

The id of the density tool

layer string

The layer to be transformed

type module:constants~densityToolType
Returns:
Type Description
GoDensityTool

addDrawSelectByPolygon(params){GoDrawSelectByPolygon}

Interactions/index.ts, line 1001

Interaction that allows a polygon to be drawn and everything that has intersected on it is obtained

Name Type Description
params Object
Name Type Description
idMap string
idDrawSelectByPolygon string
callback function
layers Array.<string>
style module:types~userStyle
clickFinish boolean
Returns:
Type Description
GoDrawSelectByPolygon

addDrawSelectByPolygonInCluster(params){GoDrawSelectByPolygon}

Interactions/index.ts, line 1077

Interaction that allows a polygon to be drawn and everything that has intersected on it is obtained

Name Type Description
params Object
Name Type Description
idMap string
idDrawSelectByPolygonInCluster string
callback function
layers Array.<string>
style module:types~userStyle
clickFinish boolean
Returns:
Type Description
GoDrawSelectByPolygon

addEditFeature(params){void}

Interactions/index.ts, line 2783

Interaction to edit feature geometry

Name Type Description
params Object
Name Type Description
idEditFeature string

The id of the edit feature

idMap string

The id of the map

idLayer string

The layer to be edited

Returns:
Type Description
void Return nothing

addExtraDataCloseToolInteractions(params)

Interactions/index.ts, line 2183

This function takes a CloseTool object and adds it to the closeToolData object.

Name Type Description
params Object
Name Type Description
data types.CloseTool

addExtraDataUpDownStreamInteractions(params)

Interactions/index.ts, line 2192

Allow to add upDownToolData to the interaction.

Name Type Description
params Object
Name Type Description
data types.UpDown

addFlowLines(params){GoflowLines}

Interactions/index.ts, line 2671

Interaction to transform a simple style in flow line style. This interactions is only for LineString Geometry

Name Type Description
params Object
Name Type Description
idMap string
idFlowLines string
idLayer string
Returns:
Type Description
GoflowLines

addFullScreen(params){void}

Interactions/index.ts, line 2072

Add new Full Screen interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

Id of the map

Returns:
Type Description
void
  • Return nothing

addHighlight(params){CancelablePromise.<GoHighlight>}

Interactions/index.ts, line 599

This function allow to add hightlight to the map.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHighlight string

The ID of the highlight.

featuresGeom Array.<Feature>

The features of the highlight.

style module:types~styleFromUser

The style of the highlight.

textFunction function

The function to get the text of the highlight.

zIndex number

zIndex of the highlight layer

Returns:
Type Description
CancelablePromise.<GoHighlight> Return the CancelablePromise.

addInterpolation(params){void}

Interactions/index.ts, line 3274

This method allows to create an interpolation interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we have the tool applied

idInterpolation string

The id of the tool

params types.interpolationParams

The id of the tool

Returns:
Type Description
void Return nothing

addIntersect(params){void}

Interactions/index.ts, line 2284

This function allow to add the intersect feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idIntersect string

The ID of the intersect.

intersectDataIn string

The layer for intersect.

intersectDataClip string

The layer to intersect.

Returns:
Type Description
void Return nothing

addIsolines(params){void}

Interactions/index.ts, line 3308

This method allows to create an isolines interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we have the tool applied

idIsolines string

The id of the tool

params types.isolinesParams

The params of the tool

Returns:
Type Description
void Return nothing

addMeasure(params){GoMeasure}

Interactions/index.ts, line 1271

Interaction for measure with line or polygon area

Name Type Description
params Object
Name Type Description
idMap string
idMeasure string
geometryType GeometryType
callbackStart function
callbackEnd function
style module:types~userStyle
defaultTooltip boolean
unitSystemSelected unitSystem
Returns:
Type Description
GoMeasure

addMouseRotation(params)

Interactions/index.ts, line 2544

Change perspective with right mouse button

Name Type Description
params Object
Name Type Default Description
olMap OlMap

the map object

sensibilityMultiplier number 2 optional

The higher the number, the more sensitive the mouse is.

addMultiRoutingHERE(params){void}

Interactions/index.ts, line 3501

This method allow to add a new event listener to the Full Screen interaction. To listenen when the screen is exit from full screen

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

routingID string

Id of the route

points Array.<types.geodesicCoordinates>

Start and end point

stops Array.<types.geodesicCoordinates>

Stops along the route

transportMode string

Transport mode

apiKey string

API key

Returns:
Type Description
void Return nothing

addNearData(params){CancelablePromise.<any>}

Interactions/index.ts, line 1714

Add Near Data Interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

idNearData string

The id from a tool

pointCoordinate Array.<number>

The coordinate data

lookingForData module:types~dataTools

The base layer to looking for near data

stylePoint module:types~ISVGIcon

The style we want to put on the Valves drawing layer

style module:types~styleFromUser

The style we want to put on the Valves drawing layer

Returns:
Type Description
CancelablePromise.<any> Return promise with the closest element.

addNearDataAttributes(params){CancelablePromise.<any>}

Interactions/index.ts, line 1748

Add Near Data Attributes Interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

idInteraction string

The id from a tool

pointCoordinate Array.<number>

The coordinate data

layer module:types~dataTools

The base layer to looking for near data attributes

stylePoint module:types~ISVGIcon

The style we want to put on the Valves drawing layer

style module:types~styleFromUser

The style we want to put on the Valves drawing layer

Returns:
Type Description
CancelablePromise.<any> Return promise with the closest element.

addOpticalFiber(params){void}

Interactions/index.ts, line 3240

This method allows to create an optical fiber segment interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we have the tool applied

idOpticalFiber string

The id of the tool

params types.opticalFiberParams

The id of the tool

Returns:
Type Description
void Return nothing

addOverlay(params){GoOverlay|undefined}

Interactions/index.ts, line 531

This function allow to add a overlay to the map.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idOverlay string

The ID of the overlay.

overlayData module:types~overlayData

The data of the overlay.

Returns:
Type Description
GoOverlay | undefined Return the overlay or undefined.

addPolygonSector(params){Promise.<any>}

Interactions/index.ts, line 1842

Add polygonSector Interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

polygonSectorId string

The id of the polygon sector interaction

polygonSectorData module:types~dataTools

Layer data

polygonSectorParams module:types~polygonSectorParams

Array contain the size of the grid

Returns:
Type Description
Promise.<any> Return promise with the polygon sector object.

addPrint(params){void}

Interactions/index.ts, line 2585

Adds a print interaction to the map.

Name Type Description
params Object

Parameters for the print interaction

Name Type Description
idMap string

The ID of the map

idPrint string

The ID for the print interaction

mapTitle string optional

Title of the map

name string optional

Name of the map

author string optional

Author of the map

date string optional

Date of the map

Returns:
Type Description
void Return nothing

addRotation(params){void}

Interactions/index.ts, line 2515

Interaction to rotate view

Name Type Description
params Object
Name Type Description
idMap string

The id of the map

idRotation string

The id of the rotation interaction

Returns:
Type Description
void Return nothing

addRoutingHERE(params){void}

Interactions/index.ts, line 3488

This method allow to add a new event listener to the Full Screen interaction. To listenen when the screen is exit from full screen

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

routingID string

Id of the route

transportMode string

Transport mode

points Array.<types.geodesicCoordinates>

Start and end point

lang string

Language code

Returns:
Type Description
void Return nothing

addSectorColor(params){CancelablePromise.<any>}

Interactions/index.ts, line 1810

Add SectorColor Interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

sectorColorId string

The id of the sector color interaction

sectorColorData module:types~dataTools

Layer data

sectorColorParams module:types~sectorColorParams

Array contain attribute and palette size

Returns:
Type Description
CancelablePromise.<any> Return promise with the sector color object.

addSelectByPolygon(params){GoDrawSelectByPolygon}

Interactions/index.ts, line 2377

Interaction that allows a polygon to be drawn and everything that has intersected on it is obtained

Name Type Description
params Object
Name Type Description
idMap string
idSelectByPolygon string
callback function
layers Array.<string>
Returns:
Type Description
GoDrawSelectByPolygon

addSelectByPolygonInCluster(params){GoDrawSelectByPolygon}

Interactions/index.ts, line 2460

Interaction that allows a polygon to be drawn and everything that has intersected on it is obtained

Name Type Description
params Object
Name Type Description
idMap string
idSelectByPolygonInCluster string
callback function
layers Array.<string>
Returns:
Type Description
GoDrawSelectByPolygon

addTooltipHoverFeature(params){void}

Interactions/index.ts, line 781

This function allow to add the tooltip feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID Of the map.

idHover string

The ID of the hover.

featuresGeom Feature.<Geometry>

The feature of the geometry.

style module:types~styleFromUser

The styles of the user.

Returns:
Type Description
void Return nothing

addUpDownStream(params){void}

Interactions/index.ts, line 911

This function allow to add the closetool feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idCloseTool string

The ID of the closetool.

id number

The ID of the feature.

tablePipe string

The table pipe.

tableValve string

The table valve.

userStyleValve module:types~styleFromUser

The valve style of the user.

userStylePipes module:types~styleFromUser

The pipes style of the user.

Returns:
Type Description
void Return nothing

addWMSGetFeatureInfo(params){CancelablePromise.<GoWMSGetFeatureInfo>}

Interactions/index.ts, line 1997

This function allow to add WMSGetFeatureInfo to the map.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idWMSGetFeatureInfo string

The ID of the WMSGetFeatureInfo.

featuresGeom Array.<Feature>

The features of the highlight.

Returns:
Type Description
CancelablePromise.<GoWMSGetFeatureInfo> Return a promise of GoWMSGetFeatureInfo

addWatershed(params){CancelablePromise.<any>}

Interactions/index.ts, line 1964

Add watershed Interaction

Name Type Description
params Object

Parameters object

Name Type Description
params module:types~watershedParams

Layer data

Returns:
Type Description
CancelablePromise.<any> Return promise with the watershed object.

autoSuggestAddress(params){CancelablePromise.<any>}

Interactions/index.ts, line 1805

This function auto suggest address while typing in the box. if an error exist, return {lat:0, lng:0}

Name Type Description
params Object
Name Type Description
textToSearch string

The string with the direction to get the coordinates.

Returns:
Type Description
CancelablePromise.<any>

changeHighlightZIndex(params){void}

Interactions/index.ts, line 1961

This function allow to change the zIndex of the highlight.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHighlight string

The ID of the highlight.

zIndex number

The zIndex of the highlight.

Returns:
Type Description
void Return nothing

changeHoverZIndex(params){void}

Interactions/index.ts, line 2145

This function allow to remove the tooltip feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHover string

The ID of the hover.

Returns:
Type Description
void Return nothing

changeStyleOfHighlight(params){void}

Interactions/index.ts, line 662

This function allow to change the highlight style if the highlight exists.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHighlight string

The ID of the highlight.

userStyle module:types~styleFromUser

The highlight style in json variable.

styleSVG module:types~ISVGIcon

The highlight style as SVG icon.

Returns:
Type Description
void

clearCloseTool(params){void}

Interactions/index.ts, line 2173

This function allow to clear the closetool feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idCloseTool string

The ID of the closetool.

Returns:
Type Description
void Return nothing

clearIntersect(params){void}

Interactions/index.ts, line 2306

This function allow to clear the intersect feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idIntersect string

The ID of the intersect.

Returns:
Type Description
void Return nothing

clearMeasure(params){void}

Interactions/index.ts, line 2649

Remove Measure Layer data

Name Type Description
params Object
Name Type Description
idMap string
idMeasure string
Returns:
Type Description
void Return nothing

clearUpDownStream(params){void}

Interactions/index.ts, line 2271

This function allow to clear the UpDown feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idUpDown string

The ID of the UpDown.

Returns:
Type Description
void Return nothing

createCadastre(params){GoCadastre}

Interactions/index.ts, line 2990

Create the Cadastre interaction

Name Type Description
params Object

Parameters object

Name Type Description
cadastreId string

The id of the Cadastre interaction

Returns:
Type Description
GoCadastre Return the Cadastre interaction

createDMD(params){GoDMD}

Interactions/index.ts, line 2946

Create the DMD interaction

Name Type Description
params Object

Parameters object

Name Type Description
dmdId string

The id of the DMD interaction

dmdToken string

The token of the DMD service

Returns:
Type Description
GoDMD Return the DMD interaction

createFeature(params)

Interactions/index.ts, line 2763

This function takes a GeoJSON object and returns an array of features.

Name Type Description
params Object
Name Type Description
feature *
Returns:
A GeoJSON object.

createIFC(props){Promise.<GoIFCComponents>}

Interactions/index.ts, line 2919

Interaction to transform a simple style in flow line style. This interactions is only for LineString Geometry

Name Type Description
props IFCConfig
Returns:
Type Description
Promise.<GoIFCComponents>

createStyle(style){Style}

Interactions/index.ts, line 383

This function allow to create the styles for the layers

Name Type Description
style module:types~styleFromUser

The style that you want to create

Returns:
Type Description
Style Return the style created

deleteFeatures(params){void}

Interactions/index.ts, line 2817

This Method allows to delete feature/s

Name Type Description
params Object
Name Type Description
idMap string

Id of the map that contains the feature/s that you want to delete

idLayer string

Id of the vector layer that contains the feature/s that you want to delete

feature Array.<Feature>

Array of feature/s you want to delete

user string

Geoserver username with permisssions to make the transaction

pass string

Geoserver password with permisssions to make the transaction

Returns:
Type Description
void Return nothing

disableDoubleClickZoom(params)

Interactions/index.ts, line 2891

This function allow to disable the zoom interaction

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

disableRotation(params){void}

Interactions/index.ts, line 2525

Interaction to disable rotate view

Name Type Description
params Object
Name Type Description
idMap string

The id of the map

Returns:
Type Description
void Return nothing

emit(event, data){void}

Interactions/index.ts, line 3420

This method allow to emit an event to the interactions.

Name Type Description
event string

The event name

data object

The data to send to the event

Returns:
Type Description
void Return nothing

enableDoubleClickZoom(params)

Interactions/index.ts, line 2900

This function allow to enable the zoom interaction

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

getAllFeaturesProperties(params){CancelablePromise.<GoHighlight>}

Interactions/index.ts, line 1895

This function allow to add hightlight to the map.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idInteraction string

The ID of the highlight.

Returns:
Type Description
CancelablePromise.<GoHighlight> Return the CancelablePromise.

getAllsensorsFromNexus(params){CancelablePromise.<any>}

Interactions/index.ts, line 1815

This function allow to get all the sensors from nexus.

Name Type Description
params Object
Name Type Description
location string

The location of the point.

token string

The token of the user.

bindingUrl string

The binding url.

Returns:
Type Description
CancelablePromise.<any> Return promise with the sensors.

getCadastre(params){GoCadastre}

Interactions/index.ts, line 2999

Get the Cadastre interaction

Name Type Description
params Object

Parameters object

Name Type Description
cadastreId string

The id of the Cadastre interaction

Returns:
Type Description
GoCadastre Return the Cadastre interaction

getCadastres(){Array.<GoCadastre>}

Interactions/index.ts, line 3008

Allow to get an array of the Cadastre interactions

Returns:
Type Description
Array.<GoCadastre> Return the Cadastre interaction

getCloseTool(params){GoCloseTools}

Interactions/index.ts, line 2211

This function allow to get the closetool feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idCloseTool string

The ID of the closetool.

Returns:
Type Description
GoCloseTools Return the closetool feature.

getCoordinatesFromDirection(params){Array.<any>}

Interactions/index.ts, line 1786

This function allow to get the coordinates from the address.

Name Type Description
params Object
Name Type Description
direction string

The direction of the point.

Returns:
Type Description
Array.<any> Return promise with the coordinates.

getCoordinatesFromDirectionHERE(params){Array.<any>}

Interactions/index.ts, line 1786

This function allow to get the coordinates from the address.

Name Type Description
params Object
Name Type Description
direction string

The direction of the point.

Returns:
Type Description
Array.<any> Return promise with the coordinates.

getCoordinatesFromDirectionProperties(params){CancelablePromise.<any>}

Interactions/index.ts, line 1776

This function allow to get the coordinates from the address.

Name Type Description
params Object
Name Type Description
direction string

The direction of the point.

Returns:
Type Description
CancelablePromise.<any> Return promise with the coordinates.

getDMD(params){GoDMD}

Interactions/index.ts, line 2956

Get the DMD interaction

Name Type Description
params Object

Parameters object

Name Type Description
dmdId string

The id of the DMD interaction

Returns:
Type Description
GoDMD Return the DMD interaction

getDMDs(){Array.<object>}

Interactions/index.ts, line 2965

Allow to get an array of the DMD interactions

Returns:
Type Description
Array.<object> Return the DMD interaction

getDensityLayer(params){GoDensityTool}

Interactions/index.ts, line 1381

Interaction to transform a Point layer in density layer

Name Type Description
params Object
Name Type Description
idMap string

The id of the map

idDensityTool string

The id of the density tool

type module:constants~densityToolType
Returns:
Type Description
GoDensityTool

getDirectionFromCoordinates(params){CancelablePromise.<any>}

Interactions/index.ts, line 1755

This function allow to get the direction from the coordinates.

Name Type Description
params Object
Name Type Description
lat number

The latitude of the point.

lng number

The longitude of the point.

Returns:
Type Description
CancelablePromise.<any> Return promise with the direction.

getDirectionFromCoordinatesHERE(params){CancelablePromise.<any>}

Interactions/index.ts, line 1755

This function allow to get the direction from the coordinates.

Name Type Description
params Object
Name Type Description
lat number

The latitude of the point.

lng number

The longitude of the point.

Returns:
Type Description
CancelablePromise.<any> Return promise with the direction.

getDirectionFromCoordinatesProperties(params){CancelablePromise.<any>}

Interactions/index.ts, line 1755

This function allow to get the direction from the coordinates.

Name Type Description
params Object
Name Type Description
lat number

The latitude of the point.

lng number

The longitude of the point.

Returns:
Type Description
CancelablePromise.<any> Return promise with the direction.

getEditFeatures(params){GoEditFeatures}

Interactions/index.ts, line 2794

Interaction for measure with line or polygon area

Name Type Description
params Object
Name Type Description
idMap string

Id of the map that contains the editable feature/s

idEditFeature string

Id of the edit interaction

Returns:
Type Description
GoEditFeatures
  • Return the edit feature

getEventHandlers(){object}

Interactions/index.ts, line 3413

This method allow to get all the event listeners of the interactions.

Returns:
Type Description
object Return an object with all the event listeners

getFeaturesByLayer(params){Promise.<types.GeoJSONFeatureCollection>}

Interactions/index.ts, line 1871

Retrieves features from a layer using authenticated GeoServer WFS requests. The layer must be defined in the map configuration.

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The ID of the map

layerId string

The ID of the layer from config (required)

cqlFilter string optional

Optional CQL filter expression

maxFeatures number optional

Maximum number of features to return (if not provided, returns all features)

propertyName Array.<string> optional

Specific properties to return (if not provided, returns all properties)

Returns:
Type Description
Promise.<types.GeoJSONFeatureCollection> Promise that resolves to a GeoJSON feature collection
Example
map.interactions.getFeaturesByLayer({
  idMap: "main",
  layerId: "valves",
  cqlFilter: "status='active'",
  maxFeatures: 100,
  propertyName: ["id", "name"]
});

getFullScreen(params){GoFullScreen}

Interactions/index.ts, line 3457

Get the Full Screen interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

Id of the map

Returns:
Type Description
GoFullScreen
  • Return the Full Screen interaction

getHighlight(params){GoHighlight}

Interactions/index.ts, line 1930

This function allow to get the highlight.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHighlight string

The ID of the highlight.

Returns:
Type Description
GoHighlight Return the highlight.

getHistoricInfoFromNexus(params){CancelablePromise.<any>}

Interactions/index.ts, line 1827

This function allow to get the historical data from nexus sensors.

Name Type Description
params Object
Name Type Description
sensorUID string

The sensor UID.

token string

The token of the user.

bindingUrl string

The binding url.

Returns:
Type Description
CancelablePromise.<any> Return promise with the historical data.

getLayerHover(params){GoHover}

Interactions/index.ts, line 2053

This function allow to get the hover feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHover string

The ID of the hover.

Returns:
Type Description
GoHover Return the hover feature.

getMultiExtent(params){void}

Interactions/index.ts, line 3368

This method allow to get the extend of multiple layers

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map

idLayers Array.<string>

Array of id layers

Returns:
Type Description
void Return null or the extend of the layers

getPrint(params){GoPrint}

Interactions/index.ts, line 2600

Get the print interaction

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

idPrint string

Id of the print interaction

Returns:
Type Description
GoPrint
  • Return the print interaction

getRotation(params){GoRotation}

Interactions/index.ts, line 2534

Get the rotation interaction

Name Type Description
params Object
Name Type Description
idMap string

Id of the map that contains the rotatable view

idRotation string

Id of the rotation interaction

Returns:
Type Description
GoRotation
  • Return the rotation interaction

getTooltipHoverFeature(params){GoHoverFeature}

Interactions/index.ts, line 2123

This function allow to get the tooltip feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHover string

The ID of the hover.

Returns:
Type Description
GoHoverFeature Return the tooltip feature.

getWMSGetFeatureInfo(params){GoWMSGetFeatureInfo}

Interactions/index.ts, line 2020

This function allow to get the WMSGetFeatureInfo.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idWMSGetFeatureInfo string

The ID of the WMSGetFeatureInfo.

Returns:
Type Description
GoWMSGetFeatureInfo Return the WMSGetFeatureInfo.

hasBuffer(idMap, idBuffer){Boolean}

Interactions/index.ts, line 3154

This method allows to know if the buffer interaction exists

Name Type Description
idMap string

The id of the map where we want to apply the tool

idBuffer string

The id of the tool

Returns:
Type Description
Boolean Return true|false

hasCadastre(params){GoCadastre}

Interactions/index.ts, line 3015

Allow to determine if the map has a Cadastre interaction by id

Name Type Description
params Object

Parameters object

Name Type Description
cadastreId string

The id of the Cadastre interaction

Returns:
Type Description
GoCadastre Return the Cadastre interaction

hasCloseTool(params){boolean}

Interactions/index.ts, line 2201

This function allow to determine if the closeTool feature exist.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idCloseTool string

The ID of the closetool.

Returns:
Type Description
boolean Return true if the closeTool feature exist, false otherwise.

hasCtrlScrollZoom(params)

Interactions/index.ts, line 2871

This function allow to determine if the custom zoom with ctrl + scroll is enabled on the map

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

hasDMD(params){GoDMD}

Interactions/index.ts, line 2972

Allow to determine if the map has a DMD interaction by id

Name Type Description
params Object

Parameters object

Name Type Description
dmdId string

The id of the DMD interaction

Returns:
Type Description
GoDMD Return the DMD interaction

hasDensityLayer(params){GoDensityTool}

Interactions/index.ts, line 1370

Interaction to transform a Point layer in density layer

Name Type Description
params Object
Name Type Description
idMap string

The id of the map

idDensityTool string

The id of the density tool

type module:constants~densityToolType
Returns:
Type Description
GoDensityTool

hasDisabledDoubleClickZoom(params)

Interactions/index.ts, line 2909

This function allow to determine if the zoom interaction is enabled

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

hasDrawSelectByPolygon(params){boolean}

Interactions/index.ts, line 2344

Method that returns if a select interaction exists

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idDrawSelectByPolygon string

The ID of the select interaction.

Returns:
Type Description
boolean

hasDrawSelectByPolygonInCluster(params){boolean}

Interactions/index.ts, line 2427

Method that returns if a select interaction exists

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idDrawSelectByPolygonInCluster string

The ID of the select interaction.

Returns:
Type Description
boolean

hasEditFeature(params){boolean}

Interactions/index.ts, line 2753

This method checks if any edit feature interaction exists

Name Type Description
params Object
Name Type Description
idMap string
idEditFeature string
Returns:
Type Description
boolean
  • Return true if the edit feature exists

hasEvent(event){boolean}

Interactions/index.ts, line 3405

This method allow to check if the interactions has an event listener.

Name Type Description
event string

The event name

Returns:
Type Description
boolean Return true if the event exists

hasFlowLines(params){boolean}

Interactions/index.ts, line 2682

Method that returns if a select interaction exists

Name Type Description
params Object
Name Type Description
idMap string
idFlowLines string
Returns:
Type Description
boolean

hasFullScreen(params){GoFullScreen}

Interactions/index.ts, line 3429

Get the Full Screen interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

Id of the map

Returns:
Type Description
GoFullScreen
  • Return the Full Screen interaction

hasGetFeature(params){boolean}

Interactions/index.ts, line 2090

This function allow to determine if the feature has the id of the map.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

Returns:
Type Description
boolean Return true if the feature exist.

hasHighlight(params){boolean}

Interactions/index.ts, line 1920

This function allow to determine if the highlight exist.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHighlight string

The ID of the highlight.

Returns:
Type Description
boolean Return true if the highlight exist.

hasHoverFeature(params){boolean}

Interactions/index.ts, line 2042

This functio determine if the map has hover feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHover string

The ID of the hover.

Returns:
Type Description
boolean Return true if the hover exist.

hasIFCModel(params){boolean}

Interactions/index.ts, line 2926

This method checks if any edit feature interaction exists

Name Type Description
params Object

Parameters object

Name Type Description
idMap string
idEditFeature string
Returns:
Type Description
boolean
  • Return true if the edit feature exists

hasInterpolation(params){Boolean}

Interactions/index.ts, line 3286

This method allows to know if the interpolation interaction exists

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

idInterpolation string

The id of the tool

Returns:
Type Description
Boolean Return true|false

hasIntersect(params){boolean}

Interactions/index.ts, line 2296

Determine if the intersect exists

Name Type Description
params Object
Name Type Description
idMap string

the id of the map

idIntersect string

The id of the intersect

Returns:
Type Description
boolean A boolean value.

hasIsolines(params){Boolean}

Interactions/index.ts, line 3319

This method allows to know if the isolines interaction exists

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

idIsolines string

The id of the tool

Returns:
Type Description
Boolean Return true|false

hasMeasure(params){boolean}

Interactions/index.ts, line 2628

Method that returns if a select interaction exists

Name Type Description
params Object
Name Type Description
idMap string
idMeasure string
Returns:
Type Description
boolean

hasNearData(params){Boolean}

Interactions/index.ts, line 3085

This method allows to know if the near data interaction exists

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

idNearData string

The id of the tool

Returns:
Type Description
Boolean Return true | false

hasNearDataAttributes(params){Boolean}

Interactions/index.ts, line 3120

This method allows to know if the near data Attributes interaction exists

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

idInteraction string

The id of the tool

Returns:
Type Description
Boolean Return true | false

hasOpticalFiber(params){Boolean}

Interactions/index.ts, line 3252

This method allows to know if the optical fiber segment interaction exists

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

idOpticalFiber string

The id of the tool

Returns:
Type Description
Boolean Return true|false

hasOverlay(params){boolean}

Interactions/index.ts, line 1850

This function allow to determine if the overlay exist.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idOverlay string

The ID of the overlay.

Returns:
Type Description
boolean Return true if the overlay exist.

hasPolygonSector(params){Boolean}

Interactions/index.ts, line 3218

This method allows to know if the polygon sector interaction exists

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

idPolygonSector string

The id of the tool

Returns:
Type Description
Boolean Return true|false

hasPrint(params){boolean}

Interactions/index.ts, line 2565

This method checks if print interaction exists

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

idPrint string

The id of the print interaction

Returns:
Type Description
boolean
  • Return true if print interaction exists

hasRotation(params){boolean}

Interactions/index.ts, line 2495

This method checks if rotation interaction exists

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

idRotation string

The id of the rotation interaction

Returns:
Type Description
boolean
  • Return true if rotation interaction exists

hasSectorColor(params){Boolean}

Interactions/index.ts, line 3184

This method allows to know if the sector color interaction exists

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

idSectorColor string

The id of the tool

Returns:
Type Description
Boolean Return true|false

hasSelectByPolygon(params){boolean}

Interactions/index.ts, line 2390

Method that returns if a select interaction exists

Name Type Description
params Object
Name Type Description
idMap string
idSelectByPolygon string
Returns:
Type Description
boolean

hasSelectByPolygonInCluster(params){boolean}

Interactions/index.ts, line 2473

Method that returns if a select interaction exists

Name Type Description
params Object
Name Type Description
idMap string
idSelectByPolygonInCluster string
Returns:
Type Description
boolean

hasToolTipHover(params){boolean}

Interactions/index.ts, line 2112

If the map has the key, and the value of the key is a map that has the key, then return true.

Name Type Description
params Object
Name Type Description
idMap string

The id of the map that the tooltip is on.

idHover string
Returns:
Type Description
boolean A boolean value.

hasUpDownStream(params){boolean}

Interactions/index.ts, line 2249

This function allow to determine if the UpDown feature exist.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idUpDown string

The ID of the UpDown.

Returns:
Type Description
boolean Return true if the UpDown feature exist, false otherwise.

hasWMSGetFeatureInfo(params){boolean}

Interactions/index.ts, line 2009

This function allow to determine if the WMSGetFeatureInfo exist.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idWMSGetFeatureInfo string

The ID of the WMSGetFeatureInfo.

Returns:
Type Description
boolean Return true if the WMSGetFeatureInfo exist.

hasWatershed(params){Boolean}

Interactions/index.ts, line 3348

This method allows to know if the watershed interaction exists

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we want to apply the tool

idWatershed string

The id of the tool

Returns:
Type Description
Boolean Return true|false

mouseHover(params){GoHover|void}

Interactions/index.ts, line 2063

Implements mouse hover interaction on map features.

Name Type Description
params Object

Configuration object for hover interaction.

Name Type Description
idHover string

The ID for the hover layer.

olMap OlMap

The OpenLayers map instance.

layer GOVectorLayer optional

Optional. Layer to apply the hover interaction.

style styleFromUser optional

Optional. Custom style to apply on hover.

callback function optional

Optional. Callback triggered when a feature is hovered. Receives feature: Feature as parameter.

styleSVG types.ISVGIcon optional

Optional. SVG-based icon style.

svgIcon string optional

Optional. Path or ID of the SVG icon as string.

zIndex number optional

Optional. z-index of the hover layer.

Returns:
Type Description
GoHover | void The hover interaction instance or nothing.

off(event, callback){void}

Interactions/index.ts, line 3387

This method allow to remove an event listener to the interactions.

Name Type Description
event string

The event name

callback function

The callback function

Returns:
Type Description
void Return nothing

on(event, callback){void}

Interactions/index.ts, line 3378

This method allow to add a new event listener to the interactions.

Name Type Description
event string

The event name

callback function

The callback function

Returns:
Type Description
void Return nothing

onFullScreenEnter(params){void}

Interactions/index.ts, line 3466

This method allow to add a new event listener to the Full Screen interaction. To listenen when the screen is in full screen

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

Id of the map

callback function

The callback function

Returns:
Type Description
void Return nothing

onFullScreenExit(params){void}

Interactions/index.ts, line 3477

This method allow to add a new event listener to the Full Screen interaction. To listenen when the screen is exit from full screen

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

Id of the map

callback function

The callback function

Returns:
Type Description
void Return nothing

once(event, callback){void}

Interactions/index.ts, line 3396

This method allow to add a event listeners to the interactions that will be executed only once.

Name Type Description
event string

The event name

callback function

The callback function

Returns:
Type Description
void Return nothing

registerGeocodingHERE(params){CancelablePromise.<void>}

Interactions/index.ts, line 1723

This function allow to register the geocoding service.

Name Type Description
params Object
Name Type Description
params types.HEREParams

The environment, appID, clientID and APIKey.

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

removeAllCustomZoom(params)

Interactions/index.ts, line 2851

This function allow to remove all the custom zooms of the map

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

removeBuffer(idMap, idBuffer){void}

Interactions/index.ts, line 3163

This method allows to remove the buffer interaction

Name Type Description
idMap string

The id of the map where we have the tool applied

idBuffer string

The id of the tool

Returns:
Type Description
void Return nothing

removeCadastre(params){boolean}

Interactions/index.ts, line 3024

Allow to remove the Cadastre interaction by id

Name Type Description
params Object

Parameters object

Name Type Description
cadastreId string

The id of the Cadastre interaction

Returns:
Type Description
boolean Return true if the Cadastre interaction was removed

removeCloseTool(params){void}

Interactions/index.ts, line 2221

This function allow to remove the closetool feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idCloseTool string

The ID of the closetool.

Returns:
Type Description
void Return nothing

removeCtrlScrollZoom(params)

Interactions/index.ts, line 2880

This function allow to disable the custom zoom with ctrl + scroll

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

removeCustomZoom(params)

Interactions/index.ts, line 2841

This function allow to remove a custom zoom to the map

Name Type Description
params Object
Name Type Description
theme string

string to define if the theme is dark or light

idMap string

Id of the map

removeDMD(params){boolean}

Interactions/index.ts, line 2981

Allow to remove the DMD interaction by id

Name Type Description
params Object

Parameters object

Name Type Description
dmdId string

The id of the DMD interaction

Returns:
Type Description
boolean Return true if the DMD interaction was removed

removeDensityLayer(params){void}

Interactions/index.ts, line 2741

This function allow to remove the density of the layer.

Name Type Description
params Object
Name Type Description
idMap string
idDensityTool string
Returns:
Type Description
void Return nothing

removeDrawSelectByPolygon(params){void}

Interactions/index.ts, line 2366

Remove Draw Select By Polygon Interaction

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idDrawSelectByPolygon string

The ID of the select interaction.

Returns:
Type Description
void Return nothing

removeDrawSelectByPolygonInCluster(params){void}

Interactions/index.ts, line 2449

Remove Draw Select By Polygon Interaction

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idDrawSelectByPolygonInCluster string

The ID of the select interaction.

Returns:
Type Description
void Return nothing

removeEditFeature(params){void}

Interactions/index.ts, line 2772

Remove Edit Feature Interaction

Name Type Description
params Object
Name Type Description
idMap string
idEditFeature string
Returns:
Type Description
void Return nothing

removeFlowLines(params){void}

Interactions/index.ts, line 2692

Remove Select By Polygon Interaction

Name Type Description
params Object
Name Type Description
idMap string

The id of the map

idFlowLines string

The id of the flowLines

Returns:
Type Description
void Return nothing

removeFullScreen(params){boolean}

Interactions/index.ts, line 2063

Remove the Full Screen interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

Id of the map

Returns:
Type Description
boolean
  • Return true if the Full Screen interaction was removed

removeHighlight(params){void}

Interactions/index.ts, line 1940

This function allow to remove the highlight.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHighlight string

The ID of the highlight.

Returns:
Type Description
void Return nothing

removeHighlightIfExist(params){void}

Interactions/index.ts, line 1950

This function allow to remove the highlight but only if the highlight exists.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHighlight string

The ID of the highlight.

Returns:
Type Description
void Return nothing

removeHover(params){void}

Interactions/index.ts, line 2080

This function allow to remove the hover feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHover string

The ID of the hover.

Returns:
Type Description
void Return nothing

removeIFCModel(params){void}

Interactions/index.ts, line 2936

Remove Edit Feature Interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string
idEditFeature string
Returns:
Type Description
void Return nothing

removeInterpolation(params){void}

Interactions/index.ts, line 3297

This method allows to remove the interpolation interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we have the tool applied

idInterpolation string

The id of the tool

Returns:
Type Description
void Return nothing

removeIntersect(params){void}

Interactions/index.ts, line 2316

This function allow to remove the intersect feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idIntersect string

The ID of the intersect.

Returns:
Type Description
void Return nothing

removeIsolines(params){void}

Interactions/index.ts, line 3329

This method allows to remove the isolines interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we have the tool applied

idIsolines string

The id of the tool

Returns:
Type Description
void Return nothing

removeMeasure(params){void}

Interactions/index.ts, line 2659

Remove Measure Interaction

Name Type Description
params Object
Name Type Description
idMap string

The id of the map

idMeasure string

The id of the measure

Returns:
Type Description
void Return nothing

removeNearData(params){void}

Interactions/index.ts, line 3095

This method allows to remove the near data interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we have the tool applied

idNearData string

The id of the tool

Returns:
Type Description
void Return nothing

removeNearDataAttributes(params){void}

Interactions/index.ts, line 3131

This method allows to remove the near data Attributes interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we have the tool applied

idInteraction string

The id of the tool

Returns:
Type Description
void Return nothing

removeOpticalFiber(params){void}

Interactions/index.ts, line 3263

This method allows to remove the optical fiber segment interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we have the tool applied

idOpticalFiber string

The id of the tool

Returns:
Type Description
void Return nothing

removeOverlay(params){void}

Interactions/index.ts, line 1860

This function allow to remove the overlay.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idOverlay string

The ID of the overlay.

Returns:
Type Description
void Return nothing

removePolygonSector(params){void}

Interactions/index.ts, line 3229

This method allows to remove the polygon sector interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we have the tool applied

idPolygonSector string

The id of the tool

Returns:
Type Description
void Return nothing

removePrint(params){void}

Interactions/index.ts, line 2575

Remove Print Interaction

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

idPrint string

The id of the print interaction

Returns:
Type Description
void Return nothing

removeRotation(params){void}

Interactions/index.ts, line 2505

Remove Rotation Interaction

Name Type Description
params Object
Name Type Description
idMap string

Id of the map

idRotation string

The id of the rotation interaction

Returns:
Type Description
void Return nothing

removeSectorColor(params){void}

Interactions/index.ts, line 3194

This method allows to remove the sector color interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we have the tool applied

idSectorColor string

The id of the tool

Returns:
Type Description
void Return nothing

removeSelectByPolygon(params)

Interactions/index.ts, line 2401

Remove Select By Polygon Interaction

Name Type Description
params Object
Name Type Description
idMap string
idSelectByPolygon string

removeSelectByPolygonInCluster(params)

Interactions/index.ts, line 2484

Remove Select By Polygon Interaction

Name Type Description
params Object
Name Type Description
idMap string
idSelectByPolygonInCluster string

removeTooltipHoverFeature(params){void}

Interactions/index.ts, line 2145

This function allow to remove the tooltip feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHover string

The ID of the hover.

Returns:
Type Description
void Return nothing

removeUpDownStream(params){void}

Interactions/index.ts, line 2260

This function allow to remove the UpDown feature.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idUpDown string

The ID of the UpDown.

Returns:
Type Description
void Return nothing

removeWMSGetFeatureInfo(params){void}

Interactions/index.ts, line 2031

This function allow to remove the WMSGetFeatureInfo.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idWMSGetFeatureInfo string

The ID of the WMSGetFeatureInfo.

Returns:
Type Description
void Return nothing

removeWatershed(params){void}

Interactions/index.ts, line 3358

This method allows to remove the watershed interaction

Name Type Description
params Object

Parameters object

Name Type Description
idMap string

The id of the map where we have the tool applied

idWatershed string

The id of the tool

Returns:
Type Description
void Return nothing

restoreHighlightStyles(params){void}

Interactions/index.ts, line 1986

This function allow to restore the highlight style.

Name Type Description
params Object
Name Type Description
idMap string

The ID of the map.

idHighlight string

The ID of the highlight.

Returns:
Type Description
void

saveEditFeatures(params){void}

Interactions/index.ts, line 2804

Interaction to edit feature geometry

Name Type Description
params Object
Name Type Description
idEditFeature string

Id of the edit interaction

idMap string

Id of the map that contains the editable feature/s

idLayer string

Id of the layer that contains the editable feature/s

user string

Geoserver username with permisssions to make the transaction

pass string

Geoserver password with permisssions to make the transaction

Returns:
Type Description
void Return nothing

setActiveDrawSelectByPolygon(params)

Interactions/index.ts, line 2355

Method to active or not active Interaction Select By Polygon

Name Type Description
params Object
Name Type Description
idMap string
idSelectByPolygon string
active boolean

setActiveDrawSelectByPolygonInCluster(params)

Interactions/index.ts, line 2438

Method to active or not active Interaction Select By Polygon

Name Type Description
params Object
Name Type Description
idMap string
idDrawSelectByPolygonInCluster string
active boolean

setActiveMeasure(params){void}

Interactions/index.ts, line 2638

Method to active or not active Interaction Measure

Name Type Description
params Object
Name Type Description
idMap string
idMeasure string
active boolean
Returns:
Type Description
void Return nothing

suggestAddress(params){CancelablePromise.<any>}

Interactions/index.ts, line 1796

This function suggest address while typing in the box. if an error exist, return {lat:0, lng:0}

Name Type Description
params Object
Name Type Description
textToSearch string

The string with the direction to get the coordinates.

Returns:
Type Description
CancelablePromise.<any>

transfromExtentCoordinates(extent, layer_projection_origin, layer_projection_destiny){module:types~Extent}

Interactions/index.ts, line 373

This function allow to transform to Extent coordinates.

Name Type Description
extent module:types~Extent

The extent.

layer_projection_origin string

The layer projection origin.

layer_projection_destiny string

The layer projection destiny.

Returns:
Type Description
module:types~Extent Return the extent transformed.

inherited typeLayerHidraulic(feature){string}

Interactions/utils/GoInteractionTool.ts, line 20

This function allow to create a style for the hidraulic layer.

Name Type Description
feature module:types~FeatureLike

The feature to style

Returns:
Type Description
string Return the new style of the feature.