Class MQTileMap

Object
   |
   +--MQTileMap

class MQTileMap

The MQTileMap is the javascript objects that represents the functionality of a Mapquest Draggable map.
Defined in toolkit.js

See:

- getMapType()
- MQMapInit

Field Detail

canvasOffsetX

Object canvasOffsetX

canvasOffsetY

Object canvasOffsetY

dcCanvasContext

Object dcCanvasContext

dcCanvasDiv

Object dcCanvasDiv

overlayOffsetX

Object overlayOffsetX

overlayOffsetY

Object overlayOffsetY

staticMapEnabled

Object staticMapEnabled

surface

Object surface

turnEventsOff

Object turnEventsOff

MQTileMap

MQTileMap( <HTMLElement> parent, <int> zoom, <MQLatLng> mqLatLng, <string> mtype, <MQMapInit> mqmapinit )

Constructs a MQTileMap object.

Parameters:
parent - A Browser DIV HTML element to be the map's container.
zoom - The initial zoomlevel to display the map.
mqLatLng - A point representing the center of the map.
mtype - the initial map type.
mqmapinit - The object to hold the best fit information.

See:
- getMapType()
- MQMapInit

addControl

void addControl(<MQControl> control, <MQMapCornerPlacement> position)

Function to add control to Map.

Parameters:
control - The MQControl derived object to add to the map.
position - the position to place the control on the map.

addOverlay

void addOverlay(<MQOverlay> mqOverlay)

Function to add the overlay to the map. Fires the "overlayadded" event on the map.

Parameters:
mqOverlay - New overlay to add.

addOverlays

void addOverlays(<mqOverlays> mqOverlays)

Function to add the overlays to the map from a collection.

Parameters:
mqOverlays - An overlays Collection to add.

addPoi

void addPoi(<MQPoi> mqPoi)

Function to add the poi to the map. Fires the "poiadded" event on the map.

Parameters:
mqPoi - New poi to add.

addPois

void addPois(mqPois)

Function to add the poi to the map. Fires the "poiadded" event on the map.

Parameters:
mqPoi - New poi to add.

addRouteHighlight

void addRouteHighlight(<MQRectLL> rectll,<String> mapserverurl,<String> sessionid,<boolean> bestfit)

Function to add route highlight to Map.

Parameters:
rectll - bounding box of route highlight.
mapserverurl - server portion of URL to AAPI mapping server.
sessionid - session id to server session that contains route shape.
bestfit - true/false bestfit the map around the route shape.

bestFit

void bestFit(<boolean> keepCenter, <int> minZoomLevel, <int> maxZoomLevel)

A function that will pan and zoom the map to "best fit" to the nearest zoom level around the points contained in the map's poi collection.

Parameters:
keepCenter - OPTIONAL: true will cause the map to retain the same center latitude/longitude as existed before the call; false (default) will allow the map center latitude/longitude to change.
minZoomLevel - OPTIONAL: minimum zoom level (default = 1).
maxZoomLevel - OPTIONAL: maximum zoom level (default = 16).

bestFitLL

void bestFitLL(<Array> arrayLL, <boolean> keepCenter, <int> minZoomLevel, <int> maxZoomLevel)

A function that will pan and zoom the map to "best fit" to the nearest zoom level around the points passed in.

Parameters:
arrayLL - a javascript array of MQLatLng objects.
keepCenter - OPTIONAL: true will cause the map to retain the same center latitude/longitude as existed before the call; false (default) will allow the map center latitude/longitude to change.
minZoomLevel - OPTIONAL: minimum zoom level (default = 1).
maxZoomLevel - OPTIONAL: maximum zoom level (default = 16).

enableDragging

void enableDragging(<boolean> benable)

Function to enable/disable map dragging.

Parameters:
benable - true/false to set state of map dragging.

getBestFitMargin

Object getBestFitMargin()

Returns the bestFit margin in pixels.

See:
- setBestFitMargin()

getBounds

MQRectLL getBounds()

Retrieves a MQRectLL object for the upper-left, lower-right corners of the Map.

Returns:
the Lat Lng coordinates for the upper-left/lower-right corners of the map.

