Class sap.viz.ui5.types.AxisModule: sap/viz/ui5/types/Axis


Module sap.viz.ui5.types.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(sId?, mSettings?)Constructor for a new sap.viz.ui5.types.Axis

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

Method Summary
sap.viz.ui5.types.Axis.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.viz.ui5.types.Axis with name sClassName and enriches it with the information contained in oClassInfo.
sap.viz.ui5.types.Axis.getMetadata()Returns a metadata object for class sap.viz.ui5.types.Axis.
destroyAxisline()Destroys the axisline in the aggregation axisline.
destroyGridline()Destroys the gridline in the aggregation gridline.
destroyLabel()Destroys the label in the aggregation label.
destroyScale()Destroys the scale in the aggregation scale.
destroyTitle()Destroys the title in the aggregation title.
getAxisline()Gets content of aggregation axisline.
getColor()Gets current value of property color.
getGridline()Gets content of aggregation gridline.
getLabel()Gets content of aggregation label.
getLineSize()Gets current value of property lineSize.
getMaxSizeRatio()Gets current value of property maxSizeRatio.
getScale()Gets content of aggregation scale.
getTitle()Gets content of aggregation title.
getVisible()Gets current value of property visible.
setAxisline(oAxisline)Sets the aggregated axisline.
setColor(sColor)Sets a new value for property color.
setGridline(oGridline)Sets the aggregated gridline.
setLabel(oLabel)Sets the aggregated label.
setLineSize(iLineSize)Sets a new value for property lineSize.
setMaxSizeRatio(fMaxSizeRatio)Sets a new value for property maxSizeRatio.
setScale(oScale)Sets the aggregated scale.
setTitle(oTitle)Sets the aggregated title.
setVisible(bVisible)Sets a new value for property visible.
destroyAxisTick()Destroys the axisTick in the aggregation axisTick.
destroyIndicator()Destroys the indicator in the aggregation indicator.
destroyLayoutInfo()Destroys the layoutInfo in the aggregation layoutInfo.
getAxisTick()Gets content of aggregation axisTick.
getEnableLabelSelection()Gets current value of property enableLabelSelection.
getForceLabelArea()Gets current value of property forceLabelArea.
getHideTitleFirst()Gets current value of property hideTitleFirst.
getIndicator()Gets content of aggregation indicator.
getIsIndependentMode()Gets current value of property isIndependentMode.
getIsKeepFirstAndLastLabel()Gets current value of property isKeepFirstAndLastLabel.
getIsPercentMode()Gets current value of property isPercentMode.
getIsTruncateAvailable()Gets current value of property isTruncateAvailable.
getLayoutInfo()Gets content of aggregation layoutInfo.
getPosition()Gets current value of property position.
getType()Gets current value of property type.
setAxisTick(oAxisTick)Sets the aggregated axisTick.
setEnableLabelSelection(bEnableLabelSelection)Sets a new value for property enableLabelSelection.
setForceLabelArea(bForceLabelArea)Sets a new value for property forceLabelArea.
setHideTitleFirst(bHideTitleFirst)Sets a new value for property hideTitleFirst.
setIndicator(oIndicator)Sets the aggregated indicator.
setIsIndependentMode(bIsIndependentMode)Sets a new value for property isIndependentMode.
setIsKeepFirstAndLastLabel(bIsKeepFirstAndLastLabel)Sets a new value for property isKeepFirstAndLastLabel.
setIsPercentMode(bIsPercentMode)Sets a new value for property isPercentMode.
setIsTruncateAvailable(bIsTruncateAvailable)Sets a new value for property isTruncateAvailable.
setLayoutInfo(oLayoutInfo)Sets the aggregated layoutInfo.
setPosition(sPosition)Sets a new value for property position.
setType(sType)Sets a new value for property type.
Constructor Detail
new sap.viz.ui5.types.Axis(sId?, mSettings?)
Constructor for a new sap.viz.ui5.types.Axis

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.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.viz.ui5.types.Axis 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.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.viz.ui5.types.Axis.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
destroyAxisline(): sap.viz.ui5.types.Axis
Destroys the axisline in the aggregation axisline.
Returns:
{sap.viz.ui5.types.Axis} Reference to this in order to allow method chaining
destroyGridline(): sap.viz.ui5.types.Axis
Destroys the gridline in the aggregation gridline.
Returns:
{sap.viz.ui5.types.Axis} Reference to this in order to allow method chaining
destroyLabel(): sap.viz.ui5.types.Axis
Destroys the label in the aggregation label.
Returns:
{sap.viz.ui5.types.Axis} Reference to this in order to allow method chaining
destroyScale(): sap.viz.ui5.types.Axis
Destroys the scale in the aggregation scale.
Returns:
{sap.viz.ui5.types.Axis} Reference to this in order to allow method chaining
destroyTitle(): sap.viz.ui5.types.Axis
Destroys the title in the aggregation title.
Returns:
{sap.viz.ui5.types.Axis} Reference to this in order to allow method chaining
Gets content of aggregation axisline.

