---

Classes

• _global_
• mxn
• mxn.BoundingBox
• mxn.Event
• mxn.Geocoder
• mxn.Invoker
• mxn.LatLonPoint
• mxn.Mapstraction
• mxn.Marker
• mxn.Polyline
• mxn.Radius
• mxn.util
• mxn.util.Color

---

Class mxn.Mapstraction

Defined in: mxn.core.js.

Class Summary

Constructor Attributes	Constructor Name and Description
	mxn.Mapstraction(element, api, debug) Mapstraction instantiates a map with some API choice into the HTML element given

Field Summary

Field Attributes	Field Name and Description
	api The name of the active API.
	currentElement The DOM element containing the map.
	element The original element value passed to the constructor.
	markers The markers currently loaded.
	options Options defaults.
	polylines The polylines currently loaded.

Method Summary

Method Attributes	Method Name and Description
	addControls(args) addControls adds controls to the map.
	addEventListener(type, func, caller) Add a listener for an event.
	addFilter(name, presently, the) addFilter adds a marker filter
	addImageOverlay(unique, url, opacity, west, south, east, north) addImageOverlay layers an georeferenced image over the map
	addJSON(json)
	addLargeControls() Adds a large map panning control and zoom buttons to the map
	addMapTypeControls() Adds a map type control to the map (streets, aerial imagery etc)
	addMarker(marker, old) Adds a marker pin to the map
	addMarkerWithData(marker, data) addMarkerWithData will addData to the marker, then add it to the map
	addOverlay(url, autoCenterAndZoom) Adds a GeoRSS or KML overlay to the map some flavors of GeoRSS and KML are not supported by some of the Map providers
	addPolyline(polyline, old) Add a polyline to the map
	addPolylineWithData(polyline, data) addPolylineWithData will addData to the polyline, then add it to the map
	addSmallControls() Adds a small map panning control and zoom buttons to the map
	addTileLayer(template, opacity, copyright, Minimum, Maximum, Should) Adds a Tile Layer to the map Requires providing a parameterized tile url.
	applyFilter(o, f)
	applyOptions() Applies the current option settings
	autoCenterAndZoom() Sets the center and zoom of the map to the smallest bounding box containing all markers and polylines
	callEventListeners(sEventType, oEventArgs) Call listeners for a particular event.
	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(lat, lon, me)
	declutterMarkers(opts) Declutter the markers on the map, group together overlapping markers.
	doFilter(showCallback, hideCallback) doFilter executes all filters added since last call Now supports a callback function for when a marker is shown or hidden
	dragging(on) Enable/disable dragging of the map
	enableScrollWheelZoom() Enable scroll wheel zooming
	getAttributeExtremes(name) getAttributeExtremes returns the minimum/maximum of "field" from all markers
	getBounds() Gets the BoundingBox of the map
	getCenter() Gets the central point of the map
	getMap() getMap returns the native map object that mapstraction is talking to
	getMapType() Gets the imagery type for the map.
	getPixelRatio() Returns a ratio to turn distance into pixels based on current projection
	getZoom() Returns the zoom level of the map
	getZoomLevelForBoundingBox(bbox) Returns the best zoom level for bounds given
	isLoaded(api) Returns the loaded state of a Map Provider
	mousePosition(element) Displays the coordinates of the cursor in the HTML element
	moveendHandler(me)
	polylineCenterAndZoom(padding) Automatically sets center and zoom level to show all polylines
	removeAllFilters() removeAllFilters
	removeAllMarkers() removeAllMarkers removes all the Markers on a map
	removeAllPolylines() Removes all polylines from the map
	removeFilter(field, operator, value) Remove the specified filter
	removeMarker(marker) removeMarker removes a Marker from the map
	removePolyline(polyline) Remove the polyline from the map
	resizeTo(width, 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)
	runDeferred() Run any queued provider API calls for the methods defined in the provider's implementation.
	setBounds(bounds) Sets the map to the appropriate location and zoom for a given BoundingBox
	setCenter(point, options) setCenter sets the central point of the map
	setCenterAndZoom(point, zoom) Centers the map to some place and zoom level
	setDebug(debug) Set the debugging on or off - shows alert panels for functions that don't exist in Mapstraction
	setDefer(set) Set the api call deferment on or off - When it's on, mxn.invoke will queue up provider API calls until runDeferred is called, at which time everything in the queue will be run in the order it was added.
	setImageOpacity(id, opacity)
	setImagePosition(id)
	setMapType(type) Sets the imagery type for the map The type can be one of: mxn.Mapstraction.ROAD mxn.Mapstraction.SATELLITE mxn.Mapstraction.HYBRID mxn.Mapstraction.PHYSICAL
	setOption(sOptName, vVal) Sets an option and applies it.
	setOptions(oOpts) Sets the current options to those specified in oOpts and applies them
	setZoom(zoom) 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.
	swap(api, element) Change the current api on the fly
	toggleFilter(field, operator, value) Delete the current filter if present; otherwise add it
	toggleTileLayer(url) Turns a Tile Layer on or off
	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"

