Class sap.suite.ui.commons.BulletChartModule: sap/suite/ui/commons/BulletChart

extends Control

Chart that displays an actual value as a horizontal bar in semantic color on the top of the background bar, the numeric value, the scaling factor, along with the thresholds, and a target value as vertical bars.

Deprecated API:Since version 1.34. Deprecated. sap.suite.ui.microchart.BulletMicroChart should be used.

Constructor Summary
new sap.suite.ui.commons.BulletChart(sId?, mSettings?)Constructor for a new BulletChart.
Event Summary
press(oControlEvent)The event is fired when the user chooses the bullet chart.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.suite.ui.commons.BulletChart.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.BulletChart with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.BulletChart.getMetadata()Returns a metadata object for class sap.suite.ui.commons.BulletChart.
addThreshold(oThreshold)Adds some threshold oThreshold to the aggregation named thresholds.
attachPress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.BulletChart.
destroyActual()Destroys the actual in the aggregation named actual.
destroyThresholds()Destroys all the thresholds in the aggregation named thresholds.
detachPress(fnFunction, oListener)Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.BulletChart.
firePress(mArguments?)Fire event press to attached listeners.
getActual()Getter for aggregation actual.
getActualValueLabel()Getter for property actualValueLabel.
getDeltaValueLabel()Getter for property deltaValueLabel.
getForecastValue()Getter for property forecastValue.
getMaxValue()Getter for property maxValue.
getMinValue()Getter for property minValue.
getMode()Getter for property mode.
getScale()Getter for property scale.
getScaleColor()Getter for property scaleColor.
getShowActualValue()Getter for property showActualValue.
getShowDeltaValue()Getter for property showDeltaValue.
getShowTargetValue()Getter for property showTargetValue.
getShowValueMarker()Getter for property showValueMarker.
getSize()Getter for property size.
getTargetValue()Getter for property targetValue.
getTargetValueLabel()Getter for property targetValueLabel.
getThresholds()Getter for aggregation thresholds.
getWidth()Getter for property width.
indexOfThreshold(oThreshold)Checks for the provided sap.suite.ui.commons.BulletChartData in the aggregation named thresholds and returns its index if found or -1 otherwise.
insertThreshold(oThreshold, iIndex)Inserts a threshold into the aggregation named thresholds.
removeAllThresholds()Removes all the controls in the aggregation named thresholds.
removeThreshold(vThreshold)Removes an threshold from the aggregation named thresholds.
setActual(oActual)Setter for the aggregated actual.
setActualValueLabel(sActualValueLabel)Setter for property actualValueLabel.
setDeltaValueLabel(sDeltaValueLabel)Setter for property deltaValueLabel.
setForecastValue(fForecastValue)Setter for property forecastValue.
setMaxValue(fMaxValue)Setter for property maxValue.
setMinValue(fMinValue)Setter for property minValue.
setMode(oMode)Setter for property mode.
setScale(sScale)Setter for property scale.
setScaleColor(oScaleColor)Setter for property scaleColor.
setShowActualValue(bShowActualValue)Setter for property showActualValue.
setShowDeltaValue(bShowDeltaValue)Setter for property showDeltaValue.
setShowTargetValue(bShowTargetValue)Setter for property showTargetValue.
setShowValueMarker(bShowValueMarker)Setter for property showValueMarker.
setSize(oSize)Setter for property size.
setTargetValue(fTargetValue)Setter for property targetValue.
setTargetValueLabel(sTargetValueLabel)Setter for property targetValueLabel.
setWidth(sWidth)Setter for property width.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, 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, 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, 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.commons.BulletChart(sId?, mSettings?)
Constructor for a new BulletChart.

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:

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.34. Deprecated. sap.suite.ui.microchart.BulletMicroChart should be used.
Event Detail
press(oControlEvent)
The event is fired when the user chooses the bullet chart.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Method Detail
sap.suite.ui.commons.BulletChart.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.suite.ui.commons.BulletChart 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.BulletChart.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.suite.ui.commons.BulletChart.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addThreshold(oThreshold): sap.suite.ui.commons.BulletChart
Adds some threshold oThreshold to the aggregation named thresholds.
Parameters:
{sap.suite.ui.commons.BulletChartData}oThreshold the threshold to add; if empty, nothing is inserted
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
attachPress(oData?, fnFunction, oListener?): sap.suite.ui.commons.BulletChart
Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.BulletChart.
. When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.BulletChart.
itself.

