Class sap.ui.vbm.PieItemModule: sap/ui/vbm/PieItem

extends Element

Slice element for a Pie Chart.

Constructor Summary
new sap.ui.vbm.PieItem(sId?, mSettings?)Constructor for a new PieItem.
Event Summary
click(oControlEvent)The event is raised when there is a click action on a pie item.
Method Summary
sap.ui.vbm.PieItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vbm.PieItem with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vbm.PieItem.getMetadata()Returns a metadata object for class sap.ui.vbm.PieItem.
attachClick(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the click event of this sap.ui.vbm.PieItem.
detachClick(fnFunction, oListener)Detaches event handler fnFunction from the click event of this sap.ui.vbm.PieItem.
fireClick(mArguments?)Fires event click to attached listeners.
getName()Gets current value of property name.
getValue()Gets current value of property value.
setName(sName)Sets a new value for property name.
setValue(sValue)Sets a new value for property value.
Constructor Detail
new sap.ui.vbm.PieItem(sId?, mSettings?)
Constructor for a new PieItem.

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
    • click : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.core.Element 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
click(oControlEvent)
The event is raised when there is a click action on a pie item.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Method Detail
sap.ui.vbm.PieItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.vbm.PieItem 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.Element.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.PieItem.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vbm.PieItem.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
attachClick(oData?, fnFunction, oListener?): sap.ui.vbm.PieItem
Attaches event handler fnFunction to the click event of this sap.ui.vbm.PieItem.

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.ui.vbm.PieItem itself.

The event is raised when there is a click action on a pie item.

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.ui.vbm.PieItem itself
Returns:
{sap.ui.vbm.PieItem} Reference to this in order to allow method chaining
detachClick(fnFunction, oListener): sap.ui.vbm.PieItem
Detaches event handler fnFunction from the click event of this sap.ui.vbm.PieItem.

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.ui.vbm.PieItem} Reference to this in order to allow method chaining
fireClick(mArguments?): sap.ui.vbm.PieItem
Fires event click to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.PieItem} Reference to this in order to allow method chaining
getName(): string
Gets current value of property name.

The name of the Pie item.

Default value is .

Returns:
{string} Value of property name
getValue(): string
Gets current value of property value.

The value of the Pie item.

Returns:
{string} Value of property value
setName(sName): sap.ui.vbm.PieItem
Sets a new value for property name.

The name of the Pie item.

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

Default value is .

Parameters:
{string}sName New value for property name
Returns:
{sap.ui.vbm.PieItem} Reference to this in order to allow method chaining
setValue(sValue): sap.ui.vbm.PieItem
Sets a new value for property value.

The value of the Pie item.

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

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