Class sap.ui.vbm.ClusterModule: sap/ui/vbm/Cluster

extends Control

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 Summary
new sap.ui.vbm.Cluster(sId?, mSettings?)Constructor for a new Cluster.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.vbm.Cluster.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vbm.Cluster with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vbm.Cluster.getMetadata()Returns a metadata object for class sap.ui.vbm.Cluster.
getColor()Gets current value of property color.
getIcon()Gets current value of property icon.
getText()Gets current value of property text.
getType()Gets current value of property type.
setColor(sColor)Sets a new value for property color.
setIcon(sIcon)Sets a new value for property icon.
setText(sText)Sets a new value for property text.
setType(sType)Sets a new value for property type.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.ui.vbm.Cluster(sId?, mSettings?)
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 for a general description of the syntax of the settings object.

The supported settings are:

  • Properties
    • color : sap.ui.core.CSSColor
    • icon : string
    • text : string
    • type : sap.ui.vbm.SemanticType (default: None)

In addition, all settings applicable to the base type sap.ui.core.Control 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.Cluster.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.

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.Cluster.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vbm.Cluster.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getColor(): sap.ui.core.CSSColor
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.

Returns:
{sap.ui.core.CSSColor} Value of property color
getIcon(): string
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.

Returns:
{string} Value of property icon
getText(): string
Gets current value of property text.

Set the text of the control.

Returns:
{string} Value of property text
getType(): sap.ui.vbm.SemanticType
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.

Returns:
{sap.ui.vbm.SemanticType} Value of property type
setColor(sColor): sap.ui.vbm.Cluster
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.

Parameters:
{sap.ui.core.CSSColor}sColor New value for property color
Returns:
{sap.ui.vbm.Cluster} Reference to this in order to allow method chaining
setIcon(sIcon): sap.ui.vbm.Cluster
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.

Parameters:
{string}sIcon New value for property icon
Returns:
{sap.ui.vbm.Cluster} Reference to this in order to allow method chaining
setText(sText): sap.ui.vbm.Cluster
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.

Parameters:
{string}sText New value for property text
Returns:
{sap.ui.vbm.Cluster} Reference to this in order to allow method chaining
setType(sType): sap.ui.vbm.Cluster
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.

Parameters:
{sap.ui.vbm.SemanticType}sType New value for property type
Returns:
{sap.ui.vbm.Cluster} Reference to this in order to allow method chaining