Home > @magiclane/maps-sdk > RoundTripParameters > (constructor)

RoundTripParameters.(constructor)

Creates a new instance of RoundTripParameters.

Signature:

constructor(options: {
        range: number;
        rangeType?: RangeType;
        randomSeed?: number;
    });

Parameters

Parameter

Type

Description

options

{ range: number; rangeType?: RangeType; randomSeed?: number; }

Configuration options

options properties:

  • range: number

    Approximate desired size of the roundtrip; meaning is the same as for the route ranges feature.

  • Optional rangeType?: RangeType

    The units in which the range is expressed. Default is dependent on the route type like for Ranges. Other options are distance in meters and time in seconds. Default is `RangeType.defaultType`

  • Optional randomSeed?: number

    If set to 0, generate a random route; any other number, use it as the seed for deterministic randomness. Default is `0`