Class MultimapViewer

Object
   |
   +--MMViewer
         |
         +--MultimapViewer

class MultimapViewer

extends MMViewer

Defined in MultimapAPI

Field Detail

superclass

<static> Object superclass

MultimapViewer

MultimapViewer( <HTMLElement> div_element, <integer> map_type, <integer> extra )

The Multimap mapviewer. A simple wrapper class to make using the mapviewer much easier. The map type is optional but defaults to world maps.
For backward-compatibility, if the second argument is given and is a string it is assumed to be a client name, in which case the third argument is taken to be the map type.

Parameters:
div_element - The containing DIV element.
map_type - (optional) The map type.
extra - For backward-compatibility, see above.

createInfoBox

InfoBoxOverlay createInfoBox( <MMLocation> position, html, <String> cssClass, <MMPoint> anchor , <boolean> dont_move, <boolean> no_combine_classes )

A function to add an info box to the mapviewer. The developer may pass in either a string of HTML to be rendered within the info box, or a HTMLElement DOM snippet that has been constructed already.
The info box will be styled with the Multimap default style, if the info box is to be restyled then the default style must be completely overridden.

Parameters:
position - Position at which to place the info box.
html - HTML to go in the info box, String or HTMLElement.
cssClass - (optional) A class name to assign to the info box
anchor - (optional) Position that the info box should be anchored to the map.
dont_move - (optional) If true, the map will not move to accommodate the info box.
no_combine_classes - (optional) If true, the passed in CSS class name is used for the widget, rather than combining it with the default - "MMInfoBox".

Returns:
A reference to the info box that has been added.

createMarker

MarkerOverlay createMarker( <MMLocation> position, <String> label, <MMIcon> icon, text )

A function to add a marker to the mapviewer.

Parameters:
position - Position at which to place the marker.
label - (optional) Tooltip text.
icon - (optional) Icon properties to use for the marker.

Returns:
A reference to the marker, or undefined if the id has already been used.

getAvailableMapTypes

Array getAvailableMapTypes()

Retrieves the list of possible map types. This function will list the range of map types that are supported by this version of the mapviewer code. It will return a simple list of integers so the calling code will have to be aware of the meaning of those values.

Returns:
The list of possible map types.

getClient

String getClient()

Retrieves the client service name for the mapviewer.

Returns:
The client service name for the mapviewer.

getCurrentPosition

MMLatLon getCurrentPosition()

Gets the current position of the map.

Returns:
The current position.

getMapBounds

MMBounds getMapBounds()

Returns the bounds of the rectangle displayed in the mapviewer.

Returns:
Coordinates of the south west and north east points of the map.

getMapPositionAt

MMLatLon getMapPositionAt( <MMPoint> step )

Returns the position at the given pixel offset.

Parameters:
step - Pixel offset from the center of the map.

Returns:
The map position at the given pixel offset.

getMapType

integer getMapType()

Gives the current map type.

Returns:
The current map type of the mapviewer.

getScaleBarUnits

String getScaleBarUnits()

Gets the units currently used for the scale bar.

Returns:
The units currently used for the scale bar, 'km' or 'miles'.

latLonToMercator

MMPoint latLonToMercator( latlon )

Converts lat/lon to Mercator Eastings/Northings.

Parameters:
lonlat - Latitude and longitude to convert.

Returns:
Mercator Eastings/Northings stored in a MMPoint.

mercatorToLatLon

MMLatLon mercatorToLatLon( mercator )

Converts Mercator eastings/northings to lon/lat.

Parameters:
Eastings - /Northings stored in a MMPoint

Returns:
Latitude and longitude of the given location.

parseXML

Object parseXML( <String> xml )

Parses an XML string. This function will attempt to parse a string by using browser built-in functionality. If the browser does not support this there is no fallback, a third party library must be used in this case.

Parameters:
xml - XML string to be parsed.

Returns:
Browser specific DOM object.

setMapType

void setMapType( <integer> map_type )

Changes the current map type. Sets the map type and redraws the mapviewer to take this change into account

Parameters:
map_type - The desired map type.

setScaleBarUnits

void setScaleBarUnits( <String> units )

Sets the units for the scale bar. Options are 'miles' or 'km'.

Parameters:
units - Units to use for the scale bar, 'km' or 'miles'.