class sap.ui.vbm.VoBase

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

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:

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


Constructor

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#constructor for a general description of the syntax of the settings object.

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

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

mSettings? object

initial settings for the new control


Properties

Name Type Default Value Description
changeable boolean false

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

Visibility: public
dragData string

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

Visibility: public
entity string

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.

Visibility: public
fxdir string true

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.

Visibility: public
fxsize string true

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

Visibility: public
hotDeltaColor string RHLSA(0;1.3;1.0;1.0)

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).

Visibility: public
hotScale string 1.0;1.0;1.0

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

Visibility: public
key string

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.

Visibility: public
labelArrow boolean false

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

Visibility: public
labelBgColor string RGB(255;255;255)

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

Visibility: public
labelBorderColor string

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

Visibility: public
labelPos string

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.

Visibility: public
labelText string

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

Visibility: public
labelType sap.ui.vbm.SemanticType None

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

Visibility: public
select boolean false

Set to true if the element is selected

Visibility: public
selectColor string RHLSA(0.0;1.0;1.0;1.0)

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

Visibility: public

Events Overview

Event Description
click

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

contextMenu

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

drop

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

handleClick

This event is raised when the design handle is clicked.

handleContextMenu

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

handleMoved

This event is raised when the design handle is moved.

click

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

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

contextMenu

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

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

Menu to open

drop

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

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

Dragged instance

handleClick

This event is raised when the design handle is clicked.

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

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

handleContextMenu

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

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

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

menu sap.ui.unified.Menu

Menu to open

handleMoved

This event is raised when the design handle is moved.

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

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


Methods Overview

Method Description
attachClick

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.

attachContextMenu

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.

attachDrop

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.

attachHandleClick

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.

attachHandleContextMenu

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.

attachHandleMoved

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.

detachClick

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.

detachContextMenu

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.

detachDrop

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.

detachHandleClick

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.

detachHandleContextMenu

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.

detachHandleMoved

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.

sap.ui.vbm.VoBase.extend

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.

fireClick

Fires event click to attached listeners.

fireContextMenu

Fires event contextMenu to attached listeners.

fireDrop

Fires event drop to attached listeners.

fireHandleClick

Fires event handleClick to attached listeners.

fireHandleContextMenu

Fires event handleContextMenu to attached listeners.

fireHandleMoved

Fires event handleMoved to attached listeners.

getChangeable

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.

getDragData

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

getEntity

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.

getFxdir

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'.

getFxsize

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'.

getHotDeltaColor

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)'.

getHotScale

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'.

getKey

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.

getLabelArrow

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.

getLabelBgColor

Gets current value of property labelBgColor.

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

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

getLabelBorderColor

Gets current value of property labelBorderColor.

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

getLabelPos

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.

getLabelText

Gets current value of property labelText.

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

getLabelType

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.

sap.ui.vbm.VoBase.getMetadata

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

getSelect

Gets current value of property select.

Set to true if the element is selected

Default value is false.

getSelectColor

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)'.

openContextMenu

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.

openDetailWindow

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

setChangeable

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.

setDragData

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.

setEntity

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.

setFxdir

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'.

setFxsize

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'.

setHotDeltaColor

Sets a new value for 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).

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)'.

setHotScale

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'.

setKey

Sets a new value for 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.

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

setLabelArrow

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.

setLabelBgColor

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)'.

setLabelBorderColor

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.

setLabelPos

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

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

setLabelText

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.

setLabelType

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.

setSelect

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.

setSelectColor

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)'.

attachClick

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.

Param Type DefaultValue Description
oData object

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

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

The function to be called when the event occurs

oListener object

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

attachContextMenu

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.

Param Type DefaultValue Description
oData object

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

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

The function to be called when the event occurs

oListener object

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

attachDrop

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.

Param Type DefaultValue Description
oData object

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

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

The function to be called when the event occurs

oListener object

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

attachHandleClick

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.

Param Type DefaultValue Description
oData object

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

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