Event Summary

Event Attributes	Event Name and Description
	changeZoom() Zoom is changed
	click() Map is clicked {location: LatLonPoint}
	endPan() Map is panned
	load() Map has loaded
	markerAdded() Marker is added {marker: Marker}
	markerRemoved() Marker is removed {marker: Marker}
	polylineAdded() Polyline is added {polyline: Polyline}
	polylineRemoved() Polyline is removed {polyline: Polyline}

---

---

---

---

---

Parameters:

{array} args

Which controls to switch on

---

Parameters:

{String} type

Event type to attach listener to

{Function} func

Callback function

{Object} caller

Callback object

---

Parameters:

{field} name

of attribute to filter on

{operator} presently

only "ge" or "le"

{value} the

value to compare against

---

Parameters:

{id} unique

DOM identifier

{src} url

of image

{opacity} opacity

0-100

{west} west

boundary

{south} south

boundary

{east} east

boundary

{north} north

boundary

---

Parameters:

json

---

---

---

Parameters:

{Marker} marker

The marker to add

{Boolean} old

If true, doesn't add this marker to the markers array. Used by the "swap" method

---

Parameters:

{Marker} marker

The marker to add

{Object} data

A data has to add

---

Parameters:

{String} url

GeoRSS or KML feed URL

{Boolean} autoCenterAndZoom

Set true to auto center and zoom after the feed is loaded

---

Parameters:

{Polyline} polyline

The Polyline to add to the map

{Boolean} old

If true replaces an existing Polyline

---

Parameters:

{Polyline} polyline

The polyline to add

{Object} data

A data has to add

---

---

Parameters:

{tile_url} template

url of the tiles.

{opacity} opacity

of the tile layer - 0 is transparent, 1 is opaque. (default=0.6)

{copyright_text} copyright

text to use for the tile layer. (default=Mapstraction)

{min_zoom} Minimum

(furtherest out) zoom level that tiles are available (default=1)

{max_zoom} Maximum

(closest) zoom level that the tiles are available (default=18)

{map_type} Should

the tile layer be a selectable map type in the layers palette (default=false)

---

Parameters:

o

f

---

---

---

Parameters:

{String} sEventType

Call listeners of this event type

{Object} oEventArgs

Event args object to pass back to the callback

---

Parameters:

points

---

Parameters:

lat

lon

me

---

Parameters:

{Object} opts

Declutter options

---

Parameters:

{Function} showCallback

{Function} hideCallback

Returns:

{Int} count of visible markers

---

Parameters:

{Boolean} on

Deprecated:

Use setOption instead.

---

Deprecated:

Use setOption instead.

---

Parameters:

{field} name

of "field" to query

Returns:

{array} of minimum/maximum

---

Returns:

{BoundingBox} The bounding box for the current map state

---

Returns:

{LatLonPoint} The center point of the map

---

Returns:

the native map object mapstraction is using

---

Returns:

{Number}

---

Returns:

{Float} ratio

---

Returns:

{Integer} The zoom level of the map

---

Parameters:

{BoundingBox} bbox

The bounds to fit

Returns:

{Integer} The closest zoom level that contains the bounding box

---

Parameters:

{String} api

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

---

Parameters:

{String} element

ID of the HTML element to display the coordinates in

---

Parameters:

me

---

Parameters:

{Number} padding

Optional number of kilometers to pad around polyline

---

---

---

---

Parameters:

{Object} field

{Object} operator

{Object} value

---

Parameters:

{Marker} marker

The marker to remove

---

Parameters:

{Polyline} polyline

The Polyline to remove from the map

---

Parameters:

{Integer} width

The width the map should be.

{Integer} height

The width the map should be.

---

---

Parameters:

{BoundingBox} bounds

The bounding box you want the map to show

---

Parameters:

{LatLonPoint} point

The point at which to center the map

{Object} options

Optional parameters

{Boolean} options.pan

Whether the map should move to the locations using a pan or just jump straight there

---

Parameters:

{LatLonPoint} point

Where the center of the map should be

{Integer} zoom

The zoom level where 0 is all the way out.

---

Parameters:

{Boolean} debug

true to turn on debugging, false to turn it off

---

Parameters:

{Boolean} set

deferred to true to turn on deferment

---

Parameters:

id

opacity

---

Parameters:

id

---

Parameters:

{Number} type

---

Parameters:

{String} sOptName

Option name

vVal

Option value

---

Parameters:

{Object} oOpts

Hash of options to set

---

Parameters:

{Number} zoom

The (native to the map) level zoom the map to.

---

Parameters:

{String} api

The API to swap to

element

---

Parameters:

{Object} field

{Object} operator

{Object} value

---

Parameters:

{tile_url} url

of the tile layer that was created.

---

---

---

---

---

---

---

---

---