Class sap.suite.ui.microchart.HarveyBallMicroChartItemModule: sap/suite/ui/microchart/HarveyBallMicroChartItem

extends Control

Configures the slices of the pie chart.


Since: 1.34.
Constructor Summary
new sap.suite.ui.microchart.HarveyBallMicroChartItem(sId?, mSettings?)The configuration of the graphic element on the chart.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.suite.ui.microchart.HarveyBallMicroChartItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.microchart.HarveyBallMicroChartItem with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.microchart.HarveyBallMicroChartItem.getMetadata()Returns a metadata object for class sap.suite.ui.microchart.HarveyBallMicroChartItem.
getColor()Gets current value of property color.
getFormattedLabel()Gets current value of property formattedLabel.
getFraction()Gets current value of property fraction.
getFractionLabel()Gets current value of property fractionLabel.
getFractionScale()Gets current value of property fractionScale.
setColor(sColor)Sets a new value for property color.
setFormattedLabel(bFormattedLabel)Sets a new value for property formattedLabel.
setFraction(fFraction)Sets a new value for property fraction.
setFractionLabel(sFractionLabel)Sets a new value for property fractionLabel.
setFractionScale(sFractionScale)Sets a new value for property fractionScale.
Constructor Detail
new sap.suite.ui.microchart.HarveyBallMicroChartItem(sId?, mSettings?)
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:

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
Method Detail
sap.suite.ui.microchart.HarveyBallMicroChartItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.suite.ui.microchart.HarveyBallMicroChartItem 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.HarveyBallMicroChartItem.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.suite.ui.microchart.HarveyBallMicroChartItem.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getColor(): sap.m.ValueColor
Gets current value of property color.

The slice color.

Default value is Neutral.

Returns:
{sap.m.ValueColor} Value of property color
getFormattedLabel(): boolean
Gets current value of property formattedLabel.

If set to true, the fractionLabel parameter is considered as the combination of the fraction value and scaling factor. The default value is false. It means that the fraction value and the scaling factor are defined separately by the fraction and the fractionScale properties accordingly.

Default value is false.

Returns:
{boolean} Value of property formattedLabel
getFraction(): float
Gets current value of property fraction.

The fraction value.

Default value is 0.

Returns:
{float} Value of property fraction
getFractionLabel(): string
Gets current value of property fractionLabel.

The fraction label. If specified, it is displayed instead of the fraction value.

Returns:
{string} Value of property fractionLabel
getFractionScale(): string
Gets current value of property fractionScale.

The scaling factor that is displayed after the fraction value.

Returns:
{string} Value of property fractionScale
Sets a new value for property color.

The slice color.

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.HarveyBallMicroChartItem} Reference to this in order to allow method chaining
setFormattedLabel(bFormattedLabel): sap.suite.ui.microchart.HarveyBallMicroChartItem
Sets a new value for property formattedLabel.

If set to true, the fractionLabel parameter is considered as the combination of the fraction value and scaling factor. The default value is false. It means that the fraction value and the scaling factor are defined separately by the fraction and the fractionScale properties accordingly.

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

Default value is false.

Parameters:
{boolean}bFormattedLabel New value for property formattedLabel
Returns:
{sap.suite.ui.microchart.HarveyBallMicroChartItem} Reference to this in order to allow method chaining
Sets a new value for property fraction.

The fraction value.

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

Default value is 0.

Parameters:
{float}fFraction New value for property fraction
Returns:
{sap.suite.ui.microchart.HarveyBallMicroChartItem} Reference to this in order to allow method chaining
setFractionLabel(sFractionLabel): sap.suite.ui.microchart.HarveyBallMicroChartItem
Sets a new value for property fractionLabel.

The fraction label. If specified, it is displayed instead of the fraction value.

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

Parameters:
{string}sFractionLabel New value for property fractionLabel
Returns:
{sap.suite.ui.microchart.HarveyBallMicroChartItem} Reference to this in order to allow method chaining
setFractionScale(sFractionScale): sap.suite.ui.microchart.HarveyBallMicroChartItem
Sets a new value for property fractionScale.

The scaling factor that is displayed after the fraction value.

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

Parameters:
{string}sFractionScale New value for property fractionScale
Returns:
{sap.suite.ui.microchart.HarveyBallMicroChartItem} Reference to this in order to allow method chaining