Settings for the axis line

Returns:
{sap.viz.ui5.types.Axis_axisline}
getColor(): string
Gets current value of property color.

Set the color of the axis line

Default value is #6c6c6c.

Returns:
{string} Value of property color
Gets content of aggregation gridline.

Settings for the gridlines on the axis

Returns:
{sap.viz.ui5.types.Axis_gridline}
Gets content of aggregation label.

Settings for the labels on this axis

Returns:
{sap.viz.ui5.types.Axis_label}
getLineSize(): int
Gets current value of property lineSize.

Set the thickness of the axis line

Default value is 1.

Returns:
{int} Value of property lineSize
getMaxSizeRatio(): float
Gets current value of property maxSizeRatio.

The ratio to limit axis' space in its container, which only accepts values between 0 and 1(0 and 1 included). All the invalid values would be replaced by default value.

Default value is 0.25.

Returns:
{float} Value of property maxSizeRatio
Gets content of aggregation scale.

Set the scale of the value axis. This property only works on value type axes.

Returns:
{sap.viz.ui5.types.Axis_scale}
Gets content of aggregation title.

Settings for the axis title

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

Set the visibility of the entire axis, including the axis line, gridlines, and labels

Default value is true.

Returns:
{boolean} Value of property visible
setAxisline(oAxisline): sap.viz.ui5.types.Axis
Sets the aggregated axisline.
Parameters:
{sap.viz.ui5.types.Axis_axisline}oAxisline The axisline to set
Returns:
{sap.viz.ui5.types.Axis} Reference to this in order to allow method chaining
setColor(sColor): sap.viz.ui5.types.Axis
Sets a new value for property color.

Set the color of the axis line

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

Default value is #6c6c6c.

Parameters:
{string}sColor New value for property color
Returns:
{sap.viz.ui5.types.Axis} Reference to this in order to allow method chaining
setGridline(oGridline): sap.viz.ui5.types.Axis
Sets the aggregated gridline.
Parameters:
{sap.viz.ui5.types.Axis_gridline}oGridline The gridline to set
Returns:
{sap.viz.ui5.types.Axis} Reference to this in order to allow method chaining
setLabel(oLabel): sap.viz.ui5.types.Axis
Sets the aggregated label.
Parameters:
{sap.viz.ui5.types.Axis_label}oLabel The label to set
Returns:
{sap.viz.ui5.types.Axis} Reference to this in order to allow method chaining
setLineSize(iLineSize): sap.viz.ui5.types.Axis
Sets a new value for property lineSize.

Set the thickness of the axis line

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

Default value is 1.

Parameters:
{int}iLineSize New value for property lineSize
Returns:
{sap.viz.ui5.types.Axis} Reference to this in order to allow method chaining
setMaxSizeRatio(fMaxSizeRatio): sap.viz.ui5.types.Axis
Sets a new value for property maxSizeRatio.

The ratio to limit axis' space in its container, which only accepts values between 0 and 1(0 and 1 included). All the invalid values would be replaced by default value.

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

Default value is 0.25.

Parameters:
{float}fMaxSizeRatio New value for property maxSizeRatio
Returns:
{sap.viz.ui5.types.Axis} Reference to this in order to allow method chaining
setScale(oScale): sap.viz.ui5.types.Axis
Sets the aggregated scale.
Parameters:
{sap.viz.ui5.types.Axis_scale}oScale The scale to set
Returns:
{sap.viz.ui5.types.Axis} Reference to this in order to allow method chaining
setTitle(oTitle): sap.viz.ui5.types.Axis
Sets the aggregated title.
Parameters:
{sap.viz.ui5.types.Axis_title}oTitle The title to set
Returns:
{sap.viz.ui5.types.Axis} Reference to this in order to allow method chaining
setVisible(bVisible): sap.viz.ui5.types.Axis
Sets a new value for property visible.

Set the visibility of the entire axis, including the axis line, gridlines, and labels

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} Reference to this in order to allow method chaining
destroyAxisTick(): sap.viz.ui5.types.Axis
Destroys the axisTick in the aggregation axisTick.
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} Reference to this in order to allow method chaining
destroyIndicator(): sap.viz.ui5.types.Axis
Destroys the indicator in the aggregation indicator.
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.
Returns:
{sap.viz.ui5.types.Axis} Reference to this in order to allow method chaining
destroyLayoutInfo(): sap.viz.ui5.types.Axis
Destroys the layoutInfo in the aggregation layoutInfo.
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} Reference to this in order to allow method chaining
Gets content of aggregation axisTick.

Settings for the ticks on the axis

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_axisTick}
getEnableLabelSelection(): boolean
Gets current value of property enableLabelSelection.

Set whether the label selection effect is enabled. For mobile devices, the default value is 'false'.

Default value is true.

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:
{boolean} Value of property enableLabelSelection
getForceLabelArea(): boolean
Gets current value of property forceLabelArea.

Set whether the label area is limited to the text area

Default value is false.

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:
{boolean} Value of property forceLabelArea
getHideTitleFirst(): boolean
Gets current value of property hideTitleFirst.

Hide axis title firstly if the space is limited.

Default value is false.

Deprecated:
Since version 1.20. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.
Returns:
{boolean} Value of property hideTitleFirst
Gets content of aggregation indicator.

Settings for the axis indicator

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.
Returns:
{sap.viz.ui5.types.Axis_indicator}
getIsIndependentMode(): boolean
Gets current value of property isIndependentMode.

Set whether the axis works in independent mode. Currently, this property is used only for boxplot charts.

Default value is false.

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:
{boolean} Value of property isIndependentMode
getIsKeepFirstAndLastLabel(): boolean
Gets current value of property isKeepFirstAndLastLabel.

Try to keep the first label and last label when the space is limited.

Default value is false.

Deprecated:
Since version 1.20. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.
Returns:
{boolean} Value of property isKeepFirstAndLastLabel
getIsPercentMode(): boolean
Gets current value of property isPercentMode.

Show the label as a percentage. For example '0.1' would show as '10'.

Default value is false.

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:
{boolean} Value of property isPercentMode
getIsTruncateAvailable(): boolean
Gets current value of property isTruncateAvailable.

Set whether truncation logic is available for the category axis

Default value is true.

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:
{boolean} Value of property isTruncateAvailable
Gets content of aggregation layoutInfo.

Settings for the layout of the category axis. This property only works for category type axes.

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_layoutInfo}
Gets current value of property position.

Set the position of the axis

Default value is bottom.

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_position} Value of property position
Gets current value of property type.

Set the axis type

