×
Namespaces

Variants
Actions
(Difference between revisions)

HERE Maps API - Short introduction to observable lists

From Nokia Developer Wiki
Jump to: navigation, search
jasfox (Talk | contribs)
m (Jasfox - - Important note about maps credentials)
jasfox (Talk | contribs)
m (Jasfox - Update links)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Nokia Maps]][[Category:Code Snippet]][[Category:JavaScript]]
+
[[Category:HERE Maps]][[Category:JavaScript]][[Category:Code Examples]]
{{Abstract|The OList class in Nokia Maps API is used to provide an observable list. In this article we show how to create the list and how to perform some operations on it.}}
+
{{Abstract|The OList class in HERE Maps API is used to provide an observable list. In this article we show how to create the list and how to perform some operations on it.}}
 
<code java>
 
<code java>
 
new nokia.maps.util.OList ([elements])  
 
new nokia.maps.util.OList ([elements])  
 
</code>
 
</code>
{{ArticleMetaData
+
{{ArticleMetaData <!-- v1.2 -->
|sourcecode= <!-- Link to example source code e.g. [[Media:The Code Example ZIP.zip]] -->
+
|sourcecode=  [https://github.com/heremaps/examples/blob/master/maps_api_for_javascript/advanced-examples/olist.html olist.html]
 
|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= Internet Explorer, Firefox, Opera, Google Chrome
 
|devices= Internet Explorer, Firefox, Opera, Google Chrome
Line 11: Line 11:
 
|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.2.3
+
|dependencies= HERE Maps 2.5.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= Nokia Maps, JavaScript, observable lists
+
|keywords= HERE Maps, JavaScript, observable lists
|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 -->
 
|translated-by= <!-- [[User:XXXX]] -->
 
|translated-by= <!-- [[User:XXXX]] -->
|translated-from-title= <!-- Title only -->  
+
|translated-from-title= <!-- Title only -->
 
|translated-from-id= <!-- Id of translated revision -->
 
|translated-from-id= <!-- Id of translated revision -->
|review-by=<!-- After re-review: [[User:username]] -->
+
|review-by= <!-- After re-review: [[User:username]] -->
 
|review-timestamp= <!-- After re-review: YYYYMMDD -->
 
|review-timestamp= <!-- After re-review: YYYYMMDD -->
|update-by=[[User:avnee.nathani]]
+
|update-by= [[User:avnee.nathani]]
|update-timestamp=20111231
+
|update-timestamp= 20111231
|creationdate=20110621
+
|creationdate= 20110621
|author=[[User:Maveric]]
+
|author= [[User:Maveric]]
 
}}
 
}}
 
{{SeeAlso|
 
{{SeeAlso|
* [http://developer.here.net/javascript_api Nokia Maps API]
+
* [http://developer.here.net/javascript_api HERE Maps API]
*  [[Nokia Maps API - How to cluster map markers|How to cluster map markers]] }}
+
*  [[HERE Maps API - How to cluster map markers]] }}
  
 
==Prerequisites==
 
==Prerequisites==
  
Nokia Maps API supported web browser (basically any modern web browser)
+
HERE Maps API supported web browser (basically any modern web browser)
  
 
==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. Please read 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
 
[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]
 
[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]
  
Line 46: Line 45:
 
To create a new list:
 
To create a new list:
  
<code java>
+
<code javascript>
 
  mylist = new nokia.maps.util.OList();
 
  mylist = new nokia.maps.util.OList();
 
</code>
 
</code>
  
 
To add to the list (e.g. three coordinates)
 
To add to the list (e.g. three coordinates)
<code java>
+
<code javascript>
 
     mylist.add([53.1]);
 
     mylist.add([53.1]);
 
     mylist.add([13.1]);
 
     mylist.add([13.1]);
Line 57: Line 56:
 
</code>
 
</code>
  
Query the length of a list:
+
Query the length of a list:
  
<code java>
+
<code javascript>
 
     mylist.getLength();
 
     mylist.getLength();
 
</code>
 
</code>
Line 67: Line 66:
 
To clear the list from items:
 
To clear the list from items:
  
<code java>
+
<code javascript>
 
     mylist.clear()
 
     mylist.clear()
 
</code>
 
</code>
  
 
The result of getLength() for the list would return zero/no items:
 
The result of getLength() for the list would return zero/no items:
<code java>
+
<code javascript>
 
     mylist.getLength();
 
     mylist.getLength();
 
</code>
 
</code>
Line 86: Line 85:
  
 
Parameters:
 
Parameters:
{Function}    callback     The callback which will be invoked after the list was modified with following arguments:
+
{Function}    callback The callback which will be invoked after the list was modified with following arguments:
 
(OList)      oList - the OList instance itself
 
(OList)      oList - the OList instance itself
 
(String)      method - the name of the method which caused the triggering
 
(String)      method - the name of the method which caused the triggering
Line 99: Line 98:
 
==Example code==
 
==Example code==
  
<code javascript>
+
A working example can be found at:
<!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>Observable Lists</title>
+
      <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+
      <script type="text/javascript"
+
            src="http://api.maps.nokia.com/2.2.3/jsl.js" charset="utf-8">
+
        </script>
+
    </head>
+
    <body>
+
  
        <div id="mapContainer" style="z-index: -1; left:0px; top:0px; width: 100%; height: 80%; position: absolute;"></div>
+
http://rawgithub.com/heremaps/examples/master/maps_api_for_javascript/advanced-examples/olist.html
        <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 = new nokia.maps.map.Display(document.getElementById("mapContainer"), {
+
components: [
+
//behavior collection
+
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,
+
center: [52.51, 13.4]
+
});
+
+
    mylist = new nokia.maps.util.OList();
+
+
    mylist.add([53.1]);
+
    mylist.add([13.1]);
+
    mylist.add([23.1]);
+
+
    alert("Length of the list: "+mylist.getLength());
+
    mylist.addObserver (listModified);
+
+
    mylist.add([53.1]); 
+
    //Comment this out to test the listener
+
+
function listModified()
+
{
+
    alert("List was modified!");
+
    alert("Length of the list: "+mylist.getLength());
+
}
+
</script>
+
</body>
+
</html>
+
</code>
+
  
==For more on the Nokia Maps API==
+
==For more on the HERE Maps API==
  
Please check out the Nokia Maps API full documentation and API reference here:
+
Please check out the HERE Maps API full documentation and API reference here:
* [http://developer.here.net/javascript_api Nokia Maps API]
+
* [http://developer.here.com/javascript_api HERE Maps API]
  
 
You may also access the interactive API explorer
 
You may also access the interactive API explorer
* [http://developer.here.net/javascript_api_explorer API explorer]
+
* [http://developer.here.com/javascript_api_explorer API explorer]

Latest revision as of 14:51, 28 November 2013

The OList class in HERE Maps API is used to provide an observable list. In this article we show how to create the list and how to perform some operations on it.

new nokia.maps.util.OList ([elements])
Article Metadata
Code Example
Source file: olist.html
Tested with
Devices(s): Internet Explorer, Firefox, Opera, Google Chrome
Compatibility
Platform(s): Web browser
Dependencies: HERE Maps 2.5.3
Article
Keywords: HERE Maps, JavaScript, observable lists
Created: Maveric (21 Jun 2011)
Updated: avnee.nathani (31 Dec 2011)
Last edited: jasfox (28 Nov 2013)

Contents

[edit] Prerequisites

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

[edit] 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

[edit] Implementation

The list can be manipulated by adding and removing items on it, and queries can be performed for e.g. the length of the list.

To create a new list:

 mylist = new nokia.maps.util.OList();

To add to the list (e.g. three coordinates)

    mylist.add([53.1]);
mylist.add([13.1]);
mylist.add([23.1]);

Query the length of a list:

    mylist.getLength();

This would return amount of "3" items as its result.

To clear the list from items:

    mylist.clear()

The result of getLength() for the list would return zero/no items:

    mylist.getLength();

The list can be enabled with an Observer.

addObserver (callback, [context])

To register a new observer.

API Reference definition:

Parameters: {Function} callback The callback which will be invoked after the list was modified with following arguments: (OList) oList - the OList instance itself (String) method - the name of the method which caused the triggering (Variant) element - the element which was added or deleted (Number) idx - the index of the concerned element

The callback can signalize that a rollback has occurred by returning true.

{Object} [context]: The context to use when the callback will be invoked.


[edit] Example code

A working example can be found at:

http://rawgithub.com/heremaps/examples/master/maps_api_for_javascript/advanced-examples/olist.html

[edit] For more on the HERE Maps API

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

You may also access the interactive API explorer

This page was last modified on 28 November 2013, at 14:51.
173 page views in the last 30 days.