Custom routes

Planning a route may involve locations beyond the origin and destination. The route can be constructed as a custom route from a polyline (defined as a list of supporting points). This allows users to import routes from another source or reconstruct driven paths.

The supportingPoints parameter is used to reconstruct a route from an imported polyline:

• The sequence of supporting points provided is used as input for route reconstruction.
• Alternative routes are calculated between the origin and destination points specified in the base path parameter locations.
• If both minDeviationDistance and minDeviationTime are set to zero, the origin and destination points are expected to be at, or very near, the beginning and end of the reference route.
• The reference route may contain traffic incidents of the type ROAD_CLOSURE , which are ignored when calculating travel time and traffic delays.

1
val supportingPoints = loadSupportingPointsFromFile()
2
val amsterdam = GeoPoint(52.377956, 4.897070)
3
val rotterdam = GeoPoint(51.926517, 4.462456)
4
val routePlanningOptions = RoutePlanningOptions(
5
    itinerary = Itinerary(origin = amsterdam, destination = rotterdam),
6
    routeLegOptions = supportingPoints.map { RouteLegOptions(supportingPoints = it) },
7
)

Next steps

Since you have learned how to work with waypoints and supporting points, here are recommendations for the next steps:

• Route planning
• Reconstructing a route from a polyline
• Route sections
• Search quickstart