Class sap.ui.vbm.GeoCircleModule: sap/ui/vbm/GeoCircle

extends VoBase

Specific Visual Object element for a GeoCircle. A GeoCircle is positioned with its centerpoint at the given position. Since the actual size of a geocircle may depend on the zoom level it might be only partly visible. Thus detail windows will open at the click position.

Constructor Summary
new sap.ui.vbm.GeoCircle(sId?, mSettings?)Constructor for a new GeoCircle.
Method Summary
sap.ui.vbm.GeoCircle.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vbm.GeoCircle with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vbm.GeoCircle.getMetadata()Returns a metadata object for class sap.ui.vbm.GeoCircle.
getColor()Gets current value of property color.
getColorBorder()Gets current value of property colorBorder.
getPosition()Gets current value of property position.
getRadius()Gets current value of property radius.
getSlices()Gets current value of property slices.
setColor(sColor)Sets a new value for property color.
setColorBorder(sColorBorder)Sets a new value for property colorBorder.
setPosition(sPosition)Sets a new value for property position.
setRadius(sRadius)Sets a new value for property radius.
setSlices(sSlices)Sets a new value for property slices.
Constructor Detail
new sap.ui.vbm.GeoCircle(sId?, mSettings?)
Constructor for a new GeoCircle.

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

In addition, all settings applicable to the base type sap.ui.vbm.VoBase 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
Method Detail
sap.ui.vbm.GeoCircle.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.vbm.GeoCircle with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.vbm.VoBase.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.GeoCircle.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vbm.GeoCircle.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getColor(): string
Gets current value of property color.

The color of the geocirle.

Default value is RGB(0,0,0).

Returns:
{string} Value of property color
getColorBorder(): string
Gets current value of property colorBorder.

The border color of the geocirle.

Default value is RGB(0,0,0).

Returns:
{string} Value of property colorBorder
getPosition(): string
Gets current value of property position.

The position of the geocircle. The format is "lon;lat;0".

Default value is 0;0;0.

Returns:
{string} Value of property position
getRadius(): string
Gets current value of property radius.

The radius in meters of the geocirle.

Default value is 10000.

Returns:
{string} Value of property radius
getSlices(): string
Gets current value of property slices.

The number of slices of the geocircle.

Default value is 20.

Returns:
{string} Value of property slices
setColor(sColor): sap.ui.vbm.GeoCircle
Sets a new value for property color.

The color of the geocirle.

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

Default value is RGB(0,0,0).

Parameters:
{string}sColor New value for property color
Returns:
{sap.ui.vbm.GeoCircle} Reference to this in order to allow method chaining
setColorBorder(sColorBorder): sap.ui.vbm.GeoCircle
Sets a new value for property colorBorder.

The border color of the geocirle.

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

Default value is RGB(0,0,0).

Parameters:
{string}sColorBorder New value for property colorBorder
Returns:
{sap.ui.vbm.GeoCircle} Reference to this in order to allow method chaining
setPosition(sPosition): sap.ui.vbm.GeoCircle
Sets a new value for property position.

The position of the geocircle. The format is "lon;lat;0".

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

Default value is 0;0;0.

Parameters:
{string}sPosition New value for property position
Returns:
{sap.ui.vbm.GeoCircle} Reference to this in order to allow method chaining
setRadius(sRadius): sap.ui.vbm.GeoCircle
Sets a new value for property radius.

The radius in meters of the geocirle.

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

Default value is 10000.

Parameters:
{string}sRadius New value for property radius
Returns:
{sap.ui.vbm.GeoCircle} Reference to this in order to allow method chaining
setSlices(sSlices): sap.ui.vbm.GeoCircle
Sets a new value for property slices.

The number of slices of the geocircle.

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

Default value is 20.

Parameters:
{string}sSlices New value for property slices
Returns:
{sap.ui.vbm.GeoCircle} Reference to this in order to allow method chaining