Class sap.makit.ValueModule: sap/makit/Value

extends Element

Represents the Value data region of the Chart.

Deprecated API:Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.


Since: 1.8.
Constructor Summary
new sap.makit.Value(sId?, mSettings?)Constructor for a new Value.
Method Summary
sap.makit.Value.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.makit.Value with name sClassName and enriches it with the information contained in oClassInfo.
sap.makit.Value.getMetadata()Returns a metadata object for class sap.makit.Value.
getDisplayName()Getter for property displayName.
getExpression()Getter for property expression.
getFormat()Getter for property format.
getLocale()Getter for property locale.
setDisplayName(sDisplayName)Setter for property displayName.
setExpression(sExpression)Setter for property expression.
setFormat(sFormat)Setter for property format.
setLocale(sLocale)Setter for property locale.
Constructor Detail
new sap.makit.Value(sId?, mSettings?)
Constructor for a new Value.

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

If the name of a setting is ambiguous (e.g. a property has the same name as an event), then the framework assumes property, aggregation, association, event in that order. To override this automatic resolution, one of the prefixes "aggregation:", "association:" or "event:" can be added to the name of the setting (such a prefixed name must be enclosed in single or double quotes).

The supported settings are:

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
Deprecated:
Since version 1.38. MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control will not be supported anymore from 1.38.
Method Detail
sap.makit.Value.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.makit.Value with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of informations as described in Element.extend.

Parameters:
{string}sClassName name of the class to be created
{object}oClassInfo? object literal with informations about the class
{function}FNMetaImpl? constructor function for the metadata object. If not given, it defaults to sap.ui.core.ElementMetadata.
Returns:
{function} the created class / constructor function
sap.makit.Value.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.makit.Value.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getDisplayName(): string
Getter for property displayName. The text label representing this Value (on value bubble or table's header)

Default value is empty/undefined

Returns:
{string} the value of property displayName
getExpression(): string
Getter for property expression. The user should map the column on this property. The expression allows more advanced column mapping. Instead of just specifying the column name (e.g. revenueValue), the user can use SAP expression language e.g. Assuming the user has a revenueValue column and an operatingCost column, the user can specify the following expression: "revenueValue - operatingCost" the resulting value displayed in the chart will be the arithmatic operation result on these two columns.

Default value is empty/undefined

Returns:
{string} the value of property expression
getFormat(): string
Getter for property format. Number formatting for the value. Accepted values: number currency percent roundedN - where N represents number of decimal places e.g. rounded4

Default value is empty/undefined

Returns:
{string} the value of property format
getLocale(): string
Getter for property locale. Comma separated locales for specifiying values in different locale. The locale will be mapped in the same order as the series data. e.g. zh-CH, en-US, de-DE The first zh-CH will be applied to the value of the first series, en-US will be applied to the second series. Currently will only work with 'currency' format. Supported locales: en, zh, de, fr, es, ru, ja, pt and their more specific variations such as en-CA, es-AR, zh-HK, etc.

Default value is empty/undefined

Returns:
{string} the value of property locale
setDisplayName(sDisplayName): sap.makit.Value
Setter for property displayName.

Default value is empty/undefined

Parameters:
{string}sDisplayName new value for property displayName
Returns:
{sap.makit.Value}this to allow method chaining
setExpression(sExpression): sap.makit.Value
Setter for property expression.

Default value is empty/undefined

Parameters:
{string}sExpression new value for property expression
Returns:
{sap.makit.Value}this to allow method chaining
setFormat(sFormat): sap.makit.Value
Setter for property format.

Default value is empty/undefined

Parameters:
{string}sFormat new value for property format
Returns:
{sap.makit.Value}this to allow method chaining
setLocale(sLocale): sap.makit.Value
Setter for property locale.

Default value is empty/undefined

Parameters:
{string}sLocale new value for property locale
Returns:
{sap.makit.Value}this to allow method chaining