RouteBase class abstract Routes & Navigation

RouteBase defines the common API surface for computed routes. It exposes geometry, time/distance metrics, terrain profiles, segments, instructions, traffic and toll information, and helpers to export or sample route data.

This class is abstract and should not be instantiated directly. Use RoutingService.calculateRoute to obtain concrete route instances of type Route.

See also:

Implementers

Constructors

RouteBase()

Properties

dominantRoads → List<String>
Dominant road names along the route.
no setter
geographicArea → RectangleGeographicArea
The geographic bounding rectangle that encloses the route.
no setter
hasFerryConnections → bool
Whether the route includes ferry connections.
no setter
hashCode → int
The hash code for this object.
no setterinherited
hasRegisteredAutoReleaseObject ↔ bool
getter/setter pairinherited
hasTollRoads → bool
Whether the route contains toll roads.
no setter
incursCosts → bool
Whether traveling this route may incur monetary costs (for example tolls).
no setter
pointerId → int
The pointer ID of the native object
no setterinherited
polygonGeographicArea → PolygonGeographicArea
Polygonal geographic area covering the route.
no setter
preferences → RoutePreferences
Preferences used when the route was calculated.
no setter
routeListener ↔ RouteListener?
Returns the currently attached RouteListener, if any.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
segments → List<RouteSegment>
List of segments that make up the route.
no setter
status → RouteStatus
Current status of the route calculation.
no setter
summary → String
Short textual summary of the route.
no setter
terrainProfile → RouteTerrainProfile?
Route terrain elevation profile, if available.
no setter
tilesGeographicArea → TilesCollectionGeographicArea
Geographic area of the route represented as a tiles collection.
no setter
tollSections → List<TollSection>
A list of tolled sections that occur along the route.
no setter
trafficEvents → List<RouteTrafficEvent>
Traffic events that affect this route (delays, closures, etc.).
no setter

Methods

clearRouteListener() → void
Remove any previously attached RouteListener.
dispose() → void
Disposes the native object.
inherited
exportAs(PathFileFormat format) → String
Export route data in a standard file format.
getClosestSegment(Coordinates coord) → int
Find the index of the route segment nearest to coord.
getCoordinateOnRoute(int distance) → Coordinates
Returns the coordinate located at distance metres from the route start.
getDistanceOnRoute(Coordinates coords, bool activePart) → int
Returns the route distance (meters) from departure at the given coords.
getPath(int start, int end) → Path?
Build a Path covering the route between start and end distances.
getTimeDistance({bool activePart = true}) → TimeDistance
Returns time and distance metrics for the route or a segment.
getTimeDistanceCoordinateOnRoute(Coordinates coordinates) → TimeDistanceCoordinate
Find the time-distance coordinate nearest to a reference coordinates.
getTimeDistanceCoordinates({required int start, required int end, required int step, required StepType stepType}) → List<TimeDistanceCoordinate>
Build a timestamped list of coordinates sampled along the route.
getWaypoints({GetWaypointsOptions options = GetWaypointsOptions.remainingInitial}) → List<Landmark>
Retrieve the route's waypoints.
getWaypointsVia(Landmark landmark) → List<Landmark>
Produce a new waypoint list inserting landmark into the remaining route waypoints.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerAutoReleaseObject(int pointerId) → void
Registers an object for auto release.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited