Class sap.viz.ui5.types.BackgroundModule: sap/viz/ui5/types/Background

extends BaseStructuredType

Module sap.viz.ui5.types.Background

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

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.Background.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.viz.ui5.types.Background with name sClassName and enriches it with the information contained in oClassInfo.
sap.viz.ui5.types.Background.getMetadata()Returns a metadata object for class sap.viz.ui5.types.Background.
destroyBorder()Destroys the border in the aggregation border.
getBorder()Gets content of aggregation border.
getDirection()Gets current value of property direction.
getDrawingEffect()Gets current value of property drawingEffect.
getVisible()Gets current value of property visible.
setBorder(oBorder)Sets the aggregated border.
setDirection(sDirection)Sets a new value for property direction.
setDrawingEffect(sDrawingEffect)Sets a new value for property drawingEffect.
setVisible(bVisible)Sets a new value for property visible.
getColor()Gets current value of property color.
setColor(sColor)Sets a new value for property color.
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.Background(sId?, mSettings?)
Constructor for a new sap.viz.ui5.types.Background

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)
    • drawingEffect : sap.viz.ui5.types.Background_drawingEffect (default: normal)
    • direction : sap.viz.ui5.types.Background_direction (default: vertical)
    • color : string (default: transparent)
  • Aggregations
    • border : sap.viz.ui5.types.Background_border

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.Background.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.viz.ui5.types.Background 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.Background.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.viz.ui5.types.Background.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
destroyBorder(): sap.viz.ui5.types.Background
Destroys the border in the aggregation border.
Returns:
{sap.viz.ui5.types.Background} Reference to this in order to allow method chaining
getBorder(): sap.viz.ui5.types.Background_border
Gets content of aggregation border.

Settings for the border

Returns:
{sap.viz.ui5.types.Background_border}
getDirection(): sap.viz.ui5.types.Background_direction
Gets current value of property direction.

Set the direction of the color gradient in the background. This only takes effect if the 'drawingEffect' value is set to 'glossy'.

Default value is vertical.

Returns:
{sap.viz.ui5.types.Background_direction} Value of property direction
getDrawingEffect(): sap.viz.ui5.types.Background_drawingEffect
Gets current value of property drawingEffect.

Set the drawing effect for the background. If this value is set to 'glossy', the background is glossy. If this value is set to 'normal', the background is matte.

Default value is normal.

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

Set the visibility

Default value is true.

Returns:
{boolean} Value of property visible
setBorder(oBorder): sap.viz.ui5.types.Background
Sets the aggregated border.
Parameters:
{sap.viz.ui5.types.Background_border}oBorder The border to set
Returns:
{sap.viz.ui5.types.Background} Reference to this in order to allow method chaining
setDirection(sDirection): sap.viz.ui5.types.Background
Sets a new value for property direction.

Set the direction of the color gradient in the background. This only takes effect if the 'drawingEffect' value is set to 'glossy'.

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

Default value is vertical.

Parameters:
{sap.viz.ui5.types.Background_direction}sDirection New value for property direction
Returns:
{sap.viz.ui5.types.Background} Reference to this in order to allow method chaining
setDrawingEffect(sDrawingEffect): sap.viz.ui5.types.Background
Sets a new value for property drawingEffect.

Set the drawing effect for the background. If this value is set to 'glossy', the background is glossy. If this value is set to 'normal', the background is matte.

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

Default value is normal.

Parameters:
{sap.viz.ui5.types.Background_drawingEffect}sDrawingEffect New value for property drawingEffect
Returns:
{sap.viz.ui5.types.Background} Reference to this in order to allow method chaining
setVisible(bVisible): sap.viz.ui5.types.Background
Sets a new value for property visible.

Set the visibility

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

Define the color for the plot background body.

Default value is transparent.

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 color
setColor(sColor): sap.viz.ui5.types.Background
Sets a new value for property color.

Define the color for the plot background body.

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

Default value is transparent.

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