NavigationInstruction class
Navigation instruction class
This class should not be instantiated directly. Instead, use the related methods from a NavigationService instance.
Represents the current navigation instruction and its surrounding route context. It packages route and position context, turn and lane details, timing/distances and traffic/speed‑limit cues and images suitable for UI rendering.
Main members expose the instruction’s route reference and geographic position, structured time/distance objects, lists of road and signpost information, and image helpers for lanes and schematic turn graphics.
A new NavigationInstruction instance is provided periodically by the navigation service as the user moves.
Also see the RouteInstruction class which provides details about a specific maneuver on the route and is available as soon as the route is calculated.
Properties
- currentCountryCodeISO → String
-
Get the ISO 3166-1 alpha-3 country code for the current navigation instruction.
no setter
- currentPosition → GemPosition?
-
Get the current position.
no setter
-
currentRoadInformation
→ List<
RoadInfo> -
Get the current road information.
no setter
- currentStreetName → String
-
Get the current street name.
no setter
- currentStreetSpeedLimit → double
-
Get the maximum speed limit on the current street in meters per second.
no setter
- driveSide → DriveSide
-
Get drive side flag of the current traveled road.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasNextNextTurnInfo → bool
-
Check if next next turn information is available.
no setter
- hasNextTurnInfo → bool
-
Check if next next turn information is available.
no setter
- hasSignpostInfo → bool
-
Check if signpost information is available.
no setter
- instructionIndex → int
-
Get the index of the current route instruction on the current route segment.
no setter
- laneImg → LaneImg
-
Get the image of the lane image
no setter
-
Get the navigation session route to which the instruction belongs
no setter
-
Get the navigation/simulation status.
no setter
- nextCountryCodeISO → String
-
Get the ISO 3166-1 alpha-3 country code for the next navigation instruction.
no setter
- nextInstruction → RouteInstruction
-
Get the next route instruction on the route
no setter
- nextNextInstruction → RouteInstruction
-
Get the next-next route instruction on the route
no setter
-
nextNextRoadInformation
→ List<
RoadInfo> -
Get the next next road information.
no setter
- nextNextStreetName → String
-
Get the next next street name.
no setter
- nextNextTurnDetails → TurnDetails?
-
Get the full details for the next-next turn.
no setter
- nextNextTurnImg → Img
-
Get the image of the next next turn instruction.
no setter
- nextNextTurnInstruction → String
-
Get the textual description for the next next turn.
no setter
-
nextRoadInformation
→ List<
RoadInfo> -
Get the next road information.
no setter
- nextStreetName → String
-
Get the next next street name.
no setter
- nextTurnDetails → TurnDetails?
-
Get the full details for the next turn.
no setter
- nextTurnImg → Img
-
Get the image of the next turn instruction.
no setter
- nextTurnInstruction → String
-
Get the textual description for the next turn.
no setter
- pointerId → int
-
no setter
- previousInstruction → RouteInstruction
-
Get the previous route instruction on the route
no setter
- remainingTravelTimeDistance → TimeDistance
-
Get remaining travel time in seconds and remaining travel distance in meters to the destination.
no setter
- remainingTravelTimeDistanceToNextWaypoint → TimeDistance
-
Get remaining traveling time in seconds to the next way point and the remaining travel distance in meters to the next way point.
no setter
- returnToRouteImage → AbstractGeometryImg
-
Get the turn image to closest position on navigation route when navigation isNavigationStatus.waitingReturnToRoute state
no setter
- returnToRoutePosition → Coordinates?
-
Get closest position on navigation route when navigation is NavigationStatus.waitingReturnToRoute state
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- segmentIndex → int
-
Get the index of the current route segment.
no setter
- signpostDetails → SignpostDetails?
-
Get the extended signpost details.
no setter
- signpostInstruction → String
-
Get the textual description for the signpost information.
no setter
- timeDistanceToNextNextTurn → TimeDistance
-
Get the distance to the next-next turn in meters and time in seconds.
no setter
- timeDistanceToNextTurn → TimeDistance
-
Get the time to the next turn in seconds, distance in meters.
no setter
- traveledTimeDistance → TimeDistance
-
Get the traveled distance in meters and the traveled time in seconds.
no setter
Methods
-
dispose(
) → void -
exportAs(
{PathFileFormat fileFormat = PathFileFormat.packedGeometry}) → Uint8List - Export navigation instruction.
-
getLaneImage(
{Size? size, ImageFileFormat? format, LaneImageRenderSettings renderSettings = const LaneImageRenderSettings()}) → Uint8List? - Get an image representation of current lane configuration.
-
getNextNextTurnImage(
{Size? size, ImageFileFormat? format}) → Uint8List? - Get the schematic image of the next next turn.
-
getNextSpeedLimitVariation(
{int checkDistance = 2147483647}) → NextSpeedLimit - Get the next speed limit variation.
-
getNextTurnImage(
{Size? size, ImageFileFormat? format}) → Uint8List? - Get the schematic image of the next turn.
-
getRoadInfoImg(
List< RoadInfo> info) → Img - Get an image representation of given road info collection
-
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