AlternativeRoutesOptions

data class AlternativeRoutesOptions(val maxAlternatives: Int = 1, val alternativeType: AlternativeType? = null, val minDeviationDistance: Distance? = null, val minDeviationTime: Duration? = null)

Specifies options related to alternative routes.

Important: This is a Public Preview API. It may be changed or removed at any time.

Parameters

maxAlternatives

Maximum number of alternative routes to generate in addition to the primary route.

alternativeType

Whether to find only better routes or any alternative to a given reference route. Can only be used with route reconstructions.

minDeviationDistance

Follow the reference route for at least this distance before deviating. Can only be used with route reconstructions.

minDeviationTime

Follow the reference route for at least this travel time before deviating. Can only be used with route reconstructions.

Constructors

Link copied to clipboard
fun AlternativeRoutesOptions(maxAlternatives: Int = 1, alternativeType: AlternativeType? = null, minDeviationDistance: Distance? = null, minDeviationTime: Duration? = null)

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard