RangeCalculationOptions
data class RangeCalculationOptions(val origin: ItineraryPoint, val budgets: Set<Budget>, val vehicle: Vehicle = Vehicle.Car(), val costModel: CostModel? = null, val departAt: Date? = null, val routeToInclude: Route? = null, val queryOptions: QueryOptions = QueryOptions())
Options for range calculation.
Important: This is a Public Preview API. It may be changed or removed at any time.
Parameters
origin
The starting location of the range.
budgets
Budgets that limit the range. All budgets must be of the same type.
vehicle
The vehicle to be used.
costModel
Options governing which streets to prefer.
departAt
Departure date and time.
routeToInclude
A route that must be included in the range up to the reachable offset. It is used to visually align the range boundary with the reachable offset on the currently navigated route, if there is one. It is recommended to pass the navigated route here if it is displayed simultaneously with the range.
queryOptions
Options regarding the way the request is sent to the server.
Constructors
Link copied to clipboard
constructor(origin: ItineraryPoint, budgets: Set<Budget>, vehicle: Vehicle = Vehicle.Car(), costModel: CostModel? = null, departAt: Date? = null, routeToInclude: Route? = null, queryOptions: QueryOptions = QueryOptions())