Route class Route
A computed navigable route.
Represents a complete route result produced by the routing engine. A Route bundles geometry, metrics, metadata and child objects (segments, instructions, traffic events, toll sections, etc.) used for rendering, analysis and navigation.
Routes are not instantiated directly — use RoutingService.calculateRoute to obtain route instances. Routes can be displayed using a MapViewRoutesCollection from a GemMapController and used for turn-by-turn navigation with NavigationService.
See also:
- RoutingService.calculateRoute - Compute routes from List<Landmark>
- MapViewRoutesCollection - Display routes on the map.
- NavigationService - Navigate along the computed route.
- AlarmService - Get notified of route events.
Properties
-
countrySections
→ List<
CountrySection> -
A list of the countries the route runs through.
no setterinherited
-
dominantRoads
→ List<
String> -
Dominant road names along the route.
no setterinherited
- extraInfo ↔ SearchableParameterList
-
Extra metadata attached to the route.
getter/setter pair
-
ferrySections
→ List<
FerrySection> -
A list of sections along the route on which the vehicle is carried over.
no setterinherited
- geographicArea → RectangleGeographicArea
-
The geographic bounding rectangle that encloses the route.
no setterinherited
- hasFerryConnections → bool
-
Whether the route includes ferry connections.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasRegisteredAutoReleaseObject ↔ bool
-
getter/setter pairinherited
- hasTollRoads → bool
-
Whether the route contains toll roads.
no setterinherited
- incursCosts → bool
-
Whether traveling this route may incur monetary costs (for example tolls).
no setterinherited
- isEVRoute → bool
-
Whether this route is designated for Electric Vehicles (EV).
no setter
- isOTRoute → bool
-
Whether this route is an Over-Track (OT) route.
no setter
- isPTRoute → bool
-
Whether this route is a Public Transport (PT) route.
no setter
- pointerId → int
-
The pointer ID of the native object
no setterinherited
- polygonGeographicArea → PolygonGeographicArea
-
Polygonal geographic area covering the route.
no setterinherited
- preferences → RoutePreferences
-
Preferences used when the route was calculated.
no setterinherited
-
restrictionSections
→ List<
RestrictionSection> -
A list of restricted sections that occur along the route.
no setterinherited
- routeListener ↔ RouteListener?
-
Returns the currently attached RouteListener, if any.
getter/setter pairinherited
- 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 setterinherited
- status → RouteStatus
-
Current status of the route calculation.
no setterinherited
- summary → String
-
Short textual summary of the route.
no setterinherited
- terrainProfile → RouteTerrainProfile?
-
Route terrain elevation profile, if available.
no setterinherited
- tilesGeographicArea → TilesCollectionGeographicArea
-
Geographic area of the route represented as a tiles collection.
no setterinherited
-
tollSections
→ List<
TollSection> -
A list of tolled sections that occur along the route.
no setterinherited
-
trafficEvents
→ List<
RouteTrafficEvent> -
Traffic events that affect this route (delays, closures, etc.).
no setterinherited
Methods
-
clearRouteListener(
) → void -
Remove any previously attached RouteListener.
inherited
-
dispose(
) → void -
Disposes the native object.
inherited
-
equals(
Route route) → bool -
Checks whether this route is equal to
route. -
exportAs(
PathFileFormat format) → String -
Export route data in a standard file format.
inherited
-
getClosestSegment(
Coordinates coord) → int -
Find the index of the route segment nearest to
coord.inherited -
getCoordinateOnRoute(
int distance) → Coordinates -
Returns the coordinate located at
distancemetres from the route start.inherited -
getDistanceOnRoute(
Coordinates coords, bool activePart) → int -
Returns the route distance (meters) from departure at the given
coords.inherited -
getPath(
int start, int end) → Path? -
Build a Path covering the route between
startandenddistances.inherited -
getTimeDistance(
{bool activePart = true}) → TimeDistance -
Returns time and distance metrics for the route or a segment.
inherited
-
getTimeDistanceCoordinateOnRoute(
Coordinates coordinates) → TimeDistanceCoordinate -
Find the time-distance coordinate nearest to a reference
coordinates.inherited -
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.
inherited
-
getWaypoints(
{GetWaypointsOptions options = GetWaypointsOptions.remainingInitial}) → List< Landmark> -
Retrieve the route's waypoints.
inherited
-
getWaypointsVia(
Landmark landmark) → List< Landmark> -
Produce a new waypoint list inserting
landmarkinto the remaining route waypoints.inherited -
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
-
toOTRoute(
) → OTRoute? - Converts this route to an OTRoute when applicable.
-
toPTRoute(
) → PTRoute? - Converts this route to a PTRoute when applicable.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited