VoBase

known direct subclasses: Area, Box, Circle, Container, GeoCircle, HeatPoint, Pie, Route, Spot

Abstract aggregation element for VO aggregations. This element implements the common part for all specific VO elements. It must not be used directly, but is the base for further extension.
As a common feature it provides the Label, which may be attached to any visual object. There are two modes for using labels:

A controlled mode by providing a label type. In this mode most parameters for the label are automatically set by programmed defaults according to the Fiori guidelines.
A freestyle mode, providing the full control on colors and layout.

Further all visual objects have common edit capabilities and it is possible to drop content on visual objects.

Constructor Summary

new sap.ui.vbm.VoBase(sId?, mSettings?)Constructor for a new VoBase.

Event Summary

click(oControlEvent)The event is raised when there is a click action on a visual object.

contextMenu(oControlEvent)The event is raised when there is a right click or a tap and hold action on a visual object.

drop(oControlEvent)The event is raised when something is dropped on the object.

handleClick(oControlEvent)This event is raised when the design handle is clicked.

handleContextMenu(oControlEvent)This event is raised when the design handle is right clicked.

handleMoved(oControlEvent)This event is raised when the design handle is moved.

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

sap.ui.vbm.VoBase.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vbm.VoBase with name sClassName and enriches it with the information contained in oClassInfo.

sap.ui.vbm.VoBase.getMetadata()Returns a metadata object for class sap.ui.vbm.VoBase.

attachClick(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the click event of this sap.ui.vbm.VoBase.

attachContextMenu(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the contextMenu event of this sap.ui.vbm.VoBase.

attachDrop(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the drop event of this sap.ui.vbm.VoBase.

attachHandleClick(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the handleClick event of this sap.ui.vbm.VoBase.

attachHandleContextMenu(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the handleContextMenu event of this sap.ui.vbm.VoBase.

attachHandleMoved(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the handleMoved event of this sap.ui.vbm.VoBase.

detachClick(fnFunction, oListener)Detaches event handler fnFunction from the click event of this sap.ui.vbm.VoBase.

detachContextMenu(fnFunction, oListener)Detaches event handler fnFunction from the contextMenu event of this sap.ui.vbm.VoBase.

detachDrop(fnFunction, oListener)Detaches event handler fnFunction from the drop event of this sap.ui.vbm.VoBase.

detachHandleClick(fnFunction, oListener)Detaches event handler fnFunction from the handleClick event of this sap.ui.vbm.VoBase.

detachHandleContextMenu(fnFunction, oListener)Detaches event handler fnFunction from the handleContextMenu event of this sap.ui.vbm.VoBase.

detachHandleMoved(fnFunction, oListener)Detaches event handler fnFunction from the handleMoved event of this sap.ui.vbm.VoBase.

fireClick(mArguments?)Fires event click to attached listeners.

fireContextMenu(mArguments?)Fires event contextMenu to attached listeners.

fireDrop(mArguments?)Fires event drop to attached listeners.

fireHandleClick(mArguments?)Fires event handleClick to attached listeners.

fireHandleContextMenu(mArguments?)Fires event handleContextMenu to attached listeners.

fireHandleMoved(mArguments?)Fires event handleMoved to attached listeners.

getChangeable()Gets current value of property changeable.

getDragData()Gets current value of property dragData.

getEntity()Gets current value of property entity.

getFxdir()Gets current value of property fxdir.

getFxsize()Gets current value of property fxsize.

getHotDeltaColor()Gets current value of property hotDeltaColor.

getHotScale()Gets current value of property hotScale.

getKey()Gets current value of property key.

getLabelArrow()Gets current value of property labelArrow.

getLabelBgColor()Gets current value of property labelBgColor.

getLabelBorderColor()Gets current value of property labelBorderColor.

getLabelPos()Gets current value of property labelPos.

getLabelText()Gets current value of property labelText.

getLabelType()Gets current value of property labelType.

getSelect()Gets current value of property select.

getSelectColor()Gets current value of property selectColor.

openContextMenu(oMenu)Open the context menu.

openDetailWindow(sCaption, sOffsetX, sOffsetY)Open a Detail Window for the visual object at click position.

setChangeable(bChangeable)Sets a new value for property changeable.

setDragData(sDragData)Sets a new value for property dragData.

setEntity(sEntity)Sets a new value for property entity.

setFxdir(sFxdir)Sets a new value for property fxdir.

setFxsize(sFxsize)Sets a new value for property fxsize.

setHotDeltaColor(sHotDeltaColor)Sets a new value for property hotDeltaColor.

setHotScale(sHotScale)Sets a new value for property hotScale.

setKey(sKey)Sets a new value for property key.

setLabelArrow(bLabelArrow)Sets a new value for property labelArrow.

setLabelBgColor(sLabelBgColor)Sets a new value for property labelBgColor.

setLabelBorderColor(sLabelBorderColor)Sets a new value for property labelBorderColor.

setLabelPos(sLabelPos)Sets a new value for property labelPos.

setLabelText(sLabelText)Sets a new value for property labelText.

setLabelType(sLabelType)Sets a new value for property labelType.

setSelect(bSelect)Sets a new value for property select.

setSelectColor(sSelectColor)Sets a new value for property selectColor.

Methods borrowed from class sap.ui.core.Element

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, invalidate, 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.VoBase(sId?, mSettings?)

Constructor for a new VoBase.

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
- key : string
- hotScale : string (default: 1.0;1.0;1.0)
- hotDeltaColor : string (default: RHLSA(0;1.3;1.0;1.0))
- selectColor : string (default: RHLSA(0.0;1.0;1.0;1.0))
- fxsize : string (default: true)
- fxdir : string (default: true)
- entity : string
- labelText : string
- labelType : sap.ui.vbm.SemanticType (default: None)
- labelBgColor : string (default: RGB(255;255;255))
- labelBorderColor : string
- labelArrow : boolean (default: false)
- labelPos : string
- changeable : boolean (default: false)
- dragData : string
- select : boolean (default: false)
Events
- click : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- contextMenu : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- handleMoved : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- handleContextMenu : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- handleClick : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- drop : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.core.Element 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

click(oControlEvent)

The event is raised when there is a click action on a visual object.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

contextMenu(oControlEvent)

The event is raised when there is a right click or a tap and hold action on a visual object.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters
{sap.ui.unified.Menu}	oControlEvent.getParameters.menu	Menu to open

drop(oControlEvent)

The event is raised when something is dropped on the object.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters
{sap.ui.vbm.VoBase}	oControlEvent.getParameters.dragSource	Dragged instance

handleClick(oControlEvent)

This event is raised when the design handle is clicked.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters
{int}	oControlEvent.getParameters.handle	The number of the handle where the click occured. Handles are numbered zero based.

handleContextMenu(oControlEvent)

This event is raised when the design handle is right clicked.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters
{int}	oControlEvent.getParameters.handle	The number of the handle where the click occured. Handles are numbered zero based.
{sap.ui.unified.Menu}	oControlEvent.getParameters.menu	Menu to open

handleMoved(oControlEvent)

This event is raised when the design handle is moved.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters
{int}	oControlEvent.getParameters.handle	The number of the handle where the click occured. Handles are numbered zero based.

Method Detail

sap.ui.vbm.VoBase.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.vbm.VoBase 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.Element.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.VoBase.getMetadata(): sap.ui.base.Metadata

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

attachClick(oData?, fnFunction, oListener?): sap.ui.vbm.VoBase

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

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

The event is raised when there is a click action on a visual object.

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.VoBase` itself

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

attachContextMenu(oData?, fnFunction, oListener?): sap.ui.vbm.VoBase

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

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

The event is raised when there is a right click or a tap and hold action on a visual object.

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.VoBase` itself

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

attachDrop(oData?, fnFunction, oListener?): sap.ui.vbm.VoBase

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

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

The event is raised when something is dropped on the object.

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.VoBase` itself

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

attachHandleClick(oData?, fnFunction, oListener?): sap.ui.vbm.VoBase

Attaches event handler fnFunction to the handleClick event of this sap.ui.vbm.VoBase.

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

This event is raised when the design handle 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.VoBase` itself

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

attachHandleContextMenu(oData?, fnFunction, oListener?): sap.ui.vbm.VoBase

Attaches event handler fnFunction to the handleContextMenu event of this sap.ui.vbm.VoBase.

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

This event is raised when the design handle is right 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.VoBase` itself

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

attachHandleMoved(oData?, fnFunction, oListener?): sap.ui.vbm.VoBase

Attaches event handler fnFunction to the handleMoved event of this sap.ui.vbm.VoBase.

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

This event is raised when the design handle is moved.

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.VoBase` itself

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

detachClick(fnFunction, oListener): sap.ui.vbm.VoBase

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

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.VoBase} Reference to this in order to allow method chaining

detachContextMenu(fnFunction, oListener): sap.ui.vbm.VoBase

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

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.VoBase} Reference to this in order to allow method chaining

detachDrop(fnFunction, oListener): sap.ui.vbm.VoBase

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

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.VoBase} Reference to this in order to allow method chaining

detachHandleClick(fnFunction, oListener): sap.ui.vbm.VoBase

Detaches event handler fnFunction from the handleClick event of this sap.ui.vbm.VoBase.

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.VoBase} Reference to this in order to allow method chaining

detachHandleContextMenu(fnFunction, oListener): sap.ui.vbm.VoBase

Detaches event handler fnFunction from the handleContextMenu event of this sap.ui.vbm.VoBase.

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.VoBase} Reference to this in order to allow method chaining

detachHandleMoved(fnFunction, oListener): sap.ui.vbm.VoBase

Detaches event handler fnFunction from the handleMoved event of this sap.ui.vbm.VoBase.

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.VoBase} Reference to this in order to allow method chaining

fireClick(mArguments?): sap.ui.vbm.VoBase

Fires event click to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

fireContextMenu(mArguments?): sap.ui.vbm.VoBase

Fires event contextMenu to attached listeners.

Expects the following event parameters:

menu of type sap.ui.unified.MenuMenu to open

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

fireDrop(mArguments?): sap.ui.vbm.VoBase

Fires event drop to attached listeners.

Expects the following event parameters:

dragSource of type sap.ui.vbm.VoBaseDragged instance

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

fireHandleClick(mArguments?): sap.ui.vbm.VoBase

Fires event handleClick to attached listeners.

Expects the following event parameters:

handle of type intThe number of the handle where the click occured. Handles are numbered zero based.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

fireHandleContextMenu(mArguments?): sap.ui.vbm.VoBase

Fires event handleContextMenu to attached listeners.

Expects the following event parameters:

handle of type intThe number of the handle where the click occured. Handles are numbered zero based.
menu of type sap.ui.unified.MenuMenu to open

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

fireHandleMoved(mArguments?): sap.ui.vbm.VoBase

Fires event handleMoved to attached listeners.

Expects the following event parameters:

handle of type intThe number of the handle where the click occured. Handles are numbered zero based.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

getChangeable(): boolean

Gets current value of property changeable.

Set to true if VO is changeable. Which properties are actually changeable can be controlled on the related VO aggregation.

Default value is false.

Returns:

{boolean} Value of property changeable

getDragData(): string

Gets current value of property dragData.

Data to be dragged. This property allows you to provide an arbitrary data string, which is transfered to the target in a drag'n drop operation

Returns:

{string} Value of property dragData

getEntity(): string

Gets current value of property entity.

The visual object builds an entity/group with other VO elements when it is hovered. The property is not supported when the PlugIn is used.

Returns:

{string} Value of property entity

getFxdir(): string

Gets current value of property fxdir.

The visual object is not rotated when the map is rotated. The property is only required when the PlugIn is used and only meaningful for some VOs.

Default value is true.

Returns:

{string} Value of property fxdir

getFxsize(): string

Gets current value of property fxsize.

The visual object should keep its size when the map is zoomed. Default value is 'true'. Only meaningful for some VOs.

Default value is true.

Returns:

{string} Value of property fxsize

getHotDeltaColor(): string

Gets current value of property hotDeltaColor.

Color change applied when visual object is hovered. The format is RHLSA(<hue>;<lightness>;<saturation>;<opacity>). The hue shift is given in degree (0 to 360). The other parameters are given as multipliers, where 1 means the component remains unchanged.
Beside the delta color approach it is also possible to specify an absolute color in the usual CSS color formats (except named colors).

Default value is RHLSA(0;1.3;1.0;1.0).

Returns:

{string} Value of property hotDeltaColor

getHotScale(): string

Gets current value of property hotScale.

Scaling factor applied when visual object is hovered. This is only supported on selected VOs, which do not present a defined geo area.

Default value is 1.0;1.0;1.0.

Returns:

{string} Value of property hotScale

getKey(): string

Gets current value of property key.

Unique identifier for the object. This is optional. If not provided the default identifier sId is used. However, sId is generated if template binding is used and thus it is not stable. Provide the key if the object really needs to have a unique and stable identifier.

Returns:

{string} Value of property key

getLabelArrow(): boolean

Gets current value of property labelArrow.

The visual objects label arrow. For left/right/top/bottom aligned labels an additional arrow points to the label's object.

Default value is false.

Returns:

{boolean} Value of property labelArrow

getLabelBgColor(): string

Gets current value of property labelBgColor.

The visual objects label background color. The default value is white.

Default value is RGB(255;255;255).

Returns:

{string} Value of property labelBgColor

getLabelBorderColor(): string

Gets current value of property labelBorderColor.

The visual objects label border color. The default is no border.

Returns:

{string} Value of property labelBorderColor

getLabelPos(): string

Gets current value of property labelPos.

The visual objects label position. This property determines the positioning of the label relative to the VO it belongs to. Possible values are:

0: centered
1: top
2: top right
3: right
4: bottom right
5: bottom
6: bottom left
7: left
8: top left

The default alignment is VO specific.
For multiple position based VOs, like Route, or Area the label is dynamically positioned. If the current display of a VO consists of multiple disconnected parts, each part gets an own label.

Returns:

{string} Value of property labelPos

getLabelText(): string

Gets current value of property labelText.

The visual objects label text. Providing a label text required, but also sufficient the get a label displayed.

Returns:

{string} Value of property labelText

getLabelType(): sap.ui.vbm.SemanticType

Gets current value of property labelType.

Type for semantic labels. A given semantic type will overrule color settings and add an icon.

Default value is None.

Returns:

{sap.ui.vbm.SemanticType} Value of property labelType

getSelect(): boolean

Gets current value of property select.

Set to true if the element is selected

Default value is false.

Returns:

{boolean} Value of property select

getSelectColor(): string

Gets current value of property selectColor.

Color change applied when visual object is selected. This can be explicit or a relative one. See above.

Default value is RHLSA(0.0;1.0;1.0;1.0).

Returns:

{string} Value of property selectColor

openContextMenu(oMenu): void

Open the context menu. The method relies on the state saved before firing event contextMenu. Further the object oMenu is expected to be the one given as parameter menu of event contextMenu.

Parameters:

{object}

oMenu

The context menu to be opened. The object is expected the have an attribute

openDetailWindow(sCaption, sOffsetX, sOffsetY): void

Open a Detail Window for the visual object at click position. The method relies on the state saved before firing event click.

Parameters:

{string}	sCaption	Caption of detail window
{string}	sOffsetX	Position offset in x-direction from the anchor point
{string}	sOffsetY	Position offset in y-direction from the anchor point

setChangeable(bChangeable): sap.ui.vbm.VoBase

Sets a new value for property changeable.

Set to true if VO is changeable. Which properties are actually changeable can be controlled on the related VO aggregation.

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

Default value is false.

Parameters:

{boolean} bChangeable New value for property changeable

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

setDragData(sDragData): sap.ui.vbm.VoBase

Sets a new value for property dragData.

Data to be dragged. This property allows you to provide an arbitrary data string, which is transfered to the target in a drag'n drop operation

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

