Class MMDataResolver

Object
   |
   +--MMDataResolver

class MMDataResolver

Defined in MultimapAPI

Constructor Detail

MMDataResolver

MMDataResolver()

The Multimap Data Resolver. This describes a globally declared object that can be queried for information. You should not need to, and in fact will not be able to, instantiate a new "MMDataResolver" object.
This object is used to determine data-coverage for any point on the globe.

getCopyright

String getCopyright( <integer> map_index, <integer> map_type )

Gets the copyright information for a map index.

Parameters:
map_index - A valid map index.
map_type - A valid map type, MM_WORLD_MAP or MM_WORLD_AERIAL.

Returns:
Copyright information for the given map index.

getCoverage

Array getCoverage( <MMLocation> position, <integer> zoom_factor, <integer> map_type )

Gets the coverage available for a given lat/lon, zoom factor and map type. Will return either an array containing zero of more entries, or undefined if coverage has not yet been retrieved for that point.

Parameters:
position - A valid latitude and longitude either as an MMLatLon or in an MMLocation.
zoom_factor - A valid zoom factor.
map_type - A valid map type.

Returns:
An array of map indexes or undefined if coverage is not available at this time.

getDataPreferences

Array getDataPreferences( map_type )

Retrieves the current data preferences in use by the Multimap API. If setDataPreferences has not been called then this function will return the default preferences, otherwise it will return the new preferences.

Returns:
An array of map indexes that are in use by the API.

getDefaultDataPreferences

Array getDefaultDataPreferences( map_type )

Retrieves the default data preferences for the Multimap API. This function will always retrieve the default data preferences, ignoring any values that have been passed into setDataPreferences.

Returns:
An array of map indexes that are in use by the API.

setDataPreferences

void setDataPreferences( <integer> map_type, <Array> preferences )

Sets the data preferences for the viewers on the page. This function will not force mapviewers to load any new tiles so you will need to either call it before drawing occurs, or call MMViewer#redrawMap after calling this.

Parameters:
map_type - A valid Multimap map type.
preferences - An array of map indexes to use.