The function to be called when the event occurs

oListener object

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

attachHandleContextMenu

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.

Param Type DefaultValue Description
oData object

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

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

The function to be called when the event occurs

oListener object

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

attachHandleMoved

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.

Param Type DefaultValue Description
oData object

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

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

The function to be called when the event occurs

oListener object

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

detachClick

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.

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

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachContextMenu

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

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

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

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachDrop

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

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

detachHandleClick

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.

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

detachHandleContextMenu

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.

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

detachHandleMoved

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.

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

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.vbm.VoBase.extend

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.

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

fireClick

Fires event click to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

fireContextMenu

Fires event contextMenu to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

menu sap.ui.unified.Menu

Menu to open

fireDrop

Fires event drop to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

dragSource sap.ui.vbm.VoBase

Dragged instance

fireHandleClick

Fires event handleClick to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

handle int

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

fireHandleContextMenu

Fires event handleContextMenu to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

handle int

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

menu sap.ui.unified.Menu

Menu to open

fireHandleMoved

Fires event handleMoved to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

handle int

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

getChangeable

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.

getDragData

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

getEntity

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.

getFxdir

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'.

getFxsize

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'.

getHotDeltaColor

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)'.

getHotScale

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'.

getKey

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.

getLabelArrow

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.

getLabelBgColor

Gets current value of property labelBgColor.

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

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

getLabelBorderColor

Gets current value of property labelBorderColor.

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

getLabelPos

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:

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.

getLabelText

Gets current value of property labelText.

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

getLabelType

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.

sap.ui.vbm.VoBase.getMetadata

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

getSelect

Gets current value of property select.

Set to true if the element is selected

Default value is false.

getSelectColor

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)'.

openContextMenu

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.

Param Type DefaultValue Description
oMenu object

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

openDetailWindow

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

Param Type DefaultValue Description
sCaption string

Caption of detail window

sOffsetX string

Position offset in x-direction from the anchor point

sOffsetY string

Position offset in y-direction from the anchor point

setChangeable

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.

Param Type DefaultValue Description
bChangeable boolean false

New value for property changeable

setDragData

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.

Param Type DefaultValue Description
sDragData string

New value for property dragData

setEntity

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.

Param Type DefaultValue Description
sEntity string

New value for property entity

setFxdir

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'.

Param Type DefaultValue Description
sFxdir string 'true'

New value for property fxdir

setFxsize

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'.

Param Type DefaultValue Description
sFxsize string 'true'

New value for property fxsize

setHotDeltaColor

Sets a new value for 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).

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)'.

Param Type DefaultValue Description
sHotDeltaColor string 'RHLSA(0;1.3;1.0;1.0)'

New value for property hotDeltaColor

setHotScale

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'.

Param Type DefaultValue Description
sHotScale string '1.0;1.0;1.0'

New value for property hotScale

setKey

Sets a new value for 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.

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

Param Type DefaultValue Description
sKey string

New value for property key

setLabelArrow

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.

Param Type DefaultValue Description
bLabelArrow boolean false

New value for property labelArrow

setLabelBgColor

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)'.

Param Type DefaultValue Description
sLabelBgColor string 'RGB(255;255;255)'

New value for property labelBgColor

setLabelBorderColor

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.

Param Type DefaultValue Description
sLabelBorderColor string

New value for property labelBorderColor

setLabelPos

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:

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.

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

Param Type DefaultValue Description
sLabelPos string

New value for property labelPos

setLabelText

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.

Param Type DefaultValue Description
sLabelText string

New value for property labelText

setLabelType

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.

Param Type DefaultValue Description
sLabelType sap.ui.vbm.SemanticType None

New value for property labelType

setSelect

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.

Param Type DefaultValue Description
bSelect boolean false

New value for property select

setSelectColor

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)'.

Param Type DefaultValue Description
sSelectColor string 'RHLSA(0.0;1.0;1.0;1.0)'

New value for property selectColor