Difference between revisions of "Linden Lab Official:Map API Reference"

From Second Life Wiki
Jump to navigation Jump to search
Line 19: Line 19:
! Return Value
! Return Value
! Description
! Description


|-
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| enterAndZoomAtSLCoord(  
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0; white-space: pre;"|addMapWindow (
XYPoint coordinate,  
MapWindow mapWindow,  
int zoom)
XYPoint coord)  
 
|valign="top"| None
|valign="top"| None
 
|valign="top"| Adds a MapWindow to the map at specified coordinate.  
|valign="top"| Centers and zooms the map to the specified location.


|-
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin: 0;"| addMarker (
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin: 0; white-space: pre;"|addMarker (
Marker marker,  
Marker marker,  
MapWindow mapWindow )
MapWindow mapWindow )
|valign="top"| None
|valign="top"| None
|valign="top"| Adds a marker. If the optional mapWindow argument is null, then clicking on the marker will not open a window.
|valign="top"| Adds a marker. If the optional mapWindow argument is null, then clicking on the marker will not open a window.


|-
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| removeMarker (Marker marker)
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0; white-space:pre;"|clickMarker (
Marker marker)  
|valign="top"| None
|valign="top"| None
|valign="top"| Removes a marker.
|valign="top"|
Simulates a clicking a marker. Will recenter the pan if its not currently in the viewport of the map.  


|-
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| removeAllMarkers ()
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"|disableDragging ()
|valign="top"| None
|valign="top"| None
|valign="top"| Removes all markers.
|valign="top"|
Disables all dragging on the map. Note: panning controls will still work.  


|-
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| addMapWindow (MapWindow mapWindow, XYPoint coord)  
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"|enableDragging ()
|valign="top"| None
|valign="top"| None
|valign="top"| Adds a MapWindow to the map at specified coordinate.  
|valign="top"|
Re-enables dragging on the map if it was disabled.  


|-
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| setCurrentZoomLevel (int zoom)  
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin: 0; white-space: pre;"|enterAndZoomAtSLCoord(  
XYPoint coordinate,
int zoom)
|valign="top"| None
|valign="top"| None
|valign="top"| Sets the zoom level to specified zoom.  
|valign="top"| Centers and zooms the map to the specified location.


|-
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| getCurrentZoomLevel ()
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"|getCurrentZoomLevel ()
|valign="top"| None
|valign="top"| None
|valign="top"|
|valign="top"|
Line 65: Line 68:


|-
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| zoomIn ()  
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"|getMapCenter ()
|valign="top"|XYPoint
|valign="top"|
Returns the current map center. See [http://secondlife.com/developers/mapapi/index.html#about_coords about coordinates].
 
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"|getViewportBounds ()
|valign="top"|Bounds
|valign="top"|
Gets the viewport bounds. See [http://secondlife.com/developers/mapapi/index.html#about_coords about coordinates].
 
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"|panDown ()  
|valign="top"| None
|valign="top"| None
|valign="top"|
|valign="top"|
Zooms in on the map if the map is not already all the way zoomed in.
Pans the map to the down by half its width.


|-
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| zoomOut ()
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"|panLeft ()
|valign="top"| None
|valign="top"| None
|valign="top"|
|valign="top"|
Zooms out on the map if the map is not already all the way zoomed out.  
Pans the map to the left by 1/2 its width.


|-
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| panLeft ()
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0; white-space: pre;"|panOrRecenterToSLCoord (
XYPoint coord,
Boolean recenter )  
|valign="top"| None
|valign="top"| None
|valign="top"|
|valign="top"|
Pans the map to the left by 1/2 its width.
Pans 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.  


|-
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| panRight ()
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"|panRight ()
|valign="top"| None
|valign="top"| None
|valign="top"|
|valign="top"|
Line 89: Line 108:


|-
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| panUp ()
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"|panUp ()
|valign="top"| None
|valign="top"| None
|valign="top"|
|valign="top"|
Line 95: Line 114:


|-
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| panDown ()  
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"|removeAllMarkers ()
|valign="top"| None
|valign="top"| None
|valign="top"|
|valign="top"|  
Pans the map to the down by half its width.
Removes all markers.


|-
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| disableDragging ()
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0; white-space: pre;"|removeMarker (
Marker marker)
|valign="top"| None
|valign="top"| None
|valign="top"|
|valign="top"| Removes a marker.
Disables all dragging on the map. Note: panning controls will still work.  


|-
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| enableDragging ()
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0; white-space: pre;"|setCurrentZoomLevel (
int zoom)  
|valign="top"| None
|valign="top"| None
|valign="top"|
|valign="top"| Sets the zoom level to specified zoom.  
Re-enables dragging on the map if it was disabled.  


|-
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"|getViewportBounds ()
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"|zoomIn ()  
|valign="top"|Bounds
|valign="top"|
Gets the viewport bounds. See [http://secondlife.com/developers/mapapi/index.html#about_coords about coordinates].
 
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| panOrRecenterToSLCoord (XYPoint coord, Boolean recenter = false)  
|valign="top"| None
|valign="top"| None
|valign="top"|
|valign="top"|
Pans 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.
Zooms in on the map if the map is not already all the way zoomed in.
 
The optional second argument specifies whether to center the given coordinate even it if is currently in the viewport.
 
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| getMapCenter ()
|valign="top"|XYPoint
|valign="top"| Returns the current map center. See [http://secondlife.com/developers/mapapi/index.html#about_coords about coordinates].


|-
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| clickMarker (Marker marker)  
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"|zoomOut ()
|valign="top"| None
|valign="top"| None
|valign="top"|
|valign="top"|
Simulates a clicking a marker. Will recenter the pan if its not currently in the viewport of the map.  
Zooms out on the map if the map is not already all the way zoomed out.  
 
|}
|}

Revision as of 15:19, 22 January 2009

SLMap

This class represents the map.

Constructor

Constructor

SLMap ( HTMLElement container, SLMapOptions options )

Creates the map. The SLMapOptions argument is optional.

Methods

Method Return Value Description


addMapWindow (

MapWindow mapWindow, XYPoint coord)

None Adds a MapWindow to the map at specified coordinate.
addMarker (

Marker marker, MapWindow mapWindow )

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

Marker marker)

None

Simulates a clicking a marker. Will recenter 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.

enterAndZoomAtSLCoord(

XYPoint coordinate, int zoom)

None Centers and zooms the map to the specified location.
getCurrentZoomLevel () None

Gets the current zoom level (1-6). See about zoom levels.

getMapCenter () XYPoint

Returns the current map center. See about coordinates.

getViewportBounds () Bounds

Gets the viewport bounds. See about coordinates.

panDown () None

Pans the map to the down by half its width.

panLeft () None

Pans the map to the left by 1/2 its width.

panOrRecenterToSLCoord (

XYPoint coord, Boolean recenter )

None

Pans 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

Pans the map to the right by 1/2 its width.

panUp () None

Pans the map to the up by 1/2 its width.

removeAllMarkers () None

Removes all markers.

removeMarker (

Marker marker)

None Removes a marker.
setCurrentZoomLevel (

int zoom)

None Sets the zoom level to specified zoom.
zoomIn () None

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

zoomOut () None

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

Retrieved from "https://wiki.secondlife.com/w/index.php?title=Linden_Lab_Official:Map_API_Reference&oldid=205633"