optimizeWaypointsOrder property

bool optimizeWaypointsOrder
getter/setter pair

A flag that indicates whether the order of waypoints that is passed to calculateRoute() should be optimized in the best order. The best order is calculated by the same metrics that are used during regular calculation, e.g. OptimizationMode. The starting and destination Waypoint are not reordered. If the whole number of waypoints is fewer than 4 - the flag doesn't affect the resulting route (nothing to optimize). The resulting order of waypoints can be identified by their waypoint indices in the route sections (see Route.sections, Section.departurePlace, Section.arrivalPlace, RoutePlace.waypointIndex). Currently, the waypoints order optimization is available only when using the OfflineRoutingEngine (only available for the Navigate license). Defaults to false.

Implementation

bool optimizeWaypointsOrder;