Class MMRoute

Object
   |
   +--MMRoute

class MMRoute

Defined in MultimapAPI

Field Detail

bounds

MMBounds bounds

The bounds of the entire route.

copyright

String copyright

The copyright information that must always be displayed with a route.

custom_emission

Array custom_emission

An array of object literals containing custom vehicle information to retrieve emissions quantities for, see MMCustomEmission for more information.

disclaimer

String disclaimer

A URL for a disclaimer that must always be displayed with a route.

distance

Object distance

The total distance of the route. This is an object containing the distance in miles and km in properties named "miles" and "km" respectively.

duration

Object duration

The duration of the route. This is an object containing duration in a number of properties: Minutes, Hours and Days.

emissions

String emissions

Option to request carbon emission quantities for the route
Permitted values - 'true' or 'false'.

error_code

String error_code

Error code returned from a route request. May be one of the following:
• MM_ROUTE_ERROR_SERVER_BUSY - The Multimap route service encountered an unexpected error whilst servicing your request, please try again. If this problem persists please contact Multimap Customer Services.
• MM_ROUTE_ERROR_POINT_OUTSIDE_NETWORK - The Multimap route service does not currently provide coverage for the requested locations. Please refer to your service documentation for information on Multimap API coverage.
• MM_ROUTE_ERROR_START_END_POINTS_SAME - The start and end points provided for the route were the same. (and there were no waypoints).
• MM_ROUTE_ERROR_NO_ROUTE - The Multimap route service could not generate a route for the requested locations.
• MM_ROUTE_ERROR_TOO_MANY_MODE_CHANGES - Too many mode changes while routing. (you can only change from driving to walking or vice-versa a maximum of 3 times (i.e., 4 stages).

error_explanation

String error_explanation

Error code explanation returned from a route request.

exclude

String exclude

Specifies classes of road to try to avoid.
Permitted values - 'highways', 'motorways' (synonym of 'highways').

geocoding_errors

Array geocoding_errors

An array of geocoding error codes returned from a route request.

lang

String lang

DEPRECATED - Use MMRoute.locale instead
Specifies language to use for route instructions.
Permitted values:
• en_us (default) - English (United States)
• en (maps to 'en_us')
• en_gb - English (United Kingdom)
• da - Danish
• de - German
• es - Spanish
• fr - French
• it - Italian
• nl - Dutch
• no - Norwegian
• pt - Portuguese
• sv - Swedish

locale

String locale

Sets the locale for the route. By default this will use the locale of the map control which defaults to en-US if none is specified.
Permitted values:
• en-US - English (United States)
• en-GB - English (United Kingdom)
• da-DK - Danish
• de-DE - German
• es-ES - Spanish
• fr-FR - French
• it-IT - Italian
• nl-NL - Dutch
• nb-NO - Norwegian
• pt-PT - Portuguese
• ru-RU - Russian
• sv-SE - Swedish

mode

String mode

Specifies mode of route - "driving" (default) or "walking".

optimize_for

String optimize_for

Specifies whether to generate the 'quickest' or 'shortest' route; defaults to 'quickest'.

polyLine

MMPolyLineOverlay polyLine

An array of polylines representing the stages of the requested route. Can be added to a map using MMViewer#addOverlay.

stages

Array stages

An array representing the stages of the requested route.

MMRoute

MMRoute( <Array> locations )

The Multimap API Routing module. JavaScript library for accessing the functionality of the Multimap API Routing module. Requires access to the Multimap API Routing module - please contact your Multimap account manager for further information.

Parameters:
locations - An array of locations representing a route.

parseInformation

void parseInformation()

Parses the information array of all route steps into an associative array for ease of use.