Documentation
Reference
2.1.50 (current version)
collection
interactivityModel
Interfaces
2.1.51 (release candidate)
collection
interactivityModel
Interfaces

IMultiRouteParams

Interface of the object that describes the format of the parameters of a multi-stop route model.

Constructor | Fields

Constructor

IMultiRouteParams()

Fields

NameTypeDescription
avoidTrafficJamsBoolean

Allows to construct a multi-stop route with consideration for the current traffic. Default value: false.

boundedByNumber[][]|null

Defines the area on the map where the objects being searched for are presumably located. This is used if the route points are set using the mailing address, and not coordinates. Default value: null.

requestSendIntervalString|Number

Time interval between requests to the router service. Can be set in milliseconds, otherwise the optimal value will be calculated automatically. Default value: "auto".

resultsInteger

The maximum number of routes returned by the multi-stop router. Default value is 3.

reverseGeocodingBoolean

Whether to use reverse geocoding for points specified as coordinates.

routingModeString

Routing type. Accepts one of the two string values:

  • "auto" - Driving route.
  • "masstransit" - Routing using public transport.
  • "pedestrian" - Walking route.
Default value: "auto".

searchCoordOrderString

Determines how to interpret descriptions of the reference points that can be defined either as arrays of coordinates or as geometries. Can take one of two values: "longlat" or "latlong". The current value of the API's coordorder parameter is used by default.

strictBoundsBoolean

To search for objects only within the area specified by the boundedBy parameter. This is used if the route points are set using the mailing address, and not coordinates. Default value: false.

viaIndexesInteger[]

Contains indexes of throughpoints in the set of reference points of the multi-stop route. The array is empty by default.

Fields details

avoidTrafficJams

{Boolean} avoidTrafficJams

Allows to construct a multi-stop route with consideration for the current traffic. Default value: false.

boundedBy

{Number[][]|null} boundedBy

Defines the area on the map where the objects being searched for are presumably located. This is used if the route points are set using the mailing address, and not coordinates. Default value: null.

requestSendInterval

{String|Number} requestSendInterval

Time interval between requests to the router service. Can be set in milliseconds, otherwise the optimal value will be calculated automatically. Default value: "auto".

results

{Integer} results

The maximum number of routes returned by the multi-stop router. Default value is 3.

reverseGeocoding

{Boolean} reverseGeocoding

Whether to use reverse geocoding for points specified as coordinates.

routingMode

{String} routingMode

Routing type. Accepts one of the two string values:

  • "auto" - Driving route.
  • "masstransit" - Routing using public transport.
  • "pedestrian" - Walking route.
Default value: "auto".

searchCoordOrder

{String} searchCoordOrder

Determines how to interpret descriptions of the reference points that can be defined either as arrays of coordinates or as geometries. Can take one of two values: "longlat" or "latlong". The current value of the API's coordorder parameter is used by default.

strictBounds

{Boolean} strictBounds

To search for objects only within the area specified by the boundedBy parameter. This is used if the route points are set using the mailing address, and not coordinates. Default value: false.

viaIndexes

{Integer[]} viaIndexes

Contains indexes of throughpoints in the set of reference points of the multi-stop route. The array is empty by default.