Class sap.viz.ui5.controls.common.BaseControlModule: sap/viz/ui5/controls/common/BaseControl

extends Control
known direct subclasses: Chart, Popover, VizContainer, VizFrame

An abstract base class for all VIZ controls


Since: 1.22.0.
Constructor Summary
new sap.viz.ui5.controls.common.BaseControl(sId?, mSettings?)Constructor for a new ui5/controls/common/BaseControl.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.viz.ui5.controls.common.BaseControl.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.viz.ui5.controls.common.BaseControl with name sClassName and enriches it with the information contained in oClassInfo.
sap.viz.ui5.controls.common.BaseControl.getMetadata()Returns a metadata object for class sap.viz.ui5.controls.common.BaseControl.
getHeight()Gets current value of property height.
getUiConfig()Gets current value of property uiConfig.
getWidth()Gets current value of property width.
setHeight(sHeight)Sets a new value for property height.
setUiConfig(oUiConfig)Sets a new value for property uiConfig.
setWidth(sWidth)Sets a new value for property width.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, 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, 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, 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.controls.common.BaseControl(sId?, mSettings?)
Constructor for a new ui5/controls/common/BaseControl.

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
    • uiConfig : object
    • width : sap.ui.core.CSSSize (default: 640px)
    • height : sap.ui.core.CSSSize (default: 480px)

In addition, all settings applicable to the base type sap.ui.core.Control 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
Method Detail
sap.viz.ui5.controls.common.BaseControl.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.viz.ui5.controls.common.BaseControl with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.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.controls.common.BaseControl.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.viz.ui5.controls.common.BaseControl.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getHeight(): sap.ui.core.CSSSize
Gets current value of property height.

Height of the VizControl as a CSS size.

Default value is 480px.

Returns:
{sap.ui.core.CSSSize} Value of property height
getUiConfig(): object
Gets current value of property uiConfig.

Configuration for initialization to VizControl. This property could only set via settings parameter in Constructor.

Returns:
{object} Value of property uiConfig
getWidth(): sap.ui.core.CSSSize
Gets current value of property width.

Width of the VizControl as a CSS size.

Default value is 640px.

Returns:
{sap.ui.core.CSSSize} Value of property width
setHeight(sHeight): sap.viz.ui5.controls.common.BaseControl
Sets a new value for property height.

Height of the VizControl as a CSS size.

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

Default value is 480px.

Parameters:
{sap.ui.core.CSSSize}sHeight New value for property height
Returns:
{sap.viz.ui5.controls.common.BaseControl} Reference to this in order to allow method chaining
setUiConfig(oUiConfig): sap.viz.ui5.controls.common.BaseControl
Sets a new value for property uiConfig.

Configuration for initialization to VizControl. This property could only set via settings parameter in Constructor.

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

Parameters:
{object}oUiConfig New value for property uiConfig
Returns:
{sap.viz.ui5.controls.common.BaseControl} Reference to this in order to allow method chaining
setWidth(sWidth): sap.viz.ui5.controls.common.BaseControl
Sets a new value for property width.

Width of the VizControl as a CSS size.

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

Default value is 640px.

Parameters:
{sap.ui.core.CSSSize}sWidth New value for property width
Returns:
{sap.viz.ui5.controls.common.BaseControl} Reference to this in order to allow method chaining