Class: MapView

new MapView()

View class

Source: gemapi.js, line 997

Extends

Em_Object

Methods

activateHighlight(resultedLandmarks, colorInfo, options, usableIcons)

Enable the default highlight service for the given landmark list.

Parameters:

Name	Type	Description
`resultedLandmarks`	gem.core.LandmarkList	landmark list on which to apply highlights
`colorInfo`	gem.core.ColorInfo	color do be used
`options`	gem.d3Scene.EHighlightOptions	options to be used for the landmark. Can be combined with \| operator
`usableIcons`	gem.d3Scene.EUsableIcons	(optional) Icon to replace with

Source: gemapi.js, line 1277

addGeoJsonAsCustomMarkers(geojsonbuffer, name, sourceslist, externalRenderer, maxGroupingLevelopt)

Add GeoJson as custom marker in the MapView

Parameters:

Name	Type	Attributes	Default	Description
`geojsonbuffer`	string			Actual Geo Json string buffer.
`name`	string			name for the added source(s)
`sourceslist`	gem.sourceslist			output list of created vector sources
`externalRenderer`	gem.d3Scene.ExternalRenderer			optional. external renderer. If not used, the internal rendering will be used to display source data.
`maxGroupingLevel`	number	<optional>	13	maximum map level to apply grouping

Source: gemapi.js, line 1297

addLandmarkStore(landmarkStore)

Add a landmark store to the view

Parameters:

Name	Type	Description
`landmarkStore`	gem.core.LandmarkStore	landmark store to be added

Source: gemapi.js, line 1589

addPath(path, borderColor, innerColor, sizeOfBorderopt, sizeOfInneropt)

Adds a path to the view.

Parameters:

Name	Type	Attributes	Default	Description
`path`	object			The path object to add.
`borderColor`	Object			The RGBA color of the border.
`innerColor`	Object			The RGBA color of the inner part of the path.
`sizeOfBorder`	number	<optional>	-1	The size of the border. Defaults to -1 if not provided.
`sizeOfInner`	number	<optional>	-1	The size of the inner part of the path. Defaults to -1 if not provided.

Source: gemapi.js, line 1614

addStoreListAsCustomMarkers(storeList, name, sourceslist, externalRenderer, storeId, nMaxGroupingLevelopt)

Add Store Locations list as custom markers in the MapView

Parameters:

Name	Type	Attributes	Default	Description
`storeList`	gem.core.StoreLocationList			Store List to be added to the view
`name`	string			Store list name
`sourceslist`	gem.sourceslist			output list of created vector sources
`externalRenderer`	gem.d3Scene.ExternalRenderer			optional. external renderer. If not used, the internal rendering will be used to display source data.
`storeId`	number			Store Id
`nMaxGroupingLevel`	number	<optional>	13	Maximum level on which grouping can occur

Source: gemapi.js, line 1316

alignNorthUp(durationMs)

Set the map north-up oriented

Parameters:

Name	Type	Description
`durationMs`	number	Animation duration in miliseconds. 0 - for instant north-up.

Source: gemapi.js, line 1054

captureMapScreen() → {Uint8Array}

Capture map screen

Source: gemapi.js, line 1253

Returns:

screen buffer

Type:: Uint8Array

captureMapScreenAsBitmapContainer() → {gem.d3Scene.BitmapContainer}

Capture map screen

Source: gemapi.js, line 1260

Returns:

Type:: gem.d3Scene.BitmapContainer

centerOnArea(coordinatesTopLeft, coordinatesBottomRight, durationMs, rectangleFloat, callbackfunction, zoomLevel)

Center the on the given WGS area specified by top left wgs coordinate and bottomright coordinate

Parameters:

Name	Type	Description
`coordinatesTopLeft`	gem.core.Coordinates	top left coordinates
`coordinatesBottomRight`	gem.core.Coordinates	bottom right coordinates
`durationMs`	number	fly animation duration (milliseconds)
`rectangleFloat`	gem.core.RectangleFloat	custom view rectangle
`callbackfunction`	callback
`zoomLevel`	number	zoom level 0 - max zoom level. See getMaxZoomLevel()

Source: gemapi.js, line 1080

centerOnCoordinates(coordinates, durationMs, callbackFunction, iXy, zoomLevel)

Center on a specified coordinates

Parameters:

Name	Type	Description
`coordinates`	gem.core.Coordinates
`durationMs`	number
`callbackFunction`	callback
`iXy`	gem.core.iXy
`zoomLevel`	number	zoom level 0 - max zoom level. See getMaxZoomLevel()

Source: gemapi.js, line 1038

centerOnRoute(route, durationMsopt, rectFloat)

Center on a route( route overview)

Parameters:

Name	Type	Attributes	Default	Description
`route`	gem.routesAndNavigation.Route
`durationMs`	number	<optional>	0	duration for animation in ms
`rectFloat`	gem.core.RectangleFloat			custom view rectangle

Source: gemapi.js, line 1380

centerOnRouteInstruction(routeInstruction, screenCoordinatesopt, zoomLevelopt)

Center on Route Instruction

Parameters:

Name	Type	Attributes	Description
`routeInstruction`	gem.routesAndNavigation.RouteInstruction
`screenCoordinates`	gem.core.screenCoordinates	<optional>	screen coordinates, where to center
`zoomLevel`	number	<optional>	zoom level

Source: gemapi.js, line 1213

centerOnRoutePortion(route, distBegin, distEnd, durationMsopt, rectFloat)

Center on a route( route overview)

Parameters:

Name	Type	Attributes	Default	Description
`route`	gem.routesAndNavigation.Route
`distBegin`	number			distance begin
`distEnd`	number			distance end
`durationMs`	number	<optional>	0	duration for animation in ms
`rectFloat`	gem.core.RectangleFloat			custom view rectangle

Source: gemapi.js, line 1558

createSource(dataType, name, markerCollectionDisplaySettings) → {number}

Parameters:

Name	Type	Description
`dataType`	gem.d3Scene.EMarkerType	type of the source
`name`	string	name given to the source
`markerCollectionDisplaySettings`	gem.d3Scene.MarkerCollectionDisplaySettings	display settings

Source: gemapi.js, line 1178

Returns:

generated source id

Type:: number

cursorSelectionLandmarks(resultedLandmarks)

Retrieve, in the given parameter, the list of landmarks under the cursor location.

Parameters:

Name	Type	Description
`resultedLandmarks`	gem.core.LandmarkList	resulted Landmarks

Source: gemapi.js, line 1113

deactivateHighlight()

Disable the highlight service.

Source: gemapi.js, line 1286

delete()

calls emscripten object destructor

Inherited From: Em_Object#delete
Source: gemapi.js, line 186

disableEdit()

Disable Edit Mode

Source: gemapi.js, line 1204

enableCursor(bVal)

Parameters:

Name	Type	Description
`bVal`	boolean

Source: gemapi.js, line 1480

enableEdit(callback)

Parameters:

Name	Type	Description
`callback`	callbackEdit

Source: gemapi.js, line 1195

enableOverlayItemWithExternalRendering(uId, externalRenderer)

Enable overlay Item with external Rendering

Parameters:

Name	Type	Description
`uId`	string
`externalRenderer`	gem.d3Scene.ExternalRenderer

Source: gemapi.js, line 1444

enableTouchGestures(gestures, enableFlag)

Toggle Touch Gesture

Parameters:

Name	Type	Description
`gestures`	gem.ETouchGestures	gestures to be toggled
`enableFlag`	boolean	enable or disable

Source: gemapi.js, line 1582

getCursorPositionWGS() → {gem.core.Xy}

Get current cursor position as WGS Coordinates

Source: gemapi.js, line 1126

Returns:

WGS Coordinates

Type:: gem.core.Xy

getMaxZoomLevel() → {number}

Get Maximum value for zoom level.

Source: gemapi.js, line 1013

Returns:

The maximum zoom value.

Type:: number

getNorthFixedFlag() → {bool}

Source: gemapi.js, line 1501

Returns:

Type:: bool

getNumberOfMarkersCollections() → {number}

Get total Number of Markers Collections

Source: gemapi.js, line 1468

Returns:

Type:: number

getRawPointer() → {object}

Returns emscripten object

Inherited From: Em_Object#getRawPointer
Source: gemapi.js, line 198

Returns:

Type:: object

getTilt() → {number}

get tilt angle

Source: gemapi.js, line 1107

Returns:

tilt angle

Type:: number

getVectorSourceAt(nId) → {gem.d3Scene.MarkerCollectionRef}

Parameters:

Name	Type	Description
`nId`	number	id for the needed source

Source: gemapi.js, line 1392

Returns:

source

Type:: gem.d3Scene.MarkerCollectionRef

getViewport() → {gem.core.RectangleInteger}

Get View viewport

Source: gemapi.js, line 1474

Returns:

viewport

Type:: gem.core.RectangleInteger

getZoomLevel() → {number}

Get the zoom level.

Source: gemapi.js, line 1006

Returns:

The zoom value.

Type:: number

isDeleted() → {boolean}

Check if emscripten object has been deleted

Inherited From: Em_Object#isDeleted
Source: gemapi.js, line 192

Returns:

Type:: boolean

isFollowingPosition() → {boolean}

Check if is it in follow position mode

Source: gemapi.js, line 1267

Returns:

Type:: boolean

queryStoreLocator(externalQueryListener, storeLocationList, storeId, bFullData, languageList, rectangleList)

Query store locator

Parameters:

Name	Type	Description
`externalQueryListener`	gem.d3Scene.ExternalQueryListener
`storeLocationList`	gem.core.StoreLocationList
`storeId`	number	store ID
`bFullData`	boolean	To query full data, or partial data
`languageList`	gem.core.GemStringList
`rectangleList`	gem.d3Scene.RectangleGeographicAreaList	list of regions to query for data

Source: gemapi.js, line 1418

queryStoreLocatorConfiguration(externalQueryListener, storeId, resultConfigurationList)

Parameters:

Name	Type	Description
`externalQueryListener`	gem.d3Scene.ExternalQueryListener
`storeId`	number
`resultConfigurationList`	gem.core.StoreLocationLangList

Source: gemapi.js, line 1436

registerCameraChangeStateCallback(callback)

Parameters:

Name	Type	Description
`callback`	*

Source: gemapi.js, line 1406

registerForNextRenderFinished(callback)

Parameters:

Name	Type	Description
`callback`	*

Source: gemapi.js, line 1509

registerLandmarkClickedEvent(resultedLandmarks, callbackfunction)

Parameters:

Name	Type	Description
`resultedLandmarks`	gem.core.LandmarkList	used for adding the clicked landmarks
`callbackfunction`	callback	Click event callback

Source: gemapi.js, line 1340

registerOnTouchEvent(callback)

Parameters:

Name	Type	Description
`callback`	*

Source: gemapi.js, line 1521

registerOnViewRendered(callback)

Parameters:

Name	Type	Description
`callback`	*

Source: gemapi.js, line 1515

registerOverlayItemClickedEvent(callbackfunction)

Parameters:

Name	Type	Description
`callbackfunction`	callbackMarkers

Source: gemapi.js, line 1351

registerStyleUpdateFinishedCallback(callbackStyle)

Get notified when style update has finished

Parameters:

Name	Type	Description
`callbackStyle`	*

Source: gemapi.js, line 1454

removeLandmarkStore(landmarkStore)

Remove a landmark store from the view

Parameters:

Name	Type	Description
`landmarkStore`	gem.core.LandmarkStore	landmark store to be removed

Source: gemapi.js, line 1596

removePath(path)

Removes a path from the view.

Parameters:

Name	Type	Description
`path`	object	The path object to remove.

Source: gemapi.js, line 1622

removeRoutefromView(route)

Remove route from view

Parameters:

Name	Type	Description
`route`	gem.Route	route that is being removed from the view

Source: gemapi.js, line 1371

removeVectorSource(pSource)

Parameters:

Name	Type	Description
`pSource`	gem.d3Scene.MarkerCollectionRef	source that should be deleted

Source: gemapi.js, line 1399

resizeView(rectangular)

Resize View

Parameters:

Name	Type	Description
`rectangular`	gem.core.RectangleFloat	The new size as a rectangle.Values needs to be normalized from the screen size(0->1).

Source: gemapi.js, line 1095

setClippingArea(area)

Set area of view clipping

Parameters:

Name	Type	Description
`area`	gem.core.RectangleFloat

Source: gemapi.js, line 1461

setCursorScreenPosition(screenCoordinates)

Set cursor position at a given position in the screen

Parameters:

Name	Type	Description
`screenCoordinates`	gem.core.Xy	screen coordinates

Source: gemapi.js, line 1120

setMapLabelsFading(bVal)

Sets the fading of map labels.

Parameters:

Name	Type	Description
`bVal`	boolean	If true, map labels will fade. If false, they will not.

Source: gemapi.js, line 1630

setMapStyle(nId)

set the style by id

Parameters:

Name	Type	Description
`nId`	number

Source: gemapi.js, line 1133

setMapViewDetailsQualityLevel(qualityLevel)

Parameters:

Name	Type	Description
`qualityLevel`	number	0 = Low Quality / High Performance;1 = Medium Quality; 2 = High Quality/ Low Performance

Source: gemapi.js, line 1603

setNorthFixedFlag(bFlag)

Parameters:

Name	Type	Description
`bFlag`	bool

Source: gemapi.js, line 1495

setTilt(angle)

set tilt angle

Parameters:

Name	Type	Description
`angle`	number	tilt angle

Source: gemapi.js, line 1101

setTrafficVisibility(bVal)

Sets the visibility of traffic information on the map.

Parameters:

Name	Type	Description
`bVal`	boolean	If true, traffic information will be visible. If false, it will not.

Source: gemapi.js, line 1638

setZoomLevel(zoomLevel)

Set zoom level

Parameters:

Name	Type	Description
`zoomLevel`	number	The zoom value.

Source: gemapi.js, line 1020

setZoomLevelOnPoint(zoomLevel, durationMs, positionInScreen)

Set zoom level, focusing in a specified screen point

Parameters:

Name	Type	Description
`zoomLevel`	number	The zoom value.
`durationMs`	number	duration The animation duration in milliseconds (0 means no animation)
`positionInScreen`	gem.core.Xy	Screen coordinates under which map should keep position.

Source: gemapi.js, line 1028

showRouteInView(route, bIsMainRoute, bAddRouteLabels, routeRenderSettings)

Add a route in the collection to be shown in the view

Parameters:

Name	Type	Description
`route`	gem.Route	route that is being added
`bIsMainRoute`	boolean	if the route should be added as a main route or not.
`bAddRouteLabels`	boolean	if the route labels should be added or not.
`routeRenderSettings`	RouteRenderSettings	route render settings