Class sap.suite.ui.microchart.RadialMicroChartModule: sap/suite/ui/microchart/RadialMicroChart

extends Control

Displays a ring chart highlighting a current status. The status is displayed with a semantically colored radial bar and a percentage value.


Since: 1.36.0.
Constructor Summary
new sap.suite.ui.microchart.RadialMicroChart(sId?, mSettings?)Describes the configuration of the graphic element on the chart.
Event Summary
press(oControlEvent)The event is triggered when the chart is pressed.
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.microchart.RadialMicroChart.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.microchart.RadialMicroChart with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.microchart.RadialMicroChart.getMetadata()Returns a metadata object for class sap.suite.ui.microchart.RadialMicroChart.
attachPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the press event of this sap.suite.ui.microchart.RadialMicroChart.
detachPress(fnFunction, oListener)Detaches event handler fnFunction from the press event of this sap.suite.ui.microchart.RadialMicroChart.
firePress(mArguments?)Fires event press to attached listeners.
getFraction()Gets current value of property fraction.
getPercentage()Gets current value of property percentage.
getTotal()Gets current value of property total.
getValueColor()Gets current value of property valueColor.
setFraction(fFraction)Sets a new value for property fraction.
setPercentage(fPercentage)Sets a new value for property percentage.
setTotal(fTotal)Sets a new value for property total.
setValueColor(sValueColor)Sets a new value for property valueColor.
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, 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, 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.microchart.RadialMicroChart(sId?, mSettings?)
Describes the configuration of the graphic element on the chart.

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.Control 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 triggered when the chart is pressed.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Method Detail
sap.suite.ui.microchart.RadialMicroChart.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.suite.ui.microchart.RadialMicroChart 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.Control.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.RadialMicroChart.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.suite.ui.microchart.RadialMicroChart.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
attachPress(oData?, fnFunction, oListener?): sap.suite.ui.microchart.RadialMicroChart
Attaches event handler fnFunction to the press event of this sap.suite.ui.microchart.RadialMicroChart.

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.RadialMicroChart itself.

The event is triggered when the chart is pressed.

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.RadialMicroChart itself
Returns:
{sap.suite.ui.microchart.RadialMicroChart} Reference to this in order to allow method chaining
detachPress(fnFunction, oListener): sap.suite.ui.microchart.RadialMicroChart
Detaches event handler fnFunction from the press event of this sap.suite.ui.microchart.RadialMicroChart.

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.RadialMicroChart} Reference to this in order to allow method chaining
firePress(mArguments?): sap.suite.ui.microchart.RadialMicroChart
Fires event press to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.suite.ui.microchart.RadialMicroChart} Reference to this in order to allow method chaining
getFraction(): float
Gets current value of property fraction.

The fraction of the total value that is displayed.

Returns:
{float} Value of property fraction
getPercentage(): float
Gets current value of property percentage.

The percentage that is displayed. When a percentage is set, properties total and fraction are not considered.

Returns:
{float} Value of property percentage
getTotal(): float
Gets current value of property total.

The total value. This is taken as 360 degrees value on the chart.

Returns:
{float} Value of property total
getValueColor(): sap.m.ValueCSSColor
Gets current value of property valueColor.

The color shown in the completed path.

Default value is Neutral.

Returns:
{sap.m.ValueCSSColor} Value of property valueColor
setFraction(fFraction): sap.suite.ui.microchart.RadialMicroChart
Sets a new value for property fraction.

The fraction of the total value that is displayed.

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

Parameters:
{float}fFraction New value for property fraction
Returns:
{sap.suite.ui.microchart.RadialMicroChart} Reference to this in order to allow method chaining
setPercentage(fPercentage): sap.suite.ui.microchart.RadialMicroChart
Sets a new value for property percentage.

The percentage that is displayed. When a percentage is set, properties total and fraction are not considered.

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

Parameters:
{float}fPercentage New value for property percentage
Returns:
{sap.suite.ui.microchart.RadialMicroChart} Reference to this in order to allow method chaining
setTotal(fTotal): sap.suite.ui.microchart.RadialMicroChart
Sets a new value for property total.

The total value. This is taken as 360 degrees value on the chart.

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

Parameters:
{float}fTotal New value for property total
Returns:
{sap.suite.ui.microchart.RadialMicroChart} Reference to this in order to allow method chaining
setValueColor(sValueColor): sap.suite.ui.microchart.RadialMicroChart
Sets a new value for property valueColor.

The color shown in the completed path.

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.ValueCSSColor}sValueColor New value for property valueColor
Returns:
{sap.suite.ui.microchart.RadialMicroChart} Reference to this in order to allow method chaining