×
Namespaces

Variants
Actions
(Difference between revisions)

HERE Maps API - Performing multiple concurrent search requests

From Nokia Developer Wiki
Jump to: navigation, search
Oskar Bukolt (Talk | contribs)
m (Oskar Bukolt - Update JS lib + API link)
jasfox (Talk | contribs)
m (Jasfox - - Important note about maps credentials)
(4 intermediate revisions by 2 users not shown)
Line 7: Line 7:
 
|platform= Web
 
|platform= Web
 
|devicecompatability= <!-- Compatible devices e.g.: All* (must have internal GPS) -->
 
|devicecompatability= <!-- Compatible devices e.g.: All* (must have internal GPS) -->
|dependencies=  Nokia Maps 2.2.1
+
|dependencies=  Nokia Maps 2.2.3
 
|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, Search
 
|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 25: Line 25:
  
 
{{SeeAlso|
 
{{SeeAlso|
*   [http://api.maps.nokia.com/en/maps/intro.html Nokia Maps API]  
+
* [http://developer.here.net/javascript_api Nokia Maps API]  
* [http://api.maps.nokia.com/en/playground/examples/maps/services/addresses.html Search example]
+
* [http://developer.here.net/apiexplorer/examples/api-for-js/places-search/map-with-search-result-addresses.html Search example]
 
  }}
 
  }}
  
 
==Introduction==   
 
==Introduction==   
  
In this article we will examine the following use case on Nokia Maps API.
+
In this article we will examine the following usage of the Nokia Maps API.
 
# Multiple addresses exist, a total of 10 for this example.  
 
# Multiple addresses exist, a total of 10 for this example.  
 
# A Map {{Icode|Marker}} is needed to be displayed for each of the addresses.  
 
# A Map {{Icode|Marker}} is needed to be displayed for each of the addresses.  
Line 44: Line 44:
 
==Important note 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  you must obtain and use authentication and authorization credentials to use the services.
+
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
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 free from the [https://api.developer.nokia.com/ovi-api Nokia Developer API Registration page].
+
[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==   
Line 55: Line 55:
 
<html>
 
<html>
 
<head>     
 
<head>     
<script type="text/javascript" charset="UTF-8" src="http://api.maps.nokia.com/2.2.1/jsl.js"></script>
+
<script type="text/javascript" charset="UTF-8" src="http://api.maps.nokia.com/2.2.3/jsl.js"></script>
 
<title>Concurrent Search example</title>
 
<title>Concurrent Search example</title>
 
</head>  
 
</head>  
Line 106: Line 106:
 
}     
 
}     
 
};     
 
};     
// we will use the same state obeserver function for all managers     
+
// we will use the same state observer function for all managers     
 
   
 
   
 
var onSearchComplete = function (data, requestStatus) {
 
var onSearchComplete = function (data, requestStatus) {

Revision as of 14:04, 4 January 2013

Article Metadata
Tested with
Devices(s): Internet Explorer, Google Chrome , Firefox, Opera
Compatibility
Platform(s): Web
Dependencies: Nokia Maps 2.2.3
Article
Keywords: Nokia Maps, JavaScript, Search
Created: Maveric (25 Oct 2011)
Last edited: jasfox (04 Jan 2013)

Contents

Introduction

In this article we will examine the following usage of the Nokia Maps API.

  1. Multiple addresses exist, a total of 10 for this example.
  2. A Map Marker is needed to be displayed for each of the addresses.
  3. Finally the ZoomLevel needs to be set to cover all of the Markers.

This article enforces the correct use of the search.Manager in case of multiple concurrent requests.

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

This is a fully working example code in HTML and JavaScript.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<html>
<head>
<script type="text/javascript" charset="UTF-8" src="http://api.maps.nokia.com/2.2.3/jsl.js"></script>
<title>Concurrent Search example</title>
</head>
<body>
<div id="map" style="width:100%; height:100%; 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");
//
/////////////////////////////////////////////////////////////////////////////////////
 
//initialize a new map
var display = new nokia.maps.map.Display(document.getElementById("map"),
{ "components": [
new nokia.maps.map.component.ZoomBar(),
new nokia.maps.map.component.Behavior(),
new nokia.maps.map.component.TypeSelector()],
"zoomLevel": 10 });
 
// we will put our address markers into this container
var addressContainer = new nokia.maps.map.Container();
 
// this function will be used when all managers have returned
var onAllManagersFinished = function() {
 
//we get the bounding box of the container
var bbox = addressContainer.getBoundingBox();
 
// if the bounding box is null then there are no objects inside
// meaning no markers have been added to it
 
if (bbox != null) {
// we have at least one address mapped
// so we add the container and zoomTo it
 
display.objects.add(addressContainer);
display.zoomTo(bbox, true);
} else {
 
// otherwise we'll pop up an error message
alert("There are no addresses to show :(");
}
};
// we will use the same state observer function for all managers
 
var onSearchComplete = function (data, requestStatus) {
if (requestStatus == "OK") {
// if we are finished, we add a marker for the mapped position
addressContainer.objects.add(new nokia.maps.map.StandardMarker(data.location.position));
 
//increment the counter to notify another manager has finished
managersFinished++;
} else if(requestStatus === "ERROR") {
 
// we'll also increment in case of an error
 
managersFinished++;
}
 
// if all managers are finished, we call the final function
if(managersFinished === addresses.length) {
onAllManagersFinished();
}
};
 
//Addresses to be displayed
var addresses = ["Helsinki, Finland", "Zaragoza, Spain", "Berlin, Germany", "Colorado Springs, USA", "Houston, TX",
"London, UK", "Vancouver, Canada", "Hyderabad, India", "Beijing, China", "Ilomantsi, Finland" ];
var i = addresses.length;
var managersFinished = 0;
 
// iterate over all addresses, create a manager for each of them,
// add the observer and call the geocode method
 
while(i--) {
nokia.places.search.manager.geoCode({
searchTerm :addresses[i],
onComplete: onSearchComplete
});
}
 
</script>
</body>
</html>

Screenshot

The following screenshot shows the resultant map after making the search.

Concurrent-search.png

261 page views in the last 30 days.