Skip to content
Switch branches/tags
Go to file
Cannot retrieve contributors at this time
<!DOCTYPE html>
<html lang="en">
<title>KML Ground Overlay as Image Layer - Azure Maps Web SDK Samples</title>
<meta charset="utf-8" />
<link rel="shortcut icon" href="/favicon.ico"/>
<meta http-equiv="x-ua-compatible" content="IE=Edge" />
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
<meta name="description" content="This sample shows how to overlay KML Ground Overlay information as an image layer on the map." />
<meta name="keywords" content="Microsoft maps, map, gis, API, SDK, image, raster, kml, layer, ground overlay, groundoverlay" />
<meta name="author" content="Microsoft Azure Maps" />
<!-- Add references to the Azure Maps Map control JavaScript and CSS files. -->
<link rel="stylesheet" href="" type="text/css" />
<script src=""></script>
<script type='text/javascript'>
var map;
//KML Ground Overlay information extracted from:
var overlayInfo = {
url: '../Common/images/image-overlays/1600px-Chartres.svg.png',
north: 48.44820923628113,
south: 48.44737203258976,
east: 1.488833825534365,
west: 1.486788581643038,
kmlRotation: 46.44067597839695
function GetMap() {
//Point the Azure Maps domain to the US Azure Gov Cloud domain.
//Initialize a map instance.
map = new atlas.Map('myMap', {
center: [-122.33, 47.6],
zoom: 12,
view: 'Auto',
//Add authentication details for connecting to Azure Maps.
authOptions: {
//Use Azure Active Directory authentication.
authType: 'anonymous',
clientId: 'c9f2f391-13f1-407b-a4a5-f0a241bacfbf', //Your Azure Active Directory client id for accessing your Azure Maps account.
getToken: function (resolve, reject, map) {
//URL to your authentication service that retrieves an Azure Active Directory Token.
var tokenServiceUrl = '';
fetch(tokenServiceUrl).then(r => r.text()).then(token => resolve(token));
//Alternatively, use an Azure Maps key. Get an Azure Maps key at NOTE: The primary key should be used as the key.
//authType: 'subscriptionKey',
//subscriptionKey: '<Your Azure Maps Key>'
//Wait until the map resources are ready.'ready', function () {
//Calculate the corner coordinates of the ground overlay.
var coords = atlas.layer.ImageLayer.getCoordinatesFromEdges(
overlayInfo.north, overlayInfo.south, overlayInfo.east, overlayInfo.west,
//KML rotations are counter-clockwise, subtrack from 360 to make them clockwise.
360 - overlayInfo.kmlRotation
//Create an image layer from the ground overlay data and add it to the map.
map.layers.add(new atlas.layer.ImageLayer({
url: overlayInfo.url,
coordinates: coords
//Optionally, calculate the bounds of the coordinates and use it set the map view.
//Create a style control and add it to the map.
map.controls.add(new atlas.control.StyleControl({
style: 'dark'
}), {
position: 'top-right'
<body onload="GetMap()">
<div id="myMap" style="position:relative;width:100%;min-width:290px;height:600px;"></div>
<fieldset style="width:calc(100% - 30px);min-width:290px;margin-top:10px;">
<legend><h1 style="font-size:16px">KML Ground Overlay as Image Layer</h1></legend>
This sample shows how to overlay KML Ground Overlay information as an image layer on the map.
KML ground overlays provide north, south, east, and west coordinates and a counter-clockwise rotation,
where as the image layer expects coordinates for each corner of the image. The KML ground overlay in this sample is of the Chartres cathedral and sourced from <a href="">wikimedia</a>.