Linden Lab Official:Map API Reference
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. |