Share via

HeatMapLayerOptions Object

  • Article

Note

Bing Maps Web Control SDK retirement

Bing Maps Web Control SDK is deprecated and will be retired. Free (Basic) account customers can continue to use Bing Maps Web Control SDK until June 30th, 2025. Enterprise account customers can continue to use Bing Maps Web Control SDK until June 30th, 2028. To avoid service disruptions, all implementations using Bing Maps Web Control SDK will need to be updated to use Azure Maps Web SDK by the retirement date that applies to your Bing Maps for Enterprise account type. For detailed migration guidance, see Migrate Bing Maps Enterprise applications to Azure Maps with GitHub Copilot.

Azure Maps is Microsoft's next-generation maps and geospatial services for developers. Azure Maps has many of the same features as Bing Maps for Enterprise, and more. To get started with Azure Maps, create a free Azure subscription and an Azure Maps account. For more information about azure Maps, see Azure Maps Documentation. For migration guidance, see Bing Maps Migration Overview.

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