Class MMMapType

Object
   |
   +--MMMapType

class MMMapType

Defined in MultimapOpenAPI

Constructor Detail

MMMapType

MMMapType( <Array> layers, <MMProjection> projection, <String> name, <MMMapTypeOptions> options )

A custom map type to be displayed in the mapviewer.

Parameters:
layers - An array of MMTileLayer objects to display in the viewer. Currently only a single layer can be displayed in the Multimap API.
projection - The projection that has been used for the map tiles.
name - The name to be displaye in the MMMapTypeWidget.
options - An object containing options for this map type.

getAlt

String getAlt()

Retrieves the value of the 'alt' option.

getBoundsZoomFactor

Object getBoundsZoomFactor( <MMBounds> bounds, <MMDimensions> view_size )

Returns the zoom factor that can fit the set of bounds specified within a given size of viewer.

Parameters:
bounds - The geographical bounding box that you wish to query.
view_size - The size of the viewer that you would like to fit the bounding box into, given in pixels.

getCopyrights

Object getCopyrights( <MMBounds> bounds, <integer> zoom_factor )

Returns the copyright objects that should be displayed at the specified zoom factor and within the specified bounding box. *

Parameters:
bounds - A bounding box.
zoom_factor - A valid zoom factor.

getErrorMessage

String getErrorMessage()

Retrieves the value of the 'errorMessage' option. This is not used by the Multimap API.

getLinkColor

String getLinkColor()

Retrieves the value of the 'linkColor' option, or '#7777cc' by default. This value is used to indicate the best color for text links overlaid on the map. It is not used by the Multimap API.

Returns:
The best color for overlaying text links on the map, '#7777cc' by default.

getMaximumResolution

integer getMaximumResolution( latlon )

Returns the value of the 'minResolution' option, or the minimum resolution of all the tile layers.

Returns:
The minimum resolution supported by this map type.

getMinimumResolution

integer getMinimumResolution( latlon )

Returns the value of the 'minResolution' option, or the minimum resolution of all the tile layers.

Returns:
The minimum resolution supported by this map type.

getName

String getName( <boolean> opt_short )

Retrieves the name of the map type. Passing true in will return the short name if one has been specified.

Parameters:
opt_short - If true returns the value of the 'shortName' option, or the name if no short version was given.

Returns:
The name of the map type, or the value of the 'shortName' option if one was given and true is passed in.

getProjection

MMProjection getProjection()

Gets a reference to the projection that was used to create the map type.

Returns:
A reference to the projection that was passed into the constructor.

getTextColor

String getTextColor()

Retrieves the value of the 'textColor' option, or 'black' by default. This value is used to indicate the best color for text overlaid on the map. It is not used by the Multimap API.

Returns:
The best text color for overlaying text on the map, 'black' by default.

getTileLayers

Array getTileLayers()

Returns a reference to the array of tile layers passed into the constructor.

Returns:
A reference to the array of tile layers.

getTileSize

integer getTileSize()

Returns the tile size for this map type. Default is 256.

Returns:
The tile sie for this map type, default 256.

getUrlArg

String getUrlArg()

Retrieves the value of the 'urlArg' option.