class sap.ui.vbm.GeoMap

Control sample: sap.ui.vbm.GeoMap
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Extends: sap.ui.vbm.VBI
Module: sap/ui/vbm/GeoMap
Application Component: CA-GTF-VBZ

Map control with the option to position multiple visual objects on top of a map. The GeoMap control shows an image based map loaded from one or more configurable external providers. Per default a map from MapQuest is used. Other map providers can be configured via property mapConfiguration. Multiple maps can be mashed up into one map layer stack. If multiple map layer stacks are provided via configuration it is possible to switch between them during runtime. The control supports the display of copyright information for the visible maps.
On top of the map the GeoMap control provides a navigation control, a scale, and a legend. Each of them can be switched off separately.
It is possible to set the initial position and zoom for the map display. Further the control allows to restrict the potentially visible map area and zoom range.
Different visual objects can be placed on the map. Visual objects are grouped in VO aggregations and an arbitrary number of VO aggregations can be assigned to the vos aggregation.
The second aggregation featureCollections allows the use of GeoJSON as source for visual objects.


Constructor

Constructor for a new GeoMap.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.ui.vbm.GeoMap(sId?, mSettings?)
Param Type Default Value Description
sId? string

id for the new control, generated automatically if no id is given

mSettings? object

initial settings for the new control


Properties

Name Type Default Value Description
centerPosition string 0;0

Center position of the Map. Format is "<longitude>;<latitude>".

Visibility: public
clustering object Visibility: public
disablePan boolean false

Disable Map Paning. This setting works only upon initialization and cannot be changed later on.

Visibility: public
disableZoom boolean false

Disable Map Zooming. This setting works only upon initialization and cannot be changed later on.

Visibility: public
enableAnimation boolean false

Enable Animation of Map Zoom. Works in combination of setZoomlevel.

Visibility: public
initialPosition string 0;0;0

Initial position of the Map. Set is only supported on initialization! Format is "<longitude>;<latitude>;0".

Visibility: public
initialZoom string 2

Initial zoom. Value needs to be positive whole number. Set is only supported on initialization!

Visibility: public
legendVisible boolean true

Toggles the visibility of the legend

Visibility: public
mapConfiguration object

This is the map configuration for the geo map. The map configuration defines the used maps, the layering of the maps and the servers that can be used to request the map tiles.

Visibility: public
navcontrolVisible boolean true

Defines the visibility of the navigation control. Only supported on initialization!

Visibility: public
refMapLayerStack string Default

Name of the map layer stack (provided in mapConfiguration) which is used for map rendering. If not set the layer stack with the name 'Default' is chosen. Property can be changed at runtime to switch between map layer stack.

Visibility: public
scaleVisible boolean true

Defines the visibility of the scale. Only supported on initialization!

Visibility: public
visualFrame object

Visual Frame object. Defining a frame {minX, maxX, minY, maxY, maxLOD, minLOD} to which the scene display is restricted.

Visibility: public
zoomlevel int 2

Zoomlevel for the Map. Value needs to be positive whole number.

Visibility: public

Borrowed Properties

Name Type Default Value Description
allowKeyEventRepeat boolean true

Allow repeating of keyboard events when key is pressed and hold.

Visibility: public
ariaLabel string

Text to be read out for the Control when used in accessibility mode (Screen reader)

Visibility: public
config object Visibility: public
enableOverlappingTest boolean true

Enable Test for Overlapped Objects for selection and context menu

Visibility: public
height sap.ui.core.CSSSize 600px

Set the height of the control.

Visibility: public
keyEventDelay int 250

Miminum delay between keyboard events. Used to reduce frequency of keyboard events.

Visibility: public
lassoSelection boolean false

Defines whether the lasso selection mode is active or not

Visibility: public
plugin boolean false

When true, the ActiveX plugin version of Visual Business will be used for rendering. For that the plugin needs to be installed on the client. Default (false) the control renders on canvas.

Visibility: public
rectZoom boolean false

Defines whether the rectangular zoom mode is active or not

Visibility: public
rectangularSelection boolean false

Defines whether the rectangular selection mode is active or not

Visibility: public
width sap.ui.core.CSSSize 800px

Set the width of the control.

Visibility: public

Aggregations

Default Aggregation: vos

Name Cardinality Type Description
clusters 0..n sap.ui.vbm.ClusterBase

Aggregation of clusters.

featureCollections 0..n sap.ui.vbm.FeatureCollection


Deprecated. This aggregation should not longer be used. Its functionality has been replaced by the more genericgeoJsonLayers aggregation.

geoJsonLayers 0..n sap.ui.vbm.GeoJsonLayer

Aggregation of GeoJSON layers. Object from a GeoJSON layer will be behind all other Visual Objects from the vos aggregation. In case of multiple GeoJSON layers the objects are orderer with the layers they belong to.

legend 0..1 sap.ui.vbm.Legend

Legend for the Map

resources 0..n sap.ui.vbm.Resource

Aggregation of resources. The images for e.g. Spots have to be provided as resources.

vos (default) 0..n sap.ui.vbm.VoAbstract

Aggregation of visual object types. A VO aggregation can be considered to be a table of VOs of a common type.


Events Overview

Event Description
centerChanged

this event is raised on map move.

click

Raised when the map is clicked.

contextMenu

