Class sap.ui.vbm.HeatmapModule: sap/ui/vbm/Heatmap
Type specific Visual Object aggregation for HeatPoint instances.
sClassName and enriches it with the information contained in oClassInfo. 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
- gradient : array
- opacity : string (default: 0.5)
- behavior : string (default: 2)
- valueScale : string (default: 1.0)
- radiusScale : string (default: 1.0)
- alphaExponent : string (default: 1.0)
- colorExponent : string (default: 1.0)
- Aggregations
- items : sap.ui.vbm.HeatPoint[] (default)
| {string} | sId? | id for the new control, generated automatically if no id is given |
| {object} | mSettings? | initial settings for the new control |
sClassName and enriches it with the information contained in oClassInfo. oClassInfo might contain the same kind of information as described in Object.extend.
| {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 |
| {function} | Created class / constructor function |
| {sap.ui.base.Metadata} | Metadata object describing this class |
items. | {sap.ui.vbm.HeatPoint} | oItem | the item to add; if empty, nothing is inserted |
| {sap.ui.vbm.Heatmap} | Reference to this in order to allow method chaining |
items. | {sap.ui.vbm.Heatmap} | Reference to this in order to allow method chaining |
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.
| {string} | Value of property alphaExponent |
behavior. Behavior of the HeatPoint, 0 Density Map, 2: Heat Map, 1: Intermediate.
Default value is 2.
| {string} | Value of property behavior |
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.
| {string} | Value of property colorExponent |
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)']
| {array} | Value of property gradient |
items. HeatPoint object aggregation
| {sap.ui.vbm.HeatPoint[]} |
opacity. Opacity of the heatmap.
Default value is 0.5.
| {string} | Value of property opacity |
radiusScale. Scaling factor for the sample radiuses.
Default value is 1.0.
| {string} | Value of property radiusScale |
valueScale. Scaling factor for the sample values.
Default value is 1.0.
| {string} | Value of property valueScale |
sap.ui.vbm.HeatPoint in the aggregation items. and returns its index if found or -1 otherwise. | {sap.ui.vbm.HeatPoint} | oItem | The item whose index is looked for |
| {int} | The index of the provided control in the aggregation if found, or -1 otherwise |
items. | {sap.ui.vbm.HeatPoint} | oItem | the item to insert; if empty, nothing is inserted |
| {int} | iIndex | 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 |
| {sap.ui.vbm.Heatmap} | Reference to this in order to allow method chaining |
items. Additionally, it unregisters them from the hosting UIArea.
| {sap.ui.vbm.HeatPoint[]} | An array of the removed elements (might be empty) |
items. | {int|string|sap.ui.vbm.HeatPoint} | vItem | The itemto remove or its index or id |
| {sap.ui.vbm.HeatPoint} | The removed item or null |
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.
| {string} | sAlphaExponent | New value for property alphaExponent |
| {sap.ui.vbm.Heatmap} | Reference to this in order to allow method chaining |
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.
| {string} | sBehavior | New value for property behavior |
| {sap.ui.vbm.Heatmap} | Reference to this in order to allow method chaining |
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.
| {string} | sColorExponent | New value for property colorExponent |
| {sap.ui.vbm.Heatmap} | Reference to this in order to allow method chaining |
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.
| {array} | sGradient | New value for property gradient |
| {sap.ui.vbm.Heatmap} | Reference to this in order to allow method chaining |
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.
| {string} | sOpacity | New value for property opacity |
| {sap.ui.vbm.Heatmap} | Reference to this in order to allow method chaining |
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.
| {string} | sRadiusScale | New value for property radiusScale |
| {sap.ui.vbm.Heatmap} | Reference to this in order to allow method chaining |
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.
| {string} | sValueScale | New value for property valueScale |
| {sap.ui.vbm.Heatmap} | Reference to this in order to allow method chaining |