Share via

HeatMapLayer Class

  • 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 from Bing Maps Web Control SDK and 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.

This is the main class that provides that heat map functionality.

Constructor

HeatMapLayer(locations: (Location | Pushpin)[], options?: HeatMapLayerOptions)

Methods

Name Return Type Description
clear() Clears all data in the heat map layer.
dispose() Disposes the heat map layer.
getVisible() boolean Returns a boolean indicating if the heat map layer is visible or not.
setLocations(loc: (Location or Pushpin)[]) Specifies the locations to use when generating the heat map.
setOptions(opt: HeatMapLayerOptions) Sets the options to use with the heat map layer.
setVisible(visible: boolean) Sets the visibility of the heat map layer.