Module sap.viz.ui5.types.Tooltip
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.Tooltip(sId?, mSettings?)Constructor for a new sap.viz.ui5.types.Tooltip Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.
Method Summary
sap.viz.ui5.types.Tooltip.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.viz.ui5.types.Tooltip with name sClassName and enriches it with the information contained in oClassInfo. getVisible()Gets current value of property visible. setLayinChart(bLayinChart)Sets a new value for property layinChart. setPostRender(oPostRender)Sets a new value for property postRender. setPreRender(oPreRender)Sets a new value for property preRender. setVisible(bVisible)Sets a new value for property visible. $,
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 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 Constructor Detail
new sap.viz.ui5.types.Tooltip(sId?, mSettings?)
Constructor for a new sap.viz.ui5.types.Tooltip
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.Tooltip.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.viz.ui5.types.Tooltip 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 |
Returns a metadata object for class sap.viz.ui5.types.Tooltip.
Returns:
Destroys the background in the aggregation background.
Returns:
Gets content of aggregation
background.
Define the background style of the tooltip.
Returns:
getFormatString(): any[]
Gets current value of property
formatString.
Set the format strings for text in the tooltip. For dual axis charts, the first array is applied to the primary axis and the second array is applied to the second axis. If you enter fewer format strings into an array than there are measures in the respective axis, then the last format string is applied to all remaining measures. The following characters are reserved as tokens for format code: MDYHSAmdyhsa#?%0@.The following is an example of an array for a chart with two measures: [["#,##0.00 DM;-#,##.00 DM","#,##.00;-#,##.00"]].
Returns:
| {any[]} | Value of property formatString |
getLayinChart(): boolean
Gets current value of property
layinChart.
Set whether the tooltip appears in the chart area
Default value is true.
Returns:
| {boolean} | Value of property layinChart |
getPostRender(): any
Gets current value of property
postRender.
A callback function can be specified as a parameter and passed to chart options when the user calls the createViz function. This callback function is called after the tooltip is rendered. The user can select and change dom elements' properties under the tooltip element.
Returns:
| {any} | Value of property postRender |
getPreRender(): any
Gets current value of property
preRender.
A callback function can be specified as a parameter and passed to chart options when the user calls the createViz function. This callback function is called before the tooltip is rendered. The input parameter is a dom element, which is at the bottom of the tooltip. Any dom element such as a button can be appended to this parent node. It can only be called when the tooltip is in actionMode.
Returns:
| {any} | Value of property preRender |
getVisible(): boolean
Gets current value of property
visible.
Set the visibility of the tooltip
Default value is true.
Returns:
| {boolean} | Value of property visible |
Sets the aggregated background.
Parameters:
Returns:
Sets a new value for property
formatString.
Set the format strings for text in the tooltip. For dual axis charts, the first array is applied to the primary axis and the second array is applied to the second axis. If you enter fewer format strings into an array than there are measures in the respective axis, then the last format string is applied to all remaining measures. The following characters are reserved as tokens for format code: MDYHSAmdyhsa#?%0@.The following is an example of an array for a chart with two measures: [["#,##0.00 DM;-#,##.00 DM","#,##.00;-#,##.00"]].
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {any[]} | sFormatString | New value for property formatString |
Returns:
Sets a new value for property
layinChart.
Set whether the tooltip appears in the chart area
When called with a value of null or undefined, the default value of the property will be restored.
Default value is true.
Parameters:
| {boolean} | bLayinChart | New value for property layinChart |
Returns:
Sets a new value for property
postRender.
A callback function can be specified as a parameter and passed to chart options when the user calls the createViz function. This callback function is called after the tooltip is rendered. The user can select and change dom elements' properties under the tooltip element.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {any} | oPostRender | New value for property postRender |
Returns:
Sets a new value for property
preRender.
A callback function can be specified as a parameter and passed to chart options when the user calls the createViz function. This callback function is called before the tooltip is rendered. The input parameter is a dom element, which is at the bottom of the tooltip. Any dom element such as a button can be appended to this parent node. It can only be called when the tooltip is in actionMode.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {any} | oPreRender | New value for property preRender |
Returns:
Sets a new value for property
visible.
Set the visibility of the tooltip
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:
Destroys the bodyDimensionLabel in the aggregation bodyDimensionLabel.
- 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:
Destroys the bodyDimensionValue in the aggregation bodyDimensionValue.
- 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:
Destroys the bodyMeasureLabel in the aggregation bodyMeasureLabel.
- 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:
Destroys the bodyMeasureValue in the aggregation bodyMeasureValue.
- 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:
Destroys the closeButton in the aggregation closeButton.
- 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:
Destroys the footerLabel in the aggregation footerLabel.
- 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:
Destroys the separationLine in the aggregation separationLine.
- 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:
Gets content of aggregation
bodyDimensionLabel.
Define the color of the dimension name of the tooltip body.
- 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:
Gets content of aggregation
bodyDimensionValue.
Define the color of the dimension value of the tooltip body.
- 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:
Gets content of aggregation
bodyMeasureLabel.
Define the color of the measure name of the tooltip body.
- 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:
Gets content of aggregation
bodyMeasureValue.
Define the color of the measure value of the tooltip body.
- 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:
Gets content of aggregation
closeButton.
Define the background and border color of tooltip close button.
- 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:
Gets current value of property
drawingEffect.
Set the drawing effect for the tooltip
Default value is normal.
- Deprecated:
- Since version 1.19. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.
Returns:
Gets content of aggregation
footerLabel.
Define the style of the label of the tooltip footer.
- 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:
Gets content of aggregation
separationLine.
Define the color of the value of the tooltip separation line.
- 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:
Sets the aggregated bodyDimensionLabel.
Parameters:
- 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:
Sets the aggregated bodyDimensionValue.
Parameters:
- 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:
Sets the aggregated bodyMeasureLabel.
Parameters:
- 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:
Sets the aggregated bodyMeasureValue.
Parameters:
- 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:
Sets the aggregated closeButton.
Parameters:
- 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:
Sets a new value for property
drawingEffect.
Set the drawing effect for the tooltip
When called with a value of null or undefined, the default value of the property will be restored.
Default value is normal.
Parameters:
- Deprecated:
- Since version 1.19. This Property has been deprecated. This interface will be removed from the SAPUI5 delivery in one of the next releases.
Returns:
Sets the aggregated footerLabel.
Parameters:
- 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:
Sets the aggregated separationLine.
Parameters:
- 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: