class sap.ui.vbm.Heatmap

Control sample: sap.ui.vbm.Heatmap
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/vbm/Heatmap
Application Component: CA-GTF-VBZ

Type specific Visual Object aggregation for HeatPoint instances.


Constructor

Constructor for a new 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#constructor for a general description of the syntax of the settings object.

new sap.ui.vbm.Heatmap(sId?, mSettings?)
Param Type Default Value Description
sId? string

id for the new control, generated automatically if no id is given

mSettings? object

initial settings for the new control


Properties

Name Type Default Value Description
alphaExponent string 1.0

Exponent for the alphaChannel
aE = 1 : alpha Channel remains linear
0 < aE < 1 : (e.g. aE=0.5 "square root") sub linear alpha channeling (lower value colors remain longer visible; range appears wider)
aE > 1 (e.g. aE=2: "squared") above linear alpha channeling ( lower value colors remain shortly visible; range appears chopped)

Visibility: public
behavior string 2

Behavior of the HeatPoint, 0 Density Map, 2: Heat Map, 1: Intermediate.

Visibility: public
colorExponent string 1.0

Exponent for the color
aE = 1 : Linear Gradient
0 < aE < 1 : Sublinear Gradient; i.E. with cE=0.5 point values are square rooted before usage [share of lower value cols will decrease]
aE > 1 : Higher Level Gradient; i.E. with cE=2 point values are squared before usage [share of lower value cols will increase]

Visibility: public
gradient array

Gradient Definition. Can be either provided as Ressource - then it is type string.
Or as Array [n0,c0,n1,c1,...,nk,ck] (ni > ni-1; ci respective colors) with an arbitrary number of color stops as in the following
Example: [0,'rgba(0,255,0,1)',220,'rgba(255,255,0,1)',255,'rgba(255,0,0,1)']

Visibility: public
opacity string 0.5

Opacity of the heatmap.

Visibility: public
radiusScale string 1.0

Scaling factor for the sample radiuses.

Visibility: public
valueScale string 1.0

Scaling factor for the sample values.

Visibility: public

Aggregations

Default Aggregation: items

Name Cardinality Type Description
items (default) 0..n sap.ui.vbm.HeatPoint

HeatPoint object aggregation


Methods Overview

Method Description
addItem

Adds some item to the aggregation items.

destroyItems

Destroys all the items in the aggregation items.

sap.ui.vbm.Heatmap.extend

Creates a new subclass of class sap.ui.vbm.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.ui.vbm.VoAbstract.extend.

getAlphaExponent

Gets current value of property alphaExponent.

Exponent for the alphaChannel
aE = 1 : alpha Channel remains linear
0 < aE < 1 : (e.g. aE=0.5 "square root") sub linear alpha channeling (lower value colors remain longer visible; range appears wider)
aE > 1 (e.g. aE=2: "squared") above linear alpha channeling ( lower value colors remain shortly visible; range appears chopped)

Default value is '1.0'.

getBehavior

Gets current value of property behavior.

Behavior of the HeatPoint, 0 Density Map, 2: Heat Map, 1: Intermediate.

Default value is '2'.

getColorExponent

Gets current value of property colorExponent.

Exponent for the color
aE = 1 : Linear Gradient
0 < aE < 1 : Sublinear Gradient; i.E. with cE=0.5 point values are square rooted before usage [share of lower value cols will decrease]
aE > 1 : Higher Level Gradient; i.E. with cE=2 point values are squared before usage [share of lower value cols will increase]

Default value is '1.0'.

getGradient

Gets current value of property gradient.

Gradient Definition. Can be either provided as Ressource - then it is type string.
Or as Array [n0,c0,n1,c1,...,nk,ck] (ni > ni-1; ci respective colors) with an arbitrary number of color stops as in the following
Example: [0,'rgba(0,255,0,1)',220,'rgba(255,255,0,1)',255,'rgba(255,0,0,1)']

getItems

Gets content of aggregation items.

HeatPoint object aggregation

sap.ui.vbm.Heatmap.getMetadata

Returns a metadata object for class sap.ui.vbm.Heatmap.

getOpacity

Gets current value of property opacity.

Opacity of the heatmap.

Default value is '0.5'.

getRadiusScale

Gets current value of property radiusScale.

Scaling factor for the sample radiuses.

Default value is '1.0'.

getValueScale

Gets current value of property valueScale.

Scaling factor for the sample values.

Default value is '1.0'.

indexOfItem

Checks for the provided sap.ui.vbm.HeatPoint in the aggregation items. and returns its index if found or -1 otherwise.

insertItem

Inserts a item into the aggregation items.

removeAllItems

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

removeItem

Removes a item from the aggregation items.

setAlphaExponent

Sets a new value for property alphaExponent.

Exponent for the alphaChannel
aE = 1 : alpha Channel remains linear
0 < aE < 1 : (e.g. aE=0.5 "square root") sub linear alpha channeling (lower value colors remain longer visible; range appears wider)
aE > 1 (e.g. aE=2: "squared") above linear alpha channeling ( lower value colors remain shortly visible; range appears chopped)

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

Default value is '1.0'.

setBehavior

Sets a new value for property behavior.

Behavior of the HeatPoint, 0 Density Map, 2: Heat Map, 1: Intermediate.

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

Default value is '2'.

setColorExponent

Sets a new value for property colorExponent.

Exponent for the color
aE = 1 : Linear Gradient
0 < aE < 1 : Sublinear Gradient; i.E. with cE=0.5 point values are square rooted before usage [share of lower value cols will decrease]
aE > 1 : Higher Level Gradient; i.E. with cE=2 point values are squared before usage [share of lower value cols will increase]

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

Default value is '1.0'.

setGradient

Sets a new value for property gradient.

Gradient Definition. Can be either provided as Ressource - then it is type string.
Or as Array [n0,c0,n1,c1,...,nk,ck] (ni > ni-1; ci respective colors) with an arbitrary number of color stops as in the following
Example: [0,'rgba(0,255,0,1)',220,'rgba(255,255,0,1)',255,'rgba(255,0,0,1)']

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

setOpacity

Sets a new value for property opacity.

Opacity of the heatmap.

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

Default value is '0.5'.

setRadiusScale

Sets a new value for property radiusScale.

Scaling factor for the sample radiuses.

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

Default value is '1.0'.

setValueScale

Sets a new value for property valueScale.

Scaling factor for the sample values.

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

Default value is '1.0'.

addItem

Adds some item to the aggregation items.

Param Type DefaultValue Description
oItem sap.ui.vbm.HeatPoint

The item to add; if empty, nothing is inserted

destroyItems

Destroys all the items in the aggregation items.

sap.ui.vbm.Heatmap.extend

Creates a new subclass of class sap.ui.vbm.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.ui.vbm.VoAbstract.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

getAlphaExponent

Gets current value of property alphaExponent.

Exponent for the alphaChannel
aE = 1 : alpha Channel remains linear
0 < aE < 1 : (e.g. aE=0.5 "square root") sub linear alpha channeling (lower value colors remain longer visible; range appears wider)
aE > 1 (e.g. aE=2: "squared") above linear alpha channeling ( lower value colors remain shortly visible; range appears chopped)

Default value is '1.0'.

getBehavior

Gets current value of property behavior.

Behavior of the HeatPoint, 0 Density Map, 2: Heat Map, 1: Intermediate.

Default value is '2'.

getColorExponent

Gets current value of property colorExponent.

Exponent for the color
aE = 1 : Linear Gradient
0 < aE < 1 : Sublinear Gradient; i.E. with cE=0.5 point values are square rooted before usage [share of lower value cols will decrease]
aE > 1 : Higher Level Gradient; i.E. with cE=2 point values are squared before usage [share of lower value cols will increase]

Default value is '1.0'.