Default value is value.

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_type} Value of property type
setAxisTick(oAxisTick): sap.viz.ui5.types.Axis
Sets the aggregated axisTick.
Parameters:
{sap.viz.ui5.types.Axis_axisTick}oAxisTick The axisTick to set
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} Reference to this in order to allow method chaining
setEnableLabelSelection(bEnableLabelSelection): sap.viz.ui5.types.Axis
Sets a new value for property enableLabelSelection.

Set whether the label selection effect is enabled. For mobile devices, the default value is 'false'.

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

Default value is true.

Parameters:
{boolean}bEnableLabelSelection New value for property enableLabelSelection
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} Reference to this in order to allow method chaining
setForceLabelArea(bForceLabelArea): sap.viz.ui5.types.Axis
Sets a new value for property forceLabelArea.

Set whether the label area is limited to the text area

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

Default value is false.

Parameters:
{boolean}bForceLabelArea New value for property forceLabelArea
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} Reference to this in order to allow method chaining
setHideTitleFirst(bHideTitleFirst): sap.viz.ui5.types.Axis
Sets a new value for property hideTitleFirst.

Hide axis title firstly if the space is limited.

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

Default value is false.

Parameters:
{boolean}bHideTitleFirst New value for property hideTitleFirst
Deprecated:
Since version 1.20. 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} Reference to this in order to allow method chaining
setIndicator(oIndicator): sap.viz.ui5.types.Axis
Sets the aggregated indicator.
Parameters:
{sap.viz.ui5.types.Axis_indicator}oIndicator The indicator to set
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.
Returns:
{sap.viz.ui5.types.Axis} Reference to this in order to allow method chaining
setIsIndependentMode(bIsIndependentMode): sap.viz.ui5.types.Axis
Sets a new value for property isIndependentMode.

Set whether the axis works in independent mode. Currently, this property is used only for boxplot charts.

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

Default value is false.

Parameters:
{boolean}bIsIndependentMode New value for property isIndependentMode
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} Reference to this in order to allow method chaining
setIsKeepFirstAndLastLabel(bIsKeepFirstAndLastLabel): sap.viz.ui5.types.Axis
Sets a new value for property isKeepFirstAndLastLabel.

Try to keep the first label and last label when the space is limited.

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

Default value is false.

Parameters:
{boolean}bIsKeepFirstAndLastLabel New value for property isKeepFirstAndLastLabel
Deprecated:
Since version 1.20. 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} Reference to this in order to allow method chaining
setIsPercentMode(bIsPercentMode): sap.viz.ui5.types.Axis
Sets a new value for property isPercentMode.

Show the label as a percentage. For example '0.1' would show as '10'.

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

Default value is false.

Parameters:
{boolean}bIsPercentMode New value for property isPercentMode
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} Reference to this in order to allow method chaining
setIsTruncateAvailable(bIsTruncateAvailable): sap.viz.ui5.types.Axis
Sets a new value for property isTruncateAvailable.

Set whether truncation logic is available for the category 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}bIsTruncateAvailable New value for property isTruncateAvailable
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} Reference to this in order to allow method chaining
setLayoutInfo(oLayoutInfo): sap.viz.ui5.types.Axis
Sets the aggregated layoutInfo.
Parameters:
{sap.viz.ui5.types.Axis_layoutInfo}oLayoutInfo The layoutInfo to set
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} Reference to this in order to allow method chaining
setPosition(sPosition): sap.viz.ui5.types.Axis
Sets a new value for property position.

Set the position of the axis

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

Default value is bottom.

Parameters:
{sap.viz.ui5.types.Axis_position}sPosition New value for property position
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} Reference to this in order to allow method chaining
setType(sType): sap.viz.ui5.types.Axis
Sets a new value for property type.

Set the axis type

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

Default value is value.

Parameters:
{sap.viz.ui5.types.Axis_type}sType New value for property type
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} Reference to this in order to allow method chaining