×
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
jasfox (Talk | contribs)
m (Jasfox - Added see also)
jasfox (Talk | contribs)
m (Jasfox - update to 2.2.4)
(17 intermediate revisions by 2 users not shown)
Line 5: Line 5:
 
|sourcecode= <!-- Link to example source code e.g. [[Media:The Code Example ZIP.zip]] -->
 
|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]]) -->
 
|installfile= <!-- Link to installation file (e.g. [[Media:The Installation File.sis]]) -->
|devices= <!-- Devices tested against - e.g. ''devices=Nokia 6131 NFC, Nokia C7-00'') -->
+
|devices= Internet Explorer, Google chrome, Firefox, Opera
 
|sdk= <!-- SDK(s) built and tested against (e.g. [http://linktosdkdownload/ Nokia Qt SDK 1.1]) -->
 
|sdk= <!-- SDK(s) built and tested against (e.g. [http://linktosdkdownload/ Nokia Qt SDK 1.1]) -->
 
|platform= Web browser
 
|platform= Web browser
 
|devicecompatability= <!-- Compatible devices e.g.: All* (must have internal GPS) -->
 
|devicecompatability= <!-- Compatible devices e.g.: All* (must have internal GPS) -->
|dependencies=Nokia Maps 2.1.0
+
|dependencies=Nokia Maps 2.2.4
 
|signing=<!-- Signing requirements - empty or one of: Self-Signed, DevCert, Manufacturer -->
 
|signing=<!-- Signing requirements - empty or one of: Self-Signed, DevCert, Manufacturer -->
 
|capabilities= <!-- Capabilities required by the article/code example (e.g. Location, NetworkServices. -->
 
|capabilities= <!-- Capabilities required by the article/code example (e.g. Location, NetworkServices. -->
|keywords= <!-- APIs, classes and methods (e.g. QSystemScreenSaver, QList, CBase -->
+
|keywords= Nokia Maps, JavaScript, routing
 
|id= <!-- Article Id (Knowledge base articles only) -->
 
|id= <!-- Article Id (Knowledge base articles only) -->
 
|language= <!-- Language category code for non-English topics - e.g. Lang-Chinese -->
 
|language= <!-- Language category code for non-English topics - e.g. Lang-Chinese -->
Line 27: Line 27:
  
 
{{SeeAlso|
 
{{SeeAlso|
*   [http://api.maps.nokia.com/ Nokia Maps API]
+
* [http://developer.here.net/javascript_api Nokia Maps API]
 
*  [[Nokia Maps API - Advanced Routing]]
 
*  [[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]
 
}}
 
}}
  
Line 37: Line 38:
 
Nokia 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==
  
Nokia provides several services options within the Maps API offering. The service is free to use, but if you complete the free registration process and obtain authentication and authorization credentials, your application will have priority access to the service and will thus avoid a potential performance penalty. Please read the [http://www.developer.nokia.com/Develop/Maps/Quota/ Location API Business Models and Usage Restrictions 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 from the [https://api.developer.nokia.com/ovi-api Nokia Developer API Registration page].
+
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
 +
[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]
  
 
==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 type="text/javascript"
+
     <head>
    src="http://api.maps.nokia.com/2.0.0/jsl.js" charset="utf-8">
+
      <title>A to B Routing Example</title>
</script>
+
      <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
</head>
+
      <script type="text/javascript"
<div id="map" style="width:100%; height:80%;"></div>
+
            src="http://api.maps.nokia.com/2.2.4/jsl.js?with=all" charset="utf-8">
<body>
+
        </script>
</div>
+
    </head>
</body>
+
    <body>
<script type="text/javascript">
+
 
+
        <div id="map" style="z-index: -1; left:0px; top:0px; width: 100%; height: 80%; position: absolute;"></div>
var map;            // Instance of Nokia Maps Display
+
        <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
Line 117: Line 132:
 
//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>
  
 
== Screenshot==
 
== Screenshot==
[[File:NokiaMapsRoute.png|600px]]
+
[[File:NokiaMapsRoute.png]]
==For more on Nokia Maps API==
+
  
For turn-by-turn routing, check out the advanced routing example [[Nokia Maps API - Advanced Routing|here]]
+
==For more on the Nokia Maps API==
  
 
Please check out the Nokia Maps API full documentation and API reference here:
 
Please check out the Nokia Maps API full documentation and API reference here:
* http://api.maps.nokia.com/
+
* [http://developer.here.net/javascript_api Nokia Maps API]
 
+
You may also access the interactive Nokia Maps API playground,
+
* http://api.maps.nokia.com/2.1.0/playground/index.html
+
 
+
==Tested with==
+
  
* 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

153 page views in the last 30 days.
×