getGradient

Gets current value of property gradient.

Gradient Definition. Can be either provided as Ressource - then it is type string.
Or as Array [n0,c0,n1,c1,...,nk,ck] (ni > ni-1; ci respective colors) with an arbitrary number of color stops as in the following
Example: [0,'rgba(0,255,0,1)',220,'rgba(255,255,0,1)',255,'rgba(255,0,0,1)']

getItems

Gets content of aggregation items.

HeatPoint object aggregation

sap.ui.vbm.Heatmap.getMetadata

Returns a metadata object for class sap.ui.vbm.Heatmap.

getOpacity

Gets current value of property opacity.

Opacity of the heatmap.

Default value is '0.5'.

getRadiusScale

Gets current value of property radiusScale.

Scaling factor for the sample radiuses.

Default value is '1.0'.

getValueScale

Gets current value of property valueScale.

Scaling factor for the sample values.

Default value is '1.0'.

indexOfItem

Checks for the provided sap.ui.vbm.HeatPoint in the aggregation items. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oItem sap.ui.vbm.HeatPoint

The item whose index is looked for

insertItem

Inserts a item into the aggregation items.

Param Type DefaultValue Description
oItem sap.ui.vbm.HeatPoint

The item to insert; if empty, nothing is inserted

iIndex int

The 0-based index the item should be inserted at; for a negative value of iIndex, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position

removeAllItems

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

removeItem

Removes a item from the aggregation items.

Param Type DefaultValue Description
vItem int string sap.ui.vbm.HeatPoint

The item to remove or its index or id

setAlphaExponent

Sets a new value for property alphaExponent.

Exponent for the alphaChannel
aE = 1 : alpha Channel remains linear
0 < aE < 1 : (e.g. aE=0.5 "square root") sub linear alpha channeling (lower value colors remain longer visible; range appears wider)
aE > 1 (e.g. aE=2: "squared") above linear alpha channeling ( lower value colors remain shortly visible; range appears chopped)

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

Default value is '1.0'.

Param Type DefaultValue Description
sAlphaExponent string '1.0'

New value for property alphaExponent

setBehavior

Sets a new value for property behavior.

Behavior of the HeatPoint, 0 Density Map, 2: Heat Map, 1: Intermediate.

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

Default value is '2'.

Param Type DefaultValue Description
sBehavior string '2'

New value for property behavior

setColorExponent

Sets a new value for property colorExponent.

Exponent for the color
aE = 1 : Linear Gradient
0 < aE < 1 : Sublinear Gradient; i.E. with cE=0.5 point values are square rooted before usage [share of lower value cols will decrease]
aE > 1 : Higher Level Gradient; i.E. with cE=2 point values are squared before usage [share of lower value cols will increase]

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

Default value is '1.0'.

Param Type DefaultValue Description
sColorExponent string '1.0'

New value for property colorExponent

setGradient

Sets a new value for property gradient.

Gradient Definition. Can be either provided as Ressource - then it is type string.
Or as Array [n0,c0,n1,c1,...,nk,ck] (ni > ni-1; ci respective colors) with an arbitrary number of color stops as in the following
Example: [0,'rgba(0,255,0,1)',220,'rgba(255,255,0,1)',255,'rgba(255,0,0,1)']

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

Param Type DefaultValue Description
sGradient array

New value for property gradient

setOpacity

Sets a new value for property opacity.

Opacity of the heatmap.

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

Default value is '0.5'.

Param Type DefaultValue Description
sOpacity string '0.5'

New value for property opacity

setRadiusScale

Sets a new value for property radiusScale.

Scaling factor for the sample radiuses.

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

Default value is '1.0'.

Param Type DefaultValue Description
sRadiusScale string '1.0'

New value for property radiusScale

setValueScale

Sets a new value for property valueScale.

Scaling factor for the sample values.

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

Default value is '1.0'.

Param Type DefaultValue Description
sValueScale string '1.0'

New value for property valueScale