×
Namespaces

Variants
Actions
(Difference between revisions)

HERE Maps API - How to add map markers

From Nokia Developer Wiki
Jump to: navigation, search
Maveric (Talk | contribs)
m (Maveric - - Implementation)
jasfox (Talk | contribs)
m (Jasfox - update to 2.2.4)
(35 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Ovi]][[Category:Web]][[Category:Browser]]
+
[[Category:Nokia Maps]][[Category:JavaScript]][[Category:Code Snippet]][[Category:Nokia Maps]][[Category:Nokia Maps]][[Category:Nokia Maps]][[Category:Nokia Maps]]
 +
{{ArticleMetaData
 +
|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]]) -->
 +
|devices= Google Chrome, Firefox, Internet Explorer, Safari
 +
|sdk= <!-- SDK(s) built and tested against (e.g. [http://linktosdkdownload/ Nokia Qt SDK 1.1]) -->
 +
|platform= Web
 +
|devicecompatability= <!-- Compatible devices e.g.: All* (must have internal GPS) -->
 +
|dependencies=  Nokia Maps Api 2.2.4
 +
|signing=<!-- Signing requirements - empty or one of: Self-Signed, DevCert, Manufacturer -->
 +
|capabilities= <!-- Capabilities required by the article/code example (e.g. Location, NetworkServices. -->
 +
|keywords= Nokia Maps, JavaScript, Markers
 +
|id= <!-- Article Id (Knowledge base articles only) -->
 +
|language= <!-- Language category code for non-English topics - e.g. Lang-Chinese -->
 +
|translated-by= <!-- [[User:XXXX]] -->
 +
|translated-from-title= <!-- Title only -->
 +
|translated-from-id= <!-- Id of translated revision -->
 +
|review-by=<!-- After re-review: [[User:username]] -->
 +
|review-timestamp= <!-- After re-review: YYYYMMDD -->
 +
|update-by= [[User:jasfox]]
 +
|update-timestamp= 20120206
 +
|creationdate=20110621
 +
|author=[[User:Maveric]]
 +
}}
 +
{{SeeAlso|
 +
* [[Nokia Maps API - Add Maps To Any Web Page]]
 +
* [http://developer.here.net/javascript_api Nokia Maps API]
 +
* [http://developer.here.net/apiexplorer/examples/api-for-js/markers/marker.html Adding a Marker]
 +
* [[How to Obtain Your Own Nokia appID and Token|Obtaining an AppId and Token]]}}
 +
 
 
==Introduction==
 
==Introduction==
  
In this article we will go thru on how to add one or more Markers to the map. A marker defines an Object that may display an icon on the map view.
+
In this article we will go through how to add one or more {{Icode|Markers}} to the map. A {{Icode|Marker}} defines an {{Icode|Object}} that may display an icon on the map view.
  
 
==Prerequisites==
 
==Prerequisites==
Line 8: Line 37:
 
A supported web browser (basically any modern web browser)
 
A supported web browser (basically any modern web browser)
  
The example assumes you have already added the Ovi Maps to your web page as explained in the previous article "Ovi Maps - add the map to any web page"
+
The example assumes you have already added the Nokia Maps to your web page as explained in the previous article [[Nokia Maps API - Add Maps To Any Web Page]]
  
==Important about Maps credentials==
+
==Important note about maps credentials==
  
With Ovi Maps API you can start without having any credentials given, but you might face a performance gap. In order to get the full potential out of 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
offering, you must get the credentials that authenticate your application against the Services. Please read through the Location API.
+
[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]
  
For more information on how to obtain the credentials, please start with the  Ovi Maps API Developers Guide section "Acquiring API credentials"
 
 
 
==Implementation==
 
==Implementation==
  
First we will need to define the Marker. This will be done by specifying:
 
  
 +
=== Defining a Marker ===
 +
First we will need to define the {{Icode|Marker}}. This will be done by specifying the location as a {{Icode|geo.Coordinate}} and then defining the {{Icode|Marker}}:
 
<code java>
 
<code java>
    myMarker = new ovi.mapsapi.map.Marker([50.1,13.1]);
+
  var center =   new nokia.maps.geo.Coordinate(40.738728,-73.99236);
 +
  var    marker = new nokia.maps.map.StandardMarker(center);
 
</code>
 
</code>
  
The Marker needs geocoordinates as parameters, that is, the latitude and longitude it will be placed on the map. In our example we are using 50.1 for the
+
The {{Icode|Marker}} needs geocoordinates as parameters, that is, its latitude and longitude on the map. In our example we are using 40.738728 for the
latitude and 13.1 for the longitude. myMarker now contains a new Marker object.
+
latitude and -73.99236 for the longitude This will place a marker in Central New York. {{Icode|marker}} now contains a new {{Icode|StandardMarker}} object.
  
To be able to put the Marker on the map, we will need to introduce a new Container. A Container is used to group Objects, thus allowing it to operate on
+
===Adding a Marker directly ===
a whole group of objects without the need to iteratively visit each Object (i.e., for changing the visibility).
+
We may place the {{Icode|StandardMarker}} on the map by adding it directly as shown:
  
<code java>
+
<code javascript>
    var myContainer = new ovi.mapsapi.map.Container()
+
  map.objects.add(marker);
 
</code>
 
</code>
  
Now that we have the Container ready, we can add the Marker into it:
 
  
<code java>
 
    myContainer.objects.add(myMarker);
 
    //or another way of putting this e.g. myContainer.objects.add(new ovi.mapsapi.map.StandardMarker([52.45705,13.21173]));
 
</code>
 
               
 
And then when the Marker is in the Container, we will need to add the Container to the map objects collection, to be able to show the content on it:
 
  
<code java>
+
 
    map.objects.add(myContainer);      
+
=== Adding a Marker via a Container ===
 +
As an alternative to adding a marker directly,  we can add it to  a {{Icode|Container}} and then add the {{Icode|Container}} to the map. A {{Icode|Container}} is used to group {{Icode|Objects}}, and thus allows them all to be operated on at once without the need to iteratively visit each one (e.g. for changing the visibility).
 +
 
 +
First create a {{Icode|Container}}:
 +
<code javascript>
 +
  var container = new nokia.maps.map.Container();
 
</code>
 
</code>
  
The properties of the Marker can be further manipulated, e.g. you can make the Marker draggable (it is not that by default) if you wish:
+
Now that we have the {{Icode|Container}} ready, we can add the {{Icode|StandardMarker}} into it:
  
 
<code java>
 
<code java>
     myMarker.set("draggable",true);  
+
     container .objects.add(marker);
 +
    //or another way of putting this e.g. container.objects.add( new nokia.maps.map.StandardMarker( new nokia.maps.geo.Coordinate(40.738728,-73.99236)));
 
</code>
 
</code>
 
+
               
And to make the Marker static again, you would give:
+
And then when the {{Icode|StandardMarker}} is in the {{Icode|Container}}, we will need to add the {{Icode|Container}} to the map objects collection, to be able to show the content on it:
  
 
<code java>
 
<code java>
     myMarker.set("draggable",false);
+
     map.objects.add(container);      
 
</code>
 
</code>
  
For a marker you can set a text e.g.  
+
=== Manipulating the Marker ===
 +
The properties of the {{Icode|StandardMarker}} can be further manipulated, e.g. you can make the {{Icode|Marker}} {{Icode|draggable}} (it is static by default) if you wish:
  
<code>
+
<code javascript>
     myMarker.set("text","Your marker!")
+
     marker.set("draggable",true);   
 
</code>
 
</code>
   
 
An external image can be attached as follows:
 
  
<code java>
+
And to make the  {{Icode|StandardMarker}} static again, you would give:
     MyMarker.set("icon","https://lh4.googleusercontent.com/-KF_2mI6ah7k/TQdNED2s0PI/AAAAAAAAABw/gxMRWz4rY78/DSCF0469.JPG");
+
 
 +
<code javascript>
 +
     marker.set("draggable",false);
 
</code>
 
</code>
   
 
Or you can select from the predefined list of shapes:
 
  
<code java>
+
For a {{Icode|StandardMarker}} you can set the {{Icode|text}} property as shown:
    var use_this_shape = "star";
+
    myMarker.set("shape", use_this_shape);   
+
  
 +
<code javascript>
 +
    marker.set("text","Your marker!")
 +
</code>
  
Sometimes it may be useful to know if a Container has been added to the Display. Earlier we could have initiated the Display object e.g. like this:
+
=== Retrieving information about the marker ===
 +
Sometimes it may be useful to know if a {{Icode|Container}} has been added to the {{Icode|Display}}. Earlier we could have initiated the {{Icode|Display}} object e.g. like this:
  
<code>
+
<code javascript>
 
...
 
...
     var map = new ovi.mapsapi.map.Display(document.getElementById("map"),  
+
     var map = nokia.maps.map.Display(document.getElementById("map"),  
 
...
 
...
 
</code>
 
</code>
  
Now, with the reference to “map”, we can request:
+
Now, with the reference to {{Icode|"map"}}, we can request:
  
 
<code java>
 
<code java>
     test = myMarkerContainer.isAdded (map)
+
     test = marker.isAdded (map)
 
</code>
 
</code>
  
In our case test would result in “true”.
+
Our case test would result in {{Icode|true}}.
  
  
With the isVisible (display) : Boolean  we will get true if the object's visibility as well as all parent's visibilities are true and if the object is
+
With the {{Icode|isVisible (display) : Boolean}} we will get true if the object's visibility as well as all parent's visibilities are true and if the object is
attached to a map (i.e. parent chain ends with a map). The returned value is only valid for the given ovi.mapsapi.map.Display object.  
+
attached to a map (i.e. parent chain ends with a map). The returned value is only valid for the given {{Icode|nokia.maps.map.Display}} object.  
  
 
Parameters:
 
Parameters:
  
{ovi.mapsapi.map.Display}  
+
{nokia.maps.map.Display}  
 
display    The display to check.  
 
display    The display to check.  
  
Line 107: Line 136:
  
 
<code java>
 
<code java>
     test = myMarkerContainer.isVisible(map);
+
     test = marker.isVisible(map);
 
</code>
 
</code>
  
 
Again, this would result in “true”.
 
Again, this would result in “true”.
  
With the getParent (display) we can get the parent of the map object.
+
With the {{Icode|getParent (display)}} we can get the parent of the map object.
 
   
 
   
 
Parameters:
 
Parameters:
  
{ovi.mapsapi.map.Display}  
+
{nokia.maps.map.Display}  
 
display    The display for which to return the parent object.  
 
display    The display for which to return the parent object.  
  
 
Returns:
 
Returns:
{ovi.mapsapi.map.Object}  
+
{nokia.maps.map.Object}  
The parent object of this object for the given display or undefined if this map object has no parent.  
+
The {{Icode|parent}} object of this object for the given display or {{Icode|undefined}} if this map object has no parent.  
  
 
<code java>
 
<code java>
     test = myMarkerContainer.getParent(map);
+
     test = marker.getParent(map);
 
</code>
 
</code>
  
If we want to get the Display names that the Container is attached to, this could be queried as follows:
+
If we want to get the {{Icode|Display}} names that the {{Icode|Container}} is attached to, this could be queried as follows:
 
<code java>
 
<code java>
     test = myMarkerContainer.getDisplays();
+
     test = marker.getDisplays();
 
</code>
 
</code>
  
This case we would know already there is the “map” Display, so requesting now the question myMarkerContainer.isAdded (test) would give us “true”,  
+
In this case we would know already that there is the {{Icode|"map" Display}}, so now asking the question {{Icode|marker.isAdded (test)}} would give us {{Icode|true}},  
because myMarkerContainer is attached to the “map”.
+
because {{Icode|marker}}  is attached to the {{Icode|"map"}}.
  
 
==Example code==
 
==Example code==
  
Here is a full example with required HTML and embedded JavaScript.
+
Here is a full example with required HTML and embedded JavaScript. Remember to add in your own [[How to Obtain Your Own Nokia appID and Token| AppId and Token]].
  
<code java>
+
<code javascript>
<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">
<title>Marker on the Map</title>
+
    <head>
<script src="http://api.maps.ovi.com/jsl.js" type="text/javascript" charset="utf-8"></script>
+
      <title>Adding a marker.</title>
</head>
+
      <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<body>
+
      <script type="text/javascript"
<div id="map" style="z-index: -1; left:0px; top:0px; width: 100%; height: 100%; position: absolute;"></div>
+
            src="http://api.maps.nokia.com/2.2.4/jsl.js?with=all" charset="utf-8">
<script type="text/javascript">
+
        </script>
 +
    </head>
 +
    <body>
  
// Set the authentication token, which is needed by the web-services to authenticate your application.
+
        <div id="mapContainer" style="z-index: -1; left:0px; top:0px; width: 100%; height: 80%; position: absolute;"></div>
ovi.mapsapi.util.ApplicationContext.set("authenticationToken", "<Token>");
+
        <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 ovi.mapsapi.map.Display(document.getElementById("map"), {'zoomLevel':8, 'center':[53.1, 15.1]});
+
//
 +
/////////////////////////////////////////////////////////////////////////////////////
  
map.set("baseMapType", map.SATELLITE);
+
        ///            THE LAT AND LONG HERE ARE IN CENTRAL NEW YORK
 
+
        var center =    new nokia.maps.geo.Coordinate(40.738728,-73.99236);
myMarker = new ovi.mapsapi.map.Marker([52.52,13.4]);
+
// Get the DOM node to which we will append the map
var myContainer = new ovi.mapsapi.map.Container()
+
var mapContainer = document.getElementById("mapContainer");
myContainer.objects.add(myMarker);
+
map.objects.add(myContainer)
+
// Create a map inside the map container DOM node
 +
var map = new nokia.maps.map.Display(mapContainer, {
 +
        // initial center and zoom level of the map
 +
        center: center,
 +
        zoomLevel: 15,
 +
        components: [
 +
                new nokia.maps.map.component.ZoomBar(),  
 +
                new nokia.maps.map.component.Behavior(),
 +
                new nokia.maps.map.component.TypeSelector(),
 +
                new nokia.maps.map.component.Traffic(),
 +
                new nokia.maps.map.component.PublicTransport(),
 +
                new nokia.maps.map.component.Overview(),
 +
                new nokia.maps.map.component.ScaleBar()
 +
        ]
 +
});
 +
var    marker = new nokia.maps.map.StandardMarker(center);
 +
map.objects.add(marker);
 
</script>
 
</script>
 
</body>
 
</body>
</html>
+
</html></code>
</code>
+
 
+
 
+
For more on Ovi Maps API
+
 
+
Please check out the Ovi Maps API full documentation and API reference here:
+
 
+
http://api.maps.ovi.com
+
  
Tested on
+
==For more on the Nokia Maps API==
  
Google Chrome 11.0x
+
Please check out the Nokia Maps API full documentation and API reference here:
 +
* [http://developer.here.net/javascript_api Nokia Maps API]
  
Mozilla Firefox 5.0
+
You may also access the interactive API explorer
 +
* [http://developer.here.net/javascript_api_explorer API explorer]

Revision as of 14:25, 14 March 2013

Article Metadata
Tested with
Devices(s): Google Chrome, Firefox, Internet Explorer, Safari
Compatibility
Platform(s): Web
Dependencies: Nokia Maps Api 2.2.4
Article
Keywords: Nokia Maps, JavaScript, Markers
Created: Maveric (21 Jun 2011)
Updated: jasfox (06 Feb 2012)
Last edited: jasfox (14 Mar 2013)

Contents

Introduction

In this article we will go through how to add one or more Markers to the map. A Marker defines an Object that may display an icon on the map view.

Prerequisites

A supported web browser (basically any modern web browser)

The example assumes you have already added the Nokia Maps to your web page as explained in the previous article Nokia Maps API - Add Maps To Any Web Page

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

Defining a Marker

First we will need to define the Marker. This will be done by specifying the location as a geo.Coordinate and then defining the Marker:

   var center =    new nokia.maps.geo.Coordinate(40.738728,-73.99236);
var marker = new nokia.maps.map.StandardMarker(center);

The Marker needs geocoordinates as parameters, that is, its latitude and longitude on the map. In our example we are using 40.738728 for the latitude and -73.99236 for the longitude This will place a marker in Central New York. marker now contains a new StandardMarker object.

Adding a Marker directly

We may place the StandardMarker on the map by adding it directly as shown:

   map.objects.add(marker);



Adding a Marker via a Container

As an alternative to adding a marker directly, we can add it to a Container and then add the Container to the map. A Container is used to group Objects, and thus allows them all to be operated on at once without the need to iteratively visit each one (e.g. for changing the visibility).

First create a Container:

   var container = new nokia.maps.map.Container();

Now that we have the Container ready, we can add the StandardMarker into it:

    container .objects.add(marker);
//or another way of putting this e.g. container.objects.add( new nokia.maps.map.StandardMarker( new nokia.maps.geo.Coordinate(40.738728,-73.99236)));

And then when the StandardMarker is in the Container, we will need to add the Container to the map objects collection, to be able to show the content on it:

    map.objects.add(container);

Manipulating the Marker

The properties of the StandardMarker can be further manipulated, e.g. you can make the Marker draggable (it is static by default) if you wish:

    marker.set("draggable",true);

And to make the StandardMarker static again, you would give:

    marker.set("draggable",false);

For a StandardMarker you can set the text property as shown:

    marker.set("text","Your marker!")

Retrieving information about the marker

Sometimes it may be useful to know if a Container has been added to the Display. Earlier we could have initiated the Display object e.g. like this:

...
var map = nokia.maps.map.Display(document.getElementById("map"),
...

Now, with the reference to "map", we can request:

    test = marker.isAdded (map)

Our case test would result in true.


With the isVisible (display) : Boolean we will get true if the object's visibility as well as all parent's visibilities are true and if the object is attached to a map (i.e. parent chain ends with a map). The returned value is only valid for the given nokia.maps.map.Display object.

Parameters:

{nokia.maps.map.Display} display The display to check.

In our case we could ask:

    test = marker.isVisible(map);

Again, this would result in “true”.

With the getParent (display) we can get the parent of the map object.

Parameters:

{nokia.maps.map.Display} display The display for which to return the parent object.

Returns: {nokia.maps.map.Object} The parent object of this object for the given display or undefined if this map object has no parent.

    test = marker.getParent(map);

If we want to get the Display names that the Container is attached to, this could be queried as follows:

    test = marker.getDisplays();

In this case we would know already that there is the "map" Display, so now asking the question marker.isAdded (test) would give us true, because marker is attached to the "map".

Example code

Here is a full example with required HTML and embedded JavaScript. 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 xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Adding a marker.</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="mapContainer" 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");
 
//
/////////////////////////////////////////////////////////////////////////////////////
 
/// THE LAT AND LONG HERE ARE IN CENTRAL NEW YORK
var center = new nokia.maps.geo.Coordinate(40.738728,-73.99236);
// Get the DOM node to which we will append the map
var mapContainer = document.getElementById("mapContainer");
 
// Create a map inside the map container DOM node
var map = new nokia.maps.map.Display(mapContainer, {
// initial center and zoom level of the map
center: center,
zoomLevel: 15,
components: [
new nokia.maps.map.component.ZoomBar(),
new nokia.maps.map.component.Behavior(),
new nokia.maps.map.component.TypeSelector(),
new nokia.maps.map.component.Traffic(),
new nokia.maps.map.component.PublicTransport(),
new nokia.maps.map.component.Overview(),
new nokia.maps.map.component.ScaleBar()
]
});
var marker = new nokia.maps.map.StandardMarker(center);
map.objects.add(marker);
</script>
</body>
</html>

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

266 page views in the last 30 days.
×