RouteInstructionBase class Route

A single route instruction used for route guidance.

RouteInstructionBase models one maneuver (for example, a turn, exit or follow-road instruction). It exposes the instruction location, localized text, images (turn images and realistic intersection renderings), signpost details and time/distance metrics used to present guidance to users and in UI lists. Instances are obtained from RouteSegment.instructions and should not be constructed directly.

For real-time turn-by-turn updates use NavigationInstruction which is produced during navigation.

See also:

Implementers

Properties

coordinates → Coordinates
Location coordinates for this instruction.
no setter
countryCodeISO → String
ISO 3166-1 alpha-3 country code for the instruction location.
no setter
exitDetails → String
Exit instruction text when this instruction is an exit.
no setter
followRoadInstruction → String
Localized textual description for follow-road guidance associated with this instruction.
no setter
hasFollowRoadInfo → bool
Whether follow-road guidance information is available for this instruction.
no setter
hashCode → int
The hash code for this object.
no setterinherited
hasRegisteredAutoReleaseObject ↔ bool
getter/setter pairinherited
hasRoadInfo → bool
Whether road information (names, shields) is available for this instruction.
no setter
hasSignpostInfo → bool
Whether signpost information is available for this instruction.
no setter
hasTurnInfo → bool
Whether detailed turn information is available for this instruction.
no setter
isCommon → bool
Whether this instruction belongs to a common-type segment (see RouteSegment.isCommon).
no setter
isExit → bool
Whether this instruction represents a main-road exit maneuver.
no setter
isFerry → bool
Whether this instruction involves a ferry crossing.
no setter
isTollRoad → bool
Whether this instruction involves a tolled road.
no setter
pointerId → int
The pointer ID of the native object
no setterinherited
realisticNextTurnImg → AbstractGeometryImg
Get the vectorial representation for the realistic next turn image as a AbstractGeometryImg.
no setter
remainingTravelTimeDistance → TimeDistance
Remaining travel time and distance from this instruction to the route end.
no setter
remainingTravelTimeDistanceToNextWaypoint → TimeDistance
Remaining time/distance to the next waypoint from this instruction.
no setter
roadInfo → List<RoadInfo>
Road information associated with this instruction (name, shield, attributes).
no setter
roadInfoImg → RoadInfoImg
Get the signpost image as a RoadInfoImg.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
signpostDetails → SignpostDetails
Detailed signpost information associated with this instruction.
no setter
signpostInstruction → String
Localized text description for signpost guidance.
no setter
timeDistanceToNextTurn → TimeDistance
Distance and time to the next turn from this instruction.
no setter
traveledTimeDistance → TimeDistance
Distance/time metrics already traveled up to this instruction.
no setter
turnDetails → TurnDetails
Detailed information describing the upcoming turn.
no setter
turnImg → Img
Vector image representation of the turn symbol as an Img.
no setter
turnInstruction → String
Localized textual instruction for the turn.
no setter

Methods

dispose() → void
Disposes the native object.
inherited
getRealisticNextTurnImage({Size? size, ImageFileFormat? format, AbstractGeometryImageRenderSettings renderSettings = const AbstractGeometryImageRenderSettings()}) → Uint8List?
Retrieve a rasterized image for the realistic next-turn rendering.
getRoadInfoImage({Size? size, ImageFileFormat? format, Color backgroundColor = Colors.transparent, bool allowResize = false}) → Uint8List?
Retrieve a raster image representing the road information (e.g., shield or icon).
getTurnImage({Size? size, ImageFileFormat? format}) → Uint8List?
Retrieve a raster image representing the turn symbol.
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