Class sap.suite.ui.commons.ComparisonDataModule: sap/suite/ui/commons/ComparisonData
Comparison tile value holder.
Deprecated API:Since version 1.34. Deprecated. sap.suite.ui.microchart.ComparisonMicroChartData should be used.
sClassName
and enriches it with the information contained in oClassInfo
.fnFunction
to the 'press' event of this sap.suite.ui.commons.ComparisonData
.fnFunction
from the 'press' event of this sap.suite.ui.commons.ComparisonData
. 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
- title : string
- value : float (default: 0)
- color : sap.suite.ui.commons.InfoTileValueColor (default: sap.suite.ui.commons.InfoTileValueColor.Neutral)
- displayValue : string
- Aggregations
- Associations
- Events
- press : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
In addition, all settings applicable to the base type sap.ui.core.Element can be used as well.
{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.34. Deprecated. sap.suite.ui.microchart.ComparisonMicroChartData should be used.
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters |
- Since:
- 1.30
sClassName
and enriches it with the information contained in oClassInfo
. oClassInfo
might contain the same kind of informations as described in Element.extend.
{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. |
{function} | the created class / constructor function |
{sap.ui.base.Metadata} | Metadata object describing this class |
fnFunction
to the 'press' event of this sap.suite.ui.commons.ComparisonData
.. When called, the context of the event handler (its
this
) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.ComparisonData
.
itself. The event is fired when the user chooses the comparison data.
Parameters:
{object} | oData? | An application specific payload object, that will be passed to the event handler along with the event object when firing the event. |
{function} | fnFunction | The function to call, when the event occurs. |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.suite.ui.commons.ComparisonData .itself. |
Since:
1.30
Returns:
{sap.suite.ui.commons.ComparisonData} | this to allow method chaining |
detachPress(fnFunction, oListener): sap.suite.ui.commons.ComparisonData Detach event handler fnFunction
from the 'press' event of this sap.suite.ui.commons.ComparisonData
.
The passed function and listener object must match the ones used for event registration.
Parameters:{function} fnFunction The function to call, when the event occurs. {object} oListener Context object on which the given function had to be called.
- Since:
- 1.30
Returns:{sap.suite.ui.commons.ComparisonData} this
to allow method chaining
firePress(mArguments?): sap.suite.ui.commons.ComparisonData Fire event press to attached listeners. Parameters:{Map} mArguments? the arguments to pass along with the event.
- Since:
- 1.30
Returns:{sap.suite.ui.commons.ComparisonData} this
to allow method chaining
getColor(): sap.suite.ui.commons.InfoTileValueColor Getter for property color
. The semantic color of the value. Default value is Neutral
Returns:{sap.suite.ui.commons.InfoTileValueColor} the value of property color
getDisplayValue(): string Getter for property displayValue
. If this property is set then it will be rendered instead of value. Default value is empty/undefined
- Since:
- 1.22
Returns:{string} the value of property displayValue
getTitle(): string Getter for property title
. The comparison bar title. Default value is empty/undefined
Returns:{string} the value of property title
getValue(): float Getter for property value
. The float value for comparison. Default value is 0
Returns:{float} the value of property value
setColor(oColor): sap.suite.ui.commons.ComparisonData Setter for property color
. Default value is Neutral
Parameters:{sap.suite.ui.commons.InfoTileValueColor} oColor new value for property color
Returns:{sap.suite.ui.commons.ComparisonData} this
to allow method chaining
setDisplayValue(sDisplayValue): sap.suite.ui.commons.ComparisonData Setter for property displayValue
. Default value is empty/undefined
Parameters:{string} sDisplayValue new value for property displayValue
- Since:
- 1.22
Returns:{sap.suite.ui.commons.ComparisonData} this
to allow method chaining
setTitle(sTitle): sap.suite.ui.commons.ComparisonData Setter for property title
. Default value is empty/undefined
Parameters:{string} sTitle new value for property title
Returns:{sap.suite.ui.commons.ComparisonData} this
to allow method chaining
setValue(fValue): sap.suite.ui.commons.ComparisonData Setter for property value
. Default value is 0
Parameters:{float} fValue new value for property value
Returns:{sap.suite.ui.commons.ComparisonData} this
to allow method chaining