Maps API for JavaScript Developer's Guide

H.data.heatmap.Provider.Options

Type Definition Summary

Options which are used to initialize the heat map Provider

[ For full details, see the Type Definition Details ]

Property Summary

Table 1. Properties
Properties

type

The type of the heat map, either "value" or "density". Default is "density"

colors

The colors of the heat map, default is H.data.heatmap.Colors.DEFAULT

min

The minimal supported zoom level, default is 0.

max

The maximal supported zoom level, default is 22.

tileSize

The size of a tile as edge length in pixels. It must be 2^n where n is in a range [0 ... 30]. Default is 256.

assumeValues

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 is false.

coarseness

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 are clamped to a integer from a range [0 ... 3]. Default is 1.

sampleDepth

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 are clamped to a integer from a range [1 ... 8]. Default is 4.

dataMax

This property holds a numeric value defining the pixel color gamma correction in case of the "density" heat maps. Values are clamped to a integer from a range [min ... max+sampleDepth]. Default is max.

Type Definition Description

Options which are used to initialize the heat map Provider

Property Details

type: {string}

The type of the heat map, either "value" or "density". Default is "density"

colors: {H.data.heatmap.Colors}

The colors of the heat map, default is H.data.heatmap.Colors.DEFAULT

min: {number=} [optional]

The minimal supported zoom level, default is 0.

max: {number=} [optional]

The maximal supported zoom level, default is 22.

tileSize: {number=} [optional]

The size of a tile as edge length in pixels. It must be 2^n where n is in a range [0 ... 30]. Default is 256.

assumeValues: {boolean=} [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 is false.

coarseness: {number=} [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 are clamped to a integer from a range [0 ... 3]. Default is 1.

sampleDepth: {number=} [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 are clamped to a integer from a range [1 ... 8]. Default is 4.

dataMax: {number=} [optional]

This property holds a numeric value defining the pixel color gamma correction in case of the "density" heat maps. Values are clamped to a integer from a range [min ... max+sampleDepth]. 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.