RouteBase class abstract
Route Base interface
This class should not be instantiated directly. Instead, use the RoutingService.calculateRoute to retrieve a list of routes.
It provides mechanisms to export route data in standard formats, sample coordinates and distances along the path, obtain time/distance metrics and terrain profiles, inspect route geometry (bounding box and polygon), and enumerate segments, instructions and traffic events for rendering or analysis.
Provides access to a RouteSegment list. It is implemented within the Route, PTRoute, OTRoute classes.
Constructors
Properties
-
dominantRoads
→ List<
String> -
Get dominant road names
no setter
- geographicArea → RectangleGeographicArea
-
Get geographic area of the route. The geographic area is the smallest rectangle that can be drawn around the route.
no setter
- hasFerryConnections → bool
-
Check if the route contains ferry connections.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasTollRoads → bool
-
Check if the route contains toll roads.
no setter
- incursCosts → bool
-
Method to check if traveling the route or route segment incurs cost to the user.
no setter
- pointerId → dynamic
-
no setter
- polygonGeographicArea → PolygonGeographicArea
-
Get polygon area of the route.
no setter
- preferences → RoutePreferences
-
Get the route preferences.
no setter
- routeListener ↔ RouteListener?
-
Get route related events listener.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
segments
→ List<
RouteSegment> -
Get route segments.
no setter
- status → RouteStatus
-
Get route status.
no setter
- summary → String
-
Get the summary of the route.
no setter
- terrainProfile → RouteTerrainProfile?
-
Get route terrain profile.
no setter
- tilesGeographicArea → TilesCollectionGeographicArea
-
Get tiles collection area of the route.
no setter
-
trafficEvents
→ List<
RouteTrafficEvent> -
Get list of traffic events affecting the route.
no setter
Methods
-
clearRouteListener(
) → void - Clear the route listener, removing any previously set listener for route-related events.
-
exportAs(
PathFileFormat format) → String - Export route data in the requested data format.
-
getClosestSegment(
Coordinates coord) → int - Get index of the closest route segment to the given coordinates.
-
getCoordinateOnRoute(
int distance) → Coordinates - Get a coordinate on route at the given distance from the departure / starting point.
-
getDistanceOnRoute(
Coordinates coords, bool activePart) → int - Get route distance from departure at the given coordinate.
-
getPath(
int start, int end) → Path? - Build path from route start - end segment.
-
getTimeDistance(
{bool activePart = true}) → TimeDistance - Get length in meters and estimated travel time in seconds for the route / route segment.
-
getTimeDistanceCoordinateOnRoute(
Coordinates coordinates) → TimeDistanceCoordinate - Get a time-distance coordinate on route closest to the given reference coordinate.
-
getTimeDistanceCoordinates(
{required int start, required int end, required int step, required StepType stepType}) → List< TimeDistanceCoordinate> - Build a list of timestamp coordinates from a route.
-
getWaypoints(
{GetWaypointsOptions options = GetWaypointsOptions.remainingInitial}) → List< Landmark> - Get list of route waypoints.
-
getWaypointsVia(
Landmark landmark) → List< Landmark> - Get a new waypoints configuration using the given intermediate via waypoint.
-
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