×
Namespaces

Variants
Actions
(Difference between revisions)

HERE Maps API - Using the geocoding service

From Nokia Developer Wiki
Jump to: navigation, search
jasfox (Talk | contribs)
m (Jasfox - - Comments on the code)
jasfox (Talk | contribs)
m (Jasfox - update to 2.2.4)
(15 intermediate revisions by 2 users not shown)
Line 8: Line 8:
 
|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]) -->
 
|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.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, search, geocoding
 
|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/ Nokia Maps API]  
+
* [http://developer.here.net/javascript_api Nokia Maps API]  
* [http://api.maps.nokia.com/en/playground/examples/maps/services/search.html Search example]
+
* [http://developer.here.net/apiexplorer/examples/api-for-js/places-search/search-by-address.html Search example]
 
  }}
 
  }}
  
Line 37: Line 37:
 
The user can enter any string to the text box and if the search text can be '''geocoded''' to a physical location, we will put a  '''single''' Marker on the map  at the target location.
 
The user can enter any string to the text box and if the search text can be '''geocoded''' to a physical location, we will put a  '''single''' Marker on the map  at the target location.
 
Alternatively the user can enter a string to a text box and the search text can used in a '''places search''' where  we will put a Marker on the map for each location found on the result list.
 
Alternatively the user can enter a string to a text box and the search text can used in a '''places search''' where  we will put a Marker on the map for each location found on the result list.
For example a free text  search for "Berlin" would result in several map Markers, as there are more than one city on the globe with that name, however a gecode search would only
+
For example a free text  search for "Berlin" would result in several map Markers, as there are several towns and cities on the globe with that name, however a geocode search would only
 
find the most significant one - i.e the Capital of Germany.
 
find the most significant one - i.e the Capital of Germany.
  
Line 44: Line 44:
 
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  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:
 
==Comments on the code==
 
==Comments on the code==
  
We will utilize the ''zoomTo'' to cover all the findings, so the map will be zoomed out far enough for them all to become visible.
+
We will utilize the {{Icode|zoomTo()}} method to cover all the findings, so the map will be zoomed out far enough for them all to become visible.
For the ''zoomTo'' we must provide the name of the boundingBox, keepCenter (false by default) and optionally animation name.
+
For the {{Icode|zoomTo()}} method we must provide the name of the {{Icode|boundingBox}}, {{Icode|keepCenter}} ({{Icode|false}} by default) and optionally animation name.
  
If the keepCenter flag is used (true) the size of the viewport will be increased such that the original map center is still  
+
If the {{Icode|keepCenter}} flag is used ({{Icode|true}}) the size of the viewport will be increased such that the original map center is still  
 
located in the center of the viewport.  
 
located in the center of the viewport.  
  
*  A call to ''nokia.places.search.manager.geoCode''  will call the '''geocoding''' service.
+
*  A call to {{Icode|nokia.places.search.manager.geoCode()}} will call the '''geocoding''' service.
* A call to ''nokia.places.search.manager.findPlaces'' will call a ''free text'' search.
+
* A call to {{Icode|nokia.places.search.manager.findPlaces()}} will call a '''free text''' search.
  
Note that the greater the  detail you eneter in an address, the higher the likelyhood that the results will resemble one another.
+
Note that the greater the  detail you enter in an address, the higher the likelihood that the results will resemble one another.
  
 
==Example code==
 
==Example code==
 
+
This example demonstrates the use of both the geocoding service and the places free text search. Remember to add in your own [[How to Obtain Your Own Nokia appID and Token| AppId and Token]].
<code java>
+
<code javascript>
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
<html>  
 
<html>  
 
<head>
 
<head>
<script type="text/javascript" charset="UTF-8" src="http://api.maps.nokia.com/2.2.0/jsl.js"></script>
+
<script type="text/javascript" charset="UTF-8" src="http://api.maps.nokia.com/2.2.4/jsl.js"></script>
 
     <title>Search example</title>
 
     <title>Search example</title>
 
</head>
 
</head>
Line 175: Line 175:
  
 
</code>
 
</code>
 +
 
==Screenshots==
 
==Screenshots==
[[File:NokiaMapsGeocoding.png|700px]]
+
[[File:NokiaMapsGeocoding.png]]
==For more on Nokia Maps API==
+
  
Please check out the Nokia Maps API full documentation and API reference here:
+
==For more on the Nokia Maps API==
* http://api.maps.nokia.com/
+
  
You may also access the interactive Nokia Maps API playground,
+
Please check out the Nokia Maps API full documentation and API reference here:
* http://api.maps.nokia.com/2.1.0/playground/index.html
+
* [http://developer.here.net/javascript_api Nokia Maps API]
 
+
==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:21, 14 March 2013

This article explains how to use Nokia Maps search and geocoding service.

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

Contents

Introduction

In this example we will create a small online tool for the user to search the globe for a city, country and so on.

We will utilize both the Nokia Maps Free text Search and Geocoding services for this.

The user can enter any string to the text box and if the search text can be geocoded to a physical location, we will put a single Marker on the map at the target location. Alternatively the user can enter a string to a text box and the search text can used in a places search where we will put a Marker on the map for each location found on the result list. For example a free text search for "Berlin" would result in several map Markers, as there are several towns and cities on the globe with that name, however a geocode search would only find the most significant one - i.e the Capital of Germany.

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

The full example code is provided below.

Comments on the code

We will utilize the zoomTo() method to cover all the findings, so the map will be zoomed out far enough for them all to become visible. For the zoomTo() method we must provide the name of the boundingBox, keepCenter (false by default) and optionally animation name.

If the keepCenter flag is used (true) the size of the viewport will be increased such that the original map center is still located in the center of the viewport.

  • A call to nokia.places.search.manager.geoCode() will call the geocoding service.
  • A call to nokia.places.search.manager.findPlaces() will call a free text search.

Note that the greater the detail you enter in an address, the higher the likelihood that the results will resemble one another.

Example code

This example demonstrates the use of both the geocoding service and the places free text search. Remember to add in your own AppId and Token.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<script type="text/javascript" charset="UTF-8" src="http://api.maps.nokia.com/2.2.4/jsl.js"></script>
<title>Search example</title>
</head>
<body>
<div id="extra" style="top:0%; position: absolute;">
<label for="geo_text_box"> Geocode </label><br/>
<input type="text" id="geo_text_box"/>
<input type="button" value="Geo code with name" onclick="mapStartGeoCode()"/>
<br/>
<label for="geo_text_box"> Free text search</label><br/>
<input type="text" id="free_text_text_box"/>
<input type="button" value="Search" onclick="mapStartFreeTextSearch()"/>
</div>
<div id="map" style="top:30%; width:100%; height:70%; 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;
 
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': 10,
});
 
map.setCenter (new nokia.maps.geo.Coordinate(18.975, 72.825833));
 
 
var onGeocodeComplete = function (data, requestStatus , requestId) {
 
if (requestStatus == "OK") {
alert("GEOCODE ENDED SUCCESSFULLY");
var marker = new nokia.maps.map.StandardMarker(data.location.position);
map.objects.add(marker);
map.zoomTo(marker.getBoundingBox(), true);
 
} else if(requestStatus == "ERROR") {
alert("GEOCODE FAILED.");
}
};
 
var onSearchComplete = function (data, requestStatus , requestId) {
 
if (requestStatus == "OK") {
alert("SEARCH ENDED SUCCESSFULLY");
// Convert all found locations into a set of markers
var resultSet = new nokia.maps.map.Container();
var locations = data.results.items;
for (i = 0, len = locations.length; i < len; i++) {
marker = new nokia.maps.map.StandardMarker(locations[i].position, { text: i+1 });
resultSet.objects.add(marker);
}
// Next we add the marker(s) to the map's object collection so they will be rendered onto the map
map.objects.add(resultSet);
// We zoom the map to a view that encapsulates all the markers into map's viewport
map.zoomTo(resultSet.getBoundingBox(), false);
} else if(requestStatus == "ERROR") {
alert("SEARCH FAILED.");
}
};
 
function mapStartGeoCode(){
var geocode = document.getElementById("geo_text_box");
 
nokia.places.search.manager.geoCode({
searchTerm : geocode.value,
onComplete: onGeocodeComplete
});
}
 
function mapStartFreeTextSearch(){
var freetext = document.getElementById("free_text_text_box");
 
nokia.places.search.manager.findPlaces({
searchTerm : freetext.value,
onComplete: onSearchComplete,
searchCenter: map.center
});
 
 
}
 
</script>
</body>
</html>

Screenshots

NokiaMapsGeocoding.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

827 page views in the last 30 days.
×