The route to query. Must contain properties.progress data.
A discriminated union — provide exactly one of:
{ traveledTimeInSeconds } — elapsed seconds from route start{ traveledDistanceInMeters } — meters traveled from route start{ clockTime } — absolute Date; elapsed seconds are derived from route.summary.departureTimeInterpolated RouteCoordinateAtProgress, or undefined when:
progress dataclockTime is before the route departure time// By elapsed time
const pos = getCoordinateAtRouteProgress(route, { traveledTimeInSeconds: 600 });
// By distance
const pos = getCoordinateAtRouteProgress(route, { traveledDistanceInMeters: 5000 });
// By clock time
const pos = getCoordinateAtRouteProgress(route, { clockTime: new Date('2025-06-01T09:30:00Z') });
Returns the geographic coordinate and cumulative progress values at the point along a route identified by a RouteProgressQuery.