Class MMLocation

Object
   |
   +--MMLocation

class MMLocation

Defined in MultimapOpenAPI

Field Detail

address

MMAddress address

The address describing this location.

bounds

MMBounds bounds

The bounding box of this location.

coords

MMLatLon coords

The coordinates of this location.

route

Object route

A route to be displayed.

search

MMSearch search

A search to perform and center on the first result of.

zoom_factor

integer zoom_factor

The ideal zoom factor for displaying this location.

MMLocation

MMLocation( <Object> various )

An object for storing information about a location. The full array of information that can be stored by this object is:
• An MMLatLon object containing lat and lon of a point.
• An MMAddress object containing the address of the point.
• Ideal Zoom Factor to display the location at.
If an MMLatLon object is given, this will always be used. If only an MMAddress object is given, then the API will attempt to resolve that address before using the MMLocation object. As the resolving process is an asynchronous process only specific mapviewer functions support it. These are drawAndPositionMap, goToPosition, createMarker and createInfoBox.
The constructor will support arguments passed in any order, detecting them by type. The only time that argument order matters is with the deprecated usage given below:
A deprecated usage format is also supported whereby arguments of an easting, northing and zoom factor can be passed in that order.

Parameters:
various - One or more of the supported objects.

copy

MMLocation copy()

Function to return a copy of the object in a new object.

Returns:
A new object containing the same data as this object.

toString

String toString()

Function to return a string version of the object.

Returns:
Formatted version of the object