Class sap.viz.ui5.types.Background_borderModule: sap/viz/ui5/types/Background_border

extends BaseStructuredType

Settings for the border

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

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_border.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.viz.ui5.types.Background_border with name sClassName and enriches it with the information contained in oClassInfo.
sap.viz.ui5.types.Background_border.getMetadata()Returns a metadata object for class sap.viz.ui5.types.Background_border.
destroyBottom()Destroys the bottom in the aggregation bottom.
destroyLeft()Destroys the left in the aggregation left.
destroyRight()Destroys the right in the aggregation right.
destroyTop()Destroys the top in the aggregation top.
getBottom()Gets content of aggregation bottom.
getLeft()Gets content of aggregation left.
getRight()Gets content of aggregation right.
getTop()Gets content of aggregation top.
setBottom(oBottom)Sets the aggregated bottom.
setLeft(oLeft)Sets the aggregated left.
setRight(oRight)Sets the aggregated right.
setTop(oTop)Sets the aggregated top.
getStroke()Gets current value of property stroke.
getStrokeWidth()Gets current value of property strokeWidth.
setStroke(sStroke)Sets a new value for property stroke.
setStrokeWidth(iStrokeWidth)Sets a new value for property strokeWidth.
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_border(sId?, mSettings?)
Constructor for a new sap.viz.ui5.types.Background_border

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
  • Aggregations
    • left : sap.viz.ui5.types.Background_border_left
    • right : sap.viz.ui5.types.Background_border_right
    • top : sap.viz.ui5.types.Background_border_top
    • bottom : sap.viz.ui5.types.Background_border_bottom

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_border.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.viz.ui5.types.Background_border 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_border.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.viz.ui5.types.Background_border.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
destroyBottom(): sap.viz.ui5.types.Background_border
Destroys the bottom in the aggregation bottom.
Returns:
{sap.viz.ui5.types.Background_border} Reference to this in order to allow method chaining
destroyLeft(): sap.viz.ui5.types.Background_border
Destroys the left in the aggregation left.
Returns:
{sap.viz.ui5.types.Background_border} Reference to this in order to allow method chaining
destroyRight(): sap.viz.ui5.types.Background_border
Destroys the right in the aggregation right.
Returns:
{sap.viz.ui5.types.Background_border} Reference to this in order to allow method chaining
destroyTop(): sap.viz.ui5.types.Background_border
Destroys the top in the aggregation top.
Returns:
{sap.viz.ui5.types.Background_border} Reference to this in order to allow method chaining
getBottom(): sap.viz.ui5.types.Background_border_bottom
Gets content of aggregation bottom.

Settings for the bottom border

Returns:
{sap.viz.ui5.types.Background_border_bottom}
getLeft(): sap.viz.ui5.types.Background_border_left
Gets content of aggregation left.

Settings for the left border

Returns:
{sap.viz.ui5.types.Background_border_left}
getRight(): sap.viz.ui5.types.Background_border_right
Gets content of aggregation right.

Settings for the right border

Returns:
{sap.viz.ui5.types.Background_border_right}
getTop(): sap.viz.ui5.types.Background_border_top
Gets content of aggregation top.

Settings for the top border

Returns:
{sap.viz.ui5.types.Background_border_top}
setBottom(oBottom): sap.viz.ui5.types.Background_border
Sets the aggregated bottom.
Parameters:
{sap.viz.ui5.types.Background_border_bottom}oBottom The bottom to set
Returns:
{sap.viz.ui5.types.Background_border} Reference to this in order to allow method chaining
setLeft(oLeft): sap.viz.ui5.types.Background_border
Sets the aggregated left.
Parameters:
{sap.viz.ui5.types.Background_border_left}oLeft The left to set
Returns:
{sap.viz.ui5.types.Background_border} Reference to this in order to allow method chaining
setRight(oRight): sap.viz.ui5.types.Background_border
Sets the aggregated right.
Parameters:
{sap.viz.ui5.types.Background_border_right}oRight The right to set
Returns:
{sap.viz.ui5.types.Background_border} Reference to this in order to allow method chaining
setTop(oTop): sap.viz.ui5.types.Background_border
Sets the aggregated top.
Parameters:
{sap.viz.ui5.types.Background_border_top}oTop The top to set
Returns:
{sap.viz.ui5.types.Background_border} Reference to this in order to allow method chaining
getStroke(): string
Gets current value of property stroke.

Settings for the color of the stroke.

Default value is #d8d8d8.

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 stroke
getStrokeWidth(): int
Gets current value of property strokeWidth.

Settings for the width of the stroke.

Default value is 1.

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:
{int} Value of property strokeWidth
setStroke(sStroke): sap.viz.ui5.types.Background_border
Sets a new value for property stroke.

Settings for the color of the stroke.

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

Default value is #d8d8d8.

Parameters:
{string}sStroke New value for property stroke
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_border} Reference to this in order to allow method chaining
setStrokeWidth(iStrokeWidth): sap.viz.ui5.types.Background_border
Sets a new value for property strokeWidth.

Settings for the width of the stroke.

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

Default value is 1.

Parameters:
{int}iStrokeWidth New value for property strokeWidth
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_border} Reference to this in order to allow method chaining