×
Namespaces

Variants
Actions
(Difference between revisions)

HERE Maps API - Coroutines

From Nokia Developer Wiki
Jump to: navigation, search
jasfox (Talk | contribs)
m (Jasfox - add monospacing.)
jasfox (Talk | contribs)
m (Jasfox - Add link.)
Line 1: Line 1:
 
[[Category:Nokia Maps]][[Category:JavaScript]][[Category:Code Snippet]]
 
[[Category:Nokia Maps]][[Category:JavaScript]][[Category:Code Snippet]]
{{Abstract|This article demonstrates the use of Nokia Maps API Coroutine feature.}}  
+
{{Abstract|This article demonstrates the use of Nokia Maps API {{Icode|Coroutine}} feature.}}  
  
 
{{ArticleMetaData
 
{{ArticleMetaData
Line 38: Line 38:
 
http://api.maps.nokia.com/2.2.0/apireference/symbols/nokia.maps.util.Coroutine.html
 
http://api.maps.nokia.com/2.2.0/apireference/symbols/nokia.maps.util.Coroutine.html
  
The example below is using the same concept as in the "Nokia Maps API - Pan the map" example.  
+
The example below is using the same concept as in the [http://api.maps.nokia.com/en/playground/examples/maps/map_essentials/moving.html How to pan the map] example.  
  
 
As the Coroutine built in serves the similar functionality as the JavaScript {{Icode|setTimeout()}} and {{Icode|setInterval()}}, you can also utilize them in same type of use cases. The main idea behind the {{Icode|Coroutine}} implementation is to serve as a point of saving some CPU time cycles, while performing multiple tasks during the same mapping program - threading.
 
As the Coroutine built in serves the similar functionality as the JavaScript {{Icode|setTimeout()}} and {{Icode|setInterval()}}, you can also utilize them in same type of use cases. The main idea behind the {{Icode|Coroutine}} implementation is to serve as a point of saving some CPU time cycles, while performing multiple tasks during the same mapping program - threading.

Revision as of 13:50, 17 April 2012

This article demonstrates the use of Nokia Maps API Coroutine feature.

Article Metadata
Tested with
Devices(s): Internet Explorer, Google Chrome, Firefox, Opera
Compatibility
Platform(s): Web browser
Dependencies: Nokia Maps 2.2.0
Article
Created: Maveric (28 Jun 2011)
Updated: avnee.nathani (31 Dec 2011)
Last edited: jasfox (17 Apr 2012)


Introduction and Prerequisites

Firstly, please read the complete section of Coroutines at the Nokia Maps API reference. It is explained there in detail, and here is the direct link:

http://api.maps.nokia.com/2.2.0/apireference/symbols/nokia.maps.util.Coroutine.html

The example below is using the same concept as in the How to pan the map example.

As the Coroutine built in serves the similar functionality as the JavaScript setTimeout() and setInterval(), you can also utilize them in same type of use cases. The main idea behind the Coroutine implementation is to serve as a point of saving some CPU time cycles, while performing multiple tasks during the same mapping program - threading.

Because there is a lot to this subject, it is highly recommended you should read the related API chapter.

Example code

This example will loop from 1 to 500 with 10ms delay. The run is displayed on screen, and after the set time period of Coroutine operations, the map will pan to a new position and the Coroutines get terminated.

<!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>Coroutines 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.0/jsl.js" charset="utf-8">
</script>
</head>
<body>
<div id="showCoords" style="height: 2.0em; font-size: 2em; color: blue;"></div>
 
<div id="map" style="width:80%; 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 myInterval = 0;
var myTimer;
var map_start_x = 100;
var map_start_y = 100;
var map_end_x = 120;
var map_end_y = 100;
var myMap;
 
if (document.addEventListener)
document.addEventListener("DOMContentLoaded", all_is_ready, false);
 
 
function all_is_ready(){
 
alert("Click OK to start the panning using Coroutine");
 
myMap = 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,
center: [52.51, 13.4]
 
});
 
 
var i = 0,
Coroutine = nokia.maps.util.Coroutine;
 
// Define the 1st coroutine - increase the value of i by one every 10 milliseconds, until we reach a 100.
// Watch the console output for the numbers!
 
var iteration = Coroutine.create("iterator", function( scope, context ) {
i++;
 
if ( i <= 500 ) {
document.getElementById("showCoords").innerHTML = "Wait until 500 to see the map move! : "+i+"/500";
return Coroutine.sleep(10);
}
 
map_start_x = map_start_x + 200;
map_start_y = map_start_y + 200;
map_end_x = map_end_x - 400;
map_end_y = map_end_y + 400;
 
// pan the map to the new position after the loop is over
myMap.pan(map_start_x, map_start_y, map_end_x, map_end_y);
 
});
 
// 2nd coroutine display iteration in console.log every 100 miliseconds
var printing = Coroutine.create("printing", function( scope, context ) {
console.log(i);
 
return Coroutine.sleep(100);
});
 
// 1st coroutine, init to the "coroutine" variable
var coroutine = iteration();
 
// 2nd second coroutine, init to the "coroutine2" variable
var coroutine2 = printing();
 
// Add an observer to the 1st coroutine for it's status
coroutine.addObserver("status", function( context, key, value, oldValue ) {
if ( value == Coroutine.TERMINATED ) { // When gets terminated
Coroutine.kill( coroutine2 ); // kill the 2nd coroutine
document.getElementById("showCoords").innerHTML = "Coroutine finished, and got terminated.";
}
});
 
}
</script>
</body>
</html>

For more on Nokia Maps API

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

You may also access the interactive Nokia Maps API playground,

206 page views in the last 30 days.

Was this page helpful?

Your feedback about this content is important. Let us know what you think.

 

Thank you!

We appreciate your feedback.

×