Pie_tooltip

Settings for tooltip related properties

Deprecated API:Since version 1.19. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.

Since: 1.7.2.

Constructor Summary

new sap.viz.ui5.types.Pie_tooltip(sId?, mSettings?)Constructor for a new sap.viz.ui5.types.Pie_tooltip

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_tooltip.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.viz.ui5.types.Pie_tooltip with name sClassName and enriches it with the information contained in oClassInfo.

sap.viz.ui5.types.Pie_tooltip.getMetadata()Returns a metadata object for class sap.viz.ui5.types.Pie_tooltip.

getFormatString()Gets current value of property formatString.

getVisible()Gets current value of property visible.

setFormatString(sFormatString)Sets a new value for property formatString.

setVisible(bVisible)Sets a new value for property visible.

getPercentageFormat()Gets current value of property percentageFormat.

getValueFormat()Gets current value of property valueFormat.

setPercentageFormat(sPercentageFormat)Sets a new value for property percentageFormat.

setValueFormat(sValueFormat)Sets a new value for property valueFormat.

Methods borrowed from class sap.ui.core.Element

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_tooltip(sId?, mSettings?)

Constructor for a new sap.viz.ui5.types.Pie_tooltip

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
- visible : boolean (default: true)
- valueFormat : string (default: n)
- percentageFormat : string (default: .0%)
- formatString : string[]

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.19. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.

Method Detail

sap.viz.ui5.types.Pie_tooltip.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.viz.ui5.types.Pie_tooltip 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_tooltip.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.viz.ui5.types.Pie_tooltip.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getFormatString(): string[]

Gets current value of property formatString.

Set format string of tooltip. The first string is applied to value and the second is applied to percentage.Any character in "MDYHSAmdyhsa#?%0@" is reserved as a token for format code.

Returns:

{string[]} Value of property formatString

getVisible(): boolean

Gets current value of property visible.

Set whether tooltip is enabled

Default value is true.

Returns:

{boolean} Value of property visible

setFormatString(sFormatString): sap.viz.ui5.types.Pie_tooltip

Sets a new value for property formatString.

Set format string of tooltip. The first string is applied to value and the second is applied to percentage.Any character in "MDYHSAmdyhsa#?%0@" is reserved as a token for format code.

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

Parameters:

{string[]} sFormatString New value for property formatString

Returns:

{sap.viz.ui5.types.Pie_tooltip} Reference to this in order to allow method chaining

setVisible(bVisible): sap.viz.ui5.types.Pie_tooltip

Sets a new value for property visible.

Set whether tooltip is enabled

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

Default value is true.

Parameters:

{boolean} bVisible New value for property visible

Returns:

{sap.viz.ui5.types.Pie_tooltip} Reference to this in order to allow method chaining

getPercentageFormat(): string

Gets current value of property percentageFormat.

Set the number format of the percentage label in tooltip

Default value is .0%.

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:

{string} Value of property percentageFormat

getValueFormat(): string

Gets current value of property valueFormat.

Set the number format of the measure value in tooltip

Default value is n.

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:

{string} Value of property valueFormat

setPercentageFormat(sPercentageFormat): sap.viz.ui5.types.Pie_tooltip

Sets a new value for property percentageFormat.

Set the number format of the percentage label in tooltip

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

Default value is .0%.

Parameters:

{string} sPercentageFormat New value for property percentageFormat

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_tooltip} Reference to this in order to allow method chaining

setValueFormat(sValueFormat): sap.viz.ui5.types.Pie_tooltip

Sets a new value for property valueFormat.

Set the number format of the measure value in tooltip

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

Default value is n.

Parameters:

{string} sValueFormat New value for property valueFormat

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_tooltip} Reference to this in order to allow method chaining