Axis_gridline

Settings for the gridlines on the 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_gridline(sId?, mSettings?)Constructor for a new sap.viz.ui5.types.Axis_gridline

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_gridline.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.viz.ui5.types.Axis_gridline with name sClassName and enriches it with the information contained in oClassInfo.

sap.viz.ui5.types.Axis_gridline.getMetadata()Returns a metadata object for class sap.viz.ui5.types.Axis_gridline.

getColor()Gets current value of property color.

getSize()Gets current value of property size.

getType()Gets current value of property type.

getVisible()Gets current value of property visible.

setColor(sColor)Sets a new value for property color.

setSize(iSize)Sets a new value for property size.

setType(sType)Sets a new value for property type.

setVisible(bVisible)Sets a new value for property visible.

getDisable()Gets current value of property disable.

getShowFirstLine()Gets current value of property showFirstLine.

getShowLastLine()Gets current value of property showLastLine.

setDisable(bDisable)Sets a new value for property disable.

setShowFirstLine(bShowFirstLine)Sets a new value for property showFirstLine.

setShowLastLine(bShowLastLine)Sets a new value for property showLastLine.

Methods borrowed from class sap.ui.core.Element

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_gridline(sId?, mSettings?)

Constructor for a new sap.viz.ui5.types.Axis_gridline

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
- visible : boolean (default: true)
- disable : boolean (default: false)
- showFirstLine : boolean (default: false)
- showLastLine : boolean (default: false)
- type : sap.viz.ui5.types.Axis_gridline_type (default: line)
- color : string (default: #d8d8d8)
- size : int (default: 1)

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_gridline.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.viz.ui5.types.Axis_gridline 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_gridline.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.viz.ui5.types.Axis_gridline.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getColor(): string

Gets current value of property color.

Set the color of the gridlines on the axis

Default value is #d8d8d8.

Returns:

{string} Value of property color

getSize(): int

Gets current value of property size.

Set the line size of gridlines on the axis

Default value is 1.

Returns:

{int} Value of property size

getType(): sap.viz.ui5.types.Axis_gridline_type

Gets current value of property type.

Set the line type of gridlines on the axis

Default value is line.

Returns:

{sap.viz.ui5.types.Axis_gridline_type} Value of property type

getVisible(): boolean

Gets current value of property visible.

Set the visibility of gridlines on the axis

Default value is true.

Returns:

{boolean} Value of property visible

setColor(sColor): sap.viz.ui5.types.Axis_gridline

Sets a new value for property color.

Set the color of the gridlines on the axis

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

Default value is #d8d8d8.

Parameters:

{string} sColor New value for property color

Returns:

{sap.viz.ui5.types.Axis_gridline} Reference to this in order to allow method chaining

setSize(iSize): sap.viz.ui5.types.Axis_gridline

Sets a new value for property size.

Set the line size of gridlines on the axis

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

Default value is 1.

Parameters:

{int} iSize New value for property size

Returns:

{sap.viz.ui5.types.Axis_gridline} Reference to this in order to allow method chaining

setType(sType): sap.viz.ui5.types.Axis_gridline

Sets a new value for property type.

Set the line type of gridlines on the axis

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

Default value is line.

Parameters:

{sap.viz.ui5.types.Axis_gridline_type} sType New value for property type

Returns:

{sap.viz.ui5.types.Axis_gridline} Reference to this in order to allow method chaining

setVisible(bVisible): sap.viz.ui5.types.Axis_gridline

Sets a new value for property visible.

Set the visibility of gridlines on the 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_gridline} Reference to this in order to allow method chaining

getDisable(): boolean

Gets current value of property disable.

Disable gridline or not

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 disable

getShowFirstLine(): boolean

Gets current value of property showFirstLine.

Set whether the first gridline on the axis appears

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 showFirstLine

getShowLastLine(): boolean

Gets current value of property showLastLine.

Set whether the last gridline on the axis appears

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 showLastLine

setDisable(bDisable): sap.viz.ui5.types.Axis_gridline

Sets a new value for property disable.

Disable gridline or not

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

Default value is false.

Parameters:

{boolean} bDisable New value for property disable

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_gridline} Reference to this in order to allow method chaining

setShowFirstLine(bShowFirstLine): sap.viz.ui5.types.Axis_gridline

Sets a new value for property showFirstLine.

Set whether the first gridline on the axis appears

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

Default value is false.

Parameters:

{boolean} bShowFirstLine New value for property showFirstLine

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_gridline} Reference to this in order to allow method chaining

setShowLastLine(bShowLastLine): sap.viz.ui5.types.Axis_gridline

Sets a new value for property showLastLine.

Set whether the last gridline on the axis appears

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

Default value is false.

Parameters:

{boolean} bShowLastLine New value for property showLastLine

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_gridline} Reference to this in order to allow method chaining