Class sap.suite.ui.commons.KpiTileModule: sap/suite/ui/commons/KpiTile
extends Control
This control is used in UnifiedThingInspector to display object-related KPIs in a factsheet.
Deprecated API:Since version 1.32. Deprecated. Numeric content or any other standard Fiori control should be used instead.
Constructor Summary
Events borrowed from class sap.ui.core.Control
Events borrowed from class sap.ui.base.ManagedObject
Method Summary
sap.suite.ui.commons.KpiTile.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.KpiTile with name
sClassName and enriches it with the information contained in oClassInfo.sap.suite.ui.commons.KpiTile.getMetadata()Returns a metadata object for class sap.suite.ui.commons.KpiTile.
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
Constructor Detail
new sap.suite.ui.commons.KpiTile(sId?, mSettings?)
Constructor for a new KpiTile.
Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.
If the name of a setting is ambiguous (e.g. a property has the same name as an event), then the framework assumes property, aggregation, association, event in that order. To override this automatic resolution, one of the prefixes "aggregation:", "association:" or "event:" can be added to the name of the setting (such a prefixed name must be enclosed in single or double quotes).
The supported settings are:
- Properties
- value : string
- description : string
- doubleFontSize : boolean (default: true)
- valueUnit : string
- valueScale : string
- valueStatus : sap.suite.ui.commons.ValueStatus (default: sap.suite.ui.commons.ValueStatus.Neutral)
- Aggregations
- Associations
- Events
Parameters:
| {string} | sId? | id for the new control, generated automatically if no id is given |
| {object} | mSettings? | initial settings for the new control |
- Deprecated:
- Since version 1.32. Deprecated. Numeric content or any other standard Fiori control should be used instead.
Method Detail
sap.suite.ui.commons.KpiTile.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.suite.ui.commons.KpiTile with name
sClassName and enriches it with the information contained in oClassInfo. oClassInfo might contain the same kind of informations as described in Element.extend.
Parameters:
| {string} | sClassName | name of the class to be created |
| {object} | oClassInfo? | object literal with informations about the class |
| {function} | FNMetaImpl? | constructor function for the metadata object. If not given, it defaults to sap.ui.core.ElementMetadata. |
Returns:
| {function} | the created class / constructor function |
sap.suite.ui.commons.KpiTile.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.suite.ui.commons.KpiTile.
Returns:
| {sap.ui.base.Metadata} | Metadata object describing this class |
getDescription(): string
Getter for property
description. The Description field. Default value is empty/undefined
Returns:
| {string} | the value of property description |
getDoubleFontSize(): boolean
Getter for property
doubleFontSize. If true, the value text will have 2 rem, if false - 1 rem. Default value is true
Returns:
| {boolean} | the value of property doubleFontSize |
getValue(): string
Getter for property
value. The Value field. Default value is empty/undefined
Returns:
| {string} | the value of property value |
getValueScale(): string
Getter for property
valueScale. The scale of a value. Default value is empty/undefined
Returns:
| {string} | the value of property valueScale |
getValueStatus(): sap.suite.ui.commons.ValueStatus
Getter for property
valueStatus. The status color of the value. Depending on the status the tile is displayed in different colors. Default value is Neutral
Returns:
| {sap.suite.ui.commons.ValueStatus} | the value of property valueStatus |
getValueUnit(): string
Getter for property
valueUnit. The percent sign, currency symbol, or unit for a value. Default value is empty/undefined
Returns:
| {string} | the value of property valueUnit |
setDescription(sDescription): sap.suite.ui.commons.KpiTile
Setter for property
description. Default value is empty/undefined
Parameters:
| {string} | sDescription | new value for property description |
Returns:
| {sap.suite.ui.commons.KpiTile} | this to allow method chaining |
setDoubleFontSize(bDoubleFontSize): sap.suite.ui.commons.KpiTile
Setter for property
doubleFontSize. Default value is true
Parameters:
| {boolean} | bDoubleFontSize | new value for property doubleFontSize |
Returns:
| {sap.suite.ui.commons.KpiTile} | this to allow method chaining |
setValue(sValue): sap.suite.ui.commons.KpiTile
Setter for property
value. Default value is empty/undefined
Parameters:
| {string} | sValue | new value for property value |
Returns:
| {sap.suite.ui.commons.KpiTile} | this to allow method chaining |
setValueScale(sValueScale): sap.suite.ui.commons.KpiTile
Setter for property
valueScale. Default value is empty/undefined
Parameters:
| {string} | sValueScale | new value for property valueScale |
Returns:
| {sap.suite.ui.commons.KpiTile} | this to allow method chaining |
setValueStatus(oValueStatus): sap.suite.ui.commons.KpiTile
Setter for property
valueStatus. Default value is Neutral
Parameters:
| {sap.suite.ui.commons.ValueStatus} | oValueStatus | new value for property valueStatus |
Returns:
| {sap.suite.ui.commons.KpiTile} | this to allow method chaining |
setValueUnit(sValueUnit): sap.suite.ui.commons.KpiTile
Setter for property
valueUnit. Default value is empty/undefined
Parameters:
| {string} | sValueUnit | new value for property valueUnit |
Returns:
| {sap.suite.ui.commons.KpiTile} | this to allow method chaining |