The event is fired when the user chooses the bullet chart.

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.BulletChart.
itself.
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
destroyActual(): sap.suite.ui.commons.BulletChart
Destroys the actual in the aggregation named actual.
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
destroyThresholds(): sap.suite.ui.commons.BulletChart
Destroys all the thresholds in the aggregation named thresholds.
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
detachPress(fnFunction, oListener): sap.suite.ui.commons.BulletChart
Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.BulletChart.

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.
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
firePress(mArguments?): sap.suite.ui.commons.BulletChart
Fire event press to attached listeners.
Parameters:
{Map}mArguments? the arguments to pass along with the event.
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
getActual(): sap.suite.ui.commons.BulletChartData
Getter for aggregation actual.
The bullet chart actual data.
Returns:
{sap.suite.ui.commons.BulletChartData}
getActualValueLabel(): string
Getter for property actualValueLabel. If set, displays a specified label instead of the numeric actual value.

Default value is empty/undefined

Returns:
{string} the value of property actualValueLabel
getDeltaValueLabel(): string
Getter for property deltaValueLabel. If set, displays a specified label instead of the calculated numeric delta value.

Default value is empty/undefined

Since:
1.23
Returns:
{string} the value of property deltaValueLabel
getForecastValue(): float
Getter for property 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.

Default value is empty/undefined

Since:
1.21
Returns:
{float} the value of property forecastValue
getMaxValue(): float
Getter for property maxValue. The maximum scale value for the bar chart used for defining a fixed size of the scale in different instances of this control.

Default value is empty/undefined

Returns:
{float} the value of property maxValue
getMinValue(): float
Getter for property minValue. The minimum scale value for the bar chart used for defining a fixed size of the scale in different instances of this control.

Default value is empty/undefined

Returns:
{float} the value of property minValue
getMode(): sap.suite.ui.commons.BulletChartMode
Getter for property 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

Since:
1.23
Returns:
{sap.suite.ui.commons.BulletChartMode} the value of property mode
getScale(): string
Getter for property scale. The scaling suffix that is added to the actual and target values.

Default value is empty/undefined

Returns:
{string} the value of property scale
getScaleColor(): sap.suite.ui.commons.CommonBackground
Getter for property scaleColor. The background color of the scale.

Default value is MediumLight

Since:
1.23
Returns:
{sap.suite.ui.commons.CommonBackground} the value of property scaleColor
getShowActualValue(): boolean
Getter for property showActualValue. If set to true, shows the numeric actual value. This property works in Actual mode only.

Default value is true

Returns:
{boolean} the value of property showActualValue
getShowDeltaValue(): boolean
Getter for property 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 false

Since:
1.23
Returns:
{boolean} the value of property showDeltaValue
getShowTargetValue(): boolean
Getter for property showTargetValue. If set to true, shows the numeric target value.

Default value is true

Returns:
{boolean} the value of property showTargetValue
getShowValueMarker(): boolean
Getter for property showValueMarker. If set to true, shows the value marker.

Default value is false

Since:
1.23
Returns:
{boolean} the value of property showValueMarker
getSize(): sap.suite.ui.commons.InfoTileSize
Getter for property size. The size of the chart. If not set, the default size is applied based on the size of the device tile.

Default value is Auto

Returns:
{sap.suite.ui.commons.InfoTileSize} the value of property size
getTargetValue(): float
Getter for property targetValue. The target value that is displayed as a black vertical bar.

Default value is empty/undefined

Returns:
{float} the value of property targetValue
getTargetValueLabel(): string
Getter for property targetValueLabel. If set, displays a specified label instead of the numeric target value.

Default value is empty/undefined

Returns:
{string} the value of property targetValueLabel
getThresholds(): sap.suite.ui.commons.BulletChartData[]
Getter for aggregation thresholds.
The bullet chart thresholds data.
Returns:
{sap.suite.ui.commons.BulletChartData[]}
getWidth(): string
Getter for property width. The width of the chart. If it is not set, the size of the control is defined by the size property.

Default value is empty/undefined

