Class sap.viz.ui5.types.PieModule: sap/viz/ui5/types/Pie

extends BaseStructuredType

Module sap.viz.ui5.types.Pie

Deprecated API:Since version 1.32.0. The chart controls in the sap.viz.ui5 package (which were always marked as experimental) have been deprecated since 1.32.0. They are no longer actively developed and won't receive new features or improvements, only important bug fixes. They will only remain in the SAPUI5 distribution for backward compatibility.

SAP strongly recommends that existing consumers of those controls migrate to the new VizFrame control to benefit from new charting enhancements and timely support.

Note: As the feature set, design and API usage of VizFrame might differ from the old chart controls, make sure you evaluate it thoroughly before migration.

Experimental API:Since version 1.7.2. Charting API is not finished yet and might change completely.


Since: 1.7.2.
Constructor Summary
new sap.viz.ui5.types.Pie(sId?, mSettings?)Constructor for a new sap.viz.ui5.types.Pie

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.

Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.viz.ui5.types.Pie.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.viz.ui5.types.Pie with name sClassName and enriches it with the information contained in oClassInfo.
sap.viz.ui5.types.Pie.getMetadata()Returns a metadata object for class sap.viz.ui5.types.Pie.
destroyAnimation()Destroys the animation in the aggregation animation.
getAnimation()Gets content of aggregation animation.
getColorPalette()Gets current value of property colorPalette.
getDrawingEffect()Gets current value of property drawingEffect.
getFormatRules()Gets current value of property formatRules.
getIsDonut()Gets current value of property isDonut.
setAnimation(oAnimation)Sets the aggregated animation.
setColorPalette(sColorPalette)Sets a new value for property colorPalette.
setDrawingEffect(sDrawingEffect)Sets a new value for property drawingEffect.
setFormatRules(sFormatRules)Sets a new value for property formatRules.
setIsDonut(bIsDonut)Sets a new value for property isDonut.
destroyToolTip()Destroys the toolTip in the aggregation toolTip.
getIsGeoPie()Gets current value of property isGeoPie.
getPlotScale()Gets current value of property plotScale.
getToolTip()Gets content of aggregation toolTip.
getValign()Gets current value of property valign.
setIsGeoPie(bIsGeoPie)Sets a new value for property isGeoPie.
setPlotScale(fPlotScale)Sets a new value for property plotScale.
setToolTip(oToolTip)Sets the aggregated toolTip.
setValign(sValign)Sets a new value for property valign.
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, 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, rerender, 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, invalidate, 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.viz.ui5.types.Pie(sId?, mSettings?)
Constructor for a new sap.viz.ui5.types.Pie

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.viz.ui5.core.BaseStructuredType 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
Deprecated:
Since version 1.32.0. The chart controls in the sap.viz.ui5 package (which were always marked as experimental) have been deprecated since 1.32.0. They are no longer actively developed and won't receive new features or improvements, only important bug fixes. They will only remain in the SAPUI5 distribution for backward compatibility.

SAP strongly recommends that existing consumers of those controls migrate to the new VizFrame control to benefit from new charting enhancements and timely support.

Note: As the feature set, design and API usage of VizFrame might differ from the old chart controls, make sure you evaluate it thoroughly before migration.

Method Detail
sap.viz.ui5.types.Pie.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.viz.ui5.types.Pie with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.viz.ui5.core.BaseStructuredType.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.viz.ui5.types.Pie.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.viz.ui5.types.Pie.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
destroyAnimation(): sap.viz.ui5.types.Pie
Destroys the animation in the aggregation animation.
Returns:
{sap.viz.ui5.types.Pie} Reference to this in order to allow method chaining
getAnimation(): sap.viz.ui5.types.Pie_animation
Gets content of aggregation animation.

Settings for animations in the plot area

Returns:
{sap.viz.ui5.types.Pie_animation}
getColorPalette(): string[]
Gets current value of property colorPalette.

Set the color palette for the sectors of the pie chart

Default value is ???.

Returns:
{string[]} Value of property colorPalette
getDrawingEffect(): sap.viz.ui5.types.Pie_drawingEffect
Gets current value of property drawingEffect.

Set the drawing effect of the pie

Default value is normal.

Returns:
{sap.viz.ui5.types.Pie_drawingEffect} Value of property drawingEffect
getFormatRules(): object[]
Gets current value of property formatRules.

Rules to format data points, sample: [{condition: [{Key1:"Value1", Key2:"Value2"}], color:"#00ff00"}, {condition: [{Key3:"Value3"}], color:"#00ffff"}]. Each rule has two properties: "condition" and "color". The relation among the condition object in "condition" array is "OR", which means the data point that met any condition in the array will apply the "color". If multiple rules could apply on the same data point, the last rule would take effect.

Returns:
{object[]} Value of property formatRules
getIsDonut(): boolean
Gets current value of property isDonut.

Set the chart to display as a donut or a pie. If this value is set to 'true', the chart displays as a donut. If this value is set to 'false', the chart displays as a pie.

Default value is false.