Parameters:

{string} sDragData New value for property dragData

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

setEntity(sEntity): sap.ui.vbm.VoBase

Sets a new value for property entity.

The visual object builds an entity/group with other VO elements when it is hovered. The property is not supported when the PlugIn is used.

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

Parameters:

{string} sEntity New value for property entity

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

setFxdir(sFxdir): sap.ui.vbm.VoBase

Sets a new value for property fxdir.

The visual object is not rotated when the map is rotated. The property is only required when the PlugIn is used and only meaningful for some VOs.

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

Default value is true.

Parameters:

{string} sFxdir New value for property fxdir

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

setFxsize(sFxsize): sap.ui.vbm.VoBase

Sets a new value for property fxsize.

The visual object should keep its size when the map is zoomed. Default value is 'true'. Only meaningful for some VOs.

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

Default value is true.

Parameters:

{string} sFxsize New value for property fxsize

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

setHotDeltaColor(sHotDeltaColor): sap.ui.vbm.VoBase

Sets a new value for property hotDeltaColor.

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

Default value is RHLSA(0;1.3;1.0;1.0).

Parameters:

{string} sHotDeltaColor New value for property hotDeltaColor

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

setHotScale(sHotScale): sap.ui.vbm.VoBase

Sets a new value for property hotScale.

Scaling factor applied when visual object is hovered. This is only supported on selected VOs, which do not present a defined geo area.

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

Default value is 1.0;1.0;1.0.

Parameters:

{string} sHotScale New value for property hotScale

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

setKey(sKey): sap.ui.vbm.VoBase

Sets a new value for property key.

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

Parameters:

{string} sKey New value for property key

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

setLabelArrow(bLabelArrow): sap.ui.vbm.VoBase

Sets a new value for property labelArrow.

The visual objects label arrow. For left/right/top/bottom aligned labels an additional arrow points to the label's object.

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

Default value is false.

Parameters:

{boolean} bLabelArrow New value for property labelArrow

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

setLabelBgColor(sLabelBgColor): sap.ui.vbm.VoBase

Sets a new value for property labelBgColor.

The visual objects label background color. The default value is white.

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

Default value is RGB(255;255;255).

Parameters:

{string} sLabelBgColor New value for property labelBgColor

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

setLabelBorderColor(sLabelBorderColor): sap.ui.vbm.VoBase

Sets a new value for property labelBorderColor.

The visual objects label border color. The default is no border.

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

Parameters:

{string} sLabelBorderColor New value for property labelBorderColor

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

setLabelPos(sLabelPos): sap.ui.vbm.VoBase

Sets a new value for property labelPos.

The visual objects label position. This property determines the positioning of the label relative to the VO it belongs to. Possible values are:

0: centered
1: top
2: top right
3: right
4: bottom right
5: bottom
6: bottom left
7: left
8: top left

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

Parameters:

{string} sLabelPos New value for property labelPos

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

setLabelText(sLabelText): sap.ui.vbm.VoBase

Sets a new value for property labelText.

The visual objects label text. Providing a label text required, but also sufficient the get a label displayed.

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

Parameters:

{string} sLabelText New value for property labelText

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

setLabelType(sLabelType): sap.ui.vbm.VoBase

Sets a new value for property labelType.

Type for semantic labels. A given semantic type will overrule color settings and add an icon.

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

Default value is None.

Parameters:

{sap.ui.vbm.SemanticType} sLabelType New value for property labelType

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

setSelect(bSelect): sap.ui.vbm.VoBase

Sets a new value for property select.

Set to true if the element is selected

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

Default value is false.

Parameters:

{boolean} bSelect New value for property select

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining

setSelectColor(sSelectColor): sap.ui.vbm.VoBase

Sets a new value for property selectColor.

Color change applied when visual object is selected. This can be explicit or a relative one. See above.

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

Default value is RHLSA(0.0;1.0;1.0;1.0).

Parameters:

{string} sSelectColor New value for property selectColor

Returns:

{sap.ui.vbm.VoBase} Reference to this in order to allow method chaining