Class sap.viz.ui5.types.TitleModule: sap/viz/ui5/types/Title

extends BaseStructuredType

Module sap.viz.ui5.types.Title

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

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.Title.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.viz.ui5.types.Title with name sClassName and enriches it with the information contained in oClassInfo.
sap.viz.ui5.types.Title.getMetadata()Returns a metadata object for class sap.viz.ui5.types.Title.
getAlignment()Gets current value of property alignment.
getText()Gets current value of property text.
getVisible()Gets current value of property visible.
setAlignment(sAlignment)Sets a new value for property alignment.
setText(sText)Sets a new value for property text.
setVisible(bVisible)Sets a new value for property visible.
destroyLayout()Destroys the layout in the aggregation layout.
getLayout()Gets content of aggregation layout.
setLayout(oLayout)Sets the aggregated layout.
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.Title(sId?, mSettings?)
Constructor for a new sap.viz.ui5.types.Title

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: false)
    • text : string
    • alignment : sap.viz.ui5.types.Title_alignment (default: center)
  • Aggregations
    • layout : sap.viz.ui5.types.Title_layout

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

Set the alignment of the main title

Default value is center.

Returns:
{sap.viz.ui5.types.Title_alignment} Value of property alignment
getText(): string
Gets current value of property text.

Set the text of the main title

Returns:
{string} Value of property text
getVisible(): boolean
Gets current value of property visible.

Set the visibility of the main title

Default value is false.

Returns:
{boolean} Value of property visible
setAlignment(sAlignment): sap.viz.ui5.types.Title
Sets a new value for property alignment.

Set the alignment of the main title

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

Default value is center.

Parameters:
{sap.viz.ui5.types.Title_alignment}sAlignment New value for property alignment
Returns:
{sap.viz.ui5.types.Title} Reference to this in order to allow method chaining
setText(sText): sap.viz.ui5.types.Title
Sets a new value for property text.

Set the text of the main title

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

Parameters:
{string}sText New value for property text
Returns:
{sap.viz.ui5.types.Title} Reference to this in order to allow method chaining
setVisible(bVisible): sap.viz.ui5.types.Title
Sets a new value for property visible.

Set the visibility of the main title

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

Default value is false.

Parameters:
{boolean}bVisible New value for property visible
Returns:
{sap.viz.ui5.types.Title} Reference to this in order to allow method chaining
destroyLayout(): sap.viz.ui5.types.Title
Destroys the layout in the aggregation layout.
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.Title} Reference to this in order to allow method chaining
getLayout(): sap.viz.ui5.types.Title_layout
Gets content of aggregation layout.

Settings for layout of title

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.Title_layout}
setLayout(oLayout): sap.viz.ui5.types.Title
Sets the aggregated layout.
Parameters:
{sap.viz.ui5.types.Title_layout}oLayout The layout to set
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.Title} Reference to this in order to allow method chaining