Cluster control to visualize clustered objects on a map. The Cluster control does not cluster anything itself, instead it only shows a predefined image. The image can be configured with the properties type, color, icon and text. If a text is given it is shown in the upper right corner of the control with a rounded border around. With the color property any color can be chosen. The type property overwrites a property color with semantic color of the type and provides a particular semantic icon in the middle of the control. With the icon property an icon can be defined and may overrule the semantic icon; if no icon is defined ( and no type) then the semantic icon for type inactive is chosen.
Constructor for a new Cluster.
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.Cluster(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 |
Name | Type | Default Value | Description |
---|---|---|---|
color | sap.ui.core.CSSColor | Set the color of the control. If a type is set then the semantic color of the type is taken instead. Visibility: public |
|
icon | string | Set the icon of the control. If a type is set then the semantic icon of the type can be overwritten with this property. If no icon and no type is set then the icon for the semantic type 'inactive' is taken. Visibility: public |
|
text | string | Set the text of the control. Visibility: public |
|
type | sap.ui.vbm.SemanticType | None | semantic type for cluster. The type specifies the icon and the color of the cluster control. Visibility: public |
Method | Description |
---|---|
sap.ui.vbm.Cluster.extend |
Creates a new subclass of class sap.ui.vbm.Cluster with name
|
getColor |
Gets current value of property color. Set the color of the control. If a type is set then the semantic color of the type is taken instead. |
getIcon |
Gets current value of property icon. Set the icon of the control. If a type is set then the semantic icon of the type can be overwritten with this property. If no icon and no type is set then the icon for the semantic type 'inactive' is taken. |
sap.ui.vbm.Cluster.getMetadata |
Returns a metadata object for class sap.ui.vbm.Cluster. |
getText |
Gets current value of property text. Set the text of the control. |
getType |
Gets current value of property type. semantic type for cluster. The type specifies the icon and the color of the cluster control. Default value is |
setColor |
Sets a new value for property color. Set the color of the control. If a type is set then the semantic color of the type is taken instead. When called with a value of |
setIcon |
Sets a new value for property icon. Set the icon of the control. If a type is set then the semantic icon of the type can be overwritten with this property. If no icon and no type is set then the icon for the semantic type 'inactive' is taken. When called with a value of |
setText |
Sets a new value for property text. Set the text of the control. When called with a value of |
setType |
Sets a new value for property type. semantic type for cluster. The type specifies the icon and the color of the cluster control. When called with a value of Default value is |
Creates a new subclass of class sap.ui.vbm.Cluster 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.Control.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 |
Gets current value of property color.
Set the color of the control. If a type is set then the semantic color of the type is taken instead.
Gets current value of property icon.
Set the icon of the control. If a type is set then the semantic icon of the type can be overwritten with this property. If no icon and no type is set then the icon for the semantic type 'inactive' is taken.
Gets current value of property type.
semantic type for cluster. The type specifies the icon and the color of the cluster control.
Default value is None
.
Sets a new value for property color.
Set the color of the control. If a type is set then the semantic color of the type is taken instead.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sColor | sap.ui.core.CSSColor |
New value for property |
Sets a new value for property icon.
Set the icon of the control. If a type is set then the semantic icon of the type can be overwritten with this property. If no icon and no type is set then the icon for the semantic type 'inactive' is taken.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sIcon | string |
New value for property |
Sets a new value for property text.
Set the text of the control.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sText | string |
New value for property |
Sets a new value for property type.
semantic type for cluster. The type specifies the icon and the color of the cluster control.
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 |
---|---|---|---|
sType | sap.ui.vbm.SemanticType | None |
New value for property |