getDistanceOnRoute method

int getDistanceOnRoute(
  1. Coordinates coords,
  2. bool activePart
)
inherited

Get route distance from departure at the given coordinate.

Parameters

  • IN coord The geographic coordinates where the distance is to be measured
  • IN distance Boolean indicating whether to consider only the active part of the route (true) or the entire route (false).

Returns

  • Coordinates at the specified distance along the route.

Throws

  • An exception if it fails.

Implementation

int getDistanceOnRoute(final Coordinates coords, final bool activePart) {
  final OperationResult resultString = objectMethod(
    _pointerId,
    'RouteBase',
    'getDistanceOnRoute',
    args: <String, Object>{'coords': coords, 'activePart': activePart},
  );

  return resultString['result'];
}