Class sap.ui.vbm.VBIModule: sap/ui/vbm/VBI

extends Control
known direct subclasses: GeoMap

The VBI control. This is the Visual Business base control, which is mainly intended to communicate directly with the Visual Business Backend API in a proprietary JSON format. This control should not be used directly in a client side application. For this the control extension sap.ui.vbm.GeoMap is recommended.
The main or high level API of the VBI control is made of

  • method load for sending JSON to the control for processing, and
  • event submit returning a result JSON as parameter data containing actual event information and changed data.
Further the high level API provides the thumbnail support.
Additionally the control offers a low level API made of several events, like render, zoom, move and so on, which allow to render application specific content directly on the controls canvas.

Constructor Summary
new sap.ui.vbm.VBI(sId?, mSettings?)Constructor for a new VBI.
Event Summary
changeTrackingMode(oControlEvent)Low level API.
closeWindow(oControlEvent)The event is raised before a Visual Business window is closed.
containerCreated(oControlEvent)The event is raised when a Visual Business container VO instance is created.
containerDestroyed(oControlEvent)The event is raised before a Visual Business container VO instance is destroyed.
move(oControlEvent)Low level API.
openWindow(oControlEvent)The event is raised before a Visual Business window is opened.
render(oControlEvent)Low level API.
submit(oControlEvent)High level API.
thumbnailClick(oControlEvent)High level API.
zoom(oControlEvent)Low level API.
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.VBI.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vbm.VBI with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vbm.VBI.getMetadata()Returns a metadata object for class sap.ui.vbm.VBI.
addRenderItem(oControl, targetElemId)Add dependant child control for rendering.
attachChangeTrackingMode(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the changeTrackingMode event of this sap.ui.vbm.VBI.
attachCloseWindow(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the closeWindow event of this sap.ui.vbm.VBI.
attachContainerCreated(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the containerCreated event of this sap.ui.vbm.VBI.
attachContainerDestroyed(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the containerDestroyed event of this sap.ui.vbm.VBI.
attachMove(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the move event of this sap.ui.vbm.VBI.
attachOpenWindow(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the openWindow event of this sap.ui.vbm.VBI.
attachRender(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the render event of this sap.ui.vbm.VBI.
attachSubmit(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the submit event of this sap.ui.vbm.VBI.
attachThumbnailClick(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the thumbnailClick event of this sap.ui.vbm.VBI.
attachZoom(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the zoom event of this sap.ui.vbm.VBI.
detachChangeTrackingMode(fnFunction, oListener)Detaches event handler fnFunction from the changeTrackingMode event of this sap.ui.vbm.VBI.
detachCloseWindow(fnFunction, oListener)Detaches event handler fnFunction from the closeWindow event of this sap.ui.vbm.VBI.
detachContainerCreated(fnFunction, oListener)Detaches event handler fnFunction from the containerCreated event of this sap.ui.vbm.VBI.
detachContainerDestroyed(fnFunction, oListener)Detaches event handler fnFunction from the containerDestroyed event of this sap.ui.vbm.VBI.
detachMove(fnFunction, oListener)Detaches event handler fnFunction from the move event of this sap.ui.vbm.VBI.
detachOpenWindow(fnFunction, oListener)Detaches event handler fnFunction from the openWindow event of this sap.ui.vbm.VBI.
detachRender(fnFunction, oListener)Detaches event handler fnFunction from the render event of this sap.ui.vbm.VBI.
detachSubmit(fnFunction, oListener)Detaches event handler fnFunction from the submit event of this sap.ui.vbm.VBI.
detachThumbnailClick(fnFunction, oListener)Detaches event handler fnFunction from the thumbnailClick event of this sap.ui.vbm.VBI.
detachZoom(fnFunction, oListener)Detaches event handler fnFunction from the zoom event of this sap.ui.vbm.VBI.
fireChangeTrackingMode(mArguments?)Fires event changeTrackingMode to attached listeners.
fireCloseWindow(mArguments?)Fires event closeWindow to attached listeners.
fireContainerCreated(mArguments?)Fires event containerCreated to attached listeners.
fireContainerDestroyed(mArguments?)Fires event containerDestroyed to attached listeners.
fireMove(mArguments?)Fires event move to attached listeners.
fireOpenWindow(mArguments?)Fires event openWindow to attached listeners.
fireRender(mArguments?)Fires event render to attached listeners.
fireSubmit(mArguments?)Fires event submit to attached listeners.
fireThumbnailClick(mArguments?)Fires event thumbnailClick to attached listeners.
fireZoom(mArguments?)Fires event zoom to attached listeners.
getHeight()Gets current value of property height.
getInfoForCluster(sIdent, iType)Retrieve information on a specific cluster object .
getLassoSelection()Gets current value of property lassoSelection.
getPicOfOverlay(iMode?)Returns a Screenshot of the Overlay.
getPlugin()Gets current value of property plugin.
getRectangularSelection()Gets current value of property rectangularSelection.
getRectZoom()Gets current value of property rectZoom.
getWidth()Gets current value of property width.
load(dat)High level load function.
maximize(iFullWidth?, iFullHeight?)Maximize from Thumbnail.
minimize(iNewWidth, iNewHeight, iFullWidth?, iFullHeight?, font?, fontCol?, fontPos?, text?)Minimize to Thumbnail.
setHeight(sHeight)Sets a new value for property height.
setLassoSelection(bSet)Set Tracking Mode for Lasso Selection on/off.
setPlugin(bPlugin)Sets a new value for property plugin.
setRectangularSelection(bSet)Set Tracking Mode for Rectangular Selection on/off.
setRectZoom(bSet)Set Tracking Mode for Rectangular Zoom on/off.
setWidth(sWidth)Sets a new value for property width.
zoomToAreas(aAreaList, corr)Zoom to one or multiple Areas.
zoomToGeoPosition(fLon, fLat, iLod)Zoom to one or multiple geo positions.
getConfig()Gets current value of property config.
setConfig(oConfig)Sets a new value for property config.
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.VBI(sId?, mSettings?)
Constructor for a new VBI.

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
  • Events
    • submit : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • thumbnailClick : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • render : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • changeTrackingMode : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • zoom : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • move : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • openWindow : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • closeWindow : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • containerCreated : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • containerDestroyed : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.core.Control 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
changeTrackingMode(oControlEvent)
Low level API. Tracking mode is set or reset. This function is not supported in plugin mode.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{int}oControlEvent.getParameters.mode tracking mode to set or reset
{boolean}oControlEvent.getParameters.bSet set or reset the mode
closeWindow(oControlEvent)
The event is raised before a Visual Business window is closed. This function is not supported in plugin mode.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{object}oControlEvent.getParameters.contentarea DomRef of placeholder Div for content.
{string}oControlEvent.getParameters.id ID of the window that is closed.
containerCreated(oControlEvent)
The event is raised when a Visual Business container VO instance is created. It is intended to be used to place arbitrary content in e.g. other controls. This event is not supported in plugin mode.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{object}oControlEvent.getParameters.contentarea DomRef of placeholder Div to render into.
{string}oControlEvent.getParameters.id ID of the container that was created.
containerDestroyed(oControlEvent)
The event is raised before a Visual Business container VO instance is destroyed. This function is not supported in plugin mode.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{object}oControlEvent.getParameters.contentarea DomRef of placeholder Div of content.
{string}oControlEvent.getParameters.id ID of the container that is destroyed.
move(oControlEvent)
Low level API. The canvas was moved. This function is not supported in plugin mode.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{object}oControlEvent.getParameters.canvas Canvas object to render into.
openWindow(oControlEvent)
The event is raised before a Visual Business window is opened. It is intended to be used to place arbitrary content in e.g. a Detail Window. This event is not supported in plugin mode.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{object}oControlEvent.getParameters.contentarea DomRef of placeholder Div to render into.
{string}oControlEvent.getParameters.id ID of the window that is opened.
render(oControlEvent)
Low level API. Rendering of the canvas content is reqested. This event can be used to do custom rendering into the Visual Business overlay canvas. This function is not supported in plugin mode.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{object}oControlEvent.getParameters.canvas Canvas object to render into.
submit(oControlEvent)
High level API. Submit event is raised.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string}oControlEvent.getParameters.data JSON (or possibly XML and case the plugin is used) string describing the delta state of Visual Business and the information about the event.
thumbnailClick(oControlEvent)
High level API. ThumbnailClick event is raised.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string}oControlEvent.getParameters.pos Geo coordinates in format "lon;lat;0"
{int}oControlEvent.getParameters.zoomLevel Level of detail.
zoom(oControlEvent)
Low level API. The canvas is zoomed. This function is not supported in plugin mode.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{object}oControlEvent.getParameters.canvas Canvas object to render into
Method Detail
sap.ui.vbm.VBI.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.vbm.VBI 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.core.Control.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.VBI.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vbm.VBI.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addRenderItem(oControl, targetElemId)
Add dependant child control for rendering.
Parameters:
oControl Child control to render
targetElemId ID of DOM element the child to append to
attachChangeTrackingMode(oData?, fnFunction, oListener?): sap.ui.vbm.VBI
Attaches event handler fnFunction to the changeTrackingMode event of this sap.ui.vbm.VBI.

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.VBI itself.

Low level API. Tracking mode is set or reset. This function is not supported in plugin mode.

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.VBI itself
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
attachCloseWindow(oData?, fnFunction, oListener?): sap.ui.vbm.VBI
Attaches event handler fnFunction to the closeWindow event of this sap.ui.vbm.VBI.

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.VBI itself.

The event is raised before a Visual Business window is closed. This function is not supported in plugin mode.

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.VBI itself
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
attachContainerCreated(oData?, fnFunction, oListener?): sap.ui.vbm.VBI
Attaches event handler fnFunction to the containerCreated event of this sap.ui.vbm.VBI.

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.VBI itself.

The event is raised when a Visual Business container VO instance is created. It is intended to be used to place arbitrary content in e.g. other controls. This event is not supported in plugin mode.

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.VBI itself
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
attachContainerDestroyed(oData?, fnFunction, oListener?): sap.ui.vbm.VBI
Attaches event handler fnFunction to the containerDestroyed event of this sap.ui.vbm.VBI.

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.VBI itself.

The event is raised before a Visual Business container VO instance is destroyed. This function is not supported in plugin mode.

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.VBI itself
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
attachMove(oData?, fnFunction, oListener?): sap.ui.vbm.VBI
Attaches event handler fnFunction to the move event of this sap.ui.vbm.VBI.

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.VBI itself.

Low level API. The canvas was moved. This function is not supported in plugin mode.

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.VBI itself
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
attachOpenWindow(oData?, fnFunction, oListener?): sap.ui.vbm.VBI
Attaches event handler fnFunction to the openWindow event of this sap.ui.vbm.VBI.

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.VBI itself.

The event is raised before a Visual Business window is opened. It is intended to be used to place arbitrary content in e.g. a Detail Window. This event is not supported in plugin mode.

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.VBI itself
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
attachRender(oData?, fnFunction, oListener?): sap.ui.vbm.VBI
Attaches event handler fnFunction to the render event of this sap.ui.vbm.VBI.

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.VBI itself.

Low level API. Rendering of the canvas content is reqested. This event can be used to do custom rendering into the Visual Business overlay canvas. This function is not supported in plugin mode.

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.VBI itself
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
attachSubmit(oData?, fnFunction, oListener?): sap.ui.vbm.VBI
Attaches event handler fnFunction to the submit event of this sap.ui.vbm.VBI.

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.VBI itself.

High level API. Submit event is raised.

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.VBI itself
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
attachThumbnailClick(oData?, fnFunction, oListener?): sap.ui.vbm.VBI
Attaches event handler fnFunction to the thumbnailClick event of this sap.ui.vbm.VBI.

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.VBI itself.

High level API. ThumbnailClick event is raised.

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.VBI itself
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
attachZoom(oData?, fnFunction, oListener?): sap.ui.vbm.VBI
Attaches event handler fnFunction to the zoom event of this sap.ui.vbm.VBI.

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.VBI itself.

Low level API. The canvas is zoomed. This function is not supported in plugin mode.

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.VBI itself
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
detachChangeTrackingMode(fnFunction, oListener): sap.ui.vbm.VBI
Detaches event handler fnFunction from the changeTrackingMode event of this sap.ui.vbm.VBI.

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.VBI} Reference to this in order to allow method chaining
detachCloseWindow(fnFunction, oListener): sap.ui.vbm.VBI
Detaches event handler fnFunction from the closeWindow event of this sap.ui.vbm.VBI.

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.VBI} Reference to this in order to allow method chaining
detachContainerCreated(fnFunction, oListener): sap.ui.vbm.VBI
Detaches event handler fnFunction from the containerCreated event of this sap.ui.vbm.VBI.

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.VBI} Reference to this in order to allow method chaining
detachContainerDestroyed(fnFunction, oListener): sap.ui.vbm.VBI
Detaches event handler fnFunction from the containerDestroyed event of this sap.ui.vbm.VBI.

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.VBI} Reference to this in order to allow method chaining
detachMove(fnFunction, oListener): sap.ui.vbm.VBI
Detaches event handler fnFunction from the move event of this sap.ui.vbm.VBI.

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.VBI} Reference to this in order to allow method chaining
detachOpenWindow(fnFunction, oListener): sap.ui.vbm.VBI
Detaches event handler fnFunction from the openWindow event of this sap.ui.vbm.VBI.

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.VBI} Reference to this in order to allow method chaining
detachRender(fnFunction, oListener): sap.ui.vbm.VBI
Detaches event handler fnFunction from the render event of this sap.ui.vbm.VBI.

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.VBI} Reference to this in order to allow method chaining
detachSubmit(fnFunction, oListener): sap.ui.vbm.VBI
Detaches event handler fnFunction from the submit event of this sap.ui.vbm.VBI.

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.VBI} Reference to this in order to allow method chaining
detachThumbnailClick(fnFunction, oListener): sap.ui.vbm.VBI
Detaches event handler fnFunction from the thumbnailClick event of this sap.ui.vbm.VBI.

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.VBI} Reference to this in order to allow method chaining
detachZoom(fnFunction, oListener): sap.ui.vbm.VBI
Detaches event handler fnFunction from the zoom event of this sap.ui.vbm.VBI.

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.VBI} Reference to this in order to allow method chaining
fireChangeTrackingMode(mArguments?): sap.ui.vbm.VBI
Fires event changeTrackingMode to attached listeners.

