Class sap.suite.ui.microchart.ComparisonMicroChartDataModule: sap/suite/ui/microchart/ComparisonMicroChartData

extends Element

Contains the values of the comparison chart.


Since: 1.34.
Constructor Summary
new sap.suite.ui.microchart.ComparisonMicroChartData(sId?, mSettings?)Constructor for a new ComparisonMicroChartData.
Event Summary
press(oControlEvent)The event is fired when the user chooses the comparison chart bar.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.suite.ui.microchart.ComparisonMicroChartData.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.microchart.ComparisonMicroChartData with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.microchart.ComparisonMicroChartData.getMetadata()Returns a metadata object for class sap.suite.ui.microchart.ComparisonMicroChartData.
attachPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the press event of this sap.suite.ui.microchart.ComparisonMicroChartData.
detachPress(fnFunction, oListener)Detaches event handler fnFunction from the press event of this sap.suite.ui.microchart.ComparisonMicroChartData.
firePress(mArguments?)Fires event press to attached listeners.
getColor()Gets current value of property color.
getDisplayValue()Gets current value of property displayValue.
getTitle()Gets current value of property title.
getValue()Gets current value of property value.
setColor(sColor)Sets a new value for property color.
setDisplayValue(sDisplayValue)Sets a new value for property displayValue.
setTitle(sTitle)Sets a new value for property title.
setValue(fValue)Sets a new value for property value.
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, 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, rerender, 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, invalidate, 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.suite.ui.microchart.ComparisonMicroChartData(sId?, mSettings?)
Constructor for a new ComparisonMicroChartData.

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
  • 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.

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Event Detail
press(oControlEvent)
The event is fired when the user chooses the comparison chart bar.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Method Detail
sap.suite.ui.microchart.ComparisonMicroChartData.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.suite.ui.microchart.ComparisonMicroChartData 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.Element.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.suite.ui.microchart.ComparisonMicroChartData.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.suite.ui.microchart.ComparisonMicroChartData.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
attachPress(oData?, fnFunction, oListener?): sap.suite.ui.microchart.ComparisonMicroChartData
Attaches event handler fnFunction to the press event of this sap.suite.ui.microchart.ComparisonMicroChartData.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.suite.ui.microchart.ComparisonMicroChartData itself.

The event is fired when the user chooses the comparison chart bar.

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 be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.suite.ui.microchart.ComparisonMicroChartData itself
Returns:
{sap.suite.ui.microchart.ComparisonMicroChartData} Reference to this in order to allow method chaining
detachPress(fnFunction, oListener): sap.suite.ui.microchart.ComparisonMicroChartData
Detaches event handler fnFunction from the press event of this sap.suite.ui.microchart.ComparisonMicroChartData.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.suite.ui.microchart.ComparisonMicroChartData} Reference to this in order to allow method chaining
firePress(mArguments?): sap.suite.ui.microchart.ComparisonMicroChartData
Fires event press to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.suite.ui.microchart.ComparisonMicroChartData} Reference to this in order to allow method chaining
getColor(): sap.m.ValueColor
Gets current value of property color.

The semantic color of the value.

Default value is Neutral.

Returns:
{sap.m.ValueColor} Value of property color
getDisplayValue(): string
Gets current value of property displayValue.

If this property is set then it will be displayed instead of value.

Default value is .

Returns:
{string} Value of property displayValue
getTitle(): string
Gets current value of property title.

The comparison bar title.

Default value is .

Returns:
{string} Value of property title
getValue(): float
Gets current value of property value.

The value for comparison.

Default value is 0.

Returns:
{float} Value of property value
setColor(sColor): sap.suite.ui.microchart.ComparisonMicroChartData
Sets a new value for property color.

The semantic color of the value.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is Neutral.

Parameters:
{sap.m.ValueColor}sColor New value for property color
Returns:
{sap.suite.ui.microchart.ComparisonMicroChartData} Reference to this in order to allow method chaining
setDisplayValue(sDisplayValue): sap.suite.ui.microchart.ComparisonMicroChartData
Sets a new value for property displayValue.

If this property is set then it will be displayed instead of value.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is .

Parameters:
{string}sDisplayValue New value for property displayValue
Returns:
{sap.suite.ui.microchart.ComparisonMicroChartData} Reference to this in order to allow method chaining
setTitle(sTitle): sap.suite.ui.microchart.ComparisonMicroChartData
Sets a new value for property title.

The comparison bar title.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is .

Parameters:
{string}sTitle New value for property title
Returns:
{sap.suite.ui.microchart.ComparisonMicroChartData} Reference to this in order to allow method chaining
setValue(fValue): sap.suite.ui.microchart.ComparisonMicroChartData
Sets a new value for property value.

The value for comparison.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 0.

Parameters:
{float}fValue New value for property value
Returns:
{sap.suite.ui.microchart.ComparisonMicroChartData} Reference to this in order to allow method chaining