Since:
1.22
Returns:
{string} the value of property width
indexOfThreshold(oThreshold): int
Checks for the provided sap.suite.ui.commons.BulletChartData in the aggregation named thresholds and returns its index if found or -1 otherwise.
Parameters:
{sap.suite.ui.commons.BulletChartData}oThreshold the threshold whose index is looked for.
Returns:
{int} the index of the provided control in the aggregation if found, or -1 otherwise
insertThreshold(oThreshold, iIndex): sap.suite.ui.commons.BulletChart
Inserts a threshold into the aggregation named thresholds.
Parameters:
{sap.suite.ui.commons.BulletChartData}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
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
removeAllThresholds(): sap.suite.ui.commons.BulletChartData[]
Removes all the controls in the aggregation named thresholds.
Additionally unregisters them from the hosting UIArea.
Returns:
{sap.suite.ui.commons.BulletChartData[]} an array of the removed elements (might be empty)
removeThreshold(vThreshold): sap.suite.ui.commons.BulletChartData
Removes an threshold from the aggregation named thresholds.
Parameters:
{int|string|sap.suite.ui.commons.BulletChartData}vThreshold the threshold to remove or its index or id
Returns:
{sap.suite.ui.commons.BulletChartData} the removed threshold or null
setActual(oActual): sap.suite.ui.commons.BulletChart
Setter for the aggregated actual.
Parameters:
{sap.suite.ui.commons.BulletChartData}oActual
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
setActualValueLabel(sActualValueLabel): sap.suite.ui.commons.BulletChart
Setter for property actualValueLabel.

Default value is empty/undefined

Parameters:
{string}sActualValueLabel new value for property actualValueLabel
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
setDeltaValueLabel(sDeltaValueLabel): sap.suite.ui.commons.BulletChart
Setter for property deltaValueLabel.

Default value is empty/undefined

Parameters:
{string}sDeltaValueLabel new value for property deltaValueLabel
Since:
1.23
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
setForecastValue(fForecastValue): sap.suite.ui.commons.BulletChart
Setter for property forecastValue.

Default value is empty/undefined

Parameters:
{float}fForecastValue new value for property forecastValue
Since:
1.21
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
setMaxValue(fMaxValue): sap.suite.ui.commons.BulletChart
Setter for property maxValue.

Default value is empty/undefined

Parameters:
{float}fMaxValue new value for property maxValue
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
setMinValue(fMinValue): sap.suite.ui.commons.BulletChart
Setter for property minValue.

Default value is empty/undefined

Parameters:
{float}fMinValue new value for property minValue
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
setMode(oMode): sap.suite.ui.commons.BulletChart
Setter for property mode.

Default value is Actual

Parameters:
{sap.suite.ui.commons.BulletChartMode}oMode new value for property mode
Since:
1.23
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
setScale(sScale): sap.suite.ui.commons.BulletChart
Setter for property scale.

Default value is empty/undefined

Parameters:
{string}sScale new value for property scale
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
setScaleColor(oScaleColor): sap.suite.ui.commons.BulletChart
Setter for property scaleColor.

Default value is MediumLight

Parameters:
{sap.suite.ui.commons.CommonBackground}oScaleColor new value for property scaleColor
Since:
1.23
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
setShowActualValue(bShowActualValue): sap.suite.ui.commons.BulletChart
Setter for property showActualValue.

Default value is true

Parameters:
{boolean}bShowActualValue new value for property showActualValue
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
setShowDeltaValue(bShowDeltaValue): sap.suite.ui.commons.BulletChart
Setter for property showDeltaValue.

Default value is false

Parameters:
{boolean}bShowDeltaValue new value for property showDeltaValue
Since:
1.23
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
setShowTargetValue(bShowTargetValue): sap.suite.ui.commons.BulletChart
Setter for property showTargetValue.

Default value is true

Parameters:
{boolean}bShowTargetValue new value for property showTargetValue
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
setShowValueMarker(bShowValueMarker): sap.suite.ui.commons.BulletChart
Setter for property showValueMarker.

Default value is false

Parameters:
{boolean}bShowValueMarker new value for property showValueMarker
Since:
1.23
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
setSize(oSize): sap.suite.ui.commons.BulletChart
Setter for property size.

Default value is Auto

Parameters:
{sap.suite.ui.commons.InfoTileSize}oSize new value for property size
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
setTargetValue(fTargetValue): sap.suite.ui.commons.BulletChart
Setter for property targetValue.

Default value is empty/undefined

Parameters:
{float}fTargetValue new value for property targetValue
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
setTargetValueLabel(sTargetValueLabel): sap.suite.ui.commons.BulletChart
Setter for property targetValueLabel.

Default value is empty/undefined

Parameters:
{string}sTargetValueLabel new value for property targetValueLabel
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining
setWidth(sWidth): sap.suite.ui.commons.BulletChart
Setter for property width.

Default value is empty/undefined

Parameters:
{string}sWidth new value for property width
Since:
1.22
Returns:
{sap.suite.ui.commons.BulletChart}this to allow method chaining