×
Namespaces

Variants
Actions
(Difference between revisions)

HERE Maps API - How to add map markers

From Nokia Developer Wiki
Jump to: navigation, search
jasfox (Talk | contribs)
m (Jasfox - update link.)
jasfox (Talk | contribs)
m (Jasfox - add monospacing.)
Line 31: Line 31:
 
==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 thru on 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 47: Line 47:
  
 
=== Defining a Marker ===
 
=== Defining a Marker ===
First we will need to define the Marker. This will be done by specifying the location as a GeoCoordinate and then defining the 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>
 
   var center =    new nokia.maps.geo.Coordinate(40.738728,-73.99236);
 
   var center =    new nokia.maps.geo.Coordinate(40.738728,-73.99236);
Line 53: Line 53:
 
</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 40.738728 for the
+
The {{Icode|Marker}} needs geocoordinates as parameters, that is, the latitude and longitude it will be placed 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.
+
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.
  
 
===Adding a Marker directly ===
 
===Adding a Marker directly ===
We may place the ''StandardMarker'' on the map by adding it directly as shown:
+
We may place the {{Icode|StandardMarker}} on the map by adding it directly as shown:
  
 
<code javascript>
 
<code javascript>
Line 65: Line 65:
  
 
=== Adding a Marker via a Container ===
 
=== Adding a Marker via a Container ===
As an alternative to adding a marker directly,  or we  can add it to  a container and the add the conatiner to the map. A container is used to group Objects, thus allows it to operate on  
+
As an alternative to adding a marker directly,  or we  can add it to  a {{Icode|Container}} and the add the {{Icode|Container}} to the map. A {{Icode|Container}} is used to group {{Icode|Objects}}, thus allows it to operate on  
a whole group of objects without the need to iteratively visit each Object (e.g. for changing the visibility).
+
a whole group of {{Icode|objects}} without the need to iteratively visit each {{Icode|Object}} (e.g. for changing the visibility).
  
First create a container:
+
First create a {{Icode|Container}}:
 
<code javascript>
 
<code javascript>
 
   var container = new nokia.maps.map.Container();
 
   var container = new nokia.maps.map.Container();
 
</code>
 
</code>
  
Now that we have the ''Container'' ready, we can add the ''StandardMarker'' into it:
+
Now that we have the {{Icode|Container}} ready, we can add the {{Icode|StandardMarker}} into it:
  
 
<code java>
 
<code java>
Line 80: Line 80:
 
</code>
 
</code>
 
                  
 
                  
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:
+
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>
Line 87: Line 87:
  
 
=== Manipulating the Marker ===
 
=== Manipulating the Marker ===
The properties of the ''StandardMarker'' can be further manipulated, e.g. you can make the ''Marker'' draggable (it is not that by default) if you wish:
+
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 javascript>
 
<code javascript>
Line 93: Line 93:
 
</code>
 
</code>
  
And to make the  ''StandardMarker'' static again, you would give:
+
And to make the  {{Icode|StandardMarker}} static again, you would give:
  
 
<code javascript>
 
<code javascript>
Line 99: Line 99:
 
</code>
 
</code>
  
For a ''StandardMarker'' you can set the text as shown:  
+
For a {{Icode|StandardMarker}} you can set the {{Icode|text}} property as shown:  
  
 
<code javascript>
 
<code javascript>
Line 106: Line 106:
  
 
=== Retrieving information about the 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:
+
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 javascript>
 
<code javascript>
Line 114: Line 114:
 
</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>
Line 120: Line 120:
 
</code>
 
</code>
  
In our case test would result in “true”.
+
In 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 ''nokia.maps.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:
Line 139: Line 139:
 
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:
Line 148: Line 148:
 
Returns:
 
Returns:
 
{nokia.maps.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>
Line 154: Line 154:
 
</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 = marker.getDisplays();
 
     test = marker.getDisplays();
 
</code>
 
</code>
  
This case we would know already there is the “map” Display, so requesting now the question'' marker.isAdded (test)'' would give us “true”,  
+
This case we would know already there is the {{Icode|"map" Display}}, so requesting now the question {{Icode|marker.isAdded (test)}} would give us {{Icode|true}},  
because ''marker'' is attached to the “map”.
+
because {{Icode|marker}}  is attached to the {{Icode|"map"}}.
  
 
==Example code==
 
==Example code==

Revision as of 11:43, 17 April 2012

Article Metadata
Tested with
Devices(s): Google Chrome, Firefox, Internet Explorer, Safari
Compatibility
Platform(s): Web
Dependencies: Nokia Maps API v2.2
Article
Created: Maveric (21 Jun 2011)
Updated: jasfox (06 Feb 2012)
Last edited: jasfox (17 Apr 2012)


Contents

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.

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 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 Nokia Developer API Registration page.

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, the latitude and longitude it will be placed 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, or we can add it to a Container and the add the Container to the map. A Container is used to group Objects, thus allows it to operate on a whole group of objects without the need to iteratively visit each Object (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)

In 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();

This case we would know already there is the "map" Display, so requesting now 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.

<!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.0/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(),
new nokia.maps.positioning.component.Positioning()
]
});
var marker = new nokia.maps.map.StandardMarker(center);
map.objects.add(marker);
</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,

401 page views in the last 30 days.
×