TomTom Maps SDK for JavaScript
This is the documentation of version 0.58.0. Go to the latest version, 1.0.0-rc.5.
TomTom Maps for JavaScript
    Preparing search index...

    Type Alias LegSectionProps

    LegSectionProps: Omit<SectionProps, "startPointIndex" | "endPointIndex"> & {
        endPointIndex?: number;
        originalWaypointIndex?: number;
        startPointIndex?: number;
        summary: LegSummary;
    }

    Route section representing a leg between waypoints.

    A leg is the portion of route between two consecutive waypoints. This is a top-level section that encompasses the entire journey segment.

    Type Declaration

    • OptionalendPointIndex?: number

      Index where this leg ends in the route coordinates.

      Only present if the route polyline geometry is available.

    • OptionaloriginalWaypointIndex?: number

      Index, in the locations the route was requested with, of the waypoint this leg ends at.

      A leg does not always end at the location with the same index: on an EV route the service inserts charging stops of its own, so legs[i] is not reliably the leg arriving at locations[i + 1]. This is the index that maps a leg back to the stop the caller passed.

      Absent on the final leg, and on legs that end somewhere the caller did not ask for — an inserted charging stop, for instance.

      // Which of the stops I passed does this leg arrive at?
      const index = leg.originalWaypointIndex;
      const stop = index === undefined ? undefined : locations[index];
    • OptionalstartPointIndex?: number

      Index where this leg starts in the route coordinates.

      Only present if the route polyline geometry is available.

    • summary: LegSummary

      Summary statistics for this leg.

      Contains departure/arrival times, distances, durations, and consumption estimates specifically for this leg of the journey.

    Leg examples:

    • A→B route: 1 leg (A to B)
    • A→B→C route: 2 legs (A to B, then B to C)
    • An EV route: one leg per charging stop the service adds, on top of the stops that were asked for
    const leg: LegSectionProps = {
      id: 'leg-1',
      summary: {
        departureTime: new Date(),
        arrivalTime: new Date(),
        lengthInMeters: 50000,
        travelTimeInSeconds: 3600,
        // ... other summary fields
      },
      startPointIndex: 0,
      endPointIndex: 250
    };

    Settings
    Member Visibility