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.
Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers.
sClassName
and enriches it with the information contained in oClassInfo
.isKeepFirstAndLastLabel
. 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
- isIndependentMode : boolean (default: false)
- isPercentMode : boolean (default: false)
- isKeepFirstAndLastLabel : boolean (default: false)
- lineSize : int (default: 1)
- color : string (default: #6c6c6c)
- type : sap.viz.ui5.types.Axis_type (default: value)
- visible : boolean (default: true)
- position : sap.viz.ui5.types.Axis_position (default: bottom)
- isTruncateAvailable : boolean (default: true)
- forceLabelArea : boolean (default: false)
- enableLabelSelection : boolean (default: true)
- hideTitleFirst : boolean (default: false)
- maxSizeRatio : float (default: 0.25)
- Aggregations
- title : sap.viz.ui5.types.Axis_title
- gridline : sap.viz.ui5.types.Axis_gridline
- axisline : sap.viz.ui5.types.Axis_axisline
- label : sap.viz.ui5.types.Axis_label
- indicator : sap.viz.ui5.types.Axis_indicator
- scale : sap.viz.ui5.types.Axis_scale
- layoutInfo : sap.viz.ui5.types.Axis_layoutInfo
- axisTick : sap.viz.ui5.types.Axis_axisTick
In addition, all settings applicable to the base type sap.viz.ui5.core.BaseStructuredType can be used as well.
{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.
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.
{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 |
{function} | Created class / constructor function |
{sap.ui.base.Metadata} | Metadata object describing this class |
axisline
. {sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
gridline
. {sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
label
. {sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
scale
. {sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
title
. {sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
axisline
. Settings for the axis line
{sap.viz.ui5.types.Axis_axisline} |
color
. Set the color of the axis line
Default value is #6c6c6c
.
{string} | Value of property color |
gridline
. Settings for the gridlines on the axis
{sap.viz.ui5.types.Axis_gridline} |
label
. Settings for the labels on this axis
{sap.viz.ui5.types.Axis_label} |
lineSize
. Set the thickness of the axis line
Default value is 1
.
{int} | Value of property lineSize |
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
.
{float} | Value of property maxSizeRatio |
scale
. Set the scale of the value axis. This property only works on value type axes.
{sap.viz.ui5.types.Axis_scale} |
title
. Settings for the axis title
{sap.viz.ui5.types.Axis_title} |
visible
. Set the visibility of the entire axis, including the axis line, gridlines, and labels
Default value is true
.
{boolean} | Value of property visible |
axisline
. {sap.viz.ui5.types.Axis_axisline} | oAxisline | The axisline to set |
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
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
.
{string} | sColor | New value for property color |
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
gridline
. {sap.viz.ui5.types.Axis_gridline} | oGridline | The gridline to set |
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
label
. {sap.viz.ui5.types.Axis_label} | oLabel | The label to set |
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
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
.
{int} | iLineSize | New value for property lineSize |
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
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
.
{float} | fMaxSizeRatio | New value for property maxSizeRatio |
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
scale
. {sap.viz.ui5.types.Axis_scale} | oScale | The scale to set |
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
title
. {sap.viz.ui5.types.Axis_title} | oTitle | The title to set |
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
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
.
{boolean} | bVisible | New value for property visible |
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
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.
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
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.
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
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.
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
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.
{sap.viz.ui5.types.Axis_axisTick} |
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.
{boolean} | Value of property enableLabelSelection |
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.
{boolean} | Value of property forceLabelArea |
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.
{boolean} | Value of property hideTitleFirst |
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.
{sap.viz.ui5.types.Axis_indicator} |
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.
{boolean} | Value of property isIndependentMode |
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.
{boolean} | Value of property isKeepFirstAndLastLabel |
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.
{boolean} | Value of property isPercentMode |
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.
{boolean} | Value of property isTruncateAvailable |
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.
{sap.viz.ui5.types.Axis_layoutInfo} |
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.
{sap.viz.ui5.types.Axis_position} | Value of property position |
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.
{sap.viz.ui5.types.Axis_type} | Value of property type |
axisTick
. {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.
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
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
.
{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.
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
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
.
{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.
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
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
.
{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.
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
indicator
. {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.
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
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
.
{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.
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
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
.
{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.
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
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
.
{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.
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
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
.
{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.
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
layoutInfo
. {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.
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
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
.
{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.
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |
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
.
{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.
{sap.viz.ui5.types.Axis} | Reference to this in order to allow method chaining |