This is the documentation of version 1.0.0-rc.3. Go to the latest version, 1.0.0-rc.5.

Function getRouteProgressForSection

getRouteProgressForSection(
route: Route,
section: RouteSpan,
): RouteSegmentProgress | undefined
Calculates progress measurements for a route section.

It wraps getRouteProgressBetween to take a section, or any RouteSpan, directly, using its startPointIndex and endPointIndex as the segment bounds.
Parameters
- route: Route
  The route whose properties.progress is interpolated.
- section: RouteSpan
  The section, or other span, whose start and end point indices define the segment.
Returns RouteSegmentProgress | undefined
A RouteSegmentProgress, or undefined if either index can't be interpolated. calculateProgressAtRoutePoint lists all the conditions.
Example
```
const section = route.properties.sections.country[0];
const result = getRouteProgressForSection(route, section);
if (result) {
  console.log(`Section starts ${result.start.distanceInMeters} m from route origin`);
  console.log(`Section ends   ${result.end.distanceInMeters} m from route origin`);
  console.log(`Section length ${result.delta.distanceInMeters} m`);
  console.log(`Section takes  ${result.delta.travelTimeInSeconds} s`);
}
```