class sap.ui.vbm.PieItem

Control sample: sap.ui.vbm.PieItem
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/vbm/PieItem
Application Component: CA-GTF-VBZ

Slice element for a Pie Chart.


Constructor

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#constructor for a general description of the syntax of the settings object.

new sap.ui.vbm.PieItem(sId?, mSettings?)
Param Type Default Value Description
sId? string

id for the new control, generated automatically if no id is given

mSettings? object

initial settings for the new control


Properties

Name Type Default Value Description
color string

The color of the Pie Item.

Visibility: public
name string empty string

The name of the Pie item.

Visibility: public
value string

The value of the Pie item.

Visibility: public

Events Overview

Event Description
click

click

This event should no longer be used. Click event from Pie and Pies now includes Pie Item index when event occurs.
Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

Methods Overview

Method Description
attachClick

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.

Since This event should no longer be used. Click event from Pie and Pies now includes Pie Item index when event occurs.
detachClick

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.

Since This event should no longer be used. Click event from Pie and Pies now includes Pie Item index when event occurs.
sap.ui.vbm.PieItem.extend

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.

fireClick

Fires event click to attached listeners.

Since This event should no longer be used. Click event from Pie and Pies now includes Pie Item index when event occurs.
getColor

Gets current value of property color.

The color of the Pie Item.

sap.ui.vbm.PieItem.getMetadata

Returns a metadata object for class sap.ui.vbm.PieItem.

getName

Gets current value of property name.

The name of the Pie item.

Default value is empty string.

getValue

Gets current value of property value.

The value of the Pie item.

setColor

Sets a new value for property color.

The color of the Pie Item.

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

setName

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 empty string.

setValue

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.

attachClick

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.

Since This event should no longer be used. Click event from Pie and Pies now includes Pie Item index when event occurs.
Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.vbm.PieItem itself

detachClick

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.

Since This event should no longer be used. Click event from Pie and Pies now includes Pie Item index when event occurs.
Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.vbm.PieItem.extend

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.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

fireClick

Fires event click to attached listeners.

Since This event should no longer be used. Click event from Pie and Pies now includes Pie Item index when event occurs.
Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

getColor

Gets current value of property color.

The color of the Pie Item.

sap.ui.vbm.PieItem.getMetadata

Returns a metadata object for class sap.ui.vbm.PieItem.

getName

Gets current value of property name.

The name of the Pie item.

Default value is empty string.

getValue

Gets current value of property value.

The value of the Pie item.

setColor

Sets a new value for property color.

The color of the Pie Item.

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

Param Type DefaultValue Description
sColor string

New value for property color

setName

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 empty string.

Param Type DefaultValue Description
sName string ''

New value for property name

setValue

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.

Param Type DefaultValue Description
sValue string

New value for property value