Class sap.ui.vbm.PieModule: sap/ui/vbm/Pie

extends VoBase

Specific Visual Object element for a Pie Chart. A Pie is a round chart, which is positioned with its centerpoint at the given position. The size of the pie can be controlled with property scale. The slices of the pie chart are defined by the aggregated PieItem elements. The detail window will open at the center of the pie.
The property hotDeltaColor borrowed from VoBase is applied only to the hot PieItem and not the whole pie.

Constructor Summary
new sap.ui.vbm.Pie(sId?, mSettings?)Constructor for a new Pie.
Events borrowed from class sap.ui.vbm.VoBase
click, contextMenu, drop, handleClick, handleContextMenu, handleMoved
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.vbm.Pie.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vbm.Pie with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vbm.Pie.getMetadata()Returns a metadata object for class sap.ui.vbm.Pie.
addItem(oItem)Adds some item to the aggregation items.
destroyItems()Destroys all the items in the aggregation items.
getItems()Gets content of aggregation items.
getPosition()Gets current value of property position.
getScale()Gets current value of property scale.
indexOfItem(oItem)Checks for the provided sap.ui.vbm.PieItem in the aggregation items.
insertItem(oItem, iIndex)Inserts a item into the aggregation items.
removeAllItems()Removes all the controls from the aggregation items.
removeItem(vItem)Removes a item from the aggregation items.
setPosition(sPosition)Sets a new value for property position.
setScale(sScale)Sets a new value for property scale.
Methods borrowed from class sap.ui.vbm.VoBase
attachClick, attachContextMenu, attachDrop, attachHandleClick, attachHandleContextMenu, attachHandleMoved, detachClick, detachContextMenu, detachDrop, detachHandleClick, detachHandleContextMenu, detachHandleMoved, fireClick, fireContextMenu, fireDrop, fireHandleClick, fireHandleContextMenu, fireHandleMoved, getChangeable, getDragData, getEntity, getFxdir, getFxsize, getHotDeltaColor, getHotScale, getKey, getLabelArrow, getLabelBgColor, getLabelBorderColor, getLabelPos, getLabelText, getLabelType, getSelect, getSelectColor, openContextMenu, openDetailWindow, setChangeable, setDragData, setEntity, setFxdir, setFxsize, setHotDeltaColor, setHotScale, setKey, setLabelArrow, setLabelBgColor, setLabelBorderColor, setLabelPos, setLabelText, setLabelType, setSelect, setSelectColor
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.ui.vbm.Pie(sId?, mSettings?)
Constructor for a new 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:

  • Properties
  • Aggregations
    • items : sap.ui.vbm.PieItem[] (default)

In addition, all settings applicable to the base type sap.ui.vbm.VoBase 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.ui.vbm.Pie.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.vbm.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.ui.vbm.VoBase.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.ui.vbm.Pie.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vbm.Pie.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addItem(oItem): sap.ui.vbm.Pie
Adds some item to the aggregation items.
Parameters:
{sap.ui.vbm.PieItem}oItem the item to add; if empty, nothing is inserted
Returns:
{sap.ui.vbm.Pie} Reference to this in order to allow method chaining
destroyItems(): sap.ui.vbm.Pie
Destroys all the items in the aggregation items.
Returns:
{sap.ui.vbm.Pie} Reference to this in order to allow method chaining
getItems(): sap.ui.vbm.PieItem[]
Gets content of aggregation items.

PieItem object aggregation. A PieItem holds the data for one slice in a Pie.

Returns:
{sap.ui.vbm.PieItem[]}
getPosition(): string
Gets current value of property position.

The position of the Pie.

Returns:
{string} Value of property position
getScale(): string
Gets current value of property scale.

The scaling of the Pie. The scale must be a vector "x-Scale;y-Scale;z-Scale", but currently only the x scaling is applied to the Pie.

Returns:
{string} Value of property scale
indexOfItem(oItem): int
Checks for the provided sap.ui.vbm.PieItem in the aggregation items. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.vbm.PieItem}oItem The item whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertItem(oItem, iIndex): sap.ui.vbm.Pie
Inserts a item into the aggregation items.
Parameters:
{sap.ui.vbm.PieItem}oItem the item to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the item should be inserted at; for a negative value of iIndex, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
Returns:
{sap.ui.vbm.Pie} Reference to this in order to allow method chaining
removeAllItems(): sap.ui.vbm.PieItem[]
Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.vbm.PieItem[]} An array of the removed elements (might be empty)
removeItem(vItem): sap.ui.vbm.PieItem
Removes a item from the aggregation items.
Parameters:
{int|string|sap.ui.vbm.PieItem}vItem The itemto remove or its index or id
Returns:
{sap.ui.vbm.PieItem} The removed item or null
setPosition(sPosition): sap.ui.vbm.Pie
Sets a new value for property position.

The position of the Pie.

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

Parameters:
{string}sPosition New value for property position
Returns:
{sap.ui.vbm.Pie} Reference to this in order to allow method chaining
setScale(sScale): sap.ui.vbm.Pie
Sets a new value for property scale.

The scaling of the Pie. The scale must be a vector "x-Scale;y-Scale;z-Scale", but currently only the x scaling is applied to the Pie.

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

Parameters:
{string}sScale New value for property scale
Returns:
{sap.ui.vbm.Pie} Reference to this in order to allow method chaining