HeatMapLayerOptions Object

The following is a list of properties that are available in the HeatMapLayerOptions object.

Name Type Description
colorGradient IDictionary of string The temperature gradient that is used to colorize the map. Default gradient:

{
     '0.00': 'rgb(255,0,255)', // Magenta
     '0.25': 'rgb(0,0,255)', // Blue
     '0.50': 'rgb(0,255,0)', // Green
     '0.75': 'rgb(255,255,0)', // Yellow
     '1.00': 'rgb(255,0,0)' // Red
}
intensity number The intensity of each heat point. This is a decimal value between 0 and 1. This is used to specify how "hot" a single data point should be. Default: 0.5
opacity number The opacity of the HeatMapLayer canvas. Value should be a decimal between 0 and 1. Default: 1
radius number The radius to draw each data point on the map. Default: 10
unit string The distance units of the radius. Possible values are:

  • pixels
  • meters

When set to pixels the size of each data point will always be the same radius, regardless of zoom level. When set to meters, the size of the data points will scale based on zoom level so as to ensure that the radius is spatially accurate. Default: pixels
visible boolean A boolean indicating if the heat map layer is visible or not.
drawOrder number In case of multiple overlay, draw order defines the order of heat map in relation to labels/Poi's. drawOrder can be between -100 to -1 to display the heat map below the Labels/Pois or 1 to 100 to display the heat map above it. Default: -2