getCenter

MQLatLng getCenter()

Function to return the center of the map in geographic coordinates.

Returns:
geographic center of the map.

getDeclutter

MQDeclutter getDeclutter()

Function to return a reference to the declutter object.

Returns:
reference to the declutter object.

getDragEnabled

boolean getDragEnabled()

Function to return state of map dragging.

Returns:
true/false state of map dragging.

getDragOffset

MQPoint getDragOffset()

Function to return the dragged offset of the map.

Returns:
the drag offset of the map.

getInfoWindow

MQInfoWindow getInfoWindow()

Function to return a reference to the maps info window. One info window exists per map, and is repositioned over pois when clicked.

Returns:
reference to the info window.

getMapType

string getMapType()

Function to get the current map type. Possible values include:
• "map" - 2D normal map
• "sat" - satellite imagery
• "hyb" - hybrid map

Returns:
The current map type.

getOverlays

MQOverlayCollection getOverlays()

Function to return overlay collection.

Returns:
the collection of overlays added to the map.

getPois

MQPoiCollection getPois()

Function to return poi collection.

Returns:
the collection of pois added to the map.

getRolloversEnabled

boolean getRolloversEnabled()

Function to get if rollover functionality is on.

Returns:
true if rollover functionality is on.

See:
- setRolloversEnabled()

getRolloverWindow

MQRolloverWindow getRolloverWindow()

Function to return a reference to the maps rollover window. One rollover window exists per map, and is repositioned over pois when rollovers are enabled.

Returns:
reference to the rollover window.

getRouteSession

Object getRouteSession()

Function to return sessionid of route highlight.

getScaleFromZoom

int getScaleFromZoom()

Function to get the current scale of the map.

Returns:
the current scale based on zoom level.

getSize

MQSize getSize()

Function to return map size.

Returns:
the size of the map.

See:
- setSize()

getZoomLevel

int getZoomLevel()

Function to get the current zoom level of the map.

Returns:
the current zoom level.

HandleOverlays

void HandleOverlays()

Function to take care of re-mapping overlays

hideStaticMap

void hideStaticMap()

Function to remove the static map image and return to tiled map and re-enable map events

See:
- showStaticMap()

llToPix

MQPoint llToPix(<MQLatLng> mqLatLng)

Function to convert geographical coordinates to pixel coordinates relative to the current map displayed.

Parameters:
mqLatLng - point to get converted.

Returns:
the new point in pixel coordinates.

openInfoWindow

void openInfoWindow(<MQPoint> mqPoint)

Function to open the info window over the map at specified pixel coordinate. The coordinate represents the spot the below the "tail" of the info window.

Parameters:
mqPoint - the pixel coordinate to open the info window to.

panToLatLng

void panToLatLng(<MQLatLng> mqLatLng)

Function to slide the mp to the new center specified. If point is greater than 100 pixels out of map boundaries the map is snapped to center, else the map will smooth srcoll to new center.

Parameters:
mqLatLng - the new center point.

pixToLL

MQLatLng pixToLL(<MQPoint> mqPoint)

Function to convert pixel coordinates to geographical coordinates relative to the current map displayed.

Parameters:
mqPoint - point to get converted.

Returns:
the new point in geographic coordinates.

redrawOverlays

void redrawOverlays()

Function to redraw all the overlays

removeAllOverlays

void removeAllOverlays()

Function to remove all overlays from the map.

removeAllPois

void removeAllPois()

Function to remove all pois from the map. Fires the "mapcleared" event on the map.

removeControl

void removeControl(<MQControl> control)

Function to remove the control from the Map.

Parameters:
control - the control to remove.

removeOverlay

void removeOverlay(<MQOverlay> mqOverlay)

Function to remove the overlay from the map. Fires the "overlayremoved" event on the map.

Parameters:
mqOverlay - the overlay to be removed.

removePoi

void removePoi(<MQPoi> mqPoi)

Function to remove the poi from the map. Fires the "poiremoved" event on the map.

Parameters:
mqPoi - the poi to be removed.

removeRouteHighlight

void removeRouteHighlight()

Function to remove route highlight from Map.

