Creating a Basic Map Control

Article
05/22/2024

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.

Create a Bing Maps Account and Get a Key

Before you begin developing your application, you need to create a developer account on the Bing Maps Account Center. A Bing Maps Developer Account allows you to create a Bing Maps Key to use in your map application. Getting a key is described in the Getting a Bing Maps Key topic.

Loading a map

Displaying the default map, which includes all of the navigation functionality, consists of the following steps:

At the top of the HTML page, add the following DOCTYPE declaration.
```
<!DOCTYPE html>
```
In the header section of an HTML page, add a META element with the charset attribute set to "utf-8", as follows:
```
<meta charset="utf-8" />
```
Alternatively, you can also use the older HTML4 method of specifying that UTF8 character sets are used:
```
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
```
Note

It is recommended that you use UTF-8 encoding in your application as it is capable of encoding all possible characters in Unicode. It is also widely supported by browsers and will ensure that your application renders correctly across the most browsers and devices.
In the header section or the body of the page add a reference to the map control script. You specify your Bing Maps key as part of the map script URL. The map control can be loaded asynchronously by specifying a callback function in the script URL and by adding "async defer" to the script tag as follows:
```
<script type='text/javascript' src='http://www.bing.com/api/maps/mapcontrol?callback=GetMap&key=[YOUR_BING_MAPS_KEY]' async defer></script>
```
To use SSL, change http to https:
```
<script type='text/javascript' src='https://www.bing.com/api/maps/mapcontrol?callback=GetMap&key=[YOUR_BING_MAPS_KEY]' async defer></script>
```
This will result in the browser inheriting the protocol from the website and automatically selecting HTTP or HTTPS as needed.

Tip

If you need to call the control without the use of cookies, use the Virtual Earth endpoint rather than the Bing endpoint. To use Virtual Earth endpoint, you would change the src= in the URLs that start with www.bing.com to start with sdk.virtualearth.net.
In the body of the page, add a DIV element to the page to contain the map. The size of the map is defined by the height and width of the DIV element. The position of the map is set by using the "position", "top", and "left" properties. You can set these values either inline or by defining the values in a style class and then referencing that class, as follows.
```
<div id="myMap" style='position:relative;width:600px;height:400px;'></div>
```
or CSS Style:
```
#myMap {
    position: relative;
    width: 600px;
    height: 400px;
}
```
Next, within a new script tag, create a function that can be called when your application loads.
```
<script type="text/javascript">
   function GetMap()
   {
   }
</script>
```
If loading the map synchronously, you can trigger the GetMap function by adding it to the onload event of the body tag.
```
<body onload="GetMap();">

var map = new Microsoft.Maps.Map('#myMap');
```
Finally, you can create an instance of the Map Class in the GetMap function. There are two different ways to do this in the Bing Maps V8 SDK. The recommended way to load the map is to use the asynchronous method which loads all the required resources needed by the map in the background and then triggers a callback function when the map has been loaded. When loading the map, you need to add a reference to the DIV element where you want the map to load. Here is how to load the map asynchronously:

The following is the full code required for loading a map asynchronously.

<!DOCTYPE html>
<html>
<head>
    <title></title>
    <meta charset="utf-8" />

    <!-- Reference to the Bing Maps SDK -->
    <script type='text/javascript'
            src='http://www.bing.com/api/maps/mapcontrol?callback=GetMap&key=[YOUR_BING_MAPS_KEY]' 
            async defer></script>
    
    <script type='text/javascript'>
    function GetMap()
    {
        var map = new Microsoft.Maps.Map('#myMap');

        //Add your post map load code here.
    }
    </script>
</head>
<body>
    <div id="myMap" style="position:relative;width:600px;height:400px;"></div>
</body>
</html>

Tip

If you refresh the page when using an async script reference to the map control, it will trigger the callback instantly as all the script is already loaded, however, the callback function or the map div may not yet be loaded on the page and would result in an error. To prevent this from happening, It is recommended that you add the map script tag to the bottom of the body of the page after the map div and all other script references.

Partager via

Creating a Basic Map Control

Create a Bing Maps Account and Get a Key

Loading a map

Ressources supplémentaires