RouteInstruction class
Route instruction class
This class should not be instantiated directly. Instead, use the RouteSegment.instructions to retrieve a list of route instructions.
It represents a single step (turn, exit, follow‑road, etc.) and carries the localized text and media needed to present visual cues, signposts or voice prompts; instances are obtained from segment instruction lists rather than constructed directly.
Holds geographic context and country info, localized instruction and signpost text, image assets for turn and realistic visuals, remaining/traveled time & distance metrics, and structured road metadata plus simple flags for special cases (exit, ferry, toll, common vs. non‑common). Common tasks are reading texts and metrics for display, fetching images for the UI, inspecting road metadata for styling or filtering, converting to more specific instruction variants when applicable.
Also see the NavigationInstruction class which provides turn-by-turn navigation instructions.
- Inheritance
-
- Object
- RouteInstructionBase
- RouteInstruction
Properties
- coordinates → Coordinates
-
Get coordinates for this route instruction.
no setterinherited
- countryCodeISO → String
-
Get ISO 3166-1 alpha-3 country code for the navigation instruction.
no setterinherited
- exitDetails → String
-
Get the exit route instruction text.
no setterinherited
- followRoadInstruction → String
-
Get textual description for the follow road information.
no setterinherited
- hasFollowRoadInfo → bool
-
Check if follow road information is available.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasRoadInfo → bool
-
Check if road information is available.
no setterinherited
- hasSignpostInfo → bool
-
Check if signpost information is available.
no setterinherited
- hasTurnInfo → bool
-
Check if turn information is available.
no setterinherited
- isCommon → bool
-
Check if this instruction is of common type.
no setterinherited
- isExit → bool
-
Check if the route instruction is a main road exit instruction.
no setterinherited
- isFerry → bool
-
Check if the route instruction is a ferry.
no setterinherited
- isTollRoad → bool
-
Check if the route instruction is a toll road.
no setterinherited
- pointerId → int
-
no setterinherited
- realisticNextTurnImg → AbstractGeometryImg
-
Get the image of the realistic next turn image
no setterinherited
- remainingTravelTimeDistance → TimeDistance
-
Get remaining travel distance in meters and remaining travel time in seconds.
no setterinherited
- remainingTravelTimeDistanceToNextWaypoint → TimeDistance
-
Get remaining travel time in seconds to the next way point and the remaining travel distance in meters to the next way point.
no setterinherited
-
roadInfo
→ List<
RoadInfo> -
Get road information.
no setterinherited
- roadInfoImg → RoadInfoImg
-
Get the image of the road info
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- signpostDetails → SignpostDetails
-
Get extended signpost details.
no setterinherited
- signpostInstruction → String
-
Get textual description for the signpost information.
no setterinherited
- timeDistanceToNextTurn → TimeDistance
-
Get distance to the next turn in meters, time in seconds.
no setterinherited
- traveledTimeDistance → TimeDistance
-
Get the traveled distance in meters and the traveled time in seconds.
no setterinherited
- turnDetails → TurnDetails
-
Get full details for the turn.
no setterinherited
- turnImg → Img
-
Get the turn image
no setterinherited
- turnInstruction → String
-
Get textual description for the turn.
no setterinherited
Methods
-
dispose(
) → void -
inherited
-
getRealisticNextTurnImage(
{Size? size, ImageFileFormat? format, AbstractGeometryImageRenderSettings renderSettings = const AbstractGeometryImageRenderSettings()}) → Uint8List? -
Get image for the realistic turn information.
inherited
-
getRoadInfoImage(
{Size? size, ImageFileFormat? format, Color backgroundColor = Colors.transparent}) → Uint8List? -
Get road image.
inherited
-
getTurnImage(
{Size? size, ImageFileFormat? format}) → Uint8List? -
Get turn image.
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
-
toEVRouteInstruction(
) → EVRouteInstruction - Convert to a EVRouteInstruction from this one.
-
toPTRouteInstruction(
) → PTRouteInstruction? - Convert to a PTRouteInstruction from this one.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited