Linden Lab Official:Map API Reference

From Second Life Wiki
Revision as of 15:03, 27 January 2009 by Rand Linden (Talk | contribs)

Jump to: navigation, search
Ll color vert 100.gif
Official Linden Lab® Information: You may access and link to this page, but you may not copy, distribute, modify, adapt, or translate any content on this page. This content is subject to the Terms of Service and is not available under the Creative Commons or any other license.

Have a suggestion to improve this page? Contact us.
Update notice

We've made improvements and changes to the webmap, effective January 15, 2009.
Some information here may be out of date as we update this wiki with the changes. Thanks for your patience.


Global functions

Function Return Value Description

gotoSLURL( x Number, y Number, SLMap slMap)

None Launches the Second Life Viewer with the avatar's location directly to the specified inworld location.

slAddDynamicScript( String scriptURL, function onLoadHandler)

None TBD

Objects

Bounds

Represents the bounds for a 2D coordinate space. Typically, you don't construct one explicitly, but rather call the getViewportBounds() method on a SLMap instance.


Constructor

Bounds ( xMin Number, xMax Number, yMin Number, yMax Number)

Properties

Property Default Description
xMin Zero Minimum x coordinate of the bounding window. Must be a postive integer.
xMax Zero Maximum x coordinate of the bounding window. Must be a postive integer.
yMin Zero Minimum y coordinate of the bounding window. Must be a postive integer.
yMax Zero Maximum y coordinate of the bounding window. Must be a postive integer.

NOTE: The default values are applied if any of the properties is not specified in the constructor call.

Example

...
var mapInstance = new SLMap(document.getElementById('map-container'));
var bounds = mapInstance.getViewportBounds();  // This is a Bounds object
...

Icon

Represents an icon to used as a marker.

Constructor

Icon ( Img mainImage, Img shadowImage )

Creates a new icon to be used on the map. The optional second parameter specifies a shadow image. The shadowImage argument is optional and defaults to null.

Example

// create the icons
var forsale_sign = new Img("Forsale.png",80,83, true); // note how the fourth parameter is set true!
var forsale_shadow = new Img("Forsale-shadow.png",98,83, true);
var forsale_icon = new Icon(forsale_sign, forsale_shadow);
var all_images = [forsale_icon, forsale_icon, forsale_icon, forsale_icon, forsale_icon, forsale_icon];

// create the marker
var marker = new Marker(all_images, new XYPoint(995,1004));
mapInstance.addMarker(marker);

Img

Represents an image to be used as an icon.

Constructor

Img ( String imageSource, Number width, Number height, Boolean hasAlphaChannel )

The followint table describes the Img object's properites:

Property Default Description
imageSource None URL of image file. Can be a relative or absolute URL.
width None Width of image in pixels (a positive integer).
height None Height of image in pixels (a positive integer).
hasAlphaChannel false Boolean that indicates whether the image is a 24-bit PNG image with alpha channel transparency. Optional parameter.

Example

// create the icons
var forsale_sign = new Img("Forsale.png",80,83, true); // note how the fourth parameter is set true!
var forsale_shadow = new Img("Forsale-shadow.png",98,83, true);
var forsale_icon = new Icon(forsale_sign, forsale_shadow);
var all_images = [forsale_icon, forsale_icon, forsale_icon, forsale_icon, forsale_icon, forsale_icon];

// create the marker
var marker = new Marker(all_images, new XYPoint(995,1004));
mapInstance.addMarker(marker);

Methods

Method Return Value Description

isAlpha()

Boolean Returns true if the image has an alpha channel, false otherwise.

MapWindow

This class represents a window placed over the map.

Constructor

MapWindow ( String windowText, options )

Creates a new map window. The given text will be what is contained in the window. Note, HTML can be used but quotes must be escaped correctly otherwise javascript errors will occur.

The options argument is an object literal that specifies the window options, as described in the following table.

Property Default Description
alwaysOnTop false Whether window is always displayed on top of other windows.
noEffect false Whether window appears with fade-in and fade-out effect.
closeOnMove false Whether window is closed when user drags the map.
bringToTop false Whether window is brought to the top when user clicks other windows.
width 252 Width of the window in pixels.
height 236 Height of the window in pixels.
padding 10 Padding of the window in pixels.

Are all the window options implemented? From the source, it looks like only width is implemented. And I couldn't find an example.

Marker

Represents a marker to be added on the map.

Constructor

Marker ( Array icons, XYPoint coordinate, MarkerOptions markerOptions )

Creates a new marker to be placed on the map at given coordinate. The first parameter is an array of icons of length 6. Each icon in the array corresponds to a zoom level, icons[0] being the icon used at the close zoom (level 0).

The MarkerOptions argument is optional.

MarkerOptions

Object used to specify optional properties when creating a Marker object.

Properties

Property Default Description
autopanOnClick true If true, the map will automatically pan the map if part of the associated MapWindow would have been clipped by an edge of the map when it was opened.
autopanPadding 45 How close the window needs to be (in pixels) to an edge of the map to trigger autopanning.
centerOnClick false If true, centers the map on the marker when user clicks on it.
clickHandler null Event handler function called when user clicks on marker, that is, when onClick event. Optional.
horizontalAlign "center" Specifies how the marker is horizontally aligned. Valid values are:
  • "left"
  • "right"
  • "center"