Raised when the map is right clicked/longPressed(tap and hold).

drop

Raised when something is dropped on the map.

keyDown

this event is raised on map key down

keyPress

this event is raised on map key press

keyUp

this event is raised on map key up

select

This event is raised when a multi selection of visual objects has occurred

zoomChanged

this event is raised on zoom in or zoom out.

centerChanged

this event is raised on map move.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
centerPoint string

Center point of the map. Format : Lon;Lat;0.0.

viewportBB object

Viewport bounding box's upperLeft and lowerRight coordinates. Format : Lon;Lat;0.0.

zoomLevel int

Level of detail.

click

Raised when the map is clicked.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
pos string

Geo coordinates in format "<longitude>;<latitude>;0"

contextMenu

Raised when the map is right clicked/longPressed(tap and hold).

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
clientX int

Client coordinate X

clientY int

Client coordinate Y

pos string

Geo coordinates in format "<longitude>;<latitude>;0"

drop

Raised when something is dropped on the map.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
pos string

Geo coordinates in format "<longitude>;<latitude>;0"

keyDown

this event is raised on map key down

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
key string

Key value of the key

code int

Code value of the key

shift boolean

Shift key modifier state

ctrl boolean

Ctrl key modifier state

alt boolean

Alt key modifier state

meta boolean

Meta key modifier state

keyPress

this event is raised on map key press

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
key string

Key value of the key

code int

Code value of the key

shift boolean

Shift key modifier state

ctrl boolean

Ctrl key modifier state

alt boolean

Alt key modifier state

meta boolean

Meta key modifier state

keyUp

this event is raised on map key up

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
key string

Key value of the key

code int

Code value of the key

shift boolean

Shift key modifier state

ctrl boolean

Ctrl key modifier state

alt boolean

Alt key modifier state

meta boolean

Meta key modifier state

select

This event is raised when a multi selection of visual objects has occurred

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

zoomChanged

this event is raised on zoom in or zoom out.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
centerPoint string

Center point of the map. Format : Lon;Lat;0.0.

viewportBB object

Viewport bounding box's upperLeft and lowerRight coordinates. Format : Lon;Lat;0.0.

zoomLevel int

Level of detail.


Methods Overview

Method Description
addCluster

Adds some cluster to the aggregation clusters.

addFeatureCollection

Adds some featureCollection to the aggregation featureCollections.

Since This aggregation should not longer be used. Its functionality has been replaced by the more generic<code>geoJsonLayers</code> aggregation.
addGeoJsonLayer

Adds some geoJsonLayer to the aggregation geoJsonLayers.

addResource

Adds some resource to the aggregation resources.

addVo

Adds some vo to the aggregation vos.

attachCenterChanged

Attaches event handler fnFunction to the centerChanged event of this sap.ui.vbm.GeoMap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.GeoMap itself.

this event is raised on map move.

attachClick

Attaches event handler fnFunction to the click event of this sap.ui.vbm.GeoMap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.GeoMap itself.

Raised when the map is clicked.

attachContextMenu

Attaches event handler fnFunction to the contextMenu event of this sap.ui.vbm.GeoMap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.GeoMap itself.

Raised when the map is right clicked/longPressed(tap and hold).

attachDrop

Attaches event handler fnFunction to the drop event of this sap.ui.vbm.GeoMap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.GeoMap itself.

Raised when something is dropped on the map.

attachKeyDown

Attaches event handler fnFunction to the keyDown event of this sap.ui.vbm.GeoMap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.GeoMap itself.

this event is raised on map key down

attachKeyPress

Attaches event handler fnFunction to the keyPress event of this sap.ui.vbm.GeoMap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.GeoMap itself.

this event is raised on map key press

attachKeyUp

Attaches event handler fnFunction to the keyUp event of this sap.ui.vbm.GeoMap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.GeoMap itself.

this event is raised on map key up

attachSelect

Attaches event handler fnFunction to the select event of this sap.ui.vbm.GeoMap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.GeoMap itself.

This event is raised when a multi selection of visual objects has occurred

attachZoomChanged

Attaches event handler fnFunction to the zoomChanged event of this sap.ui.vbm.GeoMap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.GeoMap itself.

this event is raised on zoom in or zoom out.

closeAnyDetailWindow

Close any open Detail window

destroyClusters

Destroys all the clusters in the aggregation clusters.

destroyFeatureCollections

Destroys all the featureCollections in the aggregation featureCollections.

Since This aggregation should not longer be used. Its functionality has been replaced by the more generic<code>geoJsonLayers</code> aggregation.
destroyGeoJsonLayers

Destroys all the geoJsonLayers in the aggregation geoJsonLayers.

destroyLegend

Destroys the legend in the aggregation legend.

destroyResources

Destroys all the resources in the aggregation resources.

destroyVos

Destroys all the vos in the aggregation vos.

detachCenterChanged

Detaches event handler fnFunction from the centerChanged event of this sap.ui.vbm.GeoMap.

The passed function and listener object must match the ones used for event registration.

detachClick

Detaches event handler fnFunction from the click event of this sap.ui.vbm.GeoMap.

The passed function and listener object must match the ones used for event registration.

detachContextMenu

Detaches event handler fnFunction from the contextMenu event of this sap.ui.vbm.GeoMap.

The passed function and listener object must match the ones used for event registration.

detachDrop

Detaches event handler fnFunction from the drop event of this sap.ui.vbm.GeoMap.

The passed function and listener object must match the ones used for event registration.

detachKeyDown

Detaches event handler fnFunction from the keyDown event of this sap.ui.vbm.GeoMap.

The passed function and listener object must match the ones used for event registration.

detachKeyPress

Detaches event handler fnFunction from the keyPress event of this sap.ui.vbm.GeoMap.

The passed function and listener object must match the ones used for event registration.

detachKeyUp

Detaches event handler fnFunction from the keyUp event of this sap.ui.vbm.GeoMap.

The passed function and listener object must match the ones used for event registration.

detachSelect

Detaches event handler fnFunction from the select event of this sap.ui.vbm.GeoMap.

The passed function and listener object must match the ones used for event registration.

detachZoomChanged

Detaches event handler fnFunction from the zoomChanged event of this sap.ui.vbm.GeoMap.

The passed function and listener object must match the ones used for event registration.

sap.ui.vbm.GeoMap.extend

Creates a new subclass of class sap.ui.vbm.GeoMap with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.vbm.VBI.extend.

fireCenterChanged

Fires event centerChanged to attached listeners.

fireClick

Fires event click to attached listeners.

fireContextMenu

Fires event contextMenu to attached listeners.

fireDrop

Fires event drop to attached listeners.

fireKeyDown

Fires event keyDown to attached listeners.

fireKeyPress

Fires event keyPress to attached listeners.

fireKeyUp

Fires event keyUp to attached listeners.

fireSelect

Fires event select to attached listeners.

fireZoomChanged

Fires event zoomChanged to attached listeners.

getCenterPosition

Retrieves the center position of the current map.

getClusteredSpots

Retrieves all spot instances of a {sap.ui.vbm.ClusterContainer}

getClustering

Gets current value of property clustering.

Since This property should not longer be used. Its functionality has been replaced by the <code>clusters</code> aggregation.
getClusters

Gets content of aggregation clusters.

Aggregation of clusters.

getDisablePan

Gets current value of property disablePan.

Disable Map Paning. This setting works only upon initialization and cannot be changed later on.

Default value is false.

getDisableZoom

Gets current value of property disableZoom.

Disable Map Zooming. This setting works only upon initialization and cannot be changed later on.

Default value is false.

getEnableAnimation

Gets current value of property enableAnimation.

Enable Animation of Map Zoom. Works in combination of setZoomlevel.

Default value is false.

getFeatureCollections

Gets content of aggregation featureCollections.

Since This aggregation should not longer be used. Its functionality has been replaced by the more generic<code>geoJsonLayers</code> aggregation.
getGeoJsonLayers

Gets content of aggregation geoJsonLayers.

Aggregation of GeoJSON layers. Object from a GeoJSON layer will be behind all other Visual Objects from the vos aggregation. In case of multiple GeoJSON layers the objects are orderer with the layers they belong to.

getInitialPosition

Gets current value of property initialPosition.

Initial position of the Map. Set is only supported on initialization! Format is "<longitude>;<latitude>;0".

Default value is "0;0;0".

getInitialZoom

Gets current value of property initialZoom.

Initial zoom. Value needs to be positive whole number. Set is only supported on initialization!

Default value is "2".

getLegend

Gets content of aggregation legend.

Legend for the Map

getLegendVisible

Gets current value of property legendVisible.

Toggles the visibility of the legend

Default value is true.

getMapConfiguration

Gets current value of property mapConfiguration.

This is the map configuration for the geo map. The map configuration defines the used maps, the layering of the maps and the servers that can be used to request the map tiles.

sap.ui.vbm.GeoMap.getMetadata

Returns a metadata object for class sap.ui.vbm.GeoMap.

getNavcontrolVisible

Gets current value of property navcontrolVisible.

Defines the visibility of the navigation control. Only supported on initialization!

Default value is true.

getPositionInteractive

Trigger the interactive creation mode to get a position or position array.

getRefMapLayerStack

Gets current value of property refMapLayerStack.

Name of the map layer stack (provided in mapConfiguration) which is used for map rendering. If not set the layer stack with the name 'Default' is chosen. Property can be changed at runtime to switch between map layer stack.

Default value is "Default".

getResources

Gets content of aggregation resources.

Aggregation of resources. The images for e.g. Spots have to be provided as resources.

getScaleVisible

Gets current value of property scaleVisible.

Defines the visibility of the scale. Only supported on initialization!

Default value is true.

getVisualFrame

Gets current value of property visualFrame.

Visual Frame object. Defining a frame {minX, maxX, minY, maxY, maxLOD, minLOD} to which the scene display is restricted.

getVoByInternalId

Get an aggregated VO instance by its internal ID returned by e.g. function getInfoForCluster.

getVos

Gets content of aggregation vos.

Aggregation of visual object types. A VO aggregation can be considered to be a table of VOs of a common type.

getZoomlevel

Gets current value of property zoomlevel.

Zoomlevel for the Map. Value needs to be positive whole number.

Default value is 2.

goToStartPosition

Go to Initial Start Position with Initial Zoom Level

indexOfCluster

Checks for the provided sap.ui.vbm.ClusterBase in the aggregation clusters. and returns its index if found or -1 otherwise.

indexOfFeatureCollection

Checks for the provided sap.ui.vbm.FeatureCollection in the aggregation featureCollections. and returns its index if found or -1 otherwise.

Since This aggregation should not longer be used. Its functionality has been replaced by the more generic<code>geoJsonLayers</code> aggregation.
indexOfGeoJsonLayer

Checks for the provided sap.ui.vbm.GeoJsonLayer in the aggregation geoJsonLayers. and returns its index if found or -1 otherwise.

indexOfResource

Checks for the provided sap.ui.vbm.Resource in the aggregation resources. and returns its index if found or -1 otherwise.

indexOfVo

Checks for the provided sap.ui.vbm.VoAbstract in the aggregation vos. and returns its index if found or -1 otherwise.

insertCluster

Inserts a cluster into the aggregation clusters.

insertFeatureCollection

Inserts a featureCollection into the aggregation featureCollections.

Since This aggregation should not longer be used. Its functionality has been replaced by the more generic<code>geoJsonLayers</code> aggregation.
insertGeoJsonLayer

Inserts a geoJsonLayer into the aggregation geoJsonLayers.

insertResource

Inserts a resource into the aggregation resources.

insertVo

Inserts a vo into the aggregation vos.

openDetailWindow

Open Detail window

removeAllClusters

Removes all the controls from the aggregation clusters.

Additionally, it unregisters them from the hosting UIArea.

removeAllFeatureCollections

Removes all the controls from the aggregation featureCollections.

Additionally, it unregisters them from the hosting UIArea.

Since This aggregation should not longer be used. Its functionality has been replaced by the more generic<code>geoJsonLayers</code> aggregation.
removeAllGeoJsonLayers

Removes all the controls from the aggregation geoJsonLayers.

Additionally, it unregisters them from the hosting UIArea.

removeAllResources

Removes all the controls from the aggregation resources.

Additionally, it unregisters them from the hosting UIArea.

removeAllVos

Removes all the controls from the aggregation vos.

Additionally, it unregisters them from the hosting UIArea.

removeCluster

Removes a cluster from the aggregation clusters.

removeFeatureCollection

Removes a featureCollection from the aggregation featureCollections.

Since This aggregation should not longer be used. Its functionality has been replaced by the more generic<code>geoJsonLayers</code> aggregation.
removeGeoJsonLayer

Removes a geoJsonLayer from the aggregation geoJsonLayers.

removeResource

Removes a resource from the aggregation resources.

removeVo

Removes a vo from the aggregation vos.

setCenterPosition

Sets a new value for property centerPosition.

Center position of the Map. Format is "<longitude>;<latitude>".

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "0;0".

setClustering

Set clustering definitions.

Since This property should not longer be used. Its functionality has been replaced by the <code>clusters</code> aggregation.
setDisablePan

Sets a new value for property disablePan.

Disable Map Paning. This setting works only upon initialization and cannot be changed later on.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

setDisableZoom

Sets a new value for property disableZoom.

Disable Map Zooming. This setting works only upon initialization and cannot be changed later on.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

setEnableAnimation

Sets a new value for property enableAnimation.

Enable Animation of Map Zoom. Works in combination of setZoomlevel.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

setInitialPosition

Sets a new value for property initialPosition.

Initial position of the Map. Set is only supported on initialization! Format is "<longitude>;<latitude>;0".

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "0;0;0".

setInitialZoom

Sets a new value for property initialZoom.

Initial zoom. Value needs to be positive whole number. Set is only supported on initialization!

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "2".

setLassoSelection

Set Tracking Mode for Lasso Selection on/off.

setLegend

Sets the aggregated legend.

setLegendVisible

Sets a new value for property legendVisible.

Toggles the visibility of the legend

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

setMapConfiguration

Set Map configuration data. Map Configurations contain a set of Map Providers and Map Layer Stacks refering to those providers. The GeoMap property refMapLayerStack defines, which Map Layer Stack becomes visible.

setNavcontrolVisible

Sets a new value for property navcontrolVisible.

Defines the visibility of the navigation control. Only supported on initialization!

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

setRectangularSelection

Set Tracking Mode for Rectangular Selection on/off.

setRectZoom

Set Tracking Mode for Rectangular Zoom on/off.

setRefMapLayerStack

Sets a new value for property refMapLayerStack.

Name of the map layer stack (provided in mapConfiguration) which is used for map rendering. If not set the layer stack with the name 'Default' is chosen. Property can be changed at runtime to switch between map layer stack.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "Default".

setScaleVisible

Sets a new value for property scaleVisible.

Defines the visibility of the scale. Only supported on initialization!

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

setVisualFrame

Set Visual Frame definition.

setZoomlevel

Sets a new value for property zoomlevel.

Zoomlevel for the Map. Value needs to be positive whole number.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 2.

zoomToAreasById

Zoom to Areas by Id.

addCluster

Adds some cluster to the aggregation clusters.

Param Type DefaultValue Description
oCluster sap.ui.vbm.ClusterBase

The cluster to add; if empty, nothing is inserted

addFeatureCollection

Adds some featureCollection to the aggregation featureCollections.

Since This aggregation should not longer be used. Its functionality has been replaced by the more generic<code>geoJsonLayers</code> aggregation.
Param Type DefaultValue Description
oFeatureCollection sap.ui.vbm.FeatureCollection

The featureCollection to add; if empty, nothing is inserted

addGeoJsonLayer

Adds some geoJsonLayer to the aggregation geoJsonLayers.

Param Type DefaultValue Description
oGeoJsonLayer sap.ui.vbm.GeoJsonLayer

The geoJsonLayer to add; if empty, nothing is inserted

addResource

Adds some resource to the aggregation resources.

Param Type DefaultValue Description
oResource sap.ui.vbm.Resource

The resource to add; if empty, nothing is inserted

addVo

Adds some vo to the aggregation vos.

Param Type DefaultValue Description
oVo sap.ui.vbm.VoAbstract

The vo to add; if empty, nothing is inserted

attachCenterChanged

Attaches event handler fnFunction to the centerChanged event of this sap.ui.vbm.GeoMap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.GeoMap itself.

this event is raised on map move.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.vbm.GeoMap itself

attachClick

Attaches event handler fnFunction to the click event of this sap.ui.vbm.GeoMap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.GeoMap itself.

Raised when the map is clicked.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.vbm.GeoMap itself

attachContextMenu

Attaches event handler fnFunction to the contextMenu event of this sap.ui.vbm.GeoMap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.GeoMap itself.

Raised when the map is right clicked/longPressed(tap and hold).

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.vbm.GeoMap itself

attachDrop

Attaches event handler fnFunction to the drop event of this sap.ui.vbm.GeoMap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.GeoMap itself.

Raised when something is dropped on the map.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.vbm.GeoMap itself

attachKeyDown

Attaches event handler fnFunction to the keyDown event of this sap.ui.vbm.GeoMap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.GeoMap itself.

this event is raised on map key down

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.vbm.GeoMap itself

attachKeyPress

Attaches event handler fnFunction to the keyPress event of this sap.ui.vbm.GeoMap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.GeoMap itself.

this event is raised on map key press

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.vbm.GeoMap itself

attachKeyUp

Attaches event handler fnFunction to the keyUp event of this sap.ui.vbm.GeoMap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.GeoMap itself.

this event is raised on map key up

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.vbm.GeoMap itself

attachSelect

Attaches event handler fnFunction to the select event of this sap.ui.vbm.GeoMap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.GeoMap itself.

This event is raised when a multi selection of visual objects has occurred

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.vbm.GeoMap itself

attachZoomChanged

Attaches event handler fnFunction to the zoomChanged event of this sap.ui.vbm.GeoMap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.GeoMap itself.

this event is raised on zoom in or zoom out.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.vbm.GeoMap itself

closeAnyDetailWindow

Close any open Detail window

destroyClusters

Destroys all the clusters in the aggregation clusters.

destroyFeatureCollections

Destroys all the featureCollections in the aggregation featureCollections.

Since This aggregation should not longer be used. Its functionality has been replaced by the more generic<code>geoJsonLayers</code> aggregation.

destroyGeoJsonLayers

Destroys all the geoJsonLayers in the aggregation geoJsonLayers.

destroyLegend

Destroys the legend in the aggregation legend.

destroyResources

Destroys all the resources in the aggregation resources.

destroyVos

Destroys all the vos in the aggregation vos.

detachCenterChanged

Detaches event handler fnFunction from the centerChanged event of this sap.ui.vbm.GeoMap.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachClick

Detaches event handler fnFunction from the click event of this sap.ui.vbm.GeoMap.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachContextMenu

Detaches event handler fnFunction from the contextMenu event of this sap.ui.vbm.GeoMap.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachDrop

Detaches event handler fnFunction from the drop event of this sap.ui.vbm.GeoMap.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachKeyDown

Detaches event handler fnFunction from the keyDown event of this sap.ui.vbm.GeoMap.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachKeyPress

Detaches event handler fnFunction from the keyPress event of this sap.ui.vbm.GeoMap.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachKeyUp

Detaches event handler fnFunction from the keyUp event of this sap.ui.vbm.GeoMap.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachSelect

Detaches event handler fnFunction from the select event of this sap.ui.vbm.GeoMap.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachZoomChanged

Detaches event handler fnFunction from the zoomChanged event of this sap.ui.vbm.GeoMap.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.vbm.GeoMap.extend

Creates a new subclass of class sap.ui.vbm.GeoMap with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.vbm.VBI.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

fireCenterChanged

Fires event centerChanged to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

centerPoint string

Center point of the map. Format : Lon;Lat;0.0.

viewportBB object

Viewport bounding box's upperLeft and lowerRight coordinates. Format : Lon;Lat;0.0.

zoomLevel int

Level of detail.

fireClick

Fires event click to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

pos string

Geo coordinates in format "<longitude>;<latitude>;0"

fireContextMenu

Fires event contextMenu to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

clientX int

Client coordinate X

clientY int

Client coordinate Y

pos string

Geo coordinates in format "<longitude>;<latitude>;0"

fireDrop

Fires event drop to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

pos string

Geo coordinates in format "<longitude>;<latitude>;0"

fireKeyDown

Fires event keyDown to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

key string

Key value of the key

code int

Code value of the key

shift boolean

Shift key modifier state

ctrl boolean

Ctrl key modifier state

alt boolean

Alt key modifier state

meta boolean

Meta key modifier state

fireKeyPress

Fires event keyPress to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

key string

Key value of the key

code int

Code value of the key

shift boolean

Shift key modifier state

ctrl boolean

Ctrl key modifier state

alt boolean

Alt key modifier state

meta boolean

Meta key modifier state

fireKeyUp

Fires event keyUp to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

key string

Key value of the key

code int

Code value of the key

shift boolean

Shift key modifier state

ctrl boolean

Ctrl key modifier state

alt boolean

Alt key modifier state

meta boolean

Meta key modifier state

fireSelect

Fires event select to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

fireZoomChanged

Fires event zoomChanged to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

centerPoint string

Center point of the map. Format : Lon;Lat;0.0.

viewportBB object

Viewport bounding box's upperLeft and lowerRight coordinates. Format : Lon;Lat;0.0.

zoomLevel int

Level of detail.

getCenterPosition

Retrieves the center position of the current map.

getClusteredSpots

Retrieves all spot instances of a {sap.ui.vbm.ClusterContainer}

Param Type DefaultValue Description
clusterContainer sap.ui.vbm.ClusterContainer

The cluster container whose spots we want to retrieve.

getClustering

Gets current value of property clustering.

Since This property should not longer be used. Its functionality has been replaced by the <code>clusters</code> aggregation.

getClusters

Gets content of aggregation clusters.

Aggregation of clusters.

getDisablePan

Gets current value of property disablePan.

Disable Map Paning. This setting works only upon initialization and cannot be changed later on.

Default value is false.

getDisableZoom

Gets current value of property disableZoom.

Disable Map Zooming. This setting works only upon initialization and cannot be changed later on.

Default value is false.

getEnableAnimation

Gets current value of property enableAnimation.

Enable Animation of Map Zoom. Works in combination of setZoomlevel.

Default value is false.

getFeatureCollections

Gets content of aggregation featureCollections.

Since This aggregation should not longer be used. Its functionality has been replaced by the more generic<code>geoJsonLayers</code> aggregation.

getGeoJsonLayers

Gets content of aggregation geoJsonLayers.

Aggregation of GeoJSON layers. Object from a GeoJSON layer will be behind all other Visual Objects from the vos aggregation. In case of multiple GeoJSON layers the objects are orderer with the layers they belong to.

getInitialPosition

Gets current value of property initialPosition.

Initial position of the Map. Set is only supported on initialization! Format is "<longitude>;<latitude>;0".

Default value is "0;0;0".

getInitialZoom

Gets current value of property initialZoom.

Initial zoom. Value needs to be positive whole number. Set is only supported on initialization!

Default value is "2".

getLegend

Gets content of aggregation legend.

Legend for the Map

getLegendVisible

Gets current value of property legendVisible.

Toggles the visibility of the legend

Default value is true.

getMapConfiguration

Gets current value of property mapConfiguration.

This is the map configuration for the geo map. The map configuration defines the used maps, the layering of the maps and the servers that can be used to request the map tiles.

sap.ui.vbm.GeoMap.getMetadata

Returns a metadata object for class sap.ui.vbm.GeoMap.

getNavcontrolVisible

Gets current value of property navcontrolVisible.

Defines the visibility of the navigation control. Only supported on initialization!

Default value is true.

getPositionInteractive

Trigger the interactive creation mode to get a position or position array.

Param Type DefaultValue Description
bPosArray boolean

Indicator if a single position or an array is requested

callback function

Callback function func( sPosArray ) to be called when done. Position(array) sPosArray is provided in format "lon;lat;0;..."

getRefMapLayerStack

Gets current value of property refMapLayerStack.

Name of the map layer stack (provided in mapConfiguration) which is used for map rendering. If not set the layer stack with the name 'Default' is chosen. Property can be changed at runtime to switch between map layer stack.

Default value is "Default".

getResources

Gets content of aggregation resources.

Aggregation of resources. The images for e.g. Spots have to be provided as resources.

getScaleVisible

Gets current value of property scaleVisible.

Defines the visibility of the scale. Only supported on initialization!

Default value is true.

getVisualFrame

Gets current value of property visualFrame.

Visual Frame object. Defining a frame {minX, maxX, minY, maxY, maxLOD, minLOD} to which the scene display is restricted.

getVoByInternalId

Get an aggregated VO instance by its internal ID returned by e.g. function getInfoForCluster.

Param Type DefaultValue Description
voIdentifier string

Internal VO Identifier

getVos

Gets content of aggregation vos.

Aggregation of visual object types. A VO aggregation can be considered to be a table of VOs of a common type.

getZoomlevel

Gets current value of property zoomlevel.

Zoomlevel for the Map. Value needs to be positive whole number.

Default value is 2.

goToStartPosition

Go to Initial Start Position with Initial Zoom Level

indexOfCluster

Checks for the provided sap.ui.vbm.ClusterBase in the aggregation clusters. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oCluster sap.ui.vbm.ClusterBase

The cluster whose index is looked for

indexOfFeatureCollection

Checks for the provided sap.ui.vbm.FeatureCollection in the aggregation featureCollections. and returns its index if found or -1 otherwise.

Since This aggregation should not longer be used. Its functionality has been replaced by the more generic<code>geoJsonLayers</code> aggregation.
Param Type DefaultValue Description
oFeatureCollection sap.ui.vbm.FeatureCollection

The featureCollection whose index is looked for

indexOfGeoJsonLayer

