Class sap.viz.ui5.types.Axis_scaleModule: sap/viz/ui5/types/Axis_scale


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

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

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_scale.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.viz.ui5.types.Axis_scale with name sClassName and enriches it with the information contained in oClassInfo.
sap.viz.ui5.types.Axis_scale.getMetadata()Returns a metadata object for class sap.viz.ui5.types.Axis_scale.
getFixedRange()Gets current value of property fixedRange.
getMaxValue()Gets current value of property maxValue.
getMinValue()Gets current value of property minValue.
setFixedRange(bFixedRange)Sets a new value for property fixedRange.
setMaxValue(fMaxValue)Sets a new value for property maxValue.
setMinValue(fMinValue)Sets a new value for property minValue.
getFixedTicks()Gets current value of property fixedTicks.
setFixedTicks(sFixedTicks)Sets a new value for property fixedTicks.
Constructor Detail
new sap.viz.ui5.types.Axis_scale(sId?, mSettings?)
Constructor for a new sap.viz.ui5.types.Axis_scale

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

Set whether the axis range is limited to the range between the minValue and maxValue

Default value is false.

Returns:
{boolean} Value of property fixedRange
getMaxValue(): float
Gets current value of property maxValue.

Set the maxValue of the value axis

Default value is 0.

Returns:
{float} Value of property maxValue
getMinValue(): float
Gets current value of property minValue.

Set the minValue of the value axis

Default value is 0.

Returns:
{float} Value of property minValue
setFixedRange(bFixedRange): sap.viz.ui5.types.Axis_scale
Sets a new value for property fixedRange.

Set whether the axis range is limited to the range between the minValue and maxValue

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

Default value is false.

Parameters:
{boolean}bFixedRange New value for property fixedRange
Returns:
{sap.viz.ui5.types.Axis_scale} Reference to this in order to allow method chaining
setMaxValue(fMaxValue): sap.viz.ui5.types.Axis_scale
Sets a new value for property maxValue.

Set the maxValue of the value axis

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

Default value is 0.

Parameters:
{float}fMaxValue New value for property maxValue
Returns:
{sap.viz.ui5.types.Axis_scale} Reference to this in order to allow method chaining
setMinValue(fMinValue): sap.viz.ui5.types.Axis_scale
Sets a new value for property minValue.

Set the minValue of the value axis

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

Default value is 0.

Parameters:
{float}fMinValue New value for property minValue
Returns:
{sap.viz.ui5.types.Axis_scale} Reference to this in order to allow method chaining
getFixedTicks(): object[]
Gets current value of property fixedTicks.

Set the specific ticks for value axis. The format should be [{value : "/value/", text : "/text/"}...]. If its length is less than 2, this property will not take effect.

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:
{object[]} Value of property fixedTicks
setFixedTicks(sFixedTicks): sap.viz.ui5.types.Axis_scale
Sets a new value for property fixedTicks.

Set the specific ticks for value axis. The format should be [{value : "/value/", text : "/text/"}...]. If its length is less than 2, this property will not take effect.

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

Parameters:
{object[]}sFixedTicks New value for property fixedTicks
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_scale} Reference to this in order to allow method chaining