IMultiRouteParams

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

Constructor | Fields

Constructor

IMultiRouteParams()

Fields

Name Type Description
avoidTrafficJams Boolean

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

boundedBy Number[][]|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.

requestSendInterval String|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".

results Integer

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

reverseGeocoding Boolean

Whether to use reverse geocoding for points specified as coordinates.

routingMode String
Routing type. Accepts one of the two string values:
  • "auto" - Driving route.
  • "masstransit" - Routing using public transport.
  • "pedestrian" - Walking route.
  • "bicycle" - Bicycle route.
Default value: "auto".
searchCoordOrder String

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

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[]

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.
  • "bicycle" - Bicycle 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.