Class MultimapViewer

Object
   |
   +--MMViewer
         |
         +--MultimapViewer

class MultimapViewer

extends MMViewer

Defined in MultimapOpenAPI

Constructor Detail

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.

addMapType

void addMapType( <MMMapType> map_type )

Adds a map type to the list of map types displayed in the viewer. If the map type is not already known to the viewer then an addMapType event will be called.

Parameters:
map_type - A custom, or Multimap, map type.

createInfoBox

MMInfoBoxOverlay createInfoBox( <MMLocation> position, html, <MMInfoBoxOptions> options )

A function to add an info box to the mapviewer. You 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; see MMInfoBoxOverlay for details of options.

Parameters:
position - Position at which to place the info box.
html - HTML to go in the info box, String or HTMLElement.
options - (optional) An object containing options.

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

See:
- MMInfoBoxOverlay
- MMViewer.addOverlay()

createMarker

MMMarkerOverlay createMarker( <MMLocation> position, <MMMarkerOptions> options )

A function to add a marker to the mapviewer.

Parameters:
position - Position at which to place the marker.
options - (optional) An object containing options for this marker.

Returns:
A reference to the marker that was created.

See:
- MMMarkerOverlay
- MMViewer.addOverlay()

declutterGroup

void declutterGroup( <String> group_name, <MMDeclutterOptions> options, <integer> declutter_type, <integer> cluster_type )

Declutters a group of markers, or turns off decluttering for a group of markers. If MM_DECLUTTER_NONE is passed then decluttering will be stopped for that group of markers. If no group_name is given then all markers without a group_name will be decluttered

Parameters:
group_name - (optional) Name of group to declutter.
options - (optional) An object containing options.
declutter_type - (optional) Type of decluttering required, MM_DECLUTTER_NONE, MM_DECLUTTER_GRID or the default MM_DECLUTTER_AGGREGATE.
cluster_type - (optional) Type of clustering required, MM_CLUSTER_ACCURATE or the default MM_CLUSTER_FAST.

geoBoundsToContainerPixels

MMBounds geoBoundsToContainerPixels( <MMBounds> bounds, no_check )

Retrieves pixel coordinates for a bounding box. Ensures that the south west coordinate is to the left of the north east which wouldn't necessarily happen if you call geoPosToContainerPixel yourself.

Parameters:
bounds - The bounding box that you want pixels for.

Returns:
A bounding box containing pixel coordinates.

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.

getMapType

integer getMapType()

Gives the current map type.

Returns:
The current map type of the mapviewer.

getScaleBarUnits

String getScaleBarUnits()

DEPRECATED - Use getOption( 'units' ) instead. 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, projection )

Converts lat/lon to Mercator Eastings/Northings.

Parameters:
lonlat - Latitude and longitude to convert.

Returns:
Mercator Eastings/Northings stored in an MMPoint.

mercatorToLatLon

MMLatLon mercatorToLatLon( mercator, projection )

Converts Mercator eastings/northings to lon/lat.

Parameters:
Eastings - /Northings stored in an 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.

removeMapType

void removeMapType( <MMMapType> map_type )

Removeds a map type from the list of map types displayed in the viewer. A "removeMapType" event will be called if the map type was known to the viewer.

Parameters:
map_type - A custom, or Multimap, map type.

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.

setMarkerFilters

void setMarkerFilters( <Array> filters, group_name )

This method sets the overlay filters parameter.

Parameters:
filters - An array of MMSearchFilter objects.

setScaleBarUnits

void setScaleBarUnits( <String> units )

DEPRECATED - Use setOption( 'units', 'km' ) instead. Sets the units for the scale bar. Options are 'miles' or 'km'.

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