replaceOverlays

void replaceOverlays(myOverlayCollection)

Function to remove the current collection of overlays from the map and add the collection specified to the map. Events are fired for each overlay in the old collection when removed and a "mapcleared" event just before adding the new overlays from the new collection.

Parameters:
myoverlays - the new overlay collection.

replacePois

void replacePois(<MQPoiCollection> mypois)

Function to remove the current collection of pois from the map and add the collection specified to the map. Events are fired for each poi in the old collection when removed and a "mapcleared" event just before adding the new pois from the new collection.

Parameters:
mypois - the new poi collection.

restoreState

void restoreState()

Restores the saved map position, zoom level, and map type.

See:
- saveState()

saveState

void saveState()

Stores the current map position, zoom level, and map type for later retrieval.

See:
- restoreState()

setBestFitMargin

void setBestFitMargin(bestFitMargin)

Sets the bestFit margin in pixels.

Parameters:
The - number of pixels to use for a bestFit margin.

See:
- getBestFitMargin()

setCenter

void setCenter(<MQLatLng> mqLatLng,<int> zoom)

Function to set the center of the map and optionally change the zoom level.

Parameters:
mqLatLng - point to be the new map center.
zoom - OPTIONAL: the new zoom level .

setInfoContentElement

void setInfoContentElement(<HTMLElement> contentContainer)

Function to set the content for the info window as an HTMLElement created using the browser DOM.

Parameters:
contentContainer - the info window content element.

setInfoContentHTML

void setInfoContentHTML(<string> content)

Function to set the content for the info window as HTML text.

Parameters:
content - the info window content text.

setInfoTitleElement

void setInfoTitleElement(<HTMLElement> titleContainer)

Function to set the title for the info window as an HTMLElement created using the browser DOM.

Parameters:
titleContainer - the info window title element.

setInfoTitleHTML

void setInfoTitleHTML(<string> title)

Function to set the title for the info window as HTML text.

Parameters:
title - the info window title text.

setLogoPlacement

void setLogoPlacement(<MQMapLogo> mapLogo, <MQMapCornerPlacement> mapCornerPlacement)

Sets the position of the specified logo at the specified corner placement.

Parameters:
mapLogo - The logo to position.
mapCornerPlacement - The corner and offset to place the logo.

setLogoZindex

void setLogoZindex(mapLogo, index)

setMapType

void setMapType(<string> type)

Function to set the map type for this map.

Parameters:
type - the type to change the map to. See getMapType for valid values.

See:
- getMapType()

setRolloversEnabled

void setRolloversEnabled(<boolean> benable)

Function to enable rollover behavior for when the mouse rolls over pois on the map. When enabled, rollover windows will display when mouse is over a poi.

Parameters:
benable - flag to enable/disable rollover functionality of map.

setSize

void setSize(<MQSize> mqSize)

Function to resize the map.

Parameters:
mqSize - object containing the new height and width of the map.

See:
- getSize()

setZoomLevel

void setZoomLevel(<int> level)

Function to zoom the map to the specified zoom level. Causes a "zoomend" event to be fired on the map.

Parameters:
level - the new zoom level.

showDragableMap

void showDragableMap()

Function to load a tiled map with dragging capabilities.

See:
- MQMapInit

showStaticMap

Object showStaticMap()

Function to load a printer friendly map by covering the tiles with static map image version and disable map manipulation events

See:
- hideStaticMap()

zoomIn

void zoomIn()

Function to zoom the map in one zoom level.

zoomOut

void zoomOut()

Function to zoom the map out one zoom level.

zoomToRect

void zoomToRect(<MQRectLL> rectLL,<boolean> keepcenter,<int> minzoom,<int> maxzoom)

Function to zoom the map to the closest zoom level that fits the specified rectangle.

Parameters:
rectLL - the rectangle to use as boundary.
keepcenter - OPTIONAL:Flag to specify if current map center is used or center of rectangle is used for center of map.
minzoom - OPTIONAL:Minimum zoom level to use even if rect needs a lower zoom level to fit.
maxzoom - OPTIONAL: Maximum zoom level to use even if rect needs a higher zoom level to fit.