Expects the following event parameters:

  • mode of type inttracking mode to set or reset
  • bSet of type booleanset or reset the mode
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
fireCloseWindow(mArguments?): sap.ui.vbm.VBI
Fires event closeWindow to attached listeners.

Expects the following event parameters:

  • contentarea of type objectDomRef of placeholder Div for content.
  • id of type stringID of the window that is closed.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
fireContainerCreated(mArguments?): sap.ui.vbm.VBI
Fires event containerCreated to attached listeners.

Expects the following event parameters:

  • contentarea of type objectDomRef of placeholder Div to render into.
  • id of type stringID of the container that was created.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
fireContainerDestroyed(mArguments?): sap.ui.vbm.VBI
Fires event containerDestroyed to attached listeners.

Expects the following event parameters:

  • contentarea of type objectDomRef of placeholder Div of content.
  • id of type stringID of the container that is destroyed.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
fireMove(mArguments?): sap.ui.vbm.VBI
Fires event move to attached listeners.

Expects the following event parameters:

  • canvas of type objectCanvas object to render into.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
fireOpenWindow(mArguments?): sap.ui.vbm.VBI
Fires event openWindow to attached listeners.

Expects the following event parameters:

  • contentarea of type objectDomRef of placeholder Div to render into.
  • id of type stringID of the window that is opened.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
fireRender(mArguments?): sap.ui.vbm.VBI
Fires event render to attached listeners.

Expects the following event parameters:

  • canvas of type objectCanvas object to render into.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
fireSubmit(mArguments?): sap.ui.vbm.VBI
Fires event submit to attached listeners.

Expects the following event parameters:

  • data of type stringJSON (or possibly XML and case the plugin is used) string describing the delta state of Visual Business and the information about the event.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
fireThumbnailClick(mArguments?): sap.ui.vbm.VBI
Fires event thumbnailClick to attached listeners.

Expects the following event parameters:

  • pos of type stringGeo coordinates in format "lon;lat;0"
  • zoomLevel of type intLevel of detail.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
fireZoom(mArguments?): sap.ui.vbm.VBI
Fires event zoom to attached listeners.

Expects the following event parameters:

  • canvas of type objectCanvas object to render into
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
getHeight(): sap.ui.core.CSSSize
Gets current value of property height.

Set the height of the control.

Default value is 600px.

Returns:
{sap.ui.core.CSSSize} Value of property height
getInfoForCluster(sIdent, iType): oClusterInfo
Retrieve information on a specific cluster object . Type : 0 : contained VOs 1 : child clusters (tree clustering only) 2 : parent Node (tree clustering only) 10 : Information on Node 11 : Edges of the Voronoi Area (tree clustering only, not merged with rectangle)
Parameters:
{string}sIdent Cluster Id
{sap.ui.vbm.ClusterInfoType}iType Type of information which should be returned
Returns:
{oClusterInfo} Cluster Info Object with requested info according to given Cluster Info Type
getLassoSelection(): boolean
Gets current value of property lassoSelection.

Defines whether the lasso selection mode is active or not

Default value is false.

Returns:
{boolean} Value of property lassoSelection
getPicOfOverlay(iMode?): string
Returns a Screenshot of the Overlay. Please note that the map cannot be included due to browser restrictions. Function returns the visible part of the Canvas excluding map, copyright info, navigation control, scaler, legend, detail windows, container elements. Analytic Maps are returned as they are not treated as "maps" internally. Modes 2 & 3 are experimental, trying to load the map (this may work on inhouse servers with adapted settings, standard configurations should fail)
Parameters:
{int}iMode? 0: Overlay only; 1 (default) and 3: include Labels; 2 and 3: try to include maps (will return "" if not possible)
Returns:
{string} Base64 encoded picture (PNG format) on success, "" otherwise
getPlugin(): boolean
Gets current value of property plugin.

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.

Default value is false.

Returns:
{boolean} Value of property plugin
getRectangularSelection(): boolean
Gets current value of property rectangularSelection.

Defines whether the rectangular selection mode is active or not

Default value is false.

Returns:
{boolean} Value of property rectangularSelection
getRectZoom(): boolean
Gets current value of property rectZoom.

Defines whether the rectangular zoom mode is active or not

Default value is false.

Returns:
{boolean} Value of property rectZoom
getWidth(): sap.ui.core.CSSSize
Gets current value of property width.

