[ Whereis® API Home ] [ JSON API Home ] [ Object Index ] [ Geometry Types ]
Defines a heat map, or a collection of <heatPoint> objects, or <point> objects with additonal numeric values (e.g. statistical data), used to render a heat map overlay.
Format
A single heat map definition has the following format
{
"values": [<heatPoint>],
"radius": int,
"gradient": [<color>]
}
A heat point has the following format:
{
"point":<point>,
"value":<int>
}
Parameters
Parameter | Type | Mandatory? | Description |
values | Y | Locates the centrepoint of the circle on the map | |
radius | int | N | Radius of each data value in pixels. Used to control apparent density of heat map |
| gradient | N | And array of colors as hexadecimal RGB (e.g. "#FF8800") that defines the color gradient |