importRouteWithRoutingOptions abstract method

TaskHandle importRouteWithRoutingOptions(
  1. List<Location> locations,
  2. RoutingOptions options,
  3. CalculateRouteCallback callback
)

Asynchronously creates a route from a sequence of geographic coordinates very close to each other.

The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

  • locations The list of locations used to calculate the route. Note that only the Location.coordinates of a location are used to import the route.

An RoutingError.invalidParameter error is generated when the location list size is not in the range [2,50000].

  • options The options define the vehicle and route options to calculate the route.

  • callback Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Returns TaskHandle. Handle that will be used to manipulate the execution of the task.

Implementation

TaskHandle importRouteWithRoutingOptions(List<Location> locations, RoutingOptions options, CalculateRouteCallback callback);