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

extends BaseStructuredType

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

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.Heatmap.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.viz.ui5.types.Heatmap with name sClassName and enriches it with the information contained in oClassInfo.
sap.viz.ui5.types.Heatmap.getMetadata()Returns a metadata object for class sap.viz.ui5.types.Heatmap.
destroyAnimation()Destroys the animation in the aggregation animation.
destroyBorder()Destroys the border in the aggregation border.
getAnimation()Gets content of aggregation animation.
getBorder()Gets content of aggregation border.
getColorPalette()Gets current value of property colorPalette.
getEndColor()Gets current value of property endColor.
getFormatRules()Gets current value of property formatRules.
getLegendValues()Gets current value of property legendValues.
getStartColor()Gets current value of property startColor.
setAnimation(oAnimation)Sets the aggregated animation.
setBorder(oBorder)Sets the aggregated border.
setColorPalette(sColorPalette)Sets a new value for property colorPalette.
setEndColor(sEndColor)Sets a new value for property endColor.
setFormatRules(sFormatRules)Sets a new value for property formatRules.
setLegendValues(sLegendValues)Sets a new value for property legendValues.
setStartColor(sStartColor)Sets a new value for property startColor.
destroyToolTip()Destroys the toolTip in the aggregation toolTip.
getToolTip()Gets content of aggregation toolTip.
setToolTip(oToolTip)Sets the aggregated toolTip.
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.Heatmap(sId?, mSettings?)
Constructor for a new sap.viz.ui5.types.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:

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.Heatmap.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.viz.ui5.types.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.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.Heatmap.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.viz.ui5.types.Heatmap.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
destroyAnimation(): sap.viz.ui5.types.Heatmap
Destroys the animation in the aggregation animation.
Returns:
{sap.viz.ui5.types.Heatmap} Reference to this in order to allow method chaining
destroyBorder(): sap.viz.ui5.types.Heatmap
Destroys the border in the aggregation border.
Returns:
{sap.viz.ui5.types.Heatmap} Reference to this in order to allow method chaining
getAnimation(): sap.viz.ui5.types.Heatmap_animation
Gets content of aggregation animation.

Settings for animations in the plot area

Returns:
{sap.viz.ui5.types.Heatmap_animation}
getBorder(): sap.viz.ui5.types.Heatmap_border
Gets content of aggregation border.

Settings for the border

Returns:
{sap.viz.ui5.types.Heatmap_border}
getColorPalette(): string[]
Gets current value of property colorPalette.

Set the color palette for the various sectors. For example, ["#748CB2", "#9CC677", "#EACF5E", "#F9AD79", "#D16A7C"].

Returns:
{string[]} Value of property colorPalette
getEndColor(): string
Gets current value of property endColor.

Set the end color of the heat map

Default value is #73C03C.

Returns:
{string} Value of property endColor
getFormatRules(): object[]
Gets current value of property formatRules.

Sample value for formatRules: [{condition: [{Key1:Value1, Key2:Value2}], color:"#00ff00"}, {condition: [{Key3:Value3}], color:"#00ffff"}]. Each rule has two properties: the "condition" and the "color". Value1, Value2 and Value3 are values.
The value of a dimension may be
1, Single value (string), like "China" .
2. Array (enumeration), like ["UK","USA"] .
The value of a measure may be
1, Single value (number), like 20 .
2. Arry (enumeration), like [121,122] .
3. Object (range), like {min:100, max 200} . Min and max are inclusive. If users want to inlcude 200, but not 100 in the range, they may use {min:100.00001, max:200}. If users want values larger than 100, they may write {min:100}.
The color is applied if one or more conditions in the condition array is met. If multiple rules could apply on the same data point, it is the last rule that takes effect.

Returns:
{object[]} Value of property formatRules
getLegendValues(): int[]
Gets current value of property legendValues.

Set the MBC legend values. For example, [10,11,12,13,14,15]. The values in the array should be in ascending order. If the number of values in the array is smaller than the MBC legend segment number, the MBC legend automatically calculates the values according to the data. If the number of values in the legendValues array is larger than MBC legend segment number, then only the first "segment number + 1" values are used.

