Route class
Route class
This class should not be instantiated directly. Instead, use the RoutingService.calculateRoute to retrieve a list of routes.
A concrete representation of a computed route that combines rich metadata, geometry and child objects for rendering, navigation and analysis. It models a full route result.
Common operations include operations available from RouteBase and converting the instance into a more specific route subtype when that category applies, and reading or updating auxiliary metadata attached to the route.
Can be presented on the map using the MapViewRoutesCollection associated with a GemMapController. Can be used for navigation using the NavigationService.
Properties
-
dominantRoads
→ List<
String> -
Get dominant road names
no setterinherited
- extraInfo ↔ SearchableParameterList
-
Get the route's extra information.
getter/setter pair
- geographicArea → RectangleGeographicArea
-
Get geographic area of the route. The geographic area is the smallest rectangle that can be drawn around the route.
no setterinherited
- hasFerryConnections → bool
-
Check if the route contains ferry connections.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasTollRoads → bool
-
Check if the route contains toll roads.
no setterinherited
- incursCosts → bool
-
Method to check if traveling the route or route segment incurs cost to the user.
no setterinherited
- isEVRoute → bool
-
Check if route is an Electric Vehicle Route
no setter
- isOTRoute → bool
-
Check if route is an Over Track Route
no setter
- isPTRoute → bool
-
Check if route is a Public Transport Route
no setter
- pointerId → int
-
no setterinherited
- polygonGeographicArea → PolygonGeographicArea
-
Get polygon area of the route.
no setterinherited
- preferences → RoutePreferences
-
Get the route preferences.
no setterinherited
- routeListener ↔ RouteListener?
-
Get route related events listener.
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
segments
→ List<
RouteSegment> -
Get route segments.
no setterinherited
- status → RouteStatus
-
Get route status.
no setterinherited
- summary → String
-
Get the summary of the route.
no setterinherited
- terrainProfile → RouteTerrainProfile?
-
Get route terrain profile.
no setterinherited
- tilesGeographicArea → TilesCollectionGeographicArea
-
Get tiles collection area of the route.
no setterinherited
-
tollSections
→ List<
TollSection> -
Get a list of toll sections on the route.
no setterinherited
-
trafficEvents
→ List<
RouteTrafficEvent> -
Get list of traffic events affecting the route.
no setterinherited
Methods
-
clearRouteListener(
) → void -
Clear the route listener, removing any previously set listener for route-related events.
inherited
-
dispose(
) → void -
inherited
-
equals(
Route route) → bool - Comparison operator equal.
-
exportAs(
PathFileFormat format) → String -
Export route data in the requested data format.
inherited
-
getClosestSegment(
Coordinates coord) → int -
Get index of the closest route segment to the given coordinates.
inherited
-
getCoordinateOnRoute(
int distance) → Coordinates -
Get a coordinate on route at the given distance from the departure / starting point.
inherited
-
getDistanceOnRoute(
Coordinates coords, bool activePart) → int -
Get route distance from departure at the given coordinate.
inherited
-
getPath(
int start, int end) → Path? -
Build path from route start - end segment.
inherited
-
getTimeDistance(
{bool activePart = true}) → TimeDistance -
Get length in meters and estimated travel time in seconds for the route / route segment.
inherited
-
getTimeDistanceCoordinateOnRoute(
Coordinates coordinates) → TimeDistanceCoordinate -
Get a time-distance coordinate on route closest to the given reference coordinate.
inherited
-
getTimeDistanceCoordinates(
{required int start, required int end, required int step, required StepType stepType}) → List< TimeDistanceCoordinate> -
Build a list of timestamp coordinates from a route.
inherited
-
getWaypoints(
{GetWaypointsOptions options = GetWaypointsOptions.remainingInitial}) → List< Landmark> -
Get list of route waypoints.
inherited
-
getWaypointsVia(
Landmark landmark) → List< Landmark> -
Get a new waypoints configuration using the given intermediate via waypoint.
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? - Convert to a OTRoute from this one.
-
toPTRoute(
) → PTRoute? - Convert to a PTRoute from this one.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited