Class sap.ui.vbm.GeoMapModule: sap/ui/vbm/GeoMap

extends VBI
known direct subclasses: AnalyticMap

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 Summary
new sap.ui.vbm.GeoMap(sId?, mSettings?)Constructor for a new GeoMap.
Event Summary
centerChanged(oControlEvent)this event is raised on map move.
click(oControlEvent)Raised when the map is clicked.
contextMenu(oControlEvent)Raised when the map is right clicked/longPressed(tap and hold).
drop(oControlEvent)Raised when something is dropped on the map.
select(oControlEvent)This event is raised when a multi selection of visual objects has occurred
zoomChanged(oControlEvent)this event is raised on zoom in or zoom out.
Events borrowed from class sap.ui.vbm.VBI
changeTrackingMode, closeWindow, containerCreated, containerDestroyed, move, openWindow, render, submit, thumbnailClick, zoom
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.vbm.GeoMap.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vbm.GeoMap with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vbm.GeoMap.getMetadata()Returns a metadata object for class sap.ui.vbm.GeoMap.
addCluster(oCluster)Adds some cluster to the aggregation clusters.
addGeoJsonLayer(oGeoJsonLayer)Adds some geoJsonLayer to the aggregation geoJsonLayers.
addResource(oResource)Adds some resource to the aggregation resources.
addVo(oVo)Adds some vo to the aggregation vos.
attachCenterChanged(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the centerChanged event of this sap.ui.vbm.GeoMap.
attachClick(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the click event of this sap.ui.vbm.GeoMap.
attachContextMenu(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the contextMenu event of this sap.ui.vbm.GeoMap.
attachDrop(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the drop event of this sap.ui.vbm.GeoMap.
attachSelect(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the select event of this sap.ui.vbm.GeoMap.
attachZoomChanged(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the zoomChanged event of this sap.ui.vbm.GeoMap.
closeAnyDetailWindow()Close any open Detail window
destroyClusters()Destroys all the clusters in the aggregation clusters.
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(fnFunction, oListener)Detaches event handler fnFunction from the centerChanged event of this sap.ui.vbm.GeoMap.
detachClick(fnFunction, oListener)Detaches event handler fnFunction from the click event of this sap.ui.vbm.GeoMap.
detachContextMenu(fnFunction, oListener)Detaches event handler fnFunction from the contextMenu event of this sap.ui.vbm.GeoMap.
detachDrop(fnFunction, oListener)Detaches event handler fnFunction from the drop event of this sap.ui.vbm.GeoMap.
detachSelect(fnFunction, oListener)Detaches event handler fnFunction from the select event of this sap.ui.vbm.GeoMap.
detachZoomChanged(fnFunction, oListener)Detaches event handler fnFunction from the zoomChanged event of this sap.ui.vbm.GeoMap.
fireCenterChanged(mArguments?)Fires event centerChanged to attached listeners.
fireClick(mArguments?)Fires event click to attached listeners.
fireContextMenu(mArguments?)Fires event contextMenu to attached listeners.
fireDrop(mArguments?)Fires event drop to attached listeners.
fireSelect(mArguments?)Fires event select to attached listeners.
fireZoomChanged(mArguments?)Fires event zoomChanged to attached listeners.
getCenterPosition()Gets current value of property centerPosition.
getClusters()Gets content of aggregation clusters.
getDisablePan()Gets current value of property disablePan.
getDisableZoom()Gets current value of property disableZoom.
getEnableAnimation()Gets current value of property enableAnimation.
getGeoJsonLayers()Gets content of aggregation geoJsonLayers.
getInitialPosition()Gets current value of property initialPosition.
getInitialZoom()Gets current value of property initialZoom.
getLegend()Gets content of aggregation legend.
getLegendVisible()Gets current value of property legendVisible.
getMapConfiguration()Gets current value of property mapConfiguration.
getNavcontrolVisible()Gets current value of property navcontrolVisible.
getPositionInteractive(bPosArray, callback)Trigger the interactive creation mode to get a position or position array.
getRefMapLayerStack()Gets current value of property refMapLayerStack.
getResources()Gets content of aggregation resources.
getScaleVisible()Gets current value of property scaleVisible.
getVisualFrame()Gets current value of property visualFrame.
getVoByInternalId(sIdent?)Get an aggregated VO instance by its internal ID returned by e.g.
getVos()Gets content of aggregation vos.
getZoomlevel()Gets current value of property zoomlevel.
goToStartPosition()Go to Initial Start Position with Initial Zoom Level
indexOfCluster(oCluster)Checks for the provided sap.ui.vbm.ClusterBase in the aggregation clusters.
indexOfGeoJsonLayer(oGeoJsonLayer)Checks for the provided sap.ui.vbm.GeoJsonLayer in the aggregation geoJsonLayers.
indexOfResource(oResource)Checks for the provided sap.ui.vbm.Resource in the aggregation resources.
indexOfVo(oVo)Checks for the provided sap.ui.vbm.VoAbstract in the aggregation vos.
insertCluster(oCluster, iIndex)Inserts a cluster into the aggregation clusters.
insertGeoJsonLayer(oGeoJsonLayer, iIndex)Inserts a geoJsonLayer into the aggregation geoJsonLayers.
insertResource(oResource, iIndex)Inserts a resource into the aggregation resources.
insertVo(oVo, iIndex)Inserts a vo into the aggregation vos.
openDetailWindow(sPosition, oParams?)Open Detail window
removeAllClusters()Removes all the controls from the aggregation clusters.
removeAllGeoJsonLayers()Removes all the controls from the aggregation geoJsonLayers.
removeAllResources()Removes all the controls from the aggregation resources.
removeAllVos()Removes all the controls from the aggregation vos.
removeCluster(vCluster)Removes a cluster from the aggregation clusters.
removeGeoJsonLayer(vGeoJsonLayer)Removes a geoJsonLayer from the aggregation geoJsonLayers.
removeResource(vResource)Removes a resource from the aggregation resources.
removeVo(vVo)Removes a vo from the aggregation vos.
setCenterPosition(sCenterPosition)Sets a new value for property centerPosition.
setDisablePan(bDisablePan)Sets a new value for property disablePan.
setDisableZoom(bDisableZoom)Sets a new value for property disableZoom.
setEnableAnimation(bEnableAnimation)Sets a new value for property enableAnimation.
setInitialPosition(sInitialPosition)Sets a new value for property initialPosition.
setInitialZoom(sInitialZoom)Sets a new value for property initialZoom.
setLassoSelection(bSet)Set Tracking Mode for Lasso Selection on/off.
setLegend(oLegend)Sets the aggregated legend.
setLegendVisible(bLegendVisible)Sets a new value for property legendVisible.
setMapConfiguration(oMapConfiguration)Set Map configuration data.
setNavcontrolVisible(bNavcontrolVisible)Sets a new value for property navcontrolVisible.
setRectangularSelection(bSet)Set Tracking Mode for Rectangular Selection on/off.
setRectZoom(bSet)Set Tracking Mode for Rectangular Zoom on/off.
setRefMapLayerStack(sRefMapLayerStack)Sets a new value for property refMapLayerStack.
setScaleVisible(bScaleVisible)Sets a new value for property scaleVisible.
setVisualFrame(oVisFrame)Set Visual Frame definition.
setZoomlevel(iZoomlevel)Sets a new value for property zoomlevel.
addFeatureCollection(oFeatureCollection)Adds some featureCollection to the aggregation featureCollections.
destroyFeatureCollections()Destroys all the featureCollections in the aggregation featureCollections.
getClustering()Gets current value of property clustering.
getFeatureCollections()Gets content of aggregation featureCollections.
indexOfFeatureCollection(oFeatureCollection)Checks for the provided sap.ui.vbm.FeatureCollection in the aggregation featureCollections.
insertFeatureCollection(oFeatureCollection, iIndex)Inserts a featureCollection into the aggregation featureCollections.
removeAllFeatureCollections()Removes all the controls from the aggregation featureCollections.
removeFeatureCollection(vFeatureCollection)Removes a featureCollection from the aggregation featureCollections.
setClustering(oClustering)Set clustering definitions.
Methods borrowed from class sap.ui.vbm.VBI
addRenderItem, attachChangeTrackingMode, attachCloseWindow, attachContainerCreated, attachContainerDestroyed, attachMove, attachOpenWindow, attachRender, attachSubmit, attachThumbnailClick, attachZoom, detachChangeTrackingMode, detachCloseWindow, detachContainerCreated, detachContainerDestroyed, detachMove, detachOpenWindow, detachRender, detachSubmit, detachThumbnailClick, detachZoom, fireChangeTrackingMode, fireCloseWindow, fireContainerCreated, fireContainerDestroyed, fireMove, fireOpenWindow, fireRender, fireSubmit, fireThumbnailClick, fireZoom, getConfig, getHeight, getInfoForCluster, getLassoSelection, getPicOfOverlay, getPlugin, getRectangularSelection, getRectZoom, getWidth, load, maximize, minimize, setConfig, setHeight, setPlugin, setWidth, zoomToAreas, zoomToGeoPosition
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.ui.vbm.GeoMap(sId?, mSettings?)
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 for a general description of the syntax of the settings object.

The supported settings are:

  • Properties
  • Aggregations
  • Events
    • click : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • contextMenu : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • drop : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • select : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • zoomChanged : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • centerChanged : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.vbm.VBI can be used as well.

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Event Detail
centerChanged(oControlEvent)
this event is raised on map move.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string}oControlEvent.getParameters.centerPoint Center point of the map. Format : Lon;Lat;0.0.
{object}oControlEvent.getParameters.viewportBB Viewport bounding box's upperLeft and lowerRight coordinates. Format : Lon;Lat;0.0.
{int}oControlEvent.getParameters.zoomLevel Level of detail.
click(oControlEvent)
Raised when the map is clicked.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string}oControlEvent.getParameters.pos Geo coordinates in format "<longitude>;<latitude>;0"
contextMenu(oControlEvent)
Raised when the map is right clicked/longPressed(tap and hold).
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{int}oControlEvent.getParameters.clientX Client coordinate X
{int}oControlEvent.getParameters.clientY Client coordinate Y
{string}oControlEvent.getParameters.pos Geo coordinates in format "<longitude>;<latitude>;0"
drop(oControlEvent)
Raised when something is dropped on the map.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string}oControlEvent.getParameters.pos Geo coordinates in format "<longitude>;<latitude>;0"
select(oControlEvent)
This event is raised when a multi selection of visual objects has occurred
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
zoomChanged(oControlEvent)
this event is raised on zoom in or zoom out.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string}oControlEvent.getParameters.centerPoint Center point of the map. Format : Lon;Lat;0.0.
{object}oControlEvent.getParameters.viewportBB Viewport bounding box's upperLeft and lowerRight coordinates. Format : Lon;Lat;0.0.
{int}oControlEvent.getParameters.zoomLevel Level of detail.
Method Detail
sap.ui.vbm.GeoMap.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.ui.vbm.GeoMap.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vbm.GeoMap.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addCluster(oCluster): sap.ui.vbm.GeoMap
Adds some cluster to the aggregation clusters.
Parameters:
{sap.ui.vbm.ClusterBase}oCluster the cluster to add; if empty, nothing is inserted
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
addGeoJsonLayer(oGeoJsonLayer): sap.ui.vbm.GeoMap
Adds some geoJsonLayer to the aggregation geoJsonLayers.
Parameters:
{sap.ui.vbm.GeoJsonLayer}oGeoJsonLayer the geoJsonLayer to add; if empty, nothing is inserted
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
addResource(oResource): sap.ui.vbm.GeoMap
Adds some resource to the aggregation resources.
Parameters:
{sap.ui.vbm.Resource}oResource the resource to add; if empty, nothing is inserted
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
addVo(oVo): sap.ui.vbm.GeoMap
Adds some vo to the aggregation vos.
Parameters:
{sap.ui.vbm.VoAbstract}oVo the vo to add; if empty, nothing is inserted
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
attachCenterChanged(oData?, fnFunction, oListener?): sap.ui.vbm.GeoMap
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.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.vbm.GeoMap itself
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
attachClick(oData?, fnFunction, oListener?): sap.ui.vbm.GeoMap
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.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.vbm.GeoMap itself
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
attachContextMenu(oData?, fnFunction, oListener?): sap.ui.vbm.GeoMap
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).

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.vbm.GeoMap itself
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
attachDrop(oData?, fnFunction, oListener?): sap.ui.vbm.GeoMap
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.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.vbm.GeoMap itself
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
attachSelect(oData?, fnFunction, oListener?): sap.ui.vbm.GeoMap
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

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.vbm.GeoMap itself
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
attachZoomChanged(oData?, fnFunction, oListener?): sap.ui.vbm.GeoMap
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.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.vbm.GeoMap itself
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
closeAnyDetailWindow(): void
Close any open Detail window
destroyClusters(): sap.ui.vbm.GeoMap
Destroys all the clusters in the aggregation clusters.
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
destroyGeoJsonLayers(): sap.ui.vbm.GeoMap
Destroys all the geoJsonLayers in the aggregation geoJsonLayers.
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
destroyLegend(): sap.ui.vbm.GeoMap
Destroys the legend in the aggregation legend.
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
destroyResources(): sap.ui.vbm.GeoMap
Destroys all the resources in the aggregation resources.
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
destroyVos(): sap.ui.vbm.GeoMap
Destroys all the vos in the aggregation vos.
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
detachCenterChanged(fnFunction, oListener): sap.ui.vbm.GeoMap
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.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
detachClick(fnFunction, oListener): sap.ui.vbm.GeoMap
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.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
detachContextMenu(fnFunction, oListener): sap.ui.vbm.GeoMap
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.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
detachDrop(fnFunction, oListener): sap.ui.vbm.GeoMap
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.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
detachSelect(fnFunction, oListener): sap.ui.vbm.GeoMap
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.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
detachZoomChanged(fnFunction, oListener): sap.ui.vbm.GeoMap
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.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
fireCenterChanged(mArguments?): sap.ui.vbm.GeoMap
Fires event centerChanged to attached listeners.

Expects the following event parameters:

  • centerPoint of type stringCenter point of the map. Format : Lon;Lat;0.0.
  • viewportBB of type objectViewport bounding box's upperLeft and lowerRight coordinates. Format : Lon;Lat;0.0.
  • zoomLevel of type intLevel of detail.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
fireClick(mArguments?): sap.ui.vbm.GeoMap
Fires event click to attached listeners.

Expects the following event parameters:

  • pos of type stringGeo coordinates in format "<longitude>;<latitude>;0"
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
fireContextMenu(mArguments?): sap.ui.vbm.GeoMap
Fires event contextMenu to attached listeners.

Expects the following event parameters:

  • clientX of type intClient coordinate X
  • clientY of type intClient coordinate Y
  • pos of type stringGeo coordinates in format "<longitude>;<latitude>;0"
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
fireDrop(mArguments?): sap.ui.vbm.GeoMap
Fires event drop to attached listeners.

Expects the following event parameters:

  • pos of type stringGeo coordinates in format "<longitude>;<latitude>;0"
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
fireSelect(mArguments?): sap.ui.vbm.GeoMap
Fires event select to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
fireZoomChanged(mArguments?): sap.ui.vbm.GeoMap
Fires event zoomChanged to attached listeners.

Expects the following event parameters:

  • centerPoint of type stringCenter point of the map. Format : Lon;Lat;0.0.
  • viewportBB of type objectViewport bounding box's upperLeft and lowerRight coordinates. Format : Lon;Lat;0.0.
  • zoomLevel of type intLevel of detail.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
getCenterPosition(): string
Gets current value of property centerPosition.

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

Default value is 0;0.

Returns:
{string} Value of property centerPosition
getClusters(): sap.ui.vbm.ClusterBase[]
Gets content of aggregation clusters.

Aggregation of clusters.

Returns:
{sap.ui.vbm.ClusterBase[]}
getDisablePan(): boolean
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.

Returns:
{boolean} Value of property disablePan
getDisableZoom(): boolean
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.

Returns:
{boolean} Value of property disableZoom
getEnableAnimation(): boolean
Gets current value of property enableAnimation.

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

Default value is false.

Returns:
{boolean} Value of property enableAnimation
getGeoJsonLayers(): sap.ui.vbm.GeoJsonLayer[]
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.

Returns:
{sap.ui.vbm.GeoJsonLayer[]}
getInitialPosition(): string
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.

Returns:
{string} Value of property initialPosition
getInitialZoom(): string
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.

Returns:
{string} Value of property initialZoom
getLegend(): sap.ui.vbm.Legend
Gets content of aggregation legend.

Legend for the Map

Returns:
{sap.ui.vbm.Legend}
getLegendVisible(): boolean
Gets current value of property legendVisible.

Toggles the visibility of the legend

Default value is true.

Returns:
{boolean} Value of property legendVisible
getMapConfiguration(): object
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.

Returns:
{object} Value of property mapConfiguration
getNavcontrolVisible(): boolean
Gets current value of property navcontrolVisible.

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

Default value is true.

Returns:
{boolean} Value of property navcontrolVisible
getPositionInteractive(bPosArray, callback): boolean
Trigger the interactive creation mode to get a position or position array.

Experimental API:Since 1.30.0 This method is experimental and might be modified or removerd in future versions.

Parameters:
{boolean}bPosArray Indicator if a single position or an array is requested
{function}callback Callback function func( sPosArray ) to be called when done. Position(array) sPosArray is provided in format "lon;lat;0;..."
Experimental:
Since 1.30.0 This method is experimental and might be modified or removerd in future versions.
Returns:
{boolean} Indicator whether the creation mode could be triggered successfully or not.
getRefMapLayerStack(): string
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.

Returns:
{string} Value of property refMapLayerStack
getResources(): sap.ui.vbm.Resource[]
Gets content of aggregation resources.

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

Returns:
{sap.ui.vbm.Resource[]}
getScaleVisible(): boolean
Gets current value of property scaleVisible.

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

Default value is true.

Returns:
{boolean} Value of property scaleVisible
getVisualFrame(): object
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.

Returns:
{object} Value of property visualFrame
getVoByInternalId(sIdent?): sap.ui.vbm.VoBase
Get an aggregated VO instance by its internal ID returned by e.g. function getInfoForCluster.
Parameters:
{string}sIdent? Internal VO Identifier
Returns:
{sap.ui.vbm.VoBase} VO instance element or null if nothing found
getVos(): sap.ui.vbm.VoAbstract[]
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.

Returns:
{sap.ui.vbm.VoAbstract[]}
getZoomlevel(): int
Gets current value of property zoomlevel.

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

Default value is 2.

Returns:
{int} Value of property zoomlevel
goToStartPosition(): void
Go to Initial Start Position with Initial Zoom Level
indexOfCluster(oCluster): int
Checks for the provided sap.ui.vbm.ClusterBase in the aggregation clusters. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.vbm.ClusterBase}oCluster The cluster whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
indexOfGeoJsonLayer(oGeoJsonLayer): int
Checks for the provided sap.ui.vbm.GeoJsonLayer in the aggregation geoJsonLayers. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.vbm.GeoJsonLayer}oGeoJsonLayer The geoJsonLayer whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
indexOfResource(oResource): int
Checks for the provided sap.ui.vbm.Resource in the aggregation resources. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.vbm.Resource}oResource The resource whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
indexOfVo(oVo): int
Checks for the provided sap.ui.vbm.VoAbstract in the aggregation vos. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.vbm.VoAbstract}oVo The vo whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertCluster(oCluster, iIndex): sap.ui.vbm.GeoMap
Inserts a cluster into the aggregation clusters.
Parameters:
{sap.ui.vbm.ClusterBase}oCluster the cluster to insert; if empty, nothing is inserted
{int}iIndex 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
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
insertGeoJsonLayer(oGeoJsonLayer, iIndex): sap.ui.vbm.GeoMap
Inserts a geoJsonLayer into the aggregation geoJsonLayers.
Parameters:
{sap.ui.vbm.GeoJsonLayer}oGeoJsonLayer the geoJsonLayer to insert; if empty, nothing is inserted
{int}iIndex 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
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
insertResource(oResource, iIndex): sap.ui.vbm.GeoMap
Inserts a resource into the aggregation resources.
Parameters:
{sap.ui.vbm.Resource}oResource the resource to insert; if empty, nothing is inserted
{int}iIndex 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
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
insertVo(oVo, iIndex): sap.ui.vbm.GeoMap
Inserts a vo into the aggregation vos.
Parameters:
{sap.ui.vbm.VoAbstract}oVo the vo to insert; if empty, nothing is inserted
{int}iIndex 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
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
openDetailWindow(sPosition, oParams?): void
Open Detail window
Parameters:
{string}sPosition Postion for the Detail Window in format "lon;lat;0"
{object}oParams? Parameter Objects
{string}oParams.caption? Caption of the Detail Window
removeAllClusters(): sap.ui.vbm.ClusterBase[]
Removes all the controls from the aggregation clusters.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.vbm.ClusterBase[]} An array of the removed elements (might be empty)
removeAllGeoJsonLayers(): sap.ui.vbm.GeoJsonLayer[]
Removes all the controls from the aggregation geoJsonLayers.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.vbm.GeoJsonLayer[]} An array of the removed elements (might be empty)
removeAllResources(): sap.ui.vbm.Resource[]
Removes all the controls from the aggregation resources.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.vbm.Resource[]} An array of the removed elements (might be empty)
removeAllVos(): sap.ui.vbm.VoAbstract[]
Removes all the controls from the aggregation vos.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.vbm.VoAbstract[]} An array of the removed elements (might be empty)
removeCluster(vCluster): sap.ui.vbm.ClusterBase
Removes a cluster from the aggregation clusters.
Parameters:
{int|string|sap.ui.vbm.ClusterBase}vCluster The clusterto remove or its index or id
Returns:
{sap.ui.vbm.ClusterBase} The removed cluster or null
removeGeoJsonLayer(vGeoJsonLayer): sap.ui.vbm.GeoJsonLayer
Removes a geoJsonLayer from the aggregation geoJsonLayers.
Parameters:
{int|string|sap.ui.vbm.GeoJsonLayer}vGeoJsonLayer The geoJsonLayerto remove or its index or id
Returns:
{sap.ui.vbm.GeoJsonLayer} The removed geoJsonLayer or null
removeResource(vResource): sap.ui.vbm.Resource
Removes a resource from the aggregation resources.
Parameters:
{int|string|sap.ui.vbm.Resource}vResource The resourceto remove or its index or id
Returns:
{sap.ui.vbm.Resource} The removed resource or null
removeVo(vVo): sap.ui.vbm.VoAbstract
Removes a vo from the aggregation vos.
Parameters:
{int|string|sap.ui.vbm.VoAbstract}vVo The voto remove or its index or id
Returns:
{sap.ui.vbm.VoAbstract} The removed vo or null
setCenterPosition(sCenterPosition): sap.ui.vbm.GeoMap
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.

Parameters:
{string}sCenterPosition New value for property centerPosition
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
setDisablePan(bDisablePan): sap.ui.vbm.GeoMap
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.

Parameters:
{boolean}bDisablePan New value for property disablePan
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
setDisableZoom(bDisableZoom): sap.ui.vbm.GeoMap
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.

Parameters:
{boolean}bDisableZoom New value for property disableZoom
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
setEnableAnimation(bEnableAnimation): sap.ui.vbm.GeoMap
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.

Parameters:
{boolean}bEnableAnimation New value for property enableAnimation
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
setInitialPosition(sInitialPosition): sap.ui.vbm.GeoMap
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.

Parameters:
{string}sInitialPosition New value for property initialPosition
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
setInitialZoom(sInitialZoom): sap.ui.vbm.GeoMap
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.

Parameters:
{string}sInitialZoom New value for property initialZoom
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
setLassoSelection(bSet): sap.ui.vbm.GeoMap
Set Tracking Mode for Lasso Selection on/off.
Parameters:
{boolean}bSet to start or stop tracking mode
Returns:
{sap.ui.vbm.GeoMap} This allows method chaining
setLegend(oLegend): sap.ui.vbm.GeoMap
Sets the aggregated legend.
Parameters:
{sap.ui.vbm.Legend}oLegend The legend to set
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
setLegendVisible(bLegendVisible): sap.ui.vbm.GeoMap
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.

Parameters:
{boolean}bLegendVisible New value for property legendVisible
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
setMapConfiguration(oMapConfiguration): sap.ui.vbm.GeoMap
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.
Parameters:
{object}oMapConfiguration Map Configuration object
{array}oMapConfiguration.MapProvider Array of Map Provider definitions.
{string}oMapConfiguration.MapProvider.name Name for the provider. Needed in Map Layer Stack as reference.
{string}oMapConfiguration.MapProvider.tileX X-pixel dimension of map tile. Typical 256.
{string}oMapConfiguration.MapProvider.tileY Y-pixel dimension of map tile. Typical 256.
{string}oMapConfiguration.MapProvider.minLOD Minimal supported Level Of Detail.
{string}oMapConfiguration.MapProvider.maxLOD Maximal supported Level Of Detail.
{string}oMapConfiguration.MapProvider.copyright Copyright Information to be shown with the map.
{array}oMapConfiguration.MapProvider.Source Array of source definitions. At least on Source has to be given. Multiple sources can be used for load distribution.
{string}oMapConfiguration.MapProvider.Source.id Source id.
{string}oMapConfiguration.MapProvider.Source.url Source URL for map tile service. URL includes place holders for variable informations set at runtime, e.g. {LOD}.
{array}oMapConfiguration.MapLayerStacks Array of Map Layer Stacks
{string}oMapConfiguration.MapLayerStacks.name Name of Map Layer Stack. Use with the GeoMap refMapLayerStack property.
{array}oMapConfiguration.MapLayerStacks.MapLayer Array of Map Layers. Each Layer refers to a Map Proveride. Map Layers get overlayed in the given sequence.
{string}oMapConfiguration.MapLayerStacks.MapLayer.name Name of Map Layer.
{string}oMapConfiguration.MapLayerStacks.MapLayer.refMapProvider Name of referenced Map Provider.
{string}oMapConfiguration.MapLayerStacks.MapLayer.opacity Opacity of Map Layer. Value range 0 to 1.
{sap.ui.core.CSSColor}oMapConfiguration.MapLayerStacks.MapLayer.colBkgnd Background color for Map Layer. Only meaningful if opacity is below 1.
Returns:
{sap.ui.vbm.GeoMap} This allows method chaining
setNavcontrolVisible(bNavcontrolVisible): sap.ui.vbm.GeoMap
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.

Parameters:
{boolean}bNavcontrolVisible New value for property navcontrolVisible
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
setRectangularSelection(bSet): sap.ui.vbm.GeoMap
Set Tracking Mode for Rectangular Selection on/off.
Parameters:
{boolean}bSet to start or stop tracking mode
Returns:
{sap.ui.vbm.GeoMap} This allows method chaining
setRectZoom(bSet): sap.ui.vbm.GeoMap
Set Tracking Mode for Rectangular Zoom on/off.
Parameters:
{boolean}bSet to start or stop tracking mode
Returns:
{sap.ui.vbm.GeoMap} This allows method chaining
setRefMapLayerStack(sRefMapLayerStack): sap.ui.vbm.GeoMap
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.

Parameters:
{string}sRefMapLayerStack New value for property refMapLayerStack
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
setScaleVisible(bScaleVisible): sap.ui.vbm.GeoMap
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.

Parameters:
{boolean}bScaleVisible New value for property scaleVisible
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
setVisualFrame(oVisFrame): sap.ui.vbm.GeoMap
Set Visual Frame definition.
Parameters:
{object}oVisFrame Visual Frame definition object
{float}oVisFrame.minLon Minimal longitude of visual frame
{float}oVisFrame.maxLon Maximal longitude of visual frame
{float}oVisFrame.minLat Minimal latitude of visual frame
{float}oVisFrame.maxLat Maximal latitude of visual frame
{float}oVisFrame.minLOD Minimal Level of Detail for visual frame
{float}oVisFrame.maxLOD Maximal Level of Detail for visual frame
{float}oVisFrame.maxFraction Maximal fraction [0..1] of minLOD which is acceptable, otherwise minLOD is rounded upwards
Returns:
{sap.ui.vbm.GeoMap} This allows method chaining
setZoomlevel(iZoomlevel): sap.ui.vbm.GeoMap
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.

Parameters:
{int}iZoomlevel New value for property zoomlevel
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
addFeatureCollection(oFeatureCollection): sap.ui.vbm.GeoMap
Adds some featureCollection to the aggregation featureCollections.
Parameters:
{sap.ui.vbm.FeatureCollection}oFeatureCollection the featureCollection to add; if empty, nothing is inserted
Deprecated:
This aggregation should not longer be used. Its functionality has been replaced by the more genericgeoJsonLayers aggregation.
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
destroyFeatureCollections(): sap.ui.vbm.GeoMap
Destroys all the featureCollections in the aggregation featureCollections.
Deprecated:
This aggregation should not longer be used. Its functionality has been replaced by the more genericgeoJsonLayers aggregation.
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
getClustering(): object
Gets current value of property clustering.
Deprecated:
This property should not longer be used. Its functionality has been replaced by the clusters aggregation.
Returns:
{object} Value of property clustering
getFeatureCollections(): sap.ui.vbm.FeatureCollection[]
Gets content of aggregation featureCollections.
Deprecated:
This aggregation should not longer be used. Its functionality has been replaced by the more genericgeoJsonLayers aggregation.
Returns:
{sap.ui.vbm.FeatureCollection[]}
indexOfFeatureCollection(oFeatureCollection): int
Checks for the provided sap.ui.vbm.FeatureCollection in the aggregation featureCollections. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.vbm.FeatureCollection}oFeatureCollection The featureCollection whose index is looked for
Deprecated:
This aggregation should not longer be used. Its functionality has been replaced by the more genericgeoJsonLayers aggregation.
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertFeatureCollection(oFeatureCollection, iIndex): sap.ui.vbm.GeoMap
Inserts a featureCollection into the aggregation featureCollections.
Parameters:
{sap.ui.vbm.FeatureCollection}oFeatureCollection the featureCollection to insert; if empty, nothing is inserted
{int}iIndex 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
Deprecated:
This aggregation should not longer be used. Its functionality has been replaced by the more genericgeoJsonLayers aggregation.
Returns:
{sap.ui.vbm.GeoMap} Reference to this in order to allow method chaining
removeAllFeatureCollections(): sap.ui.vbm.FeatureCollection[]
Removes all the controls from the aggregation featureCollections.

Additionally, it unregisters them from the hosting UIArea.

Deprecated:
This aggregation should not longer be used. Its functionality has been replaced by the more genericgeoJsonLayers aggregation.
Returns:
{sap.ui.vbm.FeatureCollection[]} An array of the removed elements (might be empty)
removeFeatureCollection(vFeatureCollection): sap.ui.vbm.FeatureCollection
Removes a featureCollection from the aggregation featureCollections.
Parameters:
{int|string|sap.ui.vbm.FeatureCollection}vFeatureCollection The featureCollectionto remove or its index or id
Deprecated:
This aggregation should not longer be used. Its functionality has been replaced by the more genericgeoJsonLayers aggregation.
Returns:
{sap.ui.vbm.FeatureCollection} The removed featureCollection or null
setClustering(oClustering): sap.ui.vbm.GeoMap
Set clustering definitions.
Parameters:
{object}oClustering Cluster Definition object
Deprecated:
This property should not longer be used. Its functionality has been replaced by the clusters aggregation.
Returns:
{sap.ui.vbm.GeoMap} This allows method chaining