Class sap.suite.ui.microchart.BulletMicroChartModule: sap/suite/ui/microchart/BulletMicroChart
Displays a colored horizontal bar representing a current value on top of a background bar representing the compared value. The vertical bars can represent the numeric values, the scaling factors, the thresholds, and the target values. This control replaces the deprecated sap.suite.ui.commons.BulletChart.
Since: 1.34.
sClassName
and enriches it with the information contained in oClassInfo
.fnFunction
to the press
event of this sap.suite.ui.microchart.BulletMicroChart
.fnFunction
from the press
event of this sap.suite.ui.microchart.BulletMicroChart
.sap.suite.ui.microchart.BulletMicroChartData
in the aggregation thresholds
. 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
- size : sap.m.Size (default: Auto)
- mode : sap.suite.ui.microchart.BulletMicroChartModeType (default: Actual)
- scale : string (default: )
- forecastValue : float
- targetValue : float
- minValue : float
- maxValue : float
- showActualValue : boolean (default: true)
- showDeltaValue : boolean (default: true)
- showTargetValue : boolean (default: true)
- showValueMarker : boolean (default: false)
- actualValueLabel : string (default: )
- deltaValueLabel : string (default: )
- targetValueLabel : string (default: )
- width : sap.ui.core.CSSSize
- scaleColor : sap.suite.ui.microchart.CommonBackgroundType (default: MediumLight)
- isResponsive : boolean (default: false)
- Aggregations
- actual : sap.suite.ui.microchart.BulletMicroChartData (default)
- thresholds : sap.suite.ui.microchart.BulletMicroChartData[]
- 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 |
thresholds
. {sap.suite.ui.microchart.BulletMicroChartData} | oThreshold | the threshold to add; if empty, nothing is inserted |
{sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |
fnFunction
to the press
event of this sap.suite.ui.microchart.BulletMicroChart
. 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.BulletMicroChart
itself.
The event is triggered when the chart is pressed.
{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.BulletMicroChart itself |
{sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |
actual
to model data. See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo
.
{object} | oBindingInfo | The binding information |
{sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |
thresholds
to model data. See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo
.
{object} | oBindingInfo | The binding information |
{sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |
actual
. {sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |
thresholds
. {sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |
fnFunction
from the press
event of this sap.suite.ui.microchart.BulletMicroChart
. 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.BulletMicroChart} | 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.BulletMicroChart} | Reference to this in order to allow method chaining |
actual
. Actual data of the BulletMicroChart.
{sap.suite.ui.microchart.BulletMicroChartData} |
actualValueLabel
. If set, displays a specified label instead of the numeric actual value.
Default value is .
{string} | Value of property actualValueLabel |
deltaValueLabel
. If set, displays a specified label instead of the calculated numeric delta value.
Default value is .
{string} | Value of property deltaValueLabel |
forecastValue
. The forecast value that is displayed in Actual mode only. If set, the forecast value bar appears in the background of the actual value bar.
{float} | Value of property forecastValue |
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 |
maxValue
. The maximum scale value for the bar chart used for defining a fixed size of the scale in different instances of this control.
{float} | Value of property maxValue |
minValue
. The minimum scale value for the bar chart used for defining a fixed size of the scale in different instances of this control.
{float} | Value of property minValue |
mode
. The mode of displaying the actual value itself or the delta between the actual value and the target value. If not set, the actual value is displayed.
Default value is Actual
.
{sap.suite.ui.microchart.BulletMicroChartModeType} | Value of property mode |
scale
. The scaling suffix that is added to the actual and target values.
Default value is .
{string} | Value of property scale |
scaleColor
. The background color of the scale.
Default value is MediumLight
.
{sap.suite.ui.microchart.CommonBackgroundType} | Value of property scaleColor |
showActualValue
. If set to true, shows the numeric actual value. This property works in Actual mode only.
Default value is true
.
{boolean} | Value of property showActualValue |
showDeltaValue
. If set to true, shows the calculated delta value instead of the numeric actual value regardless of the showActualValue setting. This property works in Delta mode only.
Default value is true
.
{boolean} | Value of property showDeltaValue |
showTargetValue
. If set to true, shows the numeric target value.
Default value is true
.
{boolean} | Value of property showTargetValue |
showValueMarker
. If set to true, shows the value marker.
Default value is false
.
{boolean} | Value of property showValueMarker |
size
. The size of the microchart. If not set, the default size is applied based on the size of the device tile.
Default value is Auto
.
{sap.m.Size} | Value of property size |
targetValue
. The target value that is displayed as a black vertical bar.
{float} | Value of property targetValue |
targetValueLabel
. If set, displays a specified label instead of the numeric target value.
Default value is .
{string} | Value of property targetValueLabel |
thresholds
. Threshold data of the BulletMicroChart.
{sap.suite.ui.microchart.BulletMicroChartData[]} |
width
. The width of the chart. If it is not set, the size of the control is defined by the size property.
{sap.ui.core.CSSSize} | Value of property width |
sap.suite.ui.microchart.BulletMicroChartData
in the aggregation thresholds
. and returns its index if found or -1 otherwise. {sap.suite.ui.microchart.BulletMicroChartData} | oThreshold | The threshold whose index is looked for |
{int} | The index of the provided control in the aggregation if found, or -1 otherwise |
thresholds
. {sap.suite.ui.microchart.BulletMicroChartData} | oThreshold | the threshold to insert; if empty, nothing is inserted |
{int} | iIndex | the 0 -based index the threshold should be inserted at; for a negative value of iIndex , the threshold is inserted at position 0; for a value greater than the current size of the aggregation, the threshold is inserted at the last position |
{sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |
thresholds
. Additionally, it unregisters them from the hosting UIArea.
{sap.suite.ui.microchart.BulletMicroChartData[]} | An array of the removed elements (might be empty) |
thresholds
. {int|string|sap.suite.ui.microchart.BulletMicroChartData} | vThreshold | The thresholdto remove or its index or id |
{sap.suite.ui.microchart.BulletMicroChartData} | The removed threshold or null |
actual
. {sap.suite.ui.microchart.BulletMicroChartData} | oActual | The actual to set |
{sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |
actualValueLabel
. If set, displays a specified label instead of the numeric actual value.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is .
{string} | sActualValueLabel | New value for property actualValueLabel |
{sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |
deltaValueLabel
. If set, displays a specified label instead of the calculated numeric delta value.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is .
{string} | sDeltaValueLabel | New value for property deltaValueLabel |
{sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |
forecastValue
. The forecast value that is displayed in Actual mode only. If set, the forecast value bar appears in the background of the actual value bar.
When called with a value of null
or undefined
, the default value of the property will be restored.
{float} | fForecastValue | New value for property forecastValue |
{sap.suite.ui.microchart.BulletMicroChart} | 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.BulletMicroChart} | Reference to this in order to allow method chaining |
maxValue
. The maximum scale value for the bar chart used for defining a fixed size of the scale in different instances of this control.
When called with a value of null
or undefined
, the default value of the property will be restored.
{float} | fMaxValue | New value for property maxValue |
{sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |
minValue
. The minimum scale value for the bar chart used for defining a fixed size of the scale in different instances of this control.
When called with a value of null
or undefined
, the default value of the property will be restored.
{float} | fMinValue | New value for property minValue |
{sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |
mode
. The mode of displaying the actual value itself or the delta between the actual value and the target value. If not set, the actual value is displayed.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is Actual
.
{sap.suite.ui.microchart.BulletMicroChartModeType} | sMode | New value for property mode |
{sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |
scale
. The scaling suffix that is added to the actual and target values.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is .
{string} | sScale | New value for property scale |
{sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |
scaleColor
. The background color of the scale.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is MediumLight
.
{sap.suite.ui.microchart.CommonBackgroundType} | sScaleColor | New value for property scaleColor |
{sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |
showActualValue
. If set to true, shows the numeric actual value. This property works in Actual mode only.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
{boolean} | bShowActualValue | New value for property showActualValue |
{sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |
showDeltaValue
. If set to true, shows the calculated delta value instead of the numeric actual value regardless of the showActualValue setting. This property works in Delta mode only.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
{boolean} | bShowDeltaValue | New value for property showDeltaValue |
{sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |
showTargetValue
. If set to true, shows the numeric target value.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
{boolean} | bShowTargetValue | New value for property showTargetValue |
{sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |
showValueMarker
. If set to true, shows the value marker.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
{boolean} | bShowValueMarker | New value for property showValueMarker |
{sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |
size
. The size of the microchart. If not set, the default size is applied based on the size of the device tile.
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.BulletMicroChart} | Reference to this in order to allow method chaining |
targetValue
. The target value that is displayed as a black vertical bar.
When called with a value of null
or undefined
, the default value of the property will be restored.
{float} | fTargetValue | New value for property targetValue |
{sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |
targetValueLabel
. If set, displays a specified label instead of the numeric target value.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is .
{string} | sTargetValueLabel | New value for property targetValueLabel |
{sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |
width
. The width of the chart. If it is not set, the size of the control is defined by the size property.
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.BulletMicroChart} | Reference to this in order to allow method chaining |
actual
from model data. {sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |
thresholds
from model data. {sap.suite.ui.microchart.BulletMicroChart} | Reference to this in order to allow method chaining |