class sap.ui.vbm.GeoCircle

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

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

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

new sap.ui.vbm.GeoCircle(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
color string RGB(0,0,0)

The color of the geocirle.

Visibility: public
colorBorder string RGB(0,0,0)

The border color of the geocirle.

Visibility: public
position string 0;0;0

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

Visibility: public
radius string 10000

The radius in meters of the geocirle.

Visibility: public
slices string 20

The number of slices of the geocircle.

Visibility: public

Borrowed 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

Methods Overview

Method Description
sap.ui.vbm.GeoCircle.extend

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.

getColor

Gets current value of property color.

The color of the geocirle.

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

getColorBorder

Gets current value of property colorBorder.

The border color of the geocirle.

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

sap.ui.vbm.GeoCircle.getMetadata

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

getPosition

Gets current value of property position.

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

Default value is '0;0;0'.

getRadius

Gets current value of property radius.

The radius in meters of the geocirle.

Default value is '10000'.

getSlices

Gets current value of property slices.

The number of slices of the geocircle.

Default value is '20'.

setColor

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

setColorBorder

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

setPosition

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

setRadius

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

setSlices

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

sap.ui.vbm.GeoCircle.extend

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.

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

getColor

Gets current value of property color.

The color of the geocirle.

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

getColorBorder

Gets current value of property colorBorder.

The border color of the geocirle.

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

sap.ui.vbm.GeoCircle.getMetadata

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

getPosition

Gets current value of property position.

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

Default value is '0;0;0'.

getRadius

Gets current value of property radius.

The radius in meters of the geocirle.

Default value is '10000'.

getSlices

Gets current value of property slices.

The number of slices of the geocircle.

Default value is '20'.

setColor

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

Param Type DefaultValue Description
sColor string 'RGB(0,0,0)'

New value for property color

setColorBorder

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

Param Type DefaultValue Description
sColorBorder string 'RGB(0,0,0)'

New value for property colorBorder

setPosition

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

Param Type DefaultValue Description
sPosition string '0;0;0'

New value for property position

setRadius

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

Param Type DefaultValue Description
sRadius string '10000'

New value for property radius

setSlices

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

Param Type DefaultValue Description
sSlices string '20'

New value for property slices