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

From Second Life Wiki
Jump to navigation Jump to search
Line 21: Line 21:


|-
|-
|style="font: 10pt courier; padding: 0 10px 0 10px; white-space: pre; margin: 0"|  
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| enterAndZoomAtSLCoord(  
centerAndZoomAtSLCoord(  
XYPoint coordinate,  
  [[Main Page|XYPoint]] coordinate,  
int zoom)
  int zoom)  


|valign="top"| None
|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 (
Marker marker,
MapWindow mapWindow )
|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" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| removeMarker (Marker marker) 
|valign="top"| None
|valign="top"| Removes a marker.
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| removeAllMarkers () 
|valign="top"| None
|valign="top"| Removes all markers.
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| addMapWindow (MapWindow mapWindow, XYPoint coord)
|valign="top"| None
|valign="top"| Adds a MapWindow to the map at specified coordinate.
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| setCurrentZoomLevel (int zoom)
|valign="top"| None
|valign="top"| Sets the zoom level to specified zoom.
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| getCurrentZoomLevel ()
|valign="top"| None
|valign="top"|
Gets the current zoom level (1-6). See [http://secondlife.com/developers/mapapi/index.html#about_zoom about zoom levels].
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| zoomIn ()
|valign="top"| None
|valign="top"|
Zooms in on the map if the map is not already all the way zoomed in.
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| zoomOut ()
|valign="top"| None
|valign="top"|
Zooms out on the map if the map is not already all the way zoomed out.
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| panLeft ()
|valign="top"| None
|valign="top"|
Pans the map to the left by 1/2 its width.
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| panRight ()
|valign="top"| None
|valign="top"|
Pans the map to the right by 1/2 its width.
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| panUp ()
|valign="top"| None
|valign="top"|
Pans the map to the up by 1/2 its width.
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| panDown ()
|valign="top"| None
|valign="top"|
Pans the map to the down by half its width.
|-
|valign="top" style="font: 10pt courier; padding: 10px 10px 0 10px; margin:0;"| disableDragging ()
|valign="top"| None
|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;"| enableDragging ()
|valign="top"| None
|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;"|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;"| panOrRecenterToSLCoord (XYPoint coord, Boolean recenter = false)
|valign="top"| None
|valign="top"|
|valign="top"|
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 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"| None
|valign="top"|
|valign="top"|
Centers and zooms the map to the specified location.
Simulates a clicking a marker. Will recenter the pan if its not currently in the viewport of the map.  


|}
|}

Revision as of 14:44, 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
enterAndZoomAtSLCoord(

XYPoint coordinate, int zoom)

None Centers and zooms the map to the specified location.
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.
removeMarker (Marker marker) None Removes a marker.
removeAllMarkers () None Removes all markers.
addMapWindow (MapWindow mapWindow, XYPoint coord) None Adds a MapWindow to the map at specified coordinate.
setCurrentZoomLevel (int zoom) None Sets the zoom level to specified zoom.
getCurrentZoomLevel () None

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

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.

panLeft () None

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

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.

panDown () None

Pans the map to the down by half its width.

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.

getViewportBounds () Bounds

Gets the viewport bounds. See about coordinates.

panOrRecenterToSLCoord (XYPoint coord, Boolean recenter = false) 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 second argument specifies whether to center the given coordinate even it if is currently in the viewport.

getMapCenter () XYPoint Returns the current map center. See about coordinates.
clickMarker (Marker marker) None

Simulates a clicking a marker. Will recenter the pan if its not currently in the viewport of the map.

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