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
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#constructor for a general description of the syntax of the settings object.
new sap.ui.vbm.VBI(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | id for the new control, generated automatically if no id is given |
|
mSettings? | object | initial settings for the new control |
Name | Type | Default Value | Description |
---|---|---|---|
allowKeyEventRepeat | boolean | true | Allow repeating of keyboard events when key is pressed and hold. Visibility: public |
ariaLabel | string | Text to be read out for the Control when used in accessibility mode (Screen reader) Visibility: public |
|
config | object | Visibility: public | |
enableOverlappingTest | boolean | true | Enable Test for Overlapped Objects for selection and context menu Visibility: public |
height | sap.ui.core.CSSSize | 600px | Set the height of the control. Visibility: public |
keyEventDelay | int | 250 | Miminum delay between keyboard events. Used to reduce frequency of keyboard events. Visibility: public |
lassoSelection | boolean | false | Defines whether the lasso selection mode is active or not Visibility: public |
plugin | boolean | false | When true, the ActiveX plugin version of Visual Business will be used for rendering. For that the plugin needs to be installed on the client. Default (false) the control renders on canvas. Visibility: public |
rectZoom | boolean | false | Defines whether the rectangular zoom mode is active or not Visibility: public |
rectangularSelection | boolean | false | Defines whether the rectangular selection mode is active or not Visibility: public |
width | sap.ui.core.CSSSize | 800px | Set the width of the control. Visibility: public |
Name | Cardinality | Type | Description |
---|---|---|---|
ariaDescribedBy | 0..n | sap.ui.core.Control |
Association to controls / ids which describe this control (see WAI-ARIA attribute aria-describedby). |
ariaLabelledBy | 0..n | sap.ui.core.Control |
Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledBy). |
Event | Description |
---|---|
changeTrackingMode |
Low level API. Tracking mode is set or reset. This function is not supported in plugin mode. |
closeWindow |
The event is raised before a Visual Business window is closed. This function is not supported in plugin mode. |
containerCreated |
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. |
containerDestroyed |
The event is raised before a Visual Business container VO instance is destroyed. This function is not supported in plugin mode. |
move |
Low level API. The canvas was moved. This function is not supported in plugin mode. |
openWindow |
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. |
render |
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. |
submit |
High level API. Submit event is raised. |
thumbnailClick |
High level API. ThumbnailClick event is raised. |
zoom |
Low level API. The canvas is zoomed. This function is not supported in plugin mode. |
Low level API. Tracking mode is set or reset. This function is not supported in plugin mode.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
mode | int |
tracking mode to set or reset |
bSet | boolean |
set or reset the mode |
The event is raised before a Visual Business window is closed. This function is not supported in plugin mode.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
contentarea | object |
DomRef of placeholder Div for content. |
id | string |
ID of the window that is closed. |
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.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
contentarea | object |
DomRef of placeholder Div to render into. |
id | string |
ID of the container that was created. |
The event is raised before a Visual Business container VO instance is destroyed. This function is not supported in plugin mode.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
contentarea | object |
DomRef of placeholder Div of content. |
id | string |
ID of the container that is destroyed. |
Low level API. The canvas was moved. This function is not supported in plugin mode.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
canvas | object |
Canvas object to render into. |
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.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
contentarea | object |
DomRef of placeholder Div to render into. |
id | string |
ID of the window that is opened. |
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.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
canvas | object |
Canvas object to render into. |
High level API. Submit event is raised.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
data | string |
JSON (or possibly XML and case the plugin is used) string describing the delta state of Visual Business and the information about the event. |
Method | Description |
---|---|
addAriaDescribedBy |
Adds some ariaDescribedBy into the association ariaDescribedBy. |
addAriaLabelledBy |
Adds some ariaLabelledBy into the association ariaLabelledBy. |
addRenderItem |
Add dependant child control for rendering. |
attachChangeTrackingMode |
Attaches event handler When called, the context of the event handler (its Low level API. Tracking mode is set or reset. This function is not supported in plugin mode. |
attachCloseWindow |
Attaches event handler When called, the context of the event handler (its The event is raised before a Visual Business window is closed. This function is not supported in plugin mode. |
attachContainerCreated |
Attaches event handler When called, the context of the event handler (its 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. |
attachContainerDestroyed |
Attaches event handler When called, the context of the event handler (its The event is raised before a Visual Business container VO instance is destroyed. This function is not supported in plugin mode. |
attachMove |
Attaches event handler When called, the context of the event handler (its Low level API. The canvas was moved. This function is not supported in plugin mode. |
attachOpenWindow |
Attaches event handler When called, the context of the event handler (its 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. |
attachRender |
Attaches event handler When called, the context of the event handler (its 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. |
attachSubmit |
Attaches event handler When called, the context of the event handler (its High level API. Submit event is raised. |
attachThumbnailClick |
Attaches event handler When called, the context of the event handler (its High level API. ThumbnailClick event is raised. |
attachZoom |
Attaches event handler When called, the context of the event handler (its Low level API. The canvas is zoomed. This function is not supported in plugin mode. |
detachChangeTrackingMode |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachCloseWindow |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachContainerCreated |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachContainerDestroyed |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachMove |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachOpenWindow |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachRender |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachSubmit |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachThumbnailClick |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachZoom |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.ui.vbm.VBI.extend |
Creates a new subclass of class sap.ui.vbm.VBI with name
|
fireChangeTrackingMode |
Fires event changeTrackingMode to attached listeners. |
fireCloseWindow |
Fires event closeWindow to attached listeners. |
fireContainerCreated |
Fires event containerCreated to attached listeners. |
fireContainerDestroyed |
Fires event containerDestroyed to attached listeners. |
fireMove |
Fires event move to attached listeners. |
fireOpenWindow |
Fires event openWindow to attached listeners. |
fireRender |
Fires event render to attached listeners. |
fireSubmit |
Fires event submit to attached listeners. |
fireThumbnailClick |
Fires event thumbnailClick to attached listeners. |
fireZoom |
Fires event zoom to attached listeners. |
getAllowKeyEventRepeat |
Gets current value of property allowKeyEventRepeat. Allow repeating of keyboard events when key is pressed and hold. Default value is |
getAriaDescribedBy |
Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy. |
getAriaLabel |
Gets current value of property ariaLabel. Text to be read out for the Control when used in accessibility mode (Screen reader) |
getAriaLabelledBy |
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy. |
getConfig |
Gets current value of property config.
Since This property should not longer be used. Its functionality is covered by method <code>load</code>.
|
getEnableOverlappingTest |
Gets current value of property enableOverlappingTest. Enable Test for Overlapped Objects for selection and context menu Default value is |
getHeight |
Gets current value of property height. Set the height of the control. Default value is |
getInfoForCluster |
Retrieve information on a specific cluster object. Type :
|
getKeyEventDelay |
Gets current value of property keyEventDelay. Miminum delay between keyboard events. Used to reduce frequency of keyboard events. Default value is |
getLassoSelection |
Gets current value of property lassoSelection. Defines whether the lasso selection mode is active or not Default value is |
sap.ui.vbm.VBI.getMetadata |
Returns a metadata object for class sap.ui.vbm.VBI. |
getPicOfOverlay |
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) |
getPlugin |
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 |
getRectangularSelection |
Gets current value of property rectangularSelection. Defines whether the rectangular selection mode is active or not Default value is |
getRectZoom |
Gets current value of property rectZoom. Defines whether the rectangular zoom mode is active or not Default value is |
getWidth |
Gets current value of property width. Set the width of the control. Default value is |
load |
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. |
maximize |
Maximize from Thumbnail. |
minimize |
Minimize to Thumbnail. |
removeAllAriaDescribedBy |
Removes all the controls in the association named ariaDescribedBy. |
removeAllAriaLabelledBy |
Removes all the controls in the association named ariaLabelledBy. |
removeAriaDescribedBy |
Removes an ariaDescribedBy from the association named ariaDescribedBy. |
removeAriaLabelledBy |
Removes an ariaLabelledBy from the association named ariaLabelledBy. |
setAllowKeyEventRepeat |
Sets a new value for property allowKeyEventRepeat. Allow repeating of keyboard events when key is pressed and hold. When called with a value of Default value is |
setAriaLabel |
Sets a new value for property ariaLabel. Text to be read out for the Control when used in accessibility mode (Screen reader) When called with a value of |
setConfig |
Sets a new value for property config. When called with a value of
Since This property should not longer be used. Its functionality is covered by method <code>load</code>.
|
setEnableOverlappingTest |
Sets a new value for property enableOverlappingTest. Enable Test for Overlapped Objects for selection and context menu When called with a value of Default value is |
setHeight |
Sets a new value for property height. Set the height of the control. When called with a value of Default value is |
setKeyEventDelay |
Sets a new value for property keyEventDelay. Miminum delay between keyboard events. Used to reduce frequency of keyboard events. When called with a value of Default value is |
setLassoSelection |
Set Tracking Mode for Lasso Selection on/off. |
setPlugin |
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 Default value is |
setRectangularSelection |
Set Tracking Mode for Rectangular Selection on/off. |
setRectZoom |
Set Tracking Mode for Rectangular Zoom on/off. |
setWidth |
Sets a new value for property width. Set the width of the control. When called with a value of Default value is |
zoomToAreas |
Zoom to one or multiple Areas. This function works only for the main geo scene in the Visual Business control. |
zoomToGeoPosition |
Zoom to one or multiple geo positions. This function works only for the main geo scene in the Visual Business control. |
Adds some ariaDescribedBy into the association ariaDescribedBy.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAriaDescribedBy | sap.ui.core.ID sap.ui.core.Control |
The ariaDescribedBy to add; if empty, nothing is inserted |
Adds some ariaLabelledBy into the association ariaLabelledBy.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAriaLabelledBy | sap.ui.core.ID sap.ui.core.Control |
The ariaLabelledBy to add; if empty, nothing is inserted |
Add dependant child control for rendering.
Param | Type | DefaultValue | Description |
---|---|---|---|
oControl | object |
Child control to render |
|
targetElemId | string |
ID of DOM element the child to append to |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Fires event changeTrackingMode to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
mode | int |
tracking mode to set or reset |
|
bSet | boolean |
set or reset the mode |
Fires event closeWindow to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
contentarea | object |
DomRef of placeholder Div for content. |
|
id | string |
ID of the window that is closed. |
Fires event containerCreated to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
contentarea | object |
DomRef of placeholder Div to render into. |
|
id | string |
ID of the container that was created. |
Fires event containerDestroyed to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
contentarea | object |
DomRef of placeholder Div of content. |
|
id | string |
ID of the container that is destroyed. |
Fires event move to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
canvas | object |
Canvas object to render into. |
Fires event openWindow to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
contentarea | object |
DomRef of placeholder Div to render into. |
|
id | string |
ID of the window that is opened. |
Fires event render to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
canvas | object |
Canvas object to render into. |
Fires event submit to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
data | string |
JSON (or possibly XML and case the plugin is used) string describing the delta state of Visual Business and the information about the event. |
Fires event thumbnailClick to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
pos | string |
Geo coordinates in format "lon;lat;0" |
|
zoomLevel | int |
Level of detail. |
Fires event zoom to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
canvas | object |
Canvas object to render into |
Gets current value of property allowKeyEventRepeat.
Allow repeating of keyboard events when key is pressed and hold.
Default value is true
.
Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy.
Gets current value of property ariaLabel.
Text to be read out for the Control when used in accessibility mode (Screen reader)
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
Gets current value of property config.
Gets current value of property enableOverlappingTest.
Enable Test for Overlapped Objects for selection and context menu
Default value is true
.
Gets current value of property height.
Set the height of the control.
Default value is '600px'
.
Retrieve information on a specific cluster object.
Type :
Param | Type | DefaultValue | Description |
---|---|---|---|
sIdent | string |
Cluster Id |
|
iType | sap.ui.vbm.ClusterInfoType |
Type of information which should be returned |
Gets current value of property keyEventDelay.
Miminum delay between keyboard events. Used to reduce frequency of keyboard events.
Default value is 250
.
Gets current value of property lassoSelection.
Defines whether the lasso selection mode is active or not
Default value is false
.
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)
Param | Type | DefaultValue | Description |
---|---|---|---|
iMode | int |
0: Overlay only; 1 (default) and 3: include Labels; 2 and 3: try to include maps (will return "" if not possible) |
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
.
Gets current value of property rectangularSelection.
Defines whether the rectangular selection mode is active or not
Default value is false
.
Gets current value of property rectZoom.
Defines whether the rectangular zoom mode is active or not
Default value is false
.
Gets current value of property width.
Set the width of the control.
Default value is '800px'
.
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
dat | string |
Application JSON to process |
Maximize from Thumbnail.
Param | Type | DefaultValue | Description |
---|---|---|---|
iFullWidth | int |
Width of the underlying VBI control. If ommitted current width is taken |
|
iFullHeight | int |
Height of the underlying control. If ommitted current width is taken |
Minimize to Thumbnail.
Param | Type | DefaultValue | Description |
---|---|---|---|
iNewWidth | int |
Width of the thumbnail |
|
iNewHeight | int |
Height of the thumbnail |
|
iFullWidth | int |
Width of the underlying VBI control. If ommitted or zero, current width is taken |
|
iFullHeight | int |
Height of the underlying control. If ommitted or zero, current width is taken |
|
font | string |
Font to be used for text added to the thumbnail |
|
fontCol | string |
Color for the thumbnailtext |
|
fontPos | int |
Position (0 - 8) of the text within the thumbnail |
|
text | string |
text to be shown |
Removes an ariaDescribedBy from the association named ariaDescribedBy.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAriaDescribedBy | int sap.ui.core.ID sap.ui.core.Control |
The ariaDescribedBy to be removed or its index or ID |
Removes an ariaLabelledBy from the association named ariaLabelledBy.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAriaLabelledBy | int sap.ui.core.ID sap.ui.core.Control |
The ariaLabelledBy to be removed or its index or ID |
Sets a new value for property allowKeyEventRepeat.
Allow repeating of keyboard events when key is pressed and hold.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bAllowKeyEventRepeat | boolean | true |
New value for property |
Sets a new value for property ariaLabel.
Text to be read out for the Control when used in accessibility mode (Screen reader)
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sAriaLabel | string |
New value for property |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
oConfig | object |
New value for property |
Sets a new value for property enableOverlappingTest.
Enable Test for Overlapped Objects for selection and context menu
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bEnableOverlappingTest | boolean | true |
New value for property |
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'
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sHeight | sap.ui.core.CSSSize | '600px' |
New value for property |
Sets a new value for property keyEventDelay.
Miminum delay between keyboard events. Used to reduce frequency of keyboard events.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 250
.
Param | Type | DefaultValue | Description |
---|---|---|---|
iKeyEventDelay | int | 250 |
New value for property |
Set Tracking Mode for Lasso Selection on/off.
Param | Type | DefaultValue | Description |
---|---|---|---|
bSet | boolean |
to start or stop tracking mode |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bPlugin | boolean | false |
New value for property |
Set Tracking Mode for Rectangular Selection on/off.
Param | Type | DefaultValue | Description |
---|---|---|---|
bSet | boolean |
to start or stop tracking mode |
Set Tracking Mode for Rectangular Zoom on/off.
Param | Type | DefaultValue | Description |
---|---|---|---|
bSet | boolean |
to start or stop tracking mode |
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'
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sWidth | sap.ui.core.CSSSize | '800px' |
New value for property |
Zoom to one or multiple Areas. This function works only for the main geo scene in the Visual Business control.
Param | Type | DefaultValue | Description |
---|---|---|---|
aAreaList | array |
List of Area Ids to zoom to. |
|
corr | float |
. 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. |
Zoom to one or multiple geo positions. This function works only for the main geo scene in the Visual Business control.
Param | Type | DefaultValue | Description |
---|---|---|---|
fLon | float |
Longitude in degrees. This can also be an array of longitude values. |
|
fLat | float |
Latitude in degrees. This can also be an array of latitude values. |
|
iLod | int |
Level of detail, usually between 0 and 20. This will be limited by the map provider capabilities. |