Class sap.viz.ui5.HeatmapModule: sap/viz/ui5/Heatmap

extends BaseChart

Chart sap.viz.ui5.Heatmap

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(new sap.viz.ui5.controls.VizFrame({'vizType': 'heatmap'})) 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.Heatmap(sId?, mSettings?)Constructor for a new sap.viz.ui5.Heatmap

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.

Event Summary
deselectData(oControlEvent)Event fires when certain data point(s) is(are) deselected, data context of deselected item(s) would be passed in accordance with the following format.
initialized(oControlEvent)Event fires when the loading ends.
selectData(oControlEvent)Event fires when certain data point(s) is(are) selected, data context of selected item(s) would be passed in accordance with the following format.
hideTooltip(oControlEvent)This event is deprecated, please use hideDetail decoration (refer to properties: interaction.decorations) instead.
showTooltip(oControlEvent)This event is deprecated, please use showDetail decoration (refer to properties: interaction.decorations) instead.
Events borrowed from class sap.viz.ui5.core.BaseChart
beforeCreateViz
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.Heatmap.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.viz.ui5.Heatmap with name sClassName and enriches it with the information contained in oClassInfo.
sap.viz.ui5.Heatmap.getMetadata()Returns a metadata object for class sap.viz.ui5.Heatmap.
attachDeselectData(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the deselectData event of this sap.viz.ui5.Heatmap.
attachInitialized(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the initialized event of this sap.viz.ui5.Heatmap.
attachSelectData(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the selectData event of this sap.viz.ui5.Heatmap.
destroyDataLabel()Destroys the dataLabel in the aggregation dataLabel.
destroyGeneral()Destroys the general in the aggregation general.
destroyInteraction()Destroys the interaction in the aggregation interaction.
destroyLegend()Destroys the legend in the aggregation legend.
destroyLegendGroup()Destroys the legendGroup in the aggregation legendGroup.
destroyPlotArea()Destroys the plotArea in the aggregation plotArea.
destroyTitle()Destroys the title in the aggregation title.
destroyToolTip()Destroys the toolTip in the aggregation toolTip.
destroyXAxis()Destroys the xAxis in the aggregation xAxis.
destroyXyContainer()Destroys the xyContainer in the aggregation xyContainer.
destroyYAxis()Destroys the yAxis in the aggregation yAxis.
detachDeselectData(fnFunction, oListener)Detaches event handler fnFunction from the deselectData event of this sap.viz.ui5.Heatmap.
detachInitialized(fnFunction, oListener)Detaches event handler fnFunction from the initialized event of this sap.viz.ui5.Heatmap.
detachSelectData(fnFunction, oListener)Detaches event handler fnFunction from the selectData event of this sap.viz.ui5.Heatmap.
fireDeselectData(mArguments?)Fires event deselectData to attached listeners.
fireInitialized(mArguments?)Fires event initialized to attached listeners.
fireSelectData(mArguments?)Fires event selectData to attached listeners.
getDataLabel()Gets content of aggregation dataLabel.
getGeneral()Gets content of aggregation general.
getInteraction()Gets content of aggregation interaction.
getLegend()Gets content of aggregation legend.
getLegendGroup()Gets content of aggregation legendGroup.
getPlotArea()Gets content of aggregation plotArea.
getTitle()Gets content of aggregation title.
getToolTip()Gets content of aggregation toolTip.
getXAxis()Gets content of aggregation xAxis.
getXyContainer()Gets content of aggregation xyContainer.
getYAxis()Gets content of aggregation yAxis.
setDataLabel(oDataLabel)Sets the aggregated dataLabel.
setGeneral(oGeneral)Sets the aggregated general.
setInteraction(oInteraction)Sets the aggregated interaction.
setLegend(oLegend)Sets the aggregated legend.
setLegendGroup(oLegendGroup)Sets the aggregated legendGroup.
setPlotArea(oPlotArea)Sets the aggregated plotArea.
setTitle(oTitle)Sets the aggregated title.
setToolTip(oToolTip)Sets the aggregated toolTip.
setXAxis(oXAxis)Sets the aggregated xAxis.
setXyContainer(oXyContainer)Sets the aggregated xyContainer.
setYAxis(oYAxis)Sets the aggregated yAxis.
attachHideTooltip(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the hideTooltip event of this sap.viz.ui5.Heatmap.
attachShowTooltip(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the showTooltip event of this sap.viz.ui5.Heatmap.
detachHideTooltip(fnFunction, oListener)Detaches event handler fnFunction from the hideTooltip event of this sap.viz.ui5.Heatmap.
detachShowTooltip(fnFunction, oListener)Detaches event handler fnFunction from the showTooltip event of this sap.viz.ui5.Heatmap.
fireHideTooltip(mArguments?)Fires event hideTooltip to attached listeners.
fireShowTooltip(mArguments?)Fires event showTooltip to attached listeners.
Methods borrowed from class sap.viz.ui5.core.BaseChart
attachBeforeCreateViz, destroyDataset, destroyNoData, detachBeforeCreateViz, fireBeforeCreateViz, getCss, getDataset, getHeight, getNoData, getWidth, setCss, setDataset, setHeight, setNoData, setWidth
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.Heatmap(sId?, mSettings?)
Constructor for a new sap.viz.ui5.Heatmap

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:

  • Aggregations
  • Events
    • selectData : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • deselectData : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • showTooltip : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • hideTooltip : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • initialized : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.viz.ui5.core.BaseChart 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(new sap.viz.ui5.controls.VizFrame({'vizType': 'heatmap'})) 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.

Event Detail
deselectData(oControlEvent)
Event fires when certain data point(s) is(are) deselected, data context of deselected item(s) would be passed in accordance with the following format.{name: "deselectData",data:["---the same as selectedData---"]}
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
initialized(oControlEvent)
Event fires when the loading ends. To use the event listener when creating charts, you must use an event that is passed by the events option. For more information on events options, see the usrOptions section of the createViz function in the API document.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
selectData(oControlEvent)
Event fires when certain data point(s) is(are) selected, data context of selected item(s) would be passed in accordance with the following format.{name: "selectData",data:[{ //selected element's detail target:"Dom Element",//an object pointed to corresponding dom element data:[{val: "...",//value of this element ctx:{type:"Dimension"||"Measure"||"MND", //for Dimension path:{aa:"...",di:"...",dii:"..."}, //for Measure path:{mg:"...",mi:"...",dii_a1:"...",dii_a2:"..."}, //for MND path:{mg:"...",mi:"..."} //path: analysis path //aa: analysis axis index // 0 for analysis axis 1, 1 for analysis 2 //di: dimension index //zero based //dii: dimension item index //zero based //mg: measure group index // 0 for measure group 1,1 for measure group 2 //mi: measure index // measure index in measure group zero based //dii_a1: each dii of di in analysis axis 1 index //dii_a2: each dii of di in analysis axis 2 index }},{ //for bubble, tagcloud and scatter, there will be more than one values in one selected element. var:"...",ctx:"..."}]},{ //if under multi selection, there will be more than one selected elements target:"...",data:["..."]}]}
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
hideTooltip(oControlEvent)
This event is deprecated, please use hideDetail decoration (refer to properties: interaction.decorations) instead. Event fires when the mouse hover out of the specific part of chart, no data is passed.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
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.
showTooltip(oControlEvent)
This event is deprecated, please use showDetail decoration (refer to properties: interaction.decorations) instead. Event fires when the mouse hover onto the specific part of chart, data context of tooltip would be passed in accordance with the following format.{name:"showTooltip",data:{body:[{ //All measures name:"...",val:[{//measure value is an array containing only one item value:"..."}]},"..."],footer:[{label:"...",value:"..."},"..."],plotArea:{ //this object specifies the plot area of the chart height:"...",width:"...",x:"...",y:"..."},point:{ //this object specifies a point which affects the position of tooltip x:"...",y:"..."},selectedValues:...//this number specify how many values are selected}}
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
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.
Method Detail
sap.viz.ui5.Heatmap.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.viz.ui5.Heatmap 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.BaseChart.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.Heatmap.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.viz.ui5.Heatmap.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
attachDeselectData(oData?, fnFunction, oListener?): sap.viz.ui5.Heatmap
Attaches event handler fnFunction to the deselectData event of this sap.viz.ui5.Heatmap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.viz.ui5.Heatmap itself.

Event fires when certain data point(s) is(are) deselected, data context of deselected item(s) would be passed in accordance with the following format.{name: "deselectData",data:["---the same as selectedData---"]}

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.viz.ui5.Heatmap itself
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
attachInitialized(oData?, fnFunction, oListener?): sap.viz.ui5.Heatmap
Attaches event handler fnFunction to the initialized event of this sap.viz.ui5.Heatmap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.viz.ui5.Heatmap itself.

Event fires when the loading ends. To use the event listener when creating charts, you must use an event that is passed by the events option. For more information on events options, see the usrOptions section of the createViz function in the API document.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.viz.ui5.Heatmap itself
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
attachSelectData(oData?, fnFunction, oListener?): sap.viz.ui5.Heatmap
Attaches event handler fnFunction to the selectData event of this sap.viz.ui5.Heatmap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.viz.ui5.Heatmap itself.

Event fires when certain data point(s) is(are) selected, data context of selected item(s) would be passed in accordance with the following format.{name: "selectData",data:[{ //selected element's detail target:"Dom Element",//an object pointed to corresponding dom element data:[{val: "...",//value of this element ctx:{type:"Dimension"||"Measure"||"MND", //for Dimension path:{aa:"...",di:"...",dii:"..."}, //for Measure path:{mg:"...",mi:"...",dii_a1:"...",dii_a2:"..."}, //for MND path:{mg:"...",mi:"..."} //path: analysis path //aa: analysis axis index // 0 for analysis axis 1, 1 for analysis 2 //di: dimension index //zero based //dii: dimension item index //zero based //mg: measure group index // 0 for measure group 1,1 for measure group 2 //mi: measure index // measure index in measure group zero based //dii_a1: each dii of di in analysis axis 1 index //dii_a2: each dii of di in analysis axis 2 index }},{ //for bubble, tagcloud and scatter, there will be more than one values in one selected element. var:"...",ctx:"..."}]},{ //if under multi selection, there will be more than one selected elements target:"...",data:["..."]}]}

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.viz.ui5.Heatmap itself
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
destroyDataLabel(): sap.viz.ui5.Heatmap
Destroys the dataLabel in the aggregation dataLabel.
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
destroyGeneral(): sap.viz.ui5.Heatmap
Destroys the general in the aggregation general.
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
destroyInteraction(): sap.viz.ui5.Heatmap
Destroys the interaction in the aggregation interaction.
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
destroyLegend(): sap.viz.ui5.Heatmap
Destroys the legend in the aggregation legend.
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
destroyLegendGroup(): sap.viz.ui5.Heatmap
Destroys the legendGroup in the aggregation legendGroup.
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
destroyPlotArea(): sap.viz.ui5.Heatmap
Destroys the plotArea in the aggregation plotArea.
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
destroyTitle(): sap.viz.ui5.Heatmap
Destroys the title in the aggregation title.
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
destroyToolTip(): sap.viz.ui5.Heatmap
Destroys the toolTip in the aggregation toolTip.
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
destroyXAxis(): sap.viz.ui5.Heatmap
Destroys the xAxis in the aggregation xAxis.
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
destroyXyContainer(): sap.viz.ui5.Heatmap
Destroys the xyContainer in the aggregation xyContainer.
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
destroyYAxis(): sap.viz.ui5.Heatmap
Destroys the yAxis in the aggregation yAxis.
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
detachDeselectData(fnFunction, oListener): sap.viz.ui5.Heatmap
Detaches event handler fnFunction from the deselectData event of this sap.viz.ui5.Heatmap.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
detachInitialized(fnFunction, oListener): sap.viz.ui5.Heatmap
Detaches event handler fnFunction from the initialized event of this sap.viz.ui5.Heatmap.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
detachSelectData(fnFunction, oListener): sap.viz.ui5.Heatmap
Detaches event handler fnFunction from the selectData event of this sap.viz.ui5.Heatmap.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
fireDeselectData(mArguments?): sap.viz.ui5.Heatmap
Fires event deselectData to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
fireInitialized(mArguments?): sap.viz.ui5.Heatmap
Fires event initialized to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
fireSelectData(mArguments?): sap.viz.ui5.Heatmap
Fires event selectData to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
getDataLabel(): sap.viz.ui5.types.Datalabel
Gets content of aggregation dataLabel.

Module sap.viz.modules.datalabel

Returns:
{sap.viz.ui5.types.Datalabel}
getGeneral(): sap.viz.ui5.types.RootContainer
Gets content of aggregation general.

Module sap.viz.modules.rootContainer

Returns:
{sap.viz.ui5.types.RootContainer}
getInteraction(): sap.viz.ui5.types.controller.Interaction
Gets content of aggregation interaction.

Module sap.viz.modules.controller.interaction

Returns:
{sap.viz.ui5.types.controller.Interaction}
getLegend(): sap.viz.ui5.types.legend.Common
Gets content of aggregation legend.

Module sap.viz.modules.legend.common

Returns:
{sap.viz.ui5.types.legend.Common}
getLegendGroup(): sap.viz.ui5.types.Legend
Gets content of aggregation legendGroup.

Module sap.viz.modules.legend

Returns:
{sap.viz.ui5.types.Legend}
getPlotArea(): sap.viz.ui5.types.Heatmap
Gets content of aggregation plotArea.

Module sap.viz.modules.heatmap

Returns:
{sap.viz.ui5.types.Heatmap}
getTitle(): sap.viz.ui5.types.Title
Gets content of aggregation title.

Module sap.viz.modules.title

Returns:
{sap.viz.ui5.types.Title}
getToolTip(): sap.viz.ui5.types.Tooltip
Gets content of aggregation toolTip.

Module sap.viz.chart.elements.Tooltip

Returns:
{sap.viz.ui5.types.Tooltip}
getXAxis(): sap.viz.ui5.types.Axis
Gets content of aggregation xAxis.

Module sap.viz.modules.axis

Returns:
{sap.viz.ui5.types.Axis}
getXyContainer(): sap.viz.ui5.types.XYContainer
Gets content of aggregation xyContainer.

Module sap.viz.modules.xycontainer

Returns:
{sap.viz.ui5.types.XYContainer}
getYAxis(): sap.viz.ui5.types.Axis
Gets content of aggregation yAxis.

Module sap.viz.modules.axis

Returns:
{sap.viz.ui5.types.Axis}
setDataLabel(oDataLabel): sap.viz.ui5.Heatmap
Sets the aggregated dataLabel.
Parameters:
{sap.viz.ui5.types.Datalabel}oDataLabel The dataLabel to set
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
setGeneral(oGeneral): sap.viz.ui5.Heatmap
Sets the aggregated general.
Parameters:
{sap.viz.ui5.types.RootContainer}oGeneral The general to set
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
setInteraction(oInteraction): sap.viz.ui5.Heatmap
Sets the aggregated interaction.
Parameters:
{sap.viz.ui5.types.controller.Interaction}oInteraction The interaction to set
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
setLegend(oLegend): sap.viz.ui5.Heatmap
Sets the aggregated legend.
Parameters:
{sap.viz.ui5.types.legend.Common}oLegend The legend to set
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
setLegendGroup(oLegendGroup): sap.viz.ui5.Heatmap
Sets the aggregated legendGroup.
Parameters:
{sap.viz.ui5.types.Legend}oLegendGroup The legendGroup to set
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
setPlotArea(oPlotArea): sap.viz.ui5.Heatmap
Sets the aggregated plotArea.
Parameters:
{sap.viz.ui5.types.Heatmap}oPlotArea The plotArea to set
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
setTitle(oTitle): sap.viz.ui5.Heatmap
Sets the aggregated title.
Parameters:
{sap.viz.ui5.types.Title}oTitle The title to set
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
setToolTip(oToolTip): sap.viz.ui5.Heatmap
Sets the aggregated toolTip.
Parameters:
{sap.viz.ui5.types.Tooltip}oToolTip The toolTip to set
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
setXAxis(oXAxis): sap.viz.ui5.Heatmap
Sets the aggregated xAxis.
Parameters:
{sap.viz.ui5.types.Axis}oXAxis The xAxis to set
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
setXyContainer(oXyContainer): sap.viz.ui5.Heatmap
Sets the aggregated xyContainer.
Parameters:
{sap.viz.ui5.types.XYContainer}oXyContainer The xyContainer to set
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
setYAxis(oYAxis): sap.viz.ui5.Heatmap
Sets the aggregated yAxis.
Parameters:
{sap.viz.ui5.types.Axis}oYAxis The yAxis to set
Returns:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
attachHideTooltip(oData?, fnFunction, oListener?): sap.viz.ui5.Heatmap
Attaches event handler fnFunction to the hideTooltip event of this sap.viz.ui5.Heatmap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.viz.ui5.Heatmap itself.

This event is deprecated, please use hideDetail decoration (refer to properties: interaction.decorations) instead. Event fires when the mouse hover out of the specific part of chart, no data is passed.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.viz.ui5.Heatmap itself
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:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
attachShowTooltip(oData?, fnFunction, oListener?): sap.viz.ui5.Heatmap
Attaches event handler fnFunction to the showTooltip event of this sap.viz.ui5.Heatmap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.viz.ui5.Heatmap itself.

This event is deprecated, please use showDetail decoration (refer to properties: interaction.decorations) instead. Event fires when the mouse hover onto the specific part of chart, data context of tooltip would be passed in accordance with the following format.{name:"showTooltip",data:{body:[{ //All measures name:"...",val:[{//measure value is an array containing only one item value:"..."}]},"..."],footer:[{label:"...",value:"..."},"..."],plotArea:{ //this object specifies the plot area of the chart height:"...",width:"...",x:"...",y:"..."},point:{ //this object specifies a point which affects the position of tooltip x:"...",y:"..."},selectedValues:...//this number specify how many values are selected}}

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.viz.ui5.Heatmap itself
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:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
detachHideTooltip(fnFunction, oListener): sap.viz.ui5.Heatmap
Detaches event handler fnFunction from the hideTooltip event of this sap.viz.ui5.Heatmap.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
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:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
detachShowTooltip(fnFunction, oListener): sap.viz.ui5.Heatmap
Detaches event handler fnFunction from the showTooltip event of this sap.viz.ui5.Heatmap.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
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:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
fireHideTooltip(mArguments?): sap.viz.ui5.Heatmap
Fires event hideTooltip to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
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:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining
fireShowTooltip(mArguments?): sap.viz.ui5.Heatmap
Fires event showTooltip to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
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:
{sap.viz.ui5.Heatmap} Reference to this in order to allow method chaining