Class sap.suite.ui.commons.NumericTileModule: sap/suite/ui/commons/NumericTile

extends InfoTile

This control is the implementation of the InfoTile to show a numeric value.

Deprecated API:Since version 1.25. This control has been deprecated in favor of new sap.suite.ui.commons.GenericTile.

Constructor Summary
new sap.suite.ui.commons.NumericTile(sId?, mSettings?)Constructor for a new NumericTile.
Events borrowed from class sap.suite.ui.commons.InfoTile
Events borrowed from class sap.ui.core.Control
Method Summary
sap.suite.ui.commons.NumericTile.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.NumericTile with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.NumericTile.getMetadata()Returns a metadata object for class sap.suite.ui.commons.NumericTile.
getIndicator()Getter for property indicator.
getScale()Getter for property scale.
getUnit()Getter for property unit.
getValue()Getter for property value.
getValueColor()Getter for property valueColor.
setIndicator(oIndicator)Setter for property indicator.
setScale(sScale)Setter for property scale.
setUnit(sUnit)Setter for property unit.
setValue(sValue)Setter for property value.
setValueColor(oValueColor)Setter for property valueColor.
Constructor Detail
new sap.suite.ui.commons.NumericTile(sId?, mSettings?)
Constructor for a new NumericTile.

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
    • scale : string
    • unit : string
    • valueColor : sap.suite.ui.commons.InfoTileValueColor
    • indicator : sap.suite.ui.commons.DeviationIndicator (default: sap.suite.ui.commons.DeviationIndicator.None)
  • Aggregations
    • Associations
      • Events

        In addition, all settings applicable to the base type sap.suite.ui.commons.InfoTile 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
        Deprecated:
        Since version 1.25. This control has been deprecated in favor of new sap.suite.ui.commons.GenericTile.
        Method Detail
        sap.suite.ui.commons.NumericTile.extend(sClassName, oClassInfo?, FNMetaImpl?): function
        Creates a new subclass of class sap.suite.ui.commons.NumericTile 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.NumericTile.getMetadata(): sap.ui.base.Metadata
        Returns a metadata object for class sap.suite.ui.commons.NumericTile.
        Returns:
        {sap.ui.base.Metadata} Metadata object describing this class
        Getter for property indicator. The indicator arrow that shows value deviation.

        Default value is None

        Returns:
        {sap.suite.ui.commons.DeviationIndicator} the value of property indicator
        getScale(): string
        Getter for property scale. The scaling prefix. Financial characters can be used for currencies and counters. The SI prefixes can be used for units.

        Default value is empty/undefined

        Returns:
        {string} the value of property scale
        getUnit(): string
        Getter for property unit. The percent sign, the currency symbol, or the unit of measure.

        Default value is empty/undefined

        Returns:
        {string} the value of property unit
        getValue(): string
        Getter for property value. The actual value.

        Default value is empty/undefined

        Returns:
        {string} the value of property value
        Getter for property valueColor. The semantic color of the value.

        Default value is empty/undefined

        Returns:
        {sap.suite.ui.commons.InfoTileValueColor} the value of property valueColor
        setIndicator(oIndicator): sap.suite.ui.commons.NumericTile
        Setter for property indicator.

        Default value is None

        Parameters:
        {sap.suite.ui.commons.DeviationIndicator}oIndicator new value for property indicator
        Returns:
        {sap.suite.ui.commons.NumericTile}this to allow method chaining
        Setter for property scale.

        Default value is empty/undefined

        Parameters:
        {string}sScale new value for property scale
        Returns:
        {sap.suite.ui.commons.NumericTile}this to allow method chaining
        Setter for property unit.

        Default value is empty/undefined

        Parameters:
        {string}sUnit new value for property unit
        Returns:
        {sap.suite.ui.commons.NumericTile}this to allow method chaining
        Setter for property value.

        Default value is empty/undefined

        Parameters:
        {string}sValue new value for property value
        Returns:
        {sap.suite.ui.commons.NumericTile}this to allow method chaining
        setValueColor(oValueColor): sap.suite.ui.commons.NumericTile
        Setter for property valueColor.

        Default value is empty/undefined

        Parameters:
        {sap.suite.ui.commons.InfoTileValueColor}oValueColor new value for property valueColor
        Returns:
        {sap.suite.ui.commons.NumericTile}this to allow method chaining