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

Type Alias DisplayRouteSummary

DisplayRouteSummary: Feature<Point, DisplayRouteSummaryProps>

A GeoJSON point feature with display-ready route summary props.

It represents one route summary bubble on the map, placed on the route's longest distinct section, as SummaryBubblesConfig describes.

Remarks

Use cases:

Summary bubbles along the route
Interactive route details

Example

const summaryFeature: DisplayRouteSummary = {
  type: 'Feature',
  geometry: {
    type: 'Point',
    coordinates: [4.9, 52.3]
  },
  properties: {
    id: 'route-0-summary',
    routeIndex: 0,
    routeState: 'selected',
    formattedDistance: '15 km',
    formattedDuration: '22 min'
  }
};