Checks for the provided sap.ui.vbm.GeoJsonLayer in the aggregation geoJsonLayers. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oGeoJsonLayer sap.ui.vbm.GeoJsonLayer

The geoJsonLayer whose index is looked for

indexOfResource

Checks for the provided sap.ui.vbm.Resource in the aggregation resources. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oResource sap.ui.vbm.Resource

The resource whose index is looked for

indexOfVo

Checks for the provided sap.ui.vbm.VoAbstract in the aggregation vos. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oVo sap.ui.vbm.VoAbstract

The vo whose index is looked for

insertCluster

Inserts a cluster into the aggregation clusters.

Param Type DefaultValue Description
oCluster sap.ui.vbm.ClusterBase

The cluster to insert; if empty, nothing is inserted

iIndex int

The 0-based index the cluster should be inserted at; for a negative value of iIndex, the cluster is inserted at position 0; for a value greater than the current size of the aggregation, the cluster is inserted at the last position

insertFeatureCollection

Inserts a featureCollection into the aggregation featureCollections.

Since This aggregation should not longer be used. Its functionality has been replaced by the more generic<code>geoJsonLayers</code> aggregation.
Param Type DefaultValue Description
oFeatureCollection sap.ui.vbm.FeatureCollection

The featureCollection to insert; if empty, nothing is inserted

iIndex int

The 0-based index the featureCollection should be inserted at; for a negative value of iIndex, the featureCollection is inserted at position 0; for a value greater than the current size of the aggregation, the featureCollection is inserted at the last position

insertGeoJsonLayer

Inserts a geoJsonLayer into the aggregation geoJsonLayers.

Param Type DefaultValue Description
oGeoJsonLayer sap.ui.vbm.GeoJsonLayer

The geoJsonLayer to insert; if empty, nothing is inserted

iIndex int

The 0-based index the geoJsonLayer should be inserted at; for a negative value of iIndex, the geoJsonLayer is inserted at position 0; for a value greater than the current size of the aggregation, the geoJsonLayer is inserted at the last position

insertResource

Inserts a resource into the aggregation resources.

Param Type DefaultValue Description
oResource sap.ui.vbm.Resource

The resource to insert; if empty, nothing is inserted

iIndex int

The 0-based index the resource should be inserted at; for a negative value of iIndex, the resource is inserted at position 0; for a value greater than the current size of the aggregation, the resource is inserted at the last position

insertVo

Inserts a vo into the aggregation vos.

Param Type DefaultValue Description
oVo sap.ui.vbm.VoAbstract

The vo to insert; if empty, nothing is inserted

iIndex int

The 0-based index the vo should be inserted at; for a negative value of iIndex, the vo is inserted at position 0; for a value greater than the current size of the aggregation, the vo is inserted at the last position

openDetailWindow

Open Detail window

Param Type DefaultValue Description
sPosition string

Postion for the Detail Window in format "lon;lat;0"

oParams object

Parameter Objects

caption string

Caption of the Detail Window

removeAllClusters

Removes all the controls from the aggregation clusters.

Additionally, it unregisters them from the hosting UIArea.

removeAllFeatureCollections

Removes all the controls from the aggregation featureCollections.

Additionally, it unregisters them from the hosting UIArea.

Since This aggregation should not longer be used. Its functionality has been replaced by the more generic<code>geoJsonLayers</code> aggregation.

removeAllGeoJsonLayers

Removes all the controls from the aggregation geoJsonLayers.

Additionally, it unregisters them from the hosting UIArea.

removeAllResources

Removes all the controls from the aggregation resources.

Additionally, it unregisters them from the hosting UIArea.

removeAllVos

Removes all the controls from the aggregation vos.

Additionally, it unregisters them from the hosting UIArea.

removeCluster

Removes a cluster from the aggregation clusters.

Param Type DefaultValue Description
vCluster int string sap.ui.vbm.ClusterBase

The cluster to remove or its index or id

removeFeatureCollection

Removes a featureCollection from the aggregation featureCollections.

Since This aggregation should not longer be used. Its functionality has been replaced by the more generic<code>geoJsonLayers</code> aggregation.
Param Type DefaultValue Description
vFeatureCollection int string sap.ui.vbm.FeatureCollection

The featureCollection to remove or its index or id

removeGeoJsonLayer

Removes a geoJsonLayer from the aggregation geoJsonLayers.

Param Type DefaultValue Description
vGeoJsonLayer int string sap.ui.vbm.GeoJsonLayer

The geoJsonLayer to remove or its index or id

removeResource

Removes a resource from the aggregation resources.

Param Type DefaultValue Description
vResource int string sap.ui.vbm.Resource

The resource to remove or its index or id

removeVo

Removes a vo from the aggregation vos.

Param Type DefaultValue Description
vVo int string sap.ui.vbm.VoAbstract

The vo to remove or its index or id

setCenterPosition

Sets a new value for property centerPosition.

Center position of the Map. Format is "<longitude>;<latitude>".

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "0;0".

Param Type DefaultValue Description
sCenterPosition string "0;0"

New value for property centerPosition

setClustering

Set clustering definitions.

Since This property should not longer be used. Its functionality has been replaced by the <code>clusters</code> aggregation.
Param Type DefaultValue Description
oClustering object

Cluster Definition object

setDisablePan

Sets a new value for property disablePan.

Disable Map Paning. This setting works only upon initialization and cannot be changed later on.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

Param Type DefaultValue Description
bDisablePan boolean false

New value for property disablePan

setDisableZoom

Sets a new value for property disableZoom.

Disable Map Zooming. This setting works only upon initialization and cannot be changed later on.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

Param Type DefaultValue Description
bDisableZoom boolean false

New value for property disableZoom

setEnableAnimation

Sets a new value for property enableAnimation.

Enable Animation of Map Zoom. Works in combination of setZoomlevel.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

Param Type DefaultValue Description
bEnableAnimation boolean false

New value for property enableAnimation

setInitialPosition

Sets a new value for property initialPosition.

Initial position of the Map. Set is only supported on initialization! Format is "<longitude>;<latitude>;0".

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "0;0;0".

Param Type DefaultValue Description
sInitialPosition string "0;0;0"

New value for property initialPosition

setInitialZoom

Sets a new value for property initialZoom.

Initial zoom. Value needs to be positive whole number. Set is only supported on initialization!

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "2".

Param Type DefaultValue Description
sInitialZoom string "2"

New value for property initialZoom

setLassoSelection

Set Tracking Mode for Lasso Selection on/off.

Param Type DefaultValue Description
bSet boolean

to start or stop tracking mode

setLegend

Sets the aggregated legend.

Param Type DefaultValue Description
oLegend sap.ui.vbm.Legend

The legend to set

setLegendVisible

Sets a new value for property legendVisible.

Toggles the visibility of the legend

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Param Type DefaultValue Description
bLegendVisible boolean true

New value for property legendVisible

setMapConfiguration

Set Map configuration data. Map Configurations contain a set of Map Providers and Map Layer Stacks refering to those providers. The GeoMap property refMapLayerStack defines, which Map Layer Stack becomes visible.

Param Type DefaultValue Description
oMapConfiguration object

Map Configuration object

MapProvider array

Array of Map Provider definitions.

name string

Name for the provider. Needed in Map Layer Stack as reference.

tileX string

X-pixel dimension of map tile. Typical 256.

tileY string

Y-pixel dimension of map tile. Typical 256.

minLOD string

Minimal supported Level Of Detail.

maxLOD string

Maximal supported Level Of Detail.

copyright string

Copyright Information to be shown with the map.

Header array

Array of HTTP headers definitions. Optional.

name string

Name of the header.

value string

Value of the header.

Source array

Array of source definitions. At least on Source has to be given. Multiple sources can be used for load distribution.

id string

Source id.

url string

Source URL for map tile service. URL includes place holders for variable informations set at runtime, e.g. {LOD}.

MapLayerStacks array

Array of Map Layer Stacks

name string

Name of Map Layer Stack. Use with the GeoMap refMapLayerStack property.

MapLayer array

Array of Map Layers. Each Layer refers to a Map Proveride. Map Layers get overlayed in the given sequence.

name string

Name of Map Layer.

refMapProvider string

Name of referenced Map Provider.

opacity string

Opacity of Map Layer. Value range 0 to 1.

colBkgnd sap.ui.core.CSSColor

Background color for Map Layer. Only meaningful if opacity is below 1.

setNavcontrolVisible

Sets a new value for property navcontrolVisible.

Defines the visibility of the navigation control. Only supported on initialization!

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Param Type DefaultValue Description
bNavcontrolVisible boolean true

New value for property navcontrolVisible

setRectangularSelection

Set Tracking Mode for Rectangular Selection on/off.

Param Type DefaultValue Description
bSet boolean

to start or stop tracking mode

setRectZoom

Set Tracking Mode for Rectangular Zoom on/off.

Param Type DefaultValue Description
bSet boolean

to start or stop tracking mode

setRefMapLayerStack

Sets a new value for property refMapLayerStack.

Name of the map layer stack (provided in mapConfiguration) which is used for map rendering. If not set the layer stack with the name 'Default' is chosen. Property can be changed at runtime to switch between map layer stack.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "Default".

Param Type DefaultValue Description
sRefMapLayerStack string "Default"

New value for property refMapLayerStack

setScaleVisible

Sets a new value for property scaleVisible.

Defines the visibility of the scale. Only supported on initialization!

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Param Type DefaultValue Description
bScaleVisible boolean true

New value for property scaleVisible

setVisualFrame

Set Visual Frame definition.

Param Type DefaultValue Description
oVisFrame object

Visual Frame definition object

minLon float

Minimal longitude of visual frame

maxLon float

Maximal longitude of visual frame

minLat float

Minimal latitude of visual frame

maxLat float

Maximal latitude of visual frame

minLOD float

Minimal Level of Detail for visual frame

maxLOD float

Maximal Level of Detail for visual frame

maxFraction float

Maximal fraction [0..1] of minLOD which is acceptable, otherwise minLOD is rounded upwards

setZoomlevel

Sets a new value for property zoomlevel.

Zoomlevel for the Map. Value needs to be positive whole number.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 2.

Param Type DefaultValue Description
iZoomlevel int 2

New value for property zoomlevel

zoomToAreasById

Zoom to Areas by Id.

Param Type DefaultValue Description
ui5AreaIds string[]

is an Array of areas that we want to zoom to.

correlationFactor float

is the correction factor, if correlationFactor is set to 1.0 the bounding box points are exactly on the visible boder of the new area