Set the width of the control.

Default value is 800px.

Returns:
{sap.ui.core.CSSSize} Value of property width
load(dat): void
High level load function. The function accepts a json string or an already parsed json object. This can be a Visual Business application, any delta operations on the application or other hierachical data that can be mapped by the Visual Business data provider to the inner Visual Business data context.
Parameters:
{string}dat Application JSON to process
maximize(iFullWidth?, iFullHeight?): void
Maximize from Thumbnail.
Parameters:
{int}iFullWidth? Width of the underlying VBI control. If ommitted current width is taken
{int}iFullHeight? Height of the underlying control. If ommitted current width is taken
minimize(iNewWidth, iNewHeight, iFullWidth?, iFullHeight?, font?, fontCol?, fontPos?, text?): void
Minimize to Thumbnail.
Parameters:
{int}iNewWidth Width of the thumbnail
{int}iNewHeight Height of the thumbnail
{int}iFullWidth? Width of the underlying VBI control. If ommitted or zero, current width is taken
{int}iFullHeight? Height of the underlying control. If ommitted or zero, current width is taken
{string}font? Font to be used for text added to the thumbnail
{string}fontCol? Color for the thumbnailtext
{int}fontPos? Position (0 - 8) of the text within the thumbnail
{string}text? text to be shown
setHeight(sHeight): sap.ui.vbm.VBI
Sets a new value for property height.

Set the height of the control.

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

Default value is 600px.

Parameters:
{sap.ui.core.CSSSize}sHeight New value for property height
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
setLassoSelection(bSet): sap.ui.vbm.VBI
Set Tracking Mode for Lasso Selection on/off.
Parameters:
{boolean}bSet to start or stop tracking mode
Returns:
{sap.ui.vbm.VBI} This allows method chaining
setPlugin(bPlugin): sap.ui.vbm.VBI
Sets a new value for property plugin.

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.

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

Default value is false.

Parameters:
{boolean}bPlugin New value for property plugin
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
setRectangularSelection(bSet): sap.ui.vbm.VBI
Set Tracking Mode for Rectangular Selection on/off.
Parameters:
{boolean}bSet to start or stop tracking mode
Returns:
{sap.ui.vbm.VBI} This allows method chaining
setRectZoom(bSet): sap.ui.vbm.VBI
Set Tracking Mode for Rectangular Zoom on/off.
Parameters:
{boolean}bSet to start or stop tracking mode
Returns:
{sap.ui.vbm.VBI} This allows method chaining
setWidth(sWidth): sap.ui.vbm.VBI
Sets a new value for property width.

Set the width of the control.

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

Default value is 800px.

Parameters:
{sap.ui.core.CSSSize}sWidth New value for property width
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining
zoomToAreas(aAreaList, corr): void
Zoom to one or multiple Areas. This function works only for the main geo scene in the Visual Business control.
Parameters:
{array}aAreaList List of Area Ids to zoom to.
{float}corr . This correction factor deals with the space which is reserved to the div borders. The Correction factor can be expressed either in a fracture (e.g. 0.9, this means 10% space to the borders) or array of pixel values (order left, top, right, bottom) for the added margin of the calculated zoom area, e.g. [450,150,0,0] which keeps a left border of 450 pixels and a top border of 150 pixels.
zoomToGeoPosition(fLon, fLat, iLod): void
Zoom to one or multiple geo positions. This function works only for the main geo scene in the Visual Business control.
Parameters:
{float}fLon Longitude in degrees. This can also be an array of longitude values.
{float}fLat Latitude in degrees. This can also be an array of latitude values.
{int}iLod Level of detail, usually between 0 and 20. This will be limited by the map provider capabilities.
getConfig(): object
Gets current value of property config.
Deprecated:
This property should not longer be used. Its functionality is covered by method load.
Returns:
{object} Value of property config
setConfig(oConfig): sap.ui.vbm.VBI
Sets a new value for property config.

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

Parameters:
{object}oConfig New value for property config
Deprecated:
This property should not longer be used. Its functionality is covered by method load.
Returns:
{sap.ui.vbm.VBI} Reference to this in order to allow method chaining