Maps API for JavaScript Developer's Guide

H.data.heatmap.Provider.Options

Type Definition Summary

This type encapsulates configuration (initialization) options for the heat map Provider.

[ For full details, see the Type Definition Details ]

Property Summary

Table 1. Properties
Properties

type

A value indicating the type of the heat map, either "value" or "density". The default is "density".

colors

A value indicating the colors of the heat map. The default is H.data.heatmap.Colors.DEFAULT.

min

A value indicating the minimum supported zoom level. The default is 0.

max

A value indicating the maximum supported zoom level. The default is 22.

tileSize

A value indicating the size of a tile expressed as the length of the tile edge in pixels. It must be 2^n, where n is in the range [0... 30]. The default is 256.

assumeValues

A Boolean value indicating whether to paint assumed values in regions where no data is available. This is especially useful for value maps generated from small data sets to allow tiles with no available data to be filled with the next available average value in the data set. The default is false.

coarseness

A numeric value defining the resolution reduction when producing tiles. If the coarseness is set to 0, tiles are 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 are restricted to a integer in the range [0 ... 3]. The default is 1.

sampleDepth

A numeric value defining the number of sampling iterations the heat map renderer is to perform on the data set. Each successive iteration samples the data more finely than the previous iteration. Higher values create more detailed maps but also impose a performance cost. Values are confined to a integer in the range [1 ... 8]. The default is 4.

dataMax

A numeric value defining the pixel color gamma correction for the "density" heat maps. Values are confined to integers in the range [min ... max+sampleDepth]. The default is max.

Type Definition Description

This type encapsulates configuration (initialization) options for the heat map Provider.

Property Details

type: {string}

A value indicating the type of the heat map, either "value" or "density". The default is "density".

colors: {H.data.heatmap.Colors}

A value indicating the colors of the heat map. The default is H.data.heatmap.Colors.DEFAULT.

min: {number=} [optional]

A value indicating the minimum supported zoom level. The default is 0.

max: {number=} [optional]

A value indicating the maximum supported zoom level. The default is 22.

tileSize: {number=} [optional]

A value indicating the size of a tile expressed as the length of the tile edge in pixels. It must be 2^n, where n is in the range [0... 30]. The default is 256.

assumeValues: {boolean=} [optional]

A Boolean value indicating whether to paint assumed values in regions where no data is available. This is especially useful for value maps generated from small data sets to allow tiles with no available data to be filled with the next available average value in the data set. The default is false.

coarseness: {number=} [optional]

A numeric value defining the resolution reduction when producing tiles. If the coarseness is set to 0, tiles are 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 are restricted to a integer in the range [0 ... 3]. The default is 1.

sampleDepth: {number=} [optional]

A numeric value defining the number of sampling iterations the heat map renderer is to perform on the data set. Each successive iteration samples the data more finely than the previous iteration. Higher values create more detailed maps but also impose a performance cost. Values are confined to a integer in the range [1 ... 8]. The default is 4.

dataMax: {number=} [optional]

A numeric value defining the pixel color gamma correction for the "density" heat maps. Values are confined to integers in the range [min ... max+sampleDepth]. The default is max.

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.