onMouseOutHandler null Event handler function called when mouse pointer leaves marker, that is, when onmouseout event occurs. Optional.


onMouseOverHandler null Event handler function called when mouse pointer moves over marker, that is, when onmouseover event occurs. Optional.
verticalAlign "middle" Specifies how the marker is vertically aligned. Valid values are:
  • "top"
  • "bottom"
  • "middle"
zLayer 0 Specifies the layer the marker will render on. For example, if a marker having zLayer = 1 and another marker having zLayer = 0 overlap, the marker with zLayer = 1 will be on top.

The optional clickHandler, onMouseOverHandler, and onMouseOutHandler properties specify event handler functions called when the respective events occur.

Example

The following code sets the clickHandler, onMouseOverHandler, and onMouseOutHandler properties to assign an event handler function called when theuser clicks on the marker, moves the mouse pointer over the marker, and moves the mouse pointer off the marker, respectively:

var doMarkerAction = function(marker) {alert("an event occured at (" + marker.slCoord.x + "," + marker.slCoord.y + ")"); };

var marker = new Marker(all_images, 
                        new XYPoint(997,1002), 
                        {clickHandler: doMarkerAction, 
                         onMouseOutHandler:  doMarkerAction, 
                         onMouseOverHandler: doMarkerAction});

SLMap

This class represents the map.

Constructor

SLMap ( HTMLElement container, SLMapOptions options )

Creates the map. The options argument defaults to null.

By default the map has a clickhandler function that calls gotoSLURL(), passing the location of the click. By default, the map has a doubleclickhandler function that calls centerAndZoomAtSLCoord(), passing the location of the double click.

Methods

Method Return Value Description

addMapWindow( MapWindow mapWindow, XYPoint coord )

None Add a MapWindow to the map at specified coordinate.

addMarker( Marker marker, MapWindow mapWindow )

None Add a marker. If the optional mapWindow argument is null, then clicking on the marker will not open a window.

centerAndZoomAtSLCoord( XYPoint coordinate, Number zoom)

None Centers and zooms the map to the specified location. Argument zoom must be an integer value.

clickMarker( Marker marker)

None Simulates clicking a marker. Recenters the pan if its not currently in the viewport of the map.

disableDragging()

None Disables all dragging on the map. Note: panning controls will still work.

enableDragging()

None Re-enables dragging on the map if it was disabled.

getCurrentZoomLevel()

None Gets the current zoom level (1-6). For more information, see Zoom levels.

getMapCenter()

XYPoint Returns the current map center. For more information, see About coordinates.

getViewportBounds()

Bounds Gets the viewport bounds. For more information, see About coordinates.

panDown()

None Pan the map down by half its width.

panLeft()

None Pan the map left by half its width.

panOrRecenterToSLCoord( XYPoint coord, Boolean recenter )

None Pan the map to the given coordinate if it is currently in the viewport (in the user's view). Otherwise, recenters the map to the given coordinate. The optional recenter argument specifies whether to center the given coordinate even it if is currently in the viewport. Its default value is false.

panRight()

None Pan the map right by half its width.

panUp()

None Pan the map up by half its width.

removeAllMarkers()

None Remove all markers.

removeMarker( Marker marker)

None Remove a marker.

setCurrentZoomLevel( Number zoom)

None Set the zoom level to specified value. Argument zoom must be an integer.

zoomIn()

None Zoom in on the map if the map is not already all the way zoomed in.

zoomOut()

None Zoom out on the map if the map is not already all the way zoomed out.

SLMapOptions

This class represents optional arguments to the SLMap constructor. It has no constructor, but is instantiated as an object literal.

Properties

Property Default Description
hasZoomControls true Whether the map has zoom controls.
hasPanningControls true Whether the map has pan controls.
hasOverviewMapControl null TBD
doubleClickHandler

Is this implemented?

null Specifies event handler function called when user double-clicks on the map.
clickHandler

Is this implemented?

null Specifies event handler function called when user clicks once on the map.
onStateChangedHandler null Specifies an event handler function to call when map state changes, that is:
  • Map pans
  • Zoom level changes
zoomMin 6 Specifies an minimum level a map can be zoomed to. Maximum is seven (7).
zoomMax 1 Specifies an maximum level a map can be zoomed to. Minimum is one (1).

Example

Set the onStateChangedHandler property to define an event handler called whenever the "state" of the map changes (for example, when the map bounds change).

var doSomething = function(x,y) {
                                   alert("The map state changed.");
                                 };
mapInstance = new SLMap(document.getElementById('map-container'), 
                        {onStateChangedHandler: doSomething});

SLPoint

Not currently implemented.

XYPoint

Represents a point in 2D coordinate space.

Constructor

XYPoint ( Number x, Number y )

Creates an XYPoint object.

Properties

Property Default Description
x None X coordinate
y None Y coordinate