×
Namespaces

Variants
Actions
(Difference between revisions)

HERE Maps API - How to add an HTML InfoBubble on the map

From Nokia Developer Wiki
Jump to: navigation, search
Maveric (Talk | contribs)
m (Maveric - - Example code)
jasfox (Talk | contribs)
m (Jasfox - - Adding an Infobubble directly onto the Map)
(25 intermediate revisions by 5 users not shown)
Line 1: Line 1:
[[Category:Ovi]][[Category:Web]][[Category:Browser]]
+
[[Category:Nokia Maps]][[Category:Code Snippet]][[Category:JavaScript]]
Ovi Maps API - How to add an HTML infoBubble on the map
+
{{Abstract|This article explains how to add an info bubble on the map. The info bubble can contain any HTML content.}}
 +
 
 +
{{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= Internet Explorer, Google Chrome, Firefox, Opera
 +
|sdk= <!-- SDK(s) built and tested against (e.g. [http://linktosdkdownload/ Nokia Qt SDK 1.1]) -->
 +
|platform= Web browser
 +
|devicecompatability= <!-- Compatible devices e.g.: All* (must have internal GPS) -->
 +
|dependencies=Nokia Maps 2.2.3
 +
|signing=<!-- Signing requirements - empty or one of: Self-Signed, DevCert, Manufacturer -->
 +
|capabilities= <!-- Capabilities required by the article/code example (e.g. Location, NetworkServices. -->
 +
|keywords= <!-- APIs, classes and methods (e.g. QSystemScreenSaver, QList, CBase -->
 +
|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:avnee.nathani]]
 +
|update-timestamp=20111231
 +
|creationdate=20110621
 +
|author=[[User:Maveric]]
 +
}}
 +
{{SeeAlso|
 +
* [http://developer.here.net/javascript_api Nokia Maps API]
 +
* [http://developer.here.net/apiexplorer/examples/api-for-js/information-bubbles/infomation-bubble.html Adding an Infobubble to the Map]
 +
* [http://developer.here.net/apiexplorer/examples/api-for-js/information-bubbles/marker-with-information-bubble.html Adding an Infobubble to a Marker]
 +
}}
  
 
==Introduction==
 
==Introduction==
  
An infoBubble must have a ovi.mapsapi.geo.Coordinate and content which can be either provided as a string  
+
An infoBubble must have a {{Icode|nokia.maps.geo.Coordinate}} and content which can be either provided as a string or as a {{Icode|nokia.maps.search.Location}} object.
or as a ovi.mapsapi.search.Location object.
+
  
 
API defines:
 
API defines:
 
<code java>
 
<code java>
Extends ovi.mapsapi.map.component.Component.
+
Extends nokia.maps.map.component.Component.
new ovi.mapsapi.map.component.InfoBubbles ()
+
new nokia.maps.map.component.InfoBubbles ()
 
Options Interface defining the info bubbles' options (keys)
 
Options Interface defining the info bubbles' options (keys)
 
</code>
 
</code>
Line 17: Line 45:
 
==Prerequisites==
 
==Prerequisites==
  
Ovi 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==
  
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"
+
==Adding an Infobubble directly onto the Map==
  
==Implementation==
+
In this example we will create one infoBubble with video content from YouTube. Location is mumbai, where a info bubble would be shown with out youtube video. Remember to add in your own [[How to Obtain Your Own Nokia appID and Token| AppId and Token]].
  
In this example we will create one infoBubble with video content from YouTube. Location is Bermuda Triangle near Bahamas and the video will show a plane
+
<code javascript>
flying on that area.
+
<!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>HTML Info Bubble</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>
  
==Example code==
+
        <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");
  
<code java>
+
//
<html>
+
/////////////////////////////////////////////////////////////////////////////////////
<head>
+
    <script src="http://api.maps.ovi.com/jsl.js" type="text/javascript" charset="utf-8">
+
    </script>
+
      <link rel="stylesheet" href="style.css" />
+
</head>
+
<body style = "width:100%; height:100%;">
+
<div id="map" style="width:100%; height:100%;"></div>
+
</body>
+
<script type="text/javascript">
+
  
var myInfoBubbles = new ovi.mapsapi.map.component.InfoBubbles();
+
var myInfoBubbles = new nokia.maps.map.component.InfoBubbles();
 
+
var map = new nokia.maps.map.Display(document.getElementById("mapContainer"),  // new instance of Nokia Maps
var myHTMLcontent = "<div class=\"myHtmlContent\">"+"<iframe width='425' height='349' src='http://www.youtube.com/embed/9hVAFzo30qE' frameborder='0' allowfullscreen></iframe>"+"</div>";
+
 
+
var map = new ovi.mapsapi.map.Display(document.getElementById("map"),  // new instance of Ovi Maps
+
 
{
 
{
 
+
     components: [  
+
     components: [ new nokia.maps.map.component.Behavior(),
        myInfoBubbles,
+
                 new nokia.maps.map.component.ZoomBar(),
        new ovi.mapsapi.map.component.Behavior(),
+
                 new nokia.maps.map.component.Overview(),                             
                 new ovi.mapsapi.map.component.ZoomBar(),
+
                 new nokia.maps.map.component.TypeSelector(),     
                 new ovi.mapsapi.map.component.Overview(),                             
+
                 new nokia.maps.map.component.ScaleBar(),
                 new ovi.mapsapi.map.component.TypeSelector(),     
+
                 myInfoBubbles],
                 new ovi.mapsapi.map.component.ScaleBar()
+
               
                 ],
+
     'zoomLevel': 10,  
     'zoomLevel': 6,  
+
     'center':[19.119, 72.8957]
     'center':[25, -71]
+
 
});
 
});
 +
 +
var myHTMLcontent = "<div class=\"myHtmlContent\">"+"<iframe width='425' height='349' src='http://www.youtube.com/embed/Nr41eRzUnrg' frameborder='0' allowfullscreen></iframe>"+"</div>";
 +
map.set("baseMapType", map.SATELLITE);
 +
myInfoBubbles.addBubble(myHTMLcontent, new nokia.maps.geo.Coordinate(19.119, 72.8957)) ;
 +
 +
</script>
 +
</body>
 +
</html></code>
  
map.set("baseMapType", map.SATELLITE);
+
===Screenshot===
 +
[[File:NokiaMapsInfoPopup.png|600px]]
  
myInfoBubbles.addBubble(myHTMLcontent, new ovi.mapsapi.geo.Coordinate(25, -71));
+
== Adding an InfoBubble  to a map marker ==
 +
Assuming we already have a map, the first thing to do is to create an info bubble and add it as a map component.
 +
<code javascript>
 +
var infoBubbles = new nokia.maps.map.component.InfoBubbles();
 +
map.addComponent( infoBubbles);
 +
</code>
  
</script>
+
The function described below, will add an {{Icode|onclick}} event to a marker and display the associated HTML content.
</body>
+
<code javascript>
</html>
+
function addInfoBubble(infoBubbles, marker, html) {
 +
      marker.html = html;
 +
    marker.addListener("click" ,  function(evt) {
 +
                                    infoBubbles.addBubble(evt.target.html, evt.target.coordinate); 
 +
                                        }, false);
 +
}
 
</code>
 
</code>
  
==For more on Ovi Maps API==
+
Finally the markers themselves must be added. Clicking on the marker brings up the embedded HTML.
 
+
<code javascript>
Please check out the Ovi Maps API full documentation and API reference here:
+
var marker;
 +
var markers = new Array();
 +
marker = new nokia.maps.map.StandardMarker(new nokia.maps.geo.Coordinate(53.4393381986981,-2.2211828827858));
 +
addInfoBubble( infoBubbles, marker, "<div><a href='http://www.mcfc.co.uk' >Manchester City</a></div><div >City of Manchester Stadium<br>Capacity: 48,000</div>");
 +
markers.push(marker);
 +
marker = new nokia.maps.map.StandardMarker(new nokia.maps.geo.Coordinate(53.4308166986509,-2.96082615852356));
 +
addInfoBubble( infoBubbles, marker, "<div ><a href='http://www.liverpoolfc.tv' >Liverpool</a></div><div >Anfield<br>Capacity: 45,362</div>");
 +
markers.push(marker);
 +
map.objects.addAll(markers);
 +
</code>
  
http://api.maps.ovi.com
+
===Screenshot===
 +
[[File:MarkersWithInfoBubble.png]]
  
==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.0b
+
You may also access the interactive API explorer
 +
* [http://developer.here.net/javascript_api_explorer API explorer]

Revision as of 14:20, 4 January 2013

This article explains how to add an info bubble on the map. The info bubble can contain any HTML content.

Article Metadata
Tested with
Devices(s): Internet Explorer, Google Chrome, Firefox, Opera
Compatibility
Platform(s): Web browser
Dependencies: Nokia Maps 2.2.3
Article
Created: Maveric (21 Jun 2011)
Updated: avnee.nathani (31 Dec 2011)
Last edited: jasfox (04 Jan 2013)

Contents

Introduction

An infoBubble must have a nokia.maps.geo.Coordinate and content which can be either provided as a string or as a nokia.maps.search.Location object.

API defines:

Extends nokia.maps.map.component.Component.
new nokia.maps.map.component.InfoBubbles ()
Options Interface defining the info bubbles' options (keys)


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

Adding an Infobubble directly onto the Map

In this example we will create one infoBubble with video content from YouTube. Location is mumbai, where a info bubble would be shown with out youtube video. 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>HTML Info Bubble</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>
<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 myInfoBubbles = new nokia.maps.map.component.InfoBubbles();
var map = new nokia.maps.map.Display(document.getElementById("mapContainer"), // new instance of Nokia Maps
{
 
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(),
myInfoBubbles],
 
'zoomLevel': 10,
'center':[19.119, 72.8957]
});
 
var myHTMLcontent = "<div class=\"myHtmlContent\">"+"<iframe width='425' height='349' src='http://www.youtube.com/embed/Nr41eRzUnrg' frameborder='0' allowfullscreen></iframe>"+"</div>";
map.set("baseMapType", map.SATELLITE);
myInfoBubbles.addBubble(myHTMLcontent, new nokia.maps.geo.Coordinate(19.119, 72.8957)) ;
 
</script>
</body>
</html>

Screenshot

NokiaMapsInfoPopup.png

Adding an InfoBubble to a map marker

Assuming we already have a map, the first thing to do is to create an info bubble and add it as a map component.

var infoBubbles = new nokia.maps.map.component.InfoBubbles();
map.addComponent( infoBubbles);

The function described below, will add an onclick event to a marker and display the associated HTML content.

function addInfoBubble(infoBubbles, marker, html) {
marker.html = html;
marker.addListener("click" , function(evt) {
infoBubbles.addBubble(evt.target.html, evt.target.coordinate);
}, false);
}

Finally the markers themselves must be added. Clicking on the marker brings up the embedded HTML.

var marker;
var markers = new Array();
marker = new nokia.maps.map.StandardMarker(new nokia.maps.geo.Coordinate(53.4393381986981,-2.2211828827858));
addInfoBubble( infoBubbles, marker, "<div><a href='http://www.mcfc.co.uk' >Manchester City</a></div><div >City of Manchester Stadium<br>Capacity: 48,000</div>");
markers.push(marker);
marker = new nokia.maps.map.StandardMarker(new nokia.maps.geo.Coordinate(53.4308166986509,-2.96082615852356));
addInfoBubble( infoBubbles, marker, "<div ><a href='http://www.liverpoolfc.tv' >Liverpool</a></div><div >Anfield<br>Capacity: 45,362</div>");
markers.push(marker);
map.objects.addAll(markers);

Screenshot

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

620 page views in the last 30 days.
×