Class sap.viz.ui5.types.Axis_labelModule: sap/viz/ui5/types/Axis_label

extends BaseStructuredType

Settings for the labels on this axis

Deprecated API:Since version 1.32.0. The chart controls in the sap.viz.ui5 package (which were always marked as experimental) have been deprecated since 1.32.0. They are no longer actively developed and won't receive new features or improvements, only important bug fixes. They will only remain in the SAPUI5 distribution for backward compatibility.

SAP strongly recommends that existing consumers of those controls migrate to the new VizFrame control to benefit from new charting enhancements and timely support.

Note: As the feature set, design and API usage of VizFrame might differ from the old chart controls, make sure you evaluate it thoroughly before migration.

Experimental API:Since version 1.7.2. Charting API is not finished yet and might change completely.


Since: 1.7.2.
Constructor Summary
new sap.viz.ui5.types.Axis_label(sId?, mSettings?)Constructor for a new sap.viz.ui5.types.Axis_label

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.Axis_label.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.viz.ui5.types.Axis_label with name sClassName and enriches it with the information contained in oClassInfo.
sap.viz.ui5.types.Axis_label.getMetadata()Returns a metadata object for class sap.viz.ui5.types.Axis_label.
getFormatString()Gets current value of property formatString.
getHideSubLevels()Gets current value of property hideSubLevels.
getUnitFormatType()Gets current value of property unitFormatType.
getVisible()Gets current value of property visible.
setFormatString(oFormatString)Sets a new value for property formatString.
setHideSubLevels(bHideSubLevels)Sets a new value for property hideSubLevels.
setUnitFormatType(sUnitFormatType)Sets a new value for property unitFormatType.
setVisible(bVisible)Sets a new value for property visible.
getNumberFormat()Gets current value of property numberFormat.
setNumberFormat(sNumberFormat)Sets a new value for property numberFormat.
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.viz.ui5.types.Axis_label(sId?, mSettings?)
Constructor for a new sap.viz.ui5.types.Axis_label

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:

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.32.0. The chart controls in the sap.viz.ui5 package (which were always marked as experimental) have been deprecated since 1.32.0. They are no longer actively developed and won't receive new features or improvements, only important bug fixes. They will only remain in the SAPUI5 distribution for backward compatibility.

SAP strongly recommends that existing consumers of those controls migrate to the new VizFrame control to benefit from new charting enhancements and timely support.

Note: As the feature set, design and API usage of VizFrame might differ from the old chart controls, make sure you evaluate it thoroughly before migration.

Method Detail
sap.viz.ui5.types.Axis_label.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.viz.ui5.types.Axis_label 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.Axis_label.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.viz.ui5.types.Axis_label.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getFormatString(): any
Gets current value of property formatString.

Set the format strings for labels on the value axis. If a single format string is entered, it is applied to all measures. A two-dimensional array of format strings can be entered for scatter matrix charts and multiple charts with measureNamesDimension, to apply different formats to each sub-chart. For all other chart types, the first value of the first dimension of a two-dimensional array is used as a global format string. The following characters are reserved as tokens for format code: MDYHSAmdyhsa#?%0@. The letter "u" is used at the end of a format string to format values in SI units. If the letter "u" is added to a value between 1e12 and 1e-3 before SI units are applied, the value is formatted in exponential style. The remaining syntax matches Excel format strings. The following is a simple example of a two-dimensional array for a chart with two measures: [["#,##0.00 DM;-#,##.00 DM","#,##.00;-#,##.00"]].

Returns:
{any} Value of property formatString
getHideSubLevels(): boolean
Gets current value of property hideSubLevels.

Set the visibility of the sub levels of labels on this axis

Default value is false.

Returns:
{boolean} Value of property hideSubLevels
getUnitFormatType(): sap.viz.ui5.types.Axis_label_unitFormatType
Gets current value of property unitFormatType.

Set the unit format type. If set MetricUnits, unit K,M,G,T will be applied, eg, 5000 will display as 5K, 5000000 will display as 5M, 5000000000 will display as 5G and so on. If set FinancialUnits, unit K,M,B,T will be applied. 5000000000 will display as 5B.

Default value is FinancialUnits.

Returns:
{sap.viz.ui5.types.Axis_label_unitFormatType} Value of property unitFormatType
getVisible(): boolean
Gets current value of property visible.

Set the visibility of the labels on this axis

Default value is true.

Returns:
{boolean} Value of property visible
setFormatString(oFormatString): sap.viz.ui5.types.Axis_label
Sets a new value for property formatString.

Set the format strings for labels on the value axis. If a single format string is entered, it is applied to all measures. A two-dimensional array of format strings can be entered for scatter matrix charts and multiple charts with measureNamesDimension, to apply different formats to each sub-chart. For all other chart types, the first value of the first dimension of a two-dimensional array is used as a global format string. The following characters are reserved as tokens for format code: MDYHSAmdyhsa#?%0@. The letter "u" is used at the end of a format string to format values in SI units. If the letter "u" is added to a value between 1e12 and 1e-3 before SI units are applied, the value is formatted in exponential style. The remaining syntax matches Excel format strings. The following is a simple example of a two-dimensional array for a chart with two measures: [["#,##0.00 DM;-#,##.00 DM","#,##.00;-#,##.00"]].

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

Parameters:
{any}oFormatString New value for property formatString
Returns:
{sap.viz.ui5.types.Axis_label} Reference to this in order to allow method chaining
setHideSubLevels(bHideSubLevels): sap.viz.ui5.types.Axis_label
Sets a new value for property hideSubLevels.

Set the visibility of the sub levels of labels on this axis

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

Default value is false.

Parameters:
{boolean}bHideSubLevels New value for property hideSubLevels
Returns:
{sap.viz.ui5.types.Axis_label} Reference to this in order to allow method chaining
setUnitFormatType(sUnitFormatType): sap.viz.ui5.types.Axis_label
Sets a new value for property unitFormatType.

Set the unit format type. If set MetricUnits, unit K,M,G,T will be applied, eg, 5000 will display as 5K, 5000000 will display as 5M, 5000000000 will display as 5G and so on. If set FinancialUnits, unit K,M,B,T will be applied. 5000000000 will display as 5B.

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

Default value is FinancialUnits.

Parameters:
{sap.viz.ui5.types.Axis_label_unitFormatType}sUnitFormatType New value for property unitFormatType
Returns:
{sap.viz.ui5.types.Axis_label} Reference to this in order to allow method chaining
setVisible(bVisible): sap.viz.ui5.types.Axis_label
Sets a new value for property visible.

Set the visibility of the labels on this axis

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.Axis_label} Reference to this in order to allow method chaining
getNumberFormat(): string
Gets current value of property numberFormat.

Set the number format for the value axis

Default value is .

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 numberFormat
setNumberFormat(sNumberFormat): sap.viz.ui5.types.Axis_label
Sets a new value for property numberFormat.

Set the number format for the value axis

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

Default value is .

Parameters:
{string}sNumberFormat New value for property numberFormat
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.Axis_label} Reference to this in order to allow method chaining