Class Mapstraction

Object
   |
   +--Mapstraction

class Mapstraction

Defined in mapstraction.js

Field Detail

addControlsArgs

Object addControlsArgs

api

Object api

currentElement

Object currentElement

debug

Object debug

eventListeners

Object eventListeners

images

Object images

layers

Object layers

loaded

Object loaded

maps

Object maps

markers

Object markers

onload

Object onload

polylines

Object polylines

svn_revision_string

Object svn_revision_string

HYBRID

<static> Object HYBRID

ROAD

<static> Object ROAD

SATELLITE

<static> Object SATELLITE

Mapstraction

Mapstraction(<String> element,<String> api,<Bool> debug)

Mapstraction instantiates a map with some API choice into the HTML element given

Parameters:
element - The HTML element to replace with a map
api - The API to use, one of 'google', 'yahoo', 'microsoft', 'openstreetmap', 'multimap', 'map24', 'openlayers', 'mapquest'
debug - optional parameter to turn on debug support - this uses alert panels for unsupported actions

addAPI

void addAPI(<Object> element,<String> api)

Parameters:
element -
api -

addControls

void addControls( <array> args )

addControls adds controls to the map. You specify which controls to add in the associative array that is the only argument. addControls can be called multiple time, with different args, to dynamically change controls. args = { pan: true, zoom: 'large' || 'small', overview: true, scale: true, map_type: true, }

Parameters:
args - Which controls to switch on

addEventListener

void addEventListener()

Add a listener for an event.

Parameters:
type - Event type to attach listener to
func - Callback function
caller - Callback object

addFilter

void addFilter(field, operator, value)

addFilter adds a marker filter

Parameters:
name - of attribute to filter on
presently - only "ge" or "le"
the - value to compare against

addImageOverlay

void addImageOverlay(id, src, <opacity> opacity, <west> west, <south> south, <east> east, <north> north)

addImageOverlay layers an georeferenced image over the map

Parameters:
opacity - 0-100
west - boundary
south - boundary
east - boundary
north - boundary
unique - DOM identifier
url - of image

addJSON

Object addJSON(json)

addLargeControls

void addLargeControls()

addLargeControls adds a large map panning control and zoom buttons to the map Supported by: yahoo, google, openstreetmap, multimap, mapquest, openspace

addMapListener

Object addMapListener(<String> event, <Function> callback)

Ties a callback function to a map event Currently only implemented for google maps

Parameters:
event -
callback -

Returns:
handler

addMapTypeControls

void addMapTypeControls()

addMapTypeControls adds a map type control to the map (streets, aerial imagery etc) Supported by: yahoo, google, openstreetmap, multimap, mapquest

addMarker

void addMarker(<Marker> marker, <Boolean> old)

Adds a marker pin to the map

Parameters:
marker - The marker to add
old - If true, doesn't add this marker to the markers array. Used by the "swap" method

addMarkerWithData

void addMarkerWithData(<Marker> marker, <Object> data)

addMarkerWithData will addData to the marker, then add it to the map

Parameters:
marker - The marker to add
data - A data has to add

addOverlay

void addOverlay(url, autoCenterAndZoom)

addOverlay adds a GeoRSS or KML overlay to the map some flavors of GeoRSS and KML are not supported by some of the Map providers

Parameters:
GeoRSS - or KML feed URL
set - true to auto center and zoom after the feed is loaded

addPolygon

void addPolygon(<object> polygon)

Add a polygon to the map, based on addPolyline and accepts a polyline as the template Currently only implemented in Google

Parameters:
polygon -

addPolyline

void addPolyline(<Polyline> polyline, <Boolean> old)

Add a polyline to the map

Parameters:
polyline - The Polyline to add to the map
old - If true replaces an existing Polyline

addPolylineWithData

void addPolylineWithData(<Polyline> polyline, <Object> data)

addPolylineWithData will addData to the polyline, then add it to the map

Parameters:
polyline - The polyline to add
data - A data has to add

addSmallControls

void addSmallControls()

addSmallControls adds a small map panning control and zoom buttons to the map Supported by: yahoo, google, openstreetmap, openlayers, multimap, mapquest, openspace

addTileLayer

Object addTileLayer(tile_url, <opacity> opacity, copyright_text, min_zoom, max_zoom)

Adds a Tile Layer to the map Requires providing a parameterized tile url. Use {Z}, {X}, and {Y} to specify where the parameters should go in the URL. For example, the OpenStreetMap tiles are: http://tile.openstreetmap.org/{Z}/{X}/{Y}.png

Parameters:
opacity - of the tile layer - 0 is transparent, 1 is opaque. (default=0.6)
template - url of the tiles.
copyright - text to use for the tile layer. (default=Mapstraction)
Minimum - (furtherest out) zoom level that tiles are available (default=1)
Maximum - (closest) zoom level that the tiles are available (default=18)

applyFilter

Object applyFilter(o, f)

autoCenterAndZoom

void autoCenterAndZoom()

autoCenterAndZoom sets the center and zoom of the map to the smallest bounding box containing all markers

callEventListeners

void callEventListeners(<String> sEventType, <Object> oEventArgs)

Call listeners for a particular event.

Parameters:
sEventType - Call listeners of this event type
oEventArgs - Event args object to pass back to the callback

centerAndZoomOnPoints

void centerAndZoomOnPoints(points)

centerAndZoomOnPoints sets the center and zoom of the map from an array of points This is useful if you don't want to have to add markers to the map

clickHandler

void clickHandler(lat, lon, me)

declutterMarkers

void declutterMarkers(<Object> opts)

Declutter the markers on the map, group together overlapping markers.

Parameters:
opts - Declutter options

doFilter

Int doFilter(<Function> showCallback, <Function> hideCallback)

doFilter executes all filters added since last call Now supports a callback function for when a marker is shown or hidden

Parameters:
showCallback -
hideCallback -

Returns:
count of visible markers

dragging

void dragging(<Boolean> on)

Enable/disable dragging of the map Supported by: yahoo, google, openstreetmap, multimap, openspace

Parameters:
on -

enableScrollWheelZoom

void enableScrollWheelZoom()

Enable scroll wheel zooming Currently only supported by Google

getAttributeExtremes

array getAttributeExtremes(field)

getAttributeExtremes returns the minimum/maximum of "field" from all markers

Parameters:
name - of "field" to query

Returns:
of minimum/maximum

getBounds

BoundingBox getBounds()

getBounds gets the BoundingBox of the map

Returns:
the bounding box for the current map state

getCenter

{LatLonPoint} The center point of the map getCenter()

getCenter gets the central point of the map

getMap

Object getMap()

getMap returns the native map object that mapstraction is talking to

Returns:
the native map object mapstraction is using

getMapType

Object getMapType()

getMapType gets the imagery type for the map. The type can be one of: Mapstraction.ROAD Mapstraction.SATELLITE Mapstraction.HYBRID

getPixelRatio

Float getPixelRatio()

Returns a ratio to turn distance into pixels based on current projection

Returns:
ratio

getZoom

{Integer} The zoom level of the map getZoom()

getZoom returns the zoom level of the map

getZoomLevelForBoundingBox

{Integer} The closest zoom level that contains the bounding box getZoomLevelForBoundingBox( bbox )

getZoomLevelForBoundingBox returns the best zoom level for bounds given

Parameters:
boundingBox - the bounds to fit

isLoaded

{Boolean} The state of the map loading isLoaded(<String> api)

Returns the loaded state of a Map Provider

Parameters:
api - Optional API to query for. If not specified, returns state of the originally created API

mousePosition

void mousePosition(element)

moveendHandler

void moveendHandler(me)

polylineCenterAndZoom

void polylineCenterAndZoom(<Int> radius)

Automatically sets center and zoom level to show all polylines Takes into account radious of polyline

Parameters:
radius -

removeAllFilters

void removeAllFilters()

removeAllFilters

removeAllMarkers

void removeAllMarkers()

removeAllMarkers removes all the Markers on a map

removeAllPolylines

void removeAllPolylines()

Removes all polylines from the map

removeFilter

void removeFilter(<Object> field, <Object> operator, <Object> value)

Remove the specified filter

Parameters:
field -
operator -
value -

removeMapListener

void removeMapListener(<Object> handler)

Removes an event handler from the map Currently only implemented for google maps

Parameters:
handler -

removeMarker

void removeMarker(<Marker> marker)

removeMarker removes a Marker from the map

Parameters:
marker - The marker to remove

removePolyline

void removePolyline(<Polyline> polyline)

Remove the polyline from the map

Parameters:
polyline - The Polyline to remove from the map

resizeTo

void resizeTo(<Integer> width,<Integer> height)

Resize the current map to the specified width and height (since it is actually on a child div of the mapElement passed as argument to the Mapstraction constructor, the resizing of this mapElement may have no effect on the size of the actual map)

Parameters:
width - The width the map should be.
height - The width the map should be.

setBounds

void setBounds(bounds)

setBounds sets the map to the appropriate location and zoom for a given BoundingBox

Parameters:
the - bounding box you want the map to show

setCenter

void setCenter(<LatLonPoint> point)

setCenter sets the central point of the map

Parameters:
point - The point at which to center the map

setCenterAndZoom

void setCenterAndZoom(<LatLonPoint> point, <Integer> zoom)

Centers the map to some place and zoom level

Parameters:
point - Where the center of the map should be
zoom - The zoom level where 0 is all the way out.

setDebug

{Boolean} The state of debugging setDebug(<Boolean> debug)

Set the debugging on or off - shows alert panels for functions that don't exist in Mapstraction

Parameters:
debug - true to turn on debugging, false to turn it off

setImageOpacity

void setImageOpacity(id, opacity)

setImagePosition

void setImagePosition(id)

setMapType

void setMapType(<int> type)

setMapType sets the imagery type for the map. The type can be one of: Mapstraction.ROAD Mapstraction.SATELLITE Mapstraction.HYBRID

Parameters:
type - The (native to the map) level zoom the map to.

setZoom

void setZoom(<int> zoom)

setZoom sets the zoom level for the map MS doesn't seem to do zoom=0, and Gg's sat goes closer than it's maps, and MS's sat goes closer than Y!'s TODO: Mapstraction.prototype.getZoomLevels or something.

Parameters:
zoom - The (native to the map) level zoom the map to.

swap

void swap(element,<String> api)

Change the current api on the fly

Parameters:
element -
api - The API to swap to

toggleFilter

void toggleFilter(<Object> field, <Object> operator, <Object> value)

Delete the current filter if present; otherwise add it

Parameters:
field -
operator -
value -

toggleTileLayer

void toggleTileLayer(tile_url)

Turns a Tile Layer on or off

Parameters:
url - of the tile layer that was created.

visibleCenterAndZoom

void visibleCenterAndZoom()

Sets the center and zoom of the map to the smallest bounding box containing all visible markers and polylines will only include markers and polylines with an attribute of "visible"

_getScriptLocation

<static> Object _getScriptLocation()

writeInclude

<static> void writeInclude(api, key, version)