Interface nokia.maps.heatmap.Overlay.Options
Interface Summary
This interface defines options that can be passed to the nokia.maps.heatmap.Overlay constructor.
Field Summary
Boolean
assumeValues
Optional
This property holds a boolean value defining whether to paint assumed values in regions where no data is available.
Number
coarseness
Optional
This property holds a numeric value defining the resolution reduction when producing tiles.
nokia.maps.heatmap.Overlay.Colors
colors
Optional
This property holds an object that conforms to the interface nokia.maps.heatmap.Overlay.Colors and is used to define the colors of the heat map.
String
description
Optional
This property holds a description of the provider to be used in the user interface, for example in tool tips.
Function
getCopyrights
Optional
This property specifies a function to provide copyright information.
String
label
Optional
This property will represent a label for the provider, for example for the type or overlay buttons.
Number
sampleDepth
Optional
This property holds a numeric value defining the number of sampling iterations the heat map renderer will perform on the data set.
Number
updateCycle
Optional
This property indicates the period for an automatic update cycle in seconds as integer.
Direct Inheritance
Inherited from nokia.maps.map.provider.Provider.Options:
description
getCopyrights
label
max
min
updateCycle
Field Detail
Boolean
assumeValues
Optional
This property holds a boolean value defining whether to paint assumed values in regions where no data
is available. This is especially useful for value maps which are generated from a small data sets as tiles
with no available data will be filled with the next available average value in the data set.
- Default Value:
- false
Number
coarseness
Optional
This property holds a numeric value defining the resolution reduction when producing tiles. If the coarseness
is set to 0 tiles will be produced in the original resolution. A coarseness of 1 allows the renderer to
render tiles at half the size and then scale the output, a coarseness of 2 allows the renderer to create
tiles at a size of a quarter of the original tile size. Increasing the number dramatically increases performance
but also reduces visual quality, especially when using posterization (non-interpolated colors).
Values may range between 0 and 3.
- Default Value:
- 1
nokia.maps.heatmap.Overlay.Colors
colors
Optional
This property holds an object that conforms to the interface nokia.maps.heatmap.Overlay.Colors
and is used to define the colors of the heat map. The property is optional.
If it is not provided, the following default color definition is used:
{
stops: {
"0": "#008", // dark blue
"0.2": "#0b0", // medium green
"0.5": "#ff0", // yellow
"0.7": "#f00" // red
},
interpolate: true
}
This means that the highest "heat" value is displayed in opaque red, the lowest as opaque blue, while values in between are shown in opaque green and yellow and interpolation is used to determine them.
Number
opacity
Optional
This property holds the opacity of the heat map overlay. Values may range from 0+ to 1, inclusive.
The property is optional.
- Default Value:
- 0.8
Number
sampleDepth
Optional
This property holds a numeric value defining the number of sampling iterations the heat map renderer will
perform on the data set. Each iteration will sample the data more finely. Higher values will create more detailed
maps but also cost performance.
Values may range between 1 and 8.
- Default Value:
- 4
