Class Mapstraction

Object
   |
   +--Mapstraction

class Mapstraction

Defined in mapstraction.js

Field Detail

addControlsArgs

Object addControlsArgs

api

Object api

currentElement

Object currentElement

eventListeners

Object eventListeners

maps

Object maps

markers

Object markers

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)

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'

addAPI

void addAPI(element,api)

addControls

void addControls( 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:
array - Which controls to switch on

addEventListener

void addEventListener(type, func)

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

addGeoRSSOverlay

void addGeoRSSOverlay(georssURL)

addGeoRSSOverlay adds a GeoRSS overlay to the map

Parameters:
GeoRSS - feed URL

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

addLargeControls

void addLargeControls()

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

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,<old> old)

addMarker 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

addPolyline

void addPolyline(polyline,old)

Add a polyline to the map

addSmallControls

void addSmallControls()

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

autoCenterAndZoom

void autoCenterAndZoom()

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

clickHandler

void clickHandler(lat,lon, me)

doFilter

void doFilter()

doFilter executes all filters added since last call

dragging

void dragging(<on> on)

dragging enable/disable dragging of the map (only implemented for yahoo and google) Supported by: yahoo, google, openstreetmap, multimap

Parameters:
on - Boolean

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 getCenter()

getCenter gets the central point of the map

Returns:
the center 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

getZoom

int getZoom()

getZoom returns the zoom level of the map

Returns:
the zoom level of the map

getZoomLevelForBoundingBox

int getZoomLevelForBoundingBox( bbox )

getZoomLevelForBoundingBox returns the best zoom level for bounds given

Parameters:
boundingBox - the bounds to fit

Returns:
the closest zoom level that contains the bounding box

moveendHandler

void moveendHandler(me)

removeAllMarkers

void removeAllMarkers()

removeAllMarkers removes all the Markers on a map

removeAllPolylines

void removeAllPolylines()

Removes all polylines from the map

removeMarker

void removeMarker(<Marker> marker)

removeMarker removes a Marker from the map

Parameters:
marker - The marker to remove

removePolyline

void removePolyline(polyline)

Remove the polyline from the map

resizeTo

void resizeTo(width,height)

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, <int> 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.

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.

showRoute

void showRoute(route)

Show a route from MapstractionRouter on a mapstraction map Currently only supported by MapQuest

swap

void swap(element,<String> api)

swap will change the current api on the fly

Parameters:
api - The API to swap to