class sap.ui.vbm.Circles

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

Type specific Visual Object aggregation for Circle elements.


Constructor

Constructor for a new Circles.

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.Circles(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
posChangeable boolean true

Set to true if position may be changed at runtime. The actual changeability is control on each aggregated element with property changeable.

Visibility: public
radiusChangeable boolean true

Set to true if radius may be changed at runtime. The actual changeability is control on each aggregated element with property changeable.

Visibility: public

Borrowed Properties

Name Type Default Value Description
customProperties string[]

If you want to add custom data to VO instances and make the GeoMap control aware of it, e.g. for basing clustering rules on it, you can provide an array of property names specifying the keys to consider.

Visibility: public
maxSel string n

Selection cardinality: maximum selectable elements ( valid values are "0", "1", and "n" )

Visibility: public
minSel string 0

Selection cardinality: minimum selected elements ("0" or "1" )

Visibility: public

Aggregations

Default Aggregation: items

Name Cardinality Type Description
items (default) 0..n sap.ui.vbm.Circle

circle object aggregation


Methods Overview

Method Description
addItem

Adds some item to the aggregation items.

destroyItems

Destroys all the items in the aggregation items.

sap.ui.vbm.Circles.extend

Creates a new subclass of class sap.ui.vbm.Circles 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.VoAggregation.extend.

getItems

Gets content of aggregation items.

circle object aggregation

sap.ui.vbm.Circles.getMetadata

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

getPosChangeable

Gets current value of property posChangeable.

Set to true if position may be changed at runtime. The actual changeability is control on each aggregated element with property changeable.

Default value is true.

getRadiusChangeable

Gets current value of property radiusChangeable.

Set to true if radius may be changed at runtime. The actual changeability is control on each aggregated element with property changeable.

Default value is true.

indexOfItem

Checks for the provided sap.ui.vbm.Circle in the aggregation items. and returns its index if found or -1 otherwise.

insertItem

Inserts a item into the aggregation items.

removeAllItems

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

removeItem

Removes a item from the aggregation items.

setPosChangeable

Sets a new value for property posChangeable.

Set to true if position may be changed at runtime. The actual changeability is control on each aggregated element with property changeable.

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

Default value is true.

setRadiusChangeable

Sets a new value for property radiusChangeable.

Set to true if radius may be changed at runtime. The actual changeability is control on each aggregated element with property changeable.

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

Default value is true.

addItem

Adds some item to the aggregation items.

Param Type DefaultValue Description
oItem sap.ui.vbm.Circle

The item to add; if empty, nothing is inserted

destroyItems

Destroys all the items in the aggregation items.

sap.ui.vbm.Circles.extend

Creates a new subclass of class sap.ui.vbm.Circles 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.VoAggregation.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

getItems

Gets content of aggregation items.

circle object aggregation

sap.ui.vbm.Circles.getMetadata

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

getPosChangeable

Gets current value of property posChangeable.

Set to true if position may be changed at runtime. The actual changeability is control on each aggregated element with property changeable.

Default value is true.

getRadiusChangeable

Gets current value of property radiusChangeable.

Set to true if radius may be changed at runtime. The actual changeability is control on each aggregated element with property changeable.

Default value is true.

indexOfItem

Checks for the provided sap.ui.vbm.Circle in the aggregation items. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oItem sap.ui.vbm.Circle

The item whose index is looked for

insertItem

Inserts a item into the aggregation items.

Param Type DefaultValue Description
oItem sap.ui.vbm.Circle

The item to insert; if empty, nothing is inserted

iIndex int

The 0-based index the item should be inserted at; for a negative value of iIndex, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position

removeAllItems

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

removeItem

Removes a item from the aggregation items.

Param Type DefaultValue Description
vItem int string sap.ui.vbm.Circle

The item to remove or its index or id

setPosChangeable

Sets a new value for property posChangeable.

Set to true if position may be changed at runtime. The actual changeability is control on each aggregated element with property changeable.

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
bPosChangeable boolean true

New value for property posChangeable

setRadiusChangeable

Sets a new value for property radiusChangeable.

Set to true if radius may be changed at runtime. The actual changeability is control on each aggregated element with property changeable.

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
bRadiusChangeable boolean true

New value for property radiusChangeable