×
Namespaces

Variants
Actions
(Difference between revisions)

HERE Maps API - How to calculate a route between two points

From Nokia Developer Wiki
Jump to: navigation, search
Maveric (Talk | contribs)
m (Maveric - - Example code)
jasfox (Talk | contribs)
m (Jasfox - update to 2.2.4)
(31 intermediate revisions by 6 users not shown)
Line 1: Line 1:
[[Category:Ovi]][[Category:Web]][[Category:Browser]]
+
[[Category:Nokia Maps]][[Category:Code Snippet]][[Category:JavaScript]]
==Introduction==
+
{{Abstract|This article explains how to geo-code two locations and show the route between them using Nokia Maps (providing that a valid route can be found). }}
 +
 
 +
{{ArticleMetaData
 +
|sourcecode= <!-- Link to example source code e.g. [[Media:The Code Example ZIP.zip]] -->
 +
|installfile= <!-- Link to installation file (e.g. [[Media:The Installation File.sis]]) -->
 +
|devices= Internet Explorer, Google chrome, Firefox, Opera
 +
|sdk= <!-- SDK(s) built and tested against (e.g. [http://linktosdkdownload/ Nokia Qt SDK 1.1]) -->
 +
|platform= Web browser
 +
|devicecompatability= <!-- Compatible devices e.g.: All* (must have internal GPS) -->
 +
|dependencies=Nokia Maps 2.2.4
 +
|signing=<!-- Signing requirements - empty or one of: Self-Signed, DevCert, Manufacturer -->
 +
|capabilities= <!-- Capabilities required by the article/code example (e.g. Location, NetworkServices. -->
 +
|keywords= Nokia Maps, JavaScript, routing
 +
|id= <!-- Article Id (Knowledge base articles only) -->
 +
|language= <!-- Language category code for non-English topics - e.g. Lang-Chinese -->
 +
|translated-by= <!-- [[User:XXXX]] -->
 +
|translated-from-title= <!-- Title only -->
 +
|translated-from-id= <!-- Id of translated revision -->
 +
|review-by=<!-- After re-review: [[User:username]] -->
 +
|review-timestamp= <!-- After re-review: YYYYMMDD -->
 +
|update-by=[[User:avnee.nathani]]
 +
|update-timestamp=20111231
 +
|creationdate=20110621
 +
|author=[[User:Maveric]]
 +
}}
 +
 
 +
{{SeeAlso|
 +
* [http://developer.here.net/javascript_api Nokia Maps API]
 +
*  [[Nokia Maps API - Advanced Routing]]
 +
*  [http://developer.here.net/apiexplorer/examples/api-for-js/routing/map-with-route-from-a-to-b.html A to B routing example]
 +
}}
 +
 
  
In this article we will study on how to calculate the Route between two selected points on the map, providing that a valid route can be found in all.
 
  
 
==Prerequisites==
 
==Prerequisites==
  
Ovi Maps API supported web browser (basically any modern web browser)
+
Nokia Maps API supported web browser (basically any modern web browser)
  
==Important about Maps credentials==
+
==Important note about maps credentials==
  
With Ovi Maps API you can start without having any credentials given, but you might face a performance gap. In order to get the full potential out of the
+
Nokia provides several services options within the Maps API offering. The service is free to use, but  you must obtain and use authentication and authorization credentials to use the services. Please read the
offering, you must get the credentials that authenticate your application against the Services. Please read through the Location API.
+
[http://developer.here.net/terms_conditions Terms and Conditions] and check the [http://developer.here.net/web/guest/plans Pricing Plans page]  to decide which business model best fits your needs. Authentication requires unique Maps API credentials, namely an AppId and a token. You can get these credentials free for free following the instructions [http://developer.here.net/docs/maps_js/topics/credentials.html#acquiring-credentials here]
 
+
For more information on how to obtain the credentials, please start with the  Ovi Maps API Developers Guide section "Acquiring API credentials"
+
  
 
==Implementation==
 
==Implementation==
  
In this example we will define two waypoints for the route; the geographical location of Berlin, Germany to the one of Paris, France. To be able to  
+
In this example we will define two {{Icode|waypoint}}s for the {{Icode|route}}; the geographical location of Berlin, Germany to the one of Paris, France. To be able to  
use the routing we need to initialize a new Routing Manager. We will cast the waypoints to it with some additional parameters. We want the "shortest"
+
use routing we need to initialize a new {{Icode|nokia.maps.routing.Manager}}. We will cast the {{Icode|waypoints}} to it with some additional parameters. We want the {{Icode|shortest}}
route with "car" and no fee roads with "avoidTollroad" plus having the trafficMode set to "default".
+
route with {{Icode|car}} and no toll roads with {{Icode|avoidTollroad}}, plus having the {{Icode|trafficMode}} set to {{Icode|default}}.
  
 
==Example code==
 
==Example code==
  
This example has all the required HTML and JavaScript code to perform the routing between Berlin, Germany and Paris, France.
+
This example has all the required HTML and JavaScript code to perform the routing between Berlin, Germany and Paris, France. Remember to add in your own [[How to Obtain Your Own Nokia appID and Token| AppId and Token]].
 +
{{Note|In order to use routing services, the {{Icode|with}} parameter of the script element's {{Icode|src}} attribute must be set to {{Icode|?with&#61;all}} }}
  
 
<code java>
 
<code java>
<html>
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<head>
+
<html xmlns="http://www.w3.org/1999/xhtml">
<script src="http://api.maps.ovi.com/jsl.js" type="text/javascript" charset="utf-8"></script>
+
    <head>
</head>
+
      <title>A to B Routing Example</title>
<div id="map" style="width:100%; height:80%;"></div>
+
      <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<body>
+
      <script type="text/javascript"
</div>
+
            src="http://api.maps.nokia.com/2.2.4/jsl.js?with=all" charset="utf-8">
</body>
+
        </script>
<script type="text/javascript">
+
    </head>
 +
    <body>
  
var map;            // Instance of Ovi Maps Display
+
        <div id="map" style="z-index: -1; left:0px; top:0px; width: 100%; height: 80%; position: absolute;"></div>
 +
        <script type="text/javascript">
 +
/////////////////////////////////////////////////////////////////////////////////////
 +
// Don't forget to set your API credentials
 +
//
 +
// Replace with your appId and token which you can obtain when you
 +
// register on http://api.developer.nokia.com/
 +
//
 +
nokia.Settings.set( "appId", "YOUR APP ID GOES HERE");
 +
nokia.Settings.set( "authenticationToken", "YOUR AUTHENTICATION TOKEN GOES HERE");
 +
 
 +
//
 +
/////////////////////////////////////////////////////////////////////////////////////
 +
var map;            // Instance of Nokia Maps Display
 
var router;          // New Route search
 
var router;          // New Route search
 
var geoloc;          // New Geocoding search
 
var geoloc;          // New Geocoding search
 
+
 
//Define waypoints for the Routing
 
//Define waypoints for the Routing
var waypoints = new ovi.mapsapi.routing.WaypointParameterList();
+
var waypoints = new nokia.maps.routing.WaypointParameterList();
 
+
waypoints.addCoordinate( new ovi.mapsapi.geo.Coordinate(52.500556, 13.398889));  // Berlin, Germany
+
waypoints.addCoordinate( new nokia.maps.geo.Coordinate(52.500556, 13.398889));  // Berlin, Germany
waypoints.addCoordinate( new ovi.mapsapi.geo.Coordinate(48.856667, 2.350833));  // Paris, France
+
waypoints.addCoordinate( new nokia.maps.geo.Coordinate(48.856667, 2.350833));  // Paris, France
 
+
 
//Define Routing parameters
 
//Define Routing parameters
 
+
 
var modes = [{     
 
var modes = [{     
 
     type: "shortest",
 
     type: "shortest",
Line 54: Line 97:
 
     trafficMode: "default"
 
     trafficMode: "default"
 
}];
 
}];
 
+
 
+
map = new ovi.mapsapi.map.Display(document.getElementById("map"),  
+
map = new nokia.maps.map.Display(document.getElementById("map"),  
 
{
 
{
 
+
     components: [ new ovi.mapsapi.map.component.Behavior(),
+
     components: [ new nokia.maps.map.component.Behavior(),
                 new ovi.mapsapi.map.component.ZoomBar(),
+
                 new nokia.maps.map.component.ZoomBar(),
                 new ovi.mapsapi.map.component.Overview(),                             
+
                 new nokia.maps.map.component.Overview(),                             
                 new ovi.mapsapi.map.component.TypeSelector(),     
+
                 new nokia.maps.map.component.TypeSelector(),     
                 new ovi.mapsapi.map.component.ScaleBar()],
+
                 new nokia.maps.map.component.ScaleBar()],
 
     'zoomLevel': 3,  
 
     'zoomLevel': 3,  
 
});
 
});
 
+
 
+
     router = new ovi.mapsapi.routing.Manager();  //create a route manager
+
     router = new nokia.maps.routing.Manager();  //create a route manager
 
     //    map.addListener("dblclick", eventListener);
 
     //    map.addListener("dblclick", eventListener);
 
+
 
   //onRouteCalculated will be called when a route was calculated
 
   //onRouteCalculated will be called when a route was calculated
 
  var onRouteCalculated = function(observedRouter, key, value){
 
  var onRouteCalculated = function(observedRouter, key, value){
 
     if (value == "finished") {
 
     if (value == "finished") {
 
         var routes = observedRouter.getRoutes();
 
         var routes = observedRouter.getRoutes();
       
+
 
         //create the default map representation of a route
 
         //create the default map representation of a route
         var mapRoute = new ovi.mapsapi.routing.component.RouteResultSet(routes[0]).container; //first option found
+
         var mapRoute = new nokia.maps.routing.component.RouteResultSet(routes[0]).container; //first option found
 
         map.objects.add(mapRoute);
 
         map.objects.add(mapRoute);
       
+
 
         //Zoom to the bounding box of the route
 
         //Zoom to the bounding box of the route
 
         map.zoomTo(mapRoute.getBoundingBox(), false, "default");
 
         map.zoomTo(mapRoute.getBoundingBox(), false, "default");
Line 86: Line 129:
 
     }
 
     }
 
};
 
};
 
+
 
//add the observer function to the router's "state" property
 
//add the observer function to the router's "state" property
 
router.addObserver("state", onRouteCalculated);
 
router.addObserver("state", onRouteCalculated);
 
+
 
+
 
//calculate the route (and call onRouteCalculated afterwards)
 
//calculate the route (and call onRouteCalculated afterwards)
 
router.calculateRoute(waypoints, modes);
 
router.calculateRoute(waypoints, modes);
 
 
</script>
 
</script>
 +
</body>
 
</html>
 
</html>
 
 
 
</code>
 
</code>
  
==For more on Ovi Maps API==
+
== Screenshot==
 
+
[[File:NokiaMapsRoute.png]]
Please check out the Ovi Maps API full documentation and API reference here:
+
  
http://api.maps.ovi.com
+
==For more on the Nokia Maps API==
  
==Tested with==
+
Please check out the Nokia Maps API full documentation and API reference here:
 +
* [http://developer.here.net/javascript_api Nokia Maps API]
  
Google Chrome 11.0x
+
You may also access the interactive API explorer
Mozilla Firefox 5.0
+
* [http://developer.here.net/javascript_api_explorer API explorer]

Revision as of 14:26, 14 March 2013

This article explains how to geo-code two locations and show the route between them using Nokia Maps (providing that a valid route can be found).

Article Metadata
Tested with
Devices(s): Internet Explorer, Google chrome, Firefox, Opera
Compatibility
Platform(s): Web browser
Dependencies: Nokia Maps 2.2.4
Article
Keywords: Nokia Maps, JavaScript, routing
Created: Maveric (21 Jun 2011)
Updated: avnee.nathani (31 Dec 2011)
Last edited: jasfox (14 Mar 2013)


Contents

Prerequisites

Nokia Maps API supported web browser (basically any modern web browser)

Important note about maps credentials

Nokia provides several services options within the Maps API offering. The service is free to use, but you must obtain and use authentication and authorization credentials to use the services. Please read the Terms and Conditions and check the Pricing Plans page to decide which business model best fits your needs. Authentication requires unique Maps API credentials, namely an AppId and a token. You can get these credentials free for free following the instructions here

Implementation

In this example we will define two waypoints for the route; the geographical location of Berlin, Germany to the one of Paris, France. To be able to use routing we need to initialize a new nokia.maps.routing.Manager. We will cast the waypoints to it with some additional parameters. We want the shortest route with car and no toll roads with avoidTollroad, plus having the trafficMode set to default.

Example code

This example has all the required HTML and JavaScript code to perform the routing between Berlin, Germany and Paris, France. Remember to add in your own AppId and Token.

Note.pngNote: In order to use routing services, the with parameter of the script element's src attribute must be set to ?with=all

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>A to B Routing Example</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<script type="text/javascript"
src="http://api.maps.nokia.com/2.2.4/jsl.js?with=all" charset="utf-8">
</script>
</head>
<body>
 
<div id="map" style="z-index: -1; left:0px; top:0px; width: 100%; height: 80%; position: absolute;"></div>
<script type="text/javascript">
/////////////////////////////////////////////////////////////////////////////////////
// Don't forget to set your API credentials
//
// Replace with your appId and token which you can obtain when you
// register on http://api.developer.nokia.com/
//
nokia.Settings.set( "appId", "YOUR APP ID GOES HERE");
nokia.Settings.set( "authenticationToken", "YOUR AUTHENTICATION TOKEN GOES HERE");
 
//
/////////////////////////////////////////////////////////////////////////////////////
var map; // Instance of Nokia Maps Display
var router; // New Route search
var geoloc; // New Geocoding search
 
//Define waypoints for the Routing
var waypoints = new nokia.maps.routing.WaypointParameterList();
 
waypoints.addCoordinate( new nokia.maps.geo.Coordinate(52.500556, 13.398889)); // Berlin, Germany
waypoints.addCoordinate( new nokia.maps.geo.Coordinate(48.856667, 2.350833)); // Paris, France
 
//Define Routing parameters
 
var modes = [{
type: "shortest",
transportModes: ["car"],
options: "avoidTollroad",
trafficMode: "default"
}];
 
 
map = new nokia.maps.map.Display(document.getElementById("map"),
{
 
components: [ new nokia.maps.map.component.Behavior(),
new nokia.maps.map.component.ZoomBar(),
new nokia.maps.map.component.Overview(),
new nokia.maps.map.component.TypeSelector(),
new nokia.maps.map.component.ScaleBar()],
'zoomLevel': 3,
});
 
 
router = new nokia.maps.routing.Manager(); //create a route manager
// map.addListener("dblclick", eventListener);
 
//onRouteCalculated will be called when a route was calculated
var onRouteCalculated = function(observedRouter, key, value){
if (value == "finished") {
var routes = observedRouter.getRoutes();
 
//create the default map representation of a route
var mapRoute = new nokia.maps.routing.component.RouteResultSet(routes[0]).container; //first option found
map.objects.add(mapRoute);
 
//Zoom to the bounding box of the route
map.zoomTo(mapRoute.getBoundingBox(), false, "default");
} else if(value == "failed") {
alert("The routing request failed.");
}
};
 
//add the observer function to the router's "state" property
router.addObserver("state", onRouteCalculated);
 
//calculate the route (and call onRouteCalculated afterwards)
router.calculateRoute(waypoints, modes);
</script>
</body>
</html>

Screenshot

NokiaMapsRoute.png

For more on the Nokia Maps API

Please check out the Nokia Maps API full documentation and API reference here:

You may also access the interactive API explorer

272 page views in the last 30 days.
×