Class sap.suite.ui.microchart.DeltaMicroChartModule: sap/suite/ui/microchart/DeltaMicroChart
Represents the delta of two values as a chart. This control replaces the deprecated sap.suite.ui.commons.DeltaMicroChart.
Since: 1.34.
sClassName and enriches it with the information contained in oClassInfo.fnFunction to the press event of this sap.suite.ui.microchart.DeltaMicroChart.fnFunction from the press event of this sap.suite.ui.microchart.DeltaMicroChart. 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
- value1 : float
- value2 : float
- title1 : string
- title2 : string
- displayValue1 : string
- displayValue2 : string
- deltaDisplayValue : string
- color : sap.m.ValueColor (default: Neutral)
- width : sap.ui.core.CSSSize
- size : sap.m.Size (default: Auto)
- isResponsive : boolean (default: false)
- Events
- press : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
In addition, all settings applicable to the base type sap.ui.core.Control 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 |
| {sap.ui.base.Event} | oControlEvent | |
| {sap.ui.base.EventProvider} | oControlEvent.getSource | |
| {object} | oControlEvent.getParameters |
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.
| {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 |
| {function} | Created class / constructor function |
| {sap.ui.base.Metadata} | Metadata object describing this class |
fnFunction to the press event of this sap.suite.ui.microchart.DeltaMicroChart. 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.DeltaMicroChart itself.
The event is fired when the user chooses the delta micro chart.
| {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.DeltaMicroChart itself |
| {sap.suite.ui.microchart.DeltaMicroChart} | Reference to this in order to allow method chaining |
fnFunction from the press event of this sap.suite.ui.microchart.DeltaMicroChart. The passed function and listener object must match the ones used for event registration.
| {function} | fnFunction | The function to be called, when the event occurs |
| {object} | oListener | Context object on which the given function had to be called |
| {sap.suite.ui.microchart.DeltaMicroChart} | Reference to this in order to allow method chaining |
press to attached listeners. | {Map} | mArguments? | The arguments to pass along with the event |
| {sap.suite.ui.microchart.DeltaMicroChart} | Reference to this in order to allow method chaining |
color. The semantic color of the delta value.
Default value is Neutral.
| {sap.m.ValueColor} | Value of property color |
deltaDisplayValue. If this property is set, it is rendered instead of a calculated delta.
| {string} | Value of property deltaDisplayValue |
displayValue1. If this property is set, it is rendered instead of value1.
| {string} | Value of property displayValue1 |
displayValue2. If this property is set, it is rendered instead of value2.
| {string} | Value of property displayValue2 |
isResponsive. If this set to true, width and height of the control are determined by the width and height of the container in which the control is placed. Size and Width properties are ignored in such case.
Default value is false.
- Since:
- 1.38.0
| {boolean} | Value of property isResponsive |
size. The size of the chart. If is not set, the default size is applied based on the device type.
Default value is Auto.
| {sap.m.Size} | Value of property size |
title1. The first value title.
| {string} | Value of property title1 |
title2. The second value title.
| {string} | Value of property title2 |
value1. The first value for delta calculation.
| {float} | Value of property value1 |
value2. The second value for delta calculation.
| {float} | Value of property value2 |
width. The width of the chart.
| {sap.ui.core.CSSSize} | Value of property width |
color. The semantic color of the delta value.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is Neutral.
| {sap.m.ValueColor} | sColor | New value for property color |
| {sap.suite.ui.microchart.DeltaMicroChart} | Reference to this in order to allow method chaining |
deltaDisplayValue. If this property is set, it is rendered instead of a calculated delta.
When called with a value of null or undefined, the default value of the property will be restored.
| {string} | sDeltaDisplayValue | New value for property deltaDisplayValue |
| {sap.suite.ui.microchart.DeltaMicroChart} | Reference to this in order to allow method chaining |
displayValue1. If this property is set, it is rendered instead of value1.
When called with a value of null or undefined, the default value of the property will be restored.
| {string} | sDisplayValue1 | New value for property displayValue1 |
| {sap.suite.ui.microchart.DeltaMicroChart} | Reference to this in order to allow method chaining |
displayValue2. If this property is set, it is rendered instead of value2.
When called with a value of null or undefined, the default value of the property will be restored.
| {string} | sDisplayValue2 | New value for property displayValue2 |
| {sap.suite.ui.microchart.DeltaMicroChart} | Reference to this in order to allow method chaining |
isResponsive. If this set to true, width and height of the control are determined by the width and height of the container in which the control is placed. Size and Width properties are ignored in such case.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is false.
| {boolean} | bIsResponsive | New value for property isResponsive |
- Since:
- 1.38.0
| {sap.suite.ui.microchart.DeltaMicroChart} | Reference to this in order to allow method chaining |
size. The size of the chart. If is not set, the default size is applied based on the device type.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is Auto.
| {sap.m.Size} | sSize | New value for property size |
| {sap.suite.ui.microchart.DeltaMicroChart} | Reference to this in order to allow method chaining |
title1. The first value title.
When called with a value of null or undefined, the default value of the property will be restored.
| {string} | sTitle1 | New value for property title1 |
| {sap.suite.ui.microchart.DeltaMicroChart} | Reference to this in order to allow method chaining |
title2. The second value title.
When called with a value of null or undefined, the default value of the property will be restored.
| {string} | sTitle2 | New value for property title2 |
| {sap.suite.ui.microchart.DeltaMicroChart} | Reference to this in order to allow method chaining |
value1. The first value for delta calculation.
When called with a value of null or undefined, the default value of the property will be restored.
| {float} | fValue1 | New value for property value1 |
| {sap.suite.ui.microchart.DeltaMicroChart} | Reference to this in order to allow method chaining |
value2. The second value for delta calculation.
When called with a value of null or undefined, the default value of the property will be restored.
| {float} | fValue2 | New value for property value2 |
| {sap.suite.ui.microchart.DeltaMicroChart} | Reference to this in order to allow method chaining |
width. The width of the chart.
When called with a value of null or undefined, the default value of the property will be restored.
| {sap.ui.core.CSSSize} | sWidth | New value for property width |
| {sap.suite.ui.microchart.DeltaMicroChart} | Reference to this in order to allow method chaining |