Class sap.viz.ui5.types.RootContainer_layoutModule: sap/viz/ui5/types/RootContainer_layout

extends BaseStructuredType

Settings for the layout of the root container

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

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.RootContainer_layout.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.viz.ui5.types.RootContainer_layout with name sClassName and enriches it with the information contained in oClassInfo.
sap.viz.ui5.types.RootContainer_layout.getMetadata()Returns a metadata object for class sap.viz.ui5.types.RootContainer_layout.
getPadding()Gets current value of property padding.
getPaddingBottom()Gets current value of property paddingBottom.
getPaddingLeft()Gets current value of property paddingLeft.
getPaddingRight()Gets current value of property paddingRight.
getPaddingTop()Gets current value of property paddingTop.
setPadding(iPadding)Sets a new value for property padding.
setPaddingBottom(iPaddingBottom)Sets a new value for property paddingBottom.
setPaddingLeft(iPaddingLeft)Sets a new value for property paddingLeft.
setPaddingRight(iPaddingRight)Sets a new value for property paddingRight.
setPaddingTop(iPaddingTop)Sets a new value for property paddingTop.
getAdjustPolicy()Gets current value of property adjustPolicy.
getHgap()Gets current value of property hgap.
getHideAxisTitleFirst()Gets current value of property hideAxisTitleFirst.
getVgap()Gets current value of property vgap.
setAdjustPolicy(sAdjustPolicy)Sets a new value for property adjustPolicy.
setHgap(iHgap)Sets a new value for property hgap.
setHideAxisTitleFirst(bHideAxisTitleFirst)Sets a new value for property hideAxisTitleFirst.
setVgap(iVgap)Sets a new value for property vgap.
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.RootContainer_layout(sId?, mSettings?)
Constructor for a new sap.viz.ui5.types.RootContainer_layout

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

Set the universal padding value. This single value is applied to all sides of the chart. Individual settings for each edge are also supported.

Default value is 24.

Returns:
{int} Value of property padding
getPaddingBottom(): int
Gets current value of property paddingBottom.

Set the padding value for the bottom side

Returns:
{int} Value of property paddingBottom
getPaddingLeft(): int
Gets current value of property paddingLeft.

Set the padding value for the left side

Returns:
{int} Value of property paddingLeft
getPaddingRight(): int
Gets current value of property paddingRight.

Set the padding value for the right side

Returns:
{int} Value of property paddingRight
getPaddingTop(): int
Gets current value of property paddingTop.

Set the padding value for the top side

Returns:
{int} Value of property paddingTop
setPadding(iPadding): sap.viz.ui5.types.RootContainer_layout
Sets a new value for property padding.

Set the universal padding value. This single value is applied to all sides of the chart. Individual settings for each edge are also supported.

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

Default value is 24.

Parameters:
{int}iPadding New value for property padding
Returns:
{sap.viz.ui5.types.RootContainer_layout} Reference to this in order to allow method chaining
setPaddingBottom(iPaddingBottom): sap.viz.ui5.types.RootContainer_layout
Sets a new value for property paddingBottom.

Set the padding value for the bottom side

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

Parameters:
{int}iPaddingBottom New value for property paddingBottom
Returns:
{sap.viz.ui5.types.RootContainer_layout} Reference to this in order to allow method chaining
setPaddingLeft(iPaddingLeft): sap.viz.ui5.types.RootContainer_layout
Sets a new value for property paddingLeft.

Set the padding value for the left side

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

Parameters:
{int}iPaddingLeft New value for property paddingLeft
Returns:
{sap.viz.ui5.types.RootContainer_layout} Reference to this in order to allow method chaining
setPaddingRight(iPaddingRight): sap.viz.ui5.types.RootContainer_layout
Sets a new value for property paddingRight.

Set the padding value for the right side

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

Parameters:
{int}iPaddingRight New value for property paddingRight
Returns:
{sap.viz.ui5.types.RootContainer_layout} Reference to this in order to allow method chaining
setPaddingTop(iPaddingTop): sap.viz.ui5.types.RootContainer_layout
Sets a new value for property paddingTop.

Set the padding value for the top side

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

Parameters:
{int}iPaddingTop New value for property paddingTop
Returns:
{sap.viz.ui5.types.RootContainer_layout} Reference to this in order to allow method chaining
getAdjustPolicy(): string
Gets current value of property adjustPolicy.

Indicates the layout adjust policy

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 adjustPolicy
getHgap(): int
Gets current value of property hgap.

Horizontal gap value between UI components

Default value is 8.

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 hgap
getHideAxisTitleFirst(): boolean
Gets current value of property hideAxisTitleFirst.

Hide axis title firstly if the space is limited.

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.
Returns:
{boolean} Value of property hideAxisTitleFirst
getVgap(): int
Gets current value of property vgap.

Vertical gap value between UI components

Default value is 8.

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 vgap
setAdjustPolicy(sAdjustPolicy): sap.viz.ui5.types.RootContainer_layout
Sets a new value for property adjustPolicy.

Indicates the layout adjust policy

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

Parameters:
{string}sAdjustPolicy New value for property adjustPolicy
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.RootContainer_layout} Reference to this in order to allow method chaining
setHgap(iHgap): sap.viz.ui5.types.RootContainer_layout
Sets a new value for property hgap.

Horizontal gap value between UI components

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

Default value is 8.

Parameters:
{int}iHgap New value for property hgap
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.RootContainer_layout} Reference to this in order to allow method chaining
setHideAxisTitleFirst(bHideAxisTitleFirst): sap.viz.ui5.types.RootContainer_layout
Sets a new value for property hideAxisTitleFirst.

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 true.

Parameters:
{boolean}bHideAxisTitleFirst New value for property hideAxisTitleFirst
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.RootContainer_layout} Reference to this in order to allow method chaining
setVgap(iVgap): sap.viz.ui5.types.RootContainer_layout
Sets a new value for property vgap.

Vertical gap value between UI components

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

Default value is 8.

Parameters:
{int}iVgap New value for property vgap
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.RootContainer_layout} Reference to this in order to allow method chaining