Returns:
{boolean} Value of property isDonut
setAnimation(oAnimation): sap.viz.ui5.types.Pie
Sets the aggregated animation.
Parameters:
{sap.viz.ui5.types.Pie_animation}oAnimation The animation to set
Returns:
{sap.viz.ui5.types.Pie} Reference to this in order to allow method chaining
setColorPalette(sColorPalette): sap.viz.ui5.types.Pie
Sets a new value for property colorPalette.

Set the color palette for the sectors of the pie chart

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

Default value is ???.

Parameters:
{string[]}sColorPalette New value for property colorPalette
Returns:
{sap.viz.ui5.types.Pie} Reference to this in order to allow method chaining
setDrawingEffect(sDrawingEffect): sap.viz.ui5.types.Pie
Sets a new value for property drawingEffect.

Set the drawing effect of the pie

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

Default value is normal.

Parameters:
{sap.viz.ui5.types.Pie_drawingEffect}sDrawingEffect New value for property drawingEffect
Returns:
{sap.viz.ui5.types.Pie} Reference to this in order to allow method chaining
setFormatRules(sFormatRules): sap.viz.ui5.types.Pie
Sets a new value for property formatRules.

Rules to format data points, sample: [{condition: [{Key1:"Value1", Key2:"Value2"}], color:"#00ff00"}, {condition: [{Key3:"Value3"}], color:"#00ffff"}]. Each rule has two properties: "condition" and "color". The relation among the condition object in "condition" array is "OR", which means the data point that met any condition in the array will apply the "color". If multiple rules could apply on the same data point, the last rule would take effect.

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

Parameters:
{object[]}sFormatRules New value for property formatRules
Returns:
{sap.viz.ui5.types.Pie} Reference to this in order to allow method chaining
setIsDonut(bIsDonut): sap.viz.ui5.types.Pie
Sets a new value for property isDonut.

Set the chart to display as a donut or a pie. If this value is set to 'true', the chart displays as a donut. If this value is set to 'false', the chart displays as a pie.

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

Default value is false.

Parameters:
{boolean}bIsDonut New value for property isDonut
Returns:
{sap.viz.ui5.types.Pie} Reference to this in order to allow method chaining
destroyToolTip(): sap.viz.ui5.types.Pie
Destroys the toolTip in the aggregation toolTip.
Deprecated:
Since version 1.19. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.
Returns:
{sap.viz.ui5.types.Pie} Reference to this in order to allow method chaining
getIsGeoPie(): boolean
Gets current value of property isGeoPie.

Set whether the chart displays as a geo pie chart. If this value is set to 'true', the chart displays as a geo pie chart. If this value is set to 'false', the chart does not display as a geo pie chart.

Default value is false.

Deprecated:
Since version 1.12. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.
Returns:
{boolean} Value of property isGeoPie
getPlotScale(): float
Gets current value of property plotScale.

Set the plot scale of the pie

Default value is 1.

Deprecated:
Since version 1.12. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.
Returns:
{float} Value of property plotScale
getToolTip(): sap.viz.ui5.types.Pie_tooltip
Gets content of aggregation toolTip.

Settings for tooltip related properties

Deprecated:
Since version 1.19. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.
Returns:
{sap.viz.ui5.types.Pie_tooltip}
getValign(): sap.viz.ui5.types.Pie_valign
Gets current value of property valign.

Set the vertical aligment of the chart

Default value is top.

Deprecated:
Since version 1.12. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.
Returns:
{sap.viz.ui5.types.Pie_valign} Value of property valign
setIsGeoPie(bIsGeoPie): sap.viz.ui5.types.Pie
Sets a new value for property isGeoPie.

Set whether the chart displays as a geo pie chart. If this value is set to 'true', the chart displays as a geo pie chart. If this value is set to 'false', the chart does not display as a geo pie chart.

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

Default value is false.

Parameters:
{boolean}bIsGeoPie New value for property isGeoPie
Deprecated:
Since version 1.12. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.
Returns:
{sap.viz.ui5.types.Pie} Reference to this in order to allow method chaining
setPlotScale(fPlotScale): sap.viz.ui5.types.Pie
Sets a new value for property plotScale.

Set the plot scale of the pie

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

Default value is 1.

Parameters:
{float}fPlotScale New value for property plotScale
Deprecated:
Since version 1.12. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.
Returns:
{sap.viz.ui5.types.Pie} Reference to this in order to allow method chaining
setToolTip(oToolTip): sap.viz.ui5.types.Pie
Sets the aggregated toolTip.
Parameters:
{sap.viz.ui5.types.Pie_tooltip}oToolTip The toolTip to set
Deprecated:
Since version 1.19. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.
Returns:
{sap.viz.ui5.types.Pie} Reference to this in order to allow method chaining
setValign(sValign): sap.viz.ui5.types.Pie
Sets a new value for property valign.

Set the vertical aligment of the chart

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

Default value is top.

Parameters:
{sap.viz.ui5.types.Pie_valign}sValign New value for property valign
Deprecated:
Since version 1.12. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.
Returns:
{sap.viz.ui5.types.Pie} Reference to this in order to allow method chaining