Skip to content
Switch branches/tags
Go to file
Cannot retrieve contributors at this time
<!DOCTYPE html>
<html lang="en">
<title>Get weather along a route - 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 retrieve weather data for all the waypoints along a route." />
<meta name="keywords" content="Microsoft maps, map, gis, API, SDK, REST, service, weather, AccuWeather, forecast, directions, route, routing" />
<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>
<!-- Add a reference to the Azure Maps Services Module JavaScript file. -->
<script src=""></script>
<script type='text/javascript'>
var map, searchURL, routeURL, points, datasource, routeLine;
var weatherAlongRouteUrl = 'https://{azMapsDomain}/weather/route/json?api-version=1.0&query={query}';
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.25, 47.64],
zoom: 11,
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>'
//Use MapControlCredential to share authentication between a map control and the service module.
var pipeline = atlas.service.MapsURL.newPipeline(new atlas.service.MapControlCredential(map));
//Create an instance of the SearchURL client.
searchURL = new atlas.service.SearchURL(pipeline, atlas.getDomain());
//Create an instance of the RouteURL client.
routeURL = new atlas.service.RouteURL(pipeline, atlas.getDomain());
//Wait until the map resources are ready.'ready', function () {
//Create a data source and add it to the map.
datasource = new atlas.source.DataSource();
//Add a layer for rendering the weather data points.
var waypointLayer = new atlas.layer.BubbleLayer(datasource, null, {
//color: ['get', 'color'],
filter: ['any', ['==', ['geometry-type'], 'Point'], ['==', ['geometry-type'], 'MultiPoint']] //Only render Point or MultiPoints in this layer.
//Add a layer for rendering line data.
new atlas.layer.LineLayer(datasource, null, {
strokeColor: 'rgb(0, 204, 153)',
strokeWidth: 5,
filter: ['any', ['==', ['geometry-type'], 'LineString'], ['==', ['geometry-type'], 'MultiLineString']] //Only render LineString or MultiLineString in this layer.
//Add click events to the waypoint layer.'click', waypointLayer, featureClicked);
//Create a popup but leave it closed so we can update it and display it later.
popup = new atlas.Popup();
function calculateRoute() {
var start = document.getElementById('startTbx').value;
var end = document.getElementById('endTbx').value;
if (start == '' || end == '') {
alert('Invalid waypoint point specified.');
//Geocode the start waypoint.
geocodeQuery(start, function (startPoint) {
if (!startPoint) {
alert('Unable to geocode start waypoint.');
//Geocode the end waypoint.
geocodeQuery(end, function (endPoint) {
if (!endPoint) {
alert('Unable to geocode end waypoint.');
routeURL.calculateRouteDirections(atlas.service.Aborter.timeout(3000), [startPoint, endPoint], {
maxAlternatives: 0,
instructionsType: 'text',
traffic: true
}).then(r => {
if (r && r.routes && r.routes.length > 0) {
var route = r.routes[0];
var routeCoordinates = [];
for (var legIndex = 0; legIndex < route.legs.length; legIndex++) {
var leg = route.legs[legIndex];
//Convert the route point data into a format that the map control understands.
var legCoordinates = (point) {
return [point.longitude, point.latitude];
//Combine the route point data for each route leg together to form a single path.
routeCoordinates = routeCoordinates.concat(legCoordinates);
//Create a line from the route path points and add it to the data source.
routeLine = new;
//Display the route line on the map.
//Have the map focus on the route.
padding: 40
var waypoints = [];
var alongRouteWaypoints = [];
var heading = 0;
//Loop through up to 60 instructions and create waypoints.
//Capture the waypoint information needed for the weather along route API which is "latitude,longitude,ETA (in minutes),heading".
var len = Math.min(route.guidance.instructions.length, 60);
for (var i = 0; i < len; i++) {
var ins = route.guidance.instructions[i];
var timeInMinutes = Math.round(ins.travelTimeInSeconds / 60);
//Don't get weather for instructions that are more than two hours away from the start of the route.
if (timeInMinutes > 120) {
var pos = [ins.point.longitude, ins.point.latitude];
waypoints.push(new, ins));
//Calculate the heading.
if (i < route.guidance.instructions.length - 1) {
var ins2 = route.guidance.instructions[i + 1];
heading = Math.round(atlas.math.getHeading(pos, [ins2.point.longitude, ins2.point.latitude]));
//Get weather data.
var requestUrl = weatherAlongRouteUrl.replace('{query}', alongRouteWaypoints.join(':'));
processRequest(requestUrl).then(response => {
if (response && response.waypoints && response.waypoints.length === waypoints.length) {
//Combine the weather data in with each waypoint.
for (var i = 0, len = response.waypoints.length; i < len; i++) {
Object.assign(waypoints[i].properties, response.waypoints[i]);
//Render the waypoints on the map.
function processRequest(url) {
//This is a reusable function that sets the Azure Maps platform domain, sings the request, and makes use of any transformRequest set on the map.
return new Promise((resolve, reject) => {
//Replace the domain placeholder to ensure the same Azure Maps cloud is used throughout the app.
url = url.replace('{azMapsDomain}', atlas.getDomain());
//Get the authentication details from the map for use in the request.
var requestParams = map.authentication.signRequest({ url: url });
//Transform the request.
var transform = map.getServiceOptions().tranformRequest;
if (transform) {
requestParams = transform(url);
fetch(requestParams.url, {
method: 'GET',
mode: 'cors',
headers: new Headers(requestParams.headers)
.then(r => r.json(), e => reject(e))
.then(r => {
}, e => reject(e));
//Geocode the query and return the first coordinate.
function geocodeQuery(query, callback) {
if (callback) {
searchURL.searchAddress(atlas.service.Aborter.timeout(3000), query, {
limit: 1,
view: 'Auto'
}).then(results => {
var data = results.geojson.getFeatures();
if (data && data.features.length > 0) {
} else {
function featureClicked(e) {
//Make sure the event occurred on a shape feature.
if (e.shapes && e.shapes.length > 0) {
//Get the properties of the feature.
var properties = e.shapes[0].getProperties();
//Set the content and position of the popup.
//Update the content of the popup.
content: atlas.PopupTemplate.applyTemplate(properties, {
//Since there is a lot of content, and we trust the content, don't sandbox it. Sandboxing limits the amount of data that can be rendered in the popup.
sandboxContent: false
//Update the position of the popup with the pins coordinate.
position: e.shapes[0].getCoordinates()
//Open the popup.;
<body onload="GetMap()">
<div id="myMap" style="position:relative;width:100%;min-width:290px;height:600px;"></div>
<div style="position:absolute;top:15px;left:15px;background-color:white;padding:10px;border-radius:10px;">
<td>Start: </td>
<td><input type="text" id="startTbx" value="Seattle" /></td>
<td>End: </td>
<td><input type="text" id="endTbx" value="Redmond" /></td>
<td><input type="button" value="Calculate Route" onclick="calculateRoute()" /></td>
<fieldset style="width:calc(100% - 30px);min-width:290px;margin-top:10px;">
<legend><h1 style="font-size:16px">Get weather along a route</h1></legend>
This sample shows how to retrieve weather data for all the waypoints along a route.
All weather metadata is combined with the instruction details for each waypoint.
Click on a waypoint to display a popup with all these details.
Note that the weather along a route API only supports up to 60 waypoints and routes that complete within two hours of the current time.