Returns:
{int[]} Value of property legendValues
getStartColor(): string
Gets current value of property startColor.

Set the starting color of the heat map

Default value is #C2E3A9.

Returns:
{string} Value of property startColor
setAnimation(oAnimation): sap.viz.ui5.types.Heatmap
Sets the aggregated animation.
Parameters:
{sap.viz.ui5.types.Heatmap_animation}oAnimation The animation to set
Returns:
{sap.viz.ui5.types.Heatmap} Reference to this in order to allow method chaining
setBorder(oBorder): sap.viz.ui5.types.Heatmap
Sets the aggregated border.
Parameters:
{sap.viz.ui5.types.Heatmap_border}oBorder The border to set
Returns:
{sap.viz.ui5.types.Heatmap} Reference to this in order to allow method chaining
setColorPalette(sColorPalette): sap.viz.ui5.types.Heatmap
Sets a new value for property colorPalette.

Set the color palette for the various sectors. For example, ["#748CB2", "#9CC677", "#EACF5E", "#F9AD79", "#D16A7C"].

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

Parameters:
{string[]}sColorPalette New value for property colorPalette
Returns:
{sap.viz.ui5.types.Heatmap} Reference to this in order to allow method chaining
setEndColor(sEndColor): sap.viz.ui5.types.Heatmap
Sets a new value for property endColor.

Set the end color of the heat map

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

Default value is #73C03C.

Parameters:
{string}sEndColor New value for property endColor
Returns:
{sap.viz.ui5.types.Heatmap} Reference to this in order to allow method chaining
setFormatRules(sFormatRules): sap.viz.ui5.types.Heatmap
Sets a new value for property formatRules.

Sample value for formatRules: [{condition: [{Key1:Value1, Key2:Value2}], color:"#00ff00"}, {condition: [{Key3:Value3}], color:"#00ffff"}]. Each rule has two properties: the "condition" and the "color". Value1, Value2 and Value3 are values.
The value of a dimension may be
1, Single value (string), like "China" .
2. Array (enumeration), like ["UK","USA"] .
The value of a measure may be
1, Single value (number), like 20 .
2. Arry (enumeration), like [121,122] .
3. Object (range), like {min:100, max 200} . Min and max are inclusive. If users want to inlcude 200, but not 100 in the range, they may use {min:100.00001, max:200}. If users want values larger than 100, they may write {min:100}.
The color is applied if one or more conditions in the condition array is met. If multiple rules could apply on the same data point, it is the last rule that takes effect.

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

Parameters:
{object[]}sFormatRules New value for property formatRules
Returns:
{sap.viz.ui5.types.Heatmap} Reference to this in order to allow method chaining
setLegendValues(sLegendValues): sap.viz.ui5.types.Heatmap
Sets a new value for property legendValues.

Set the MBC legend values. For example, [10,11,12,13,14,15]. The values in the array should be in ascending order. If the number of values in the array is smaller than the MBC legend segment number, the MBC legend automatically calculates the values according to the data. If the number of values in the legendValues array is larger than MBC legend segment number, then only the first "segment number + 1" values are used.

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

Parameters:
{int[]}sLegendValues New value for property legendValues
Returns:
{sap.viz.ui5.types.Heatmap} Reference to this in order to allow method chaining
setStartColor(sStartColor): sap.viz.ui5.types.Heatmap
Sets a new value for property startColor.

Set the starting color of the heat map

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

Default value is #C2E3A9.

Parameters:
{string}sStartColor New value for property startColor
Returns:
{sap.viz.ui5.types.Heatmap} Reference to this in order to allow method chaining
destroyToolTip(): sap.viz.ui5.types.Heatmap
Destroys the toolTip in the aggregation toolTip.
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.Heatmap} Reference to this in order to allow method chaining
getToolTip(): sap.viz.ui5.types.Heatmap_tooltip
Gets content of aggregation toolTip.

Settings for tooltip

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.Heatmap_tooltip}
setToolTip(oToolTip): sap.viz.ui5.types.Heatmap
Sets the aggregated toolTip.
Parameters:
{sap.viz.ui5.types.Heatmap_tooltip}oToolTip The toolTip 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.Heatmap} Reference to this in order to allow method chaining