Natty Linden: Updated for version 2 of API #2

2016-12-14T01:51:46Z

Updated for version 2 of API #2

← Older revision		Revision as of 18:51, 13 December 2016
Line 20:		Line 20:
	\| [[Image:Yellow marker.gif]]		\| [[Image:Yellow marker.gif]]
	\| b_map_yellow.gif		\| b_map_yellow.gif
	\| ~~<br>~~http://~~slurl~~.com/examples/b_map_yellow.gif		\| http://maps.secondlife.com/examples/b_map_yellow.gif

	\|-		\|-
	\| [[Image:Fountain.gif]]		\| [[Image:Fountain.gif]]
	\| fountain.gif		\| fountain.gif
	\| http://~~slurl~~.com/examples/fountain.gif		\| http://maps.secondlife.com/examples/fountain.gif
	\|}		\|}

Line 212:		Line 212:

	<source lang="javascript">		<source lang="javascript">
	// creates a ~~window~~		// creates a popup
	L.popup()		L.popup()
	.setLatLng([1002, 997])		.setLatLng([1002, 997])
Line 256:		Line 256:
	lmap.setView([1001.5, 997.5], 7);		lmap.setView([1001.5, 997.5], 7);

	// creates a ~~window~~		// creates a popup
	L.popup()		L.popup()
	.setLatLng([1002, 997])		.setLatLng([1002, 997])
Line 264:		Line 264:
	</script>		</script>

	<title>Map API Examples - Map with an initial open ~~window~~</title>		<title>Map API Examples - Map with an initial open popup</title>

	</head><body onload="loadmap()">		</head><body onload="loadmap()">

	<h1>Map with an initial open ~~window~~ </h1>		<h1>Map with an initial open popup </h1>
	<p><a href="javascript:gotoSLURL(997, 1002, lmap)"> Go to (997, 1002)</a> where the welcome fountain is.</p>		<p><a href="javascript:gotoSLURL(997, 1002, lmap)"> Go to (997, 1002)</a> where the welcome fountain is.</p>

Line 326:		Line 326:
	});		});

	// creates a ~~window~~		// creates a popup
	var popup = L.popup().setContent("<p>This is where the welcome area fountain is!!</p><img src='fountain.gif'>");		var popup = L.popup().setContent("<p>This is where the welcome area fountain is!!</p><img src='fountain.gif'>");

Natty Linden: Updated for version 2 of API

2016-12-14T01:49:52Z

Updated for version 2 of API

Show changes

Rand Linden at 21:27, 4 May 2011

2011-05-04T21:27:57Z

← Older revision		Revision as of 14:27, 4 May 2011
Line 1:		Line 1:
	{{Supported API}}		{{Supported API}}
	{{:API Portal/navigation}}		{{:API Portal/navigation\|map}}
	__TOC__		__TOC__

Rand Linden: moved Map API Basic Examples to Linden Lab Official:Map API Basic Examples

2011-05-04T20:44:23Z

moved Map API Basic Examples to Linden Lab Official:Map API Basic Examples

← Older revision	Revision as of 13:44, 4 May 2011
(No difference)

Rand Linden at 17:58, 4 May 2011

2011-05-04T17:58:23Z

← Older revision		Revision as of 10:58, 4 May 2011
Line 1:		Line 1:
			{{Supported API}}
	{{:API Portal/navigation}}		{{:API Portal/navigation}}
	__TOC__		__TOC__

Rand Linden: Created page with '{{:API Portal/navigation}} TOC See [http://slurl.com/examples/ Second Life Map API Examples] to see these examples in action.
== Required image files == Som...'

2010-10-26T17:19:30Z

Created page with '{{:API Portal/navigation}} __TOC__ See [http://slurl.com/examples/ Second Life Map API Examples] to see these examples in action. <br clear=all/> == Required image files == Som...'

New page

{{:API Portal/navigation}}
__TOC__

See [http://slurl.com/examples/ Second Life Map API Examples] to see these examples in action.
<br clear=all/>
== Required image files ==

Some of the following examples use image files for markers. To run the examples with the code as shown, download the image files and save them in the same directory as the example HTML files. Alternatively, create the Img objects using the URLs listed in the table below that refer to the images stored on this wiki.

The following table lists the images used in the examples:

{| {{Prettytable}}
|-{{Hl2}}
! Image
! File name
! URL

|-
| [[Image:Yellow marker.gif]]
| b_map_yellow.gif
| <br>http://slurl.com/examples/b_map_yellow.gif

|-
| [[Image:Fountain.gif]]
| fountain.gif
| http://slurl.com/examples/fountain.gif

|-
| [[Image:Forsale.png]]
| forsale.png
| http://slurl.com/examples/forsale.png

|-
|[[Image:Forsale-shadow.png]]
| forsale-shadow.png
|http://slurl.com/examples/forsale-shadow.png
|}

== Simple map ==

The first example is a map with basic panning and zooming capabilities. When you are done, it will look as shown here.

[[Image:MapAPI ex1.png|thumb|right|Simple map]]

You can pan the map and zoom in and out.

To create this example, follow these steps:

# Add common HTML header code.
# Add HTML body element.
# Add '''loadmap()''' function.
# Save and test.

<br clear="all"/>

'''1. Add common HTML header'''

First, include the [[Webmap_API#Common_HTML_header|common header code]], required by all Webmap applications.

<pre><nowiki>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<script src="http://slurl.com/_scripts/slmapapi.js" type="text/javascript"></script>
<script src="http://maps.google.com/maps?file=api&v=2&key={GOOGLE MAPS KEY}" type="text/javascript"></script>

<link rel="stylesheet" type="text/css" href="http://slurl.com/_styles/MAIN.css" />
<style>
div#map-container {
width: 500px;
height: 500px;
}
</style>
...
</head>
</nowiki></pre>

Be sure to replace {GOOGLE MAPS KEY} with your Google Map key.

'''2. Add HTML body element'''

Next, add the HTML body element to contain your map. The body contains a Javascript onload event handler that calls the '''loadmap()''' function you will define in the next step.

<pre>
<body onload="loadmap()" onunload="GUnload()">
<div id="map-container"></div>
</body>
</pre>

The div element is passed to the SLMap object constructor, using the <code>document.getElementById('map-container')</code> DOM method call.

NOTE: If you want the position attribute of the div element to be absolute, either set it programmatically using Javascript or using the style attribute tag. Setting the position attribute of this element in the CSS stylesheet will not work.

'''3. Add loadmap() function'''

The body element you just added has a Javascript event handler for the "onload" event, called when the browser initially loads the page. You deifined this to call a '''loadmap()''' function. Now, define that Javascript function in the head of your page (after the code that is already there), as follows:

<script>
function loadmap() {
mapInstance = new SLMap(document.getElementById('map-container'));
mapInstance.centerAndZoomAtSLCoord(new XYPoint(997, 1002), 3);
}
</script>

The first line defines a new Map object from the HTML div element. The second line centers the map at a specific point, and zooms it to zoom level three.

'''4. Save and test'''

When you are done, save the file, and then load it into your web browser. Try panning the map by clicking and dragging the mouse cursor; you can also pan by clicking on the arrow icons on the four sides. Also try zooming the view in and out by clicking the "+" and "-" icons.

'''Complete source code'''

<pre>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<script src="http://maps.google.com/maps?file=api&v=2&key=[GOOGLE MAPS KEY]" type="text/javascript"></script>
<script src="http://slurl.com/_scripts/slmapapi.js" type="text/javascript"></script>

<link rel="stylesheet" type="text/css" href="http://slurl.com/_styles/MAIN.css" />
<style>
div#map-container {
width: 500px;
height: 500px;
}
</style>

<script>
function loadmap() {
mapInstance = new SLMap(document.getElementById('map-container'));
mapInstance.centerAndZoomAtSLCoord(new XYPoint(997, 1002), 2);
}
</script>

</head>
<body onload="loadmap()" onunload="GUnload()">
<div id="map-container"></div>
</body>
</pre>

==Map with a marker ==

[[Image:Map with Marker.png|thumb|right|Map with a marker]]

A ''marker'' is simply an image displayed at a specific location on the map. The Map API enables you to define an image for each zoom level, so the marker can appear differently at each zoom level if you wish.

This example shows how to make a map with a marker. The code is the same as the first example, with with addition of some Javascript after the initialization of the map in the page's onload event handler function, '''loadmap()'''.

To use the code below verbatim, you must download the marker image as described in [[#Required_image_files|Required image files]]; you can also use the URL of the wiki image if you prefer.

The code first creates the icon for the marker, then places it on the map at (997, 1002) at the welcome area fountain. Because the same icon is specified for every zoom level, it appears the same size regardless of zoom level.

<br clear="all"/>
<pre>
// Create the icons
var yellow_dot_image = new Img("b_map_yellow.gif", 9, 9);
var yellow_icon = new Icon(yellow_dot_image);
var all_images = [yellow_icon, yellow_icon, yellow_icon, yellow_icon, yellow_icon, yellow_icon];

// Create the marker
var marker = new Marker(all_images, new XYPoint(997, 1002));
mapInstance.addMarker(marker);
</pre>

In this example, clicking on the marker does nothing. Subsequent examples illustrate adding some onClick behavior.

'''Source code'''

Replace the first line comment below with the [[Webmap_API#Common_HTML_header|common header code]].

<pre>

<script>
function loadmap() {
// creates the map
var mapInstance = new SLMap(document.getElementById('map-container'));
mapInstance.centerAndZoomAtSLCoord(new XYPoint(997, 1002), 2);

// creates the icons
var yellow_dot_image = new Img("b_map_yellow.gif", 9, 9);
var yellow_icon = new Icon(yellow_dot_image);
var all_images = [yellow_icon, yellow_icon, yellow_icon, yellow_icon, yellow_icon, yellow_icon];

// creates the marker
var marker = new Marker(all_images, new XYPoint(997, 1002));
mapInstance.addMarker(marker);
}
</script>
</head>
<body onload="loadmap()" onunload="GUnload()">
<p>There should be a yellow marker in the center of this map:
<div id="map-container"></div>
</body>
</pre>

==Map with an initial open window ==

[[Image:Map_with_window.png|thumb|right|Map with a window]]

A Webmap ''window'' is a caption pointing to a specific point on the map, as shown in the screenshot at right. It looks something like a comic book dialog bubble.

Use the [[Webmap_API_Reference#MapWindow|MapWindow]] object to create a window.
For example, to create a window that opens initially when the page loads:
# Instantiate a [[Webmap_API_Reference#MapWindow|MapWindow]] object with the desired caption.
# Call the '''addMapWindow()''' method on the [[Webmap_API_Reference#SLMap|SLMap]] object to add the window to the map.
<br clear="all"/>
For example:

<pre>
// creates a window
var mapWindow = new MapWindow("This is where the welcome area fountain is!!");
mapInstance.addMapWindow(mapWindow, new XYPoint(997, 1002));
</pre>

The code adds an open window to the map positioned again at (997, 1002), right above the welcome area fountain.

NOTE: after the user closes the window there is no way to bring it back. A subsequent example will show how to enable the user to reopen the window, by using markers with windows.
<br clear="all"/>

To make the map initially centered on the fountain, change the call to '''centerAndZoomAtSLCoord()''' as follows:

mapInstance.centerAndZoomAtSLCoord(new XYPoint(997, 1002), 3);

'''Source code'''

This example shows how to create a map with a window. The code is the same as the first example, with the addition of some lines of Javascript after the initialization of the map, in the '''loadmap()''' function. In addition, the map is centered in a different location in order to make the window fully visible.

Replace the first line comment below with the [[Webmap_API#Common_HTML_header|common header code]].

<pre>

<script>
function loadmap() {
mapInstance = new SLMap(document.getElementById('map-container'));
mapInstance.centerAndZoomAtSLCoord(new XYPoint(997, 1002), 3);

// Create window
var mapWindow = new MapWindow("This is where the welcome area fountain is!!");
mapInstance.addMapWindow(mapWindow, new XYPoint(997, 1002));
}
</script>
</head>
<body onload="loadmap()" onunload="GUnload()">
<h1>Simple Map Example</h1>
<div id="map-container"></div>
</body>
</pre>

==Map with a marker that opens a window ==

[[Image:Map with marker and window.png|thumb|right|Map with marker that opens a window]]

This example shows how to create a map with a marker which opens a window when clicked. It is a combination of the previous two examples, because the code first creates a marker and a window.

The difference comes in adding the marker to the map: this time you provide the window object as well as the marker object in the call to '''addMarker()''':

mapInstance.addMarker(marker, mapWindow);

Doing this adds the marker and causes it to open the specified window when the user clicks it. If the user subsequently closes the window, s/he can open it again by clicking on the marker.

<br clear="all" />
'''Source code'''

Replace the first line comment below with the [[Webmap_API#Common_HTML_header|common header code]].

<pre>

<script>
function loadmap() {
// Create the map
var mapInstance = new SLMap(document.getElementById('map-container'));
mapInstance.centerAndZoomAtSLCoord(new XYPoint(997.5, 1001.5), 2);

// Create the icons
var yellow_dot_image = new Img("b_map_yellow.gif", 9, 9);
var yellow_icon = new Icon(yellow_dot_image);
var all_images = [yellow_icon, yellow_icon, yellow_icon, yellow_icon, yellow_icon, yellow_icon];

// Create the marker
var marker = new Marker(all_images, new XYPoint(997, 1002));

// Create a window
var mapWindow = new MapWindow("This is where the welcome area fountain is!! <br><img src='fountain.gif'>");

// Adds the marker to the map
mapInstance.addMarker(marker, mapWindow);
}
</script>
</head>
<body onload="loadmap()" onunload="GUnload()">
<p>This map shows a yellow marker on the welcome fountain. When you click the marker,
a window appears with a screenshot of the fountain.</p>
<div id="map-container"></div>
</body>
</pre>