@magiclane/maps-sdk
    Preparing search index...

    Class RoundTripParameters

    Round trip parameters

    Index

    Constructors

    • Creates a new instance of RoundTripParameters.

      Parameters

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

        Configuration options

        • OptionalrandomSeed?: number

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

        • range: number

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

        • OptionalrangeType?: 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

      Returns RoundTripParameters

    Properties

    randomSeed: number

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

    range: number

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

    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.

    Methods

    • Get hash code for use in maps/sets

      Returns number

    • Internal

      Serializes this instance to a JSON-compatible map.

      Used internally, not intended for direct use by consumers. The map structure may change without notice.

      Returns Record<string, any>

      JSON-compatible map

    • Internal

      Deserializes a JSON-compatible map to create an instance.

      Used internally, not intended for direct use by consumers. The expected map structure may change without notice.

      Parameters

      • json: any

        JSON-compatible map

      Returns RoundTripParameters

      A new RoundTripParameters instance