Type Alias DisplayRouteSummaryProps

Type Declaration

• OptionalformattedDistance?: string

  The route's distance, formatted in the chosen units.

  Remarks

  The SDK formats it from the display units configuration:

  • Metric: "15 km", "2.9 km" or "500 m"
  • Imperial (US): "9½ mi" or "600 ft"

  Example

  formattedDistance: '15 km'
  formattedDistance: '9½ mi'
  Copy

• OptionalformattedDuration?: string

  The route's formatted duration.

  Remarks

  Human-readable travel time with appropriate units:

  • Short: "15 min"
  • Medium: "1 hr 30 min"
  • Long: "2 hr 15 min"

  It accounts for traffic if traffic data is enabled.

  Example

  formattedDuration: '22 min'
  formattedDuration: '1 hr 45 min'
  Copy

• OptionalformattedDurationDifference?: string

  How much longer or shorter the route takes than the selected one, formatted, such as +6 min or -3 min.

  Remarks

  Absent on the selected route, and where both durations round to the same minute. It is the difference of the rounded durations, so it matches the durations the bubbles show.

• OptionalformattedTraffic?: string

  The route's formatted traffic delay.

  Remarks

  It is the summary's trafficDelayInSeconds, the delay of the traffic events along the route. It is absent when that delay rounds to under a minute or the routing service did not send it.

  Example

  formattedTraffic: '5 min'
  formattedTraffic: '1 hr 15 min'
  formattedTraffic: undefined  // No delay
  Copy

• OptionalmagnitudeOfDelay?: DelayMagnitude

  The route's overall delay magnitude: the worst minor, moderate or major of its traffic sections.

  Remarks

  Absent when the route has no traffic section of a known magnitude, or carries no traffic sections at all. Use it to colour-code delays or show visual indicators in a UI.

  Example

  magnitudeOfDelay: 'moderate'
  Copy

• Optionaltitle?: string

  What a SummaryBubbleLabelConfig.title function returned for this route, which the bubble writes in place of its fields.