Navigator class abstract

This class provides the basic navigation functionality.

It provides notifications about current map-matched location updates (see NavigableLocation). And, if a route has been set, about the route progress (see RouteProgress), route deviations (see RouteDeviation) and maneuver notifications (see EventTextListener).

All transport modes are supported for turn-by-turn navigation, except for public transit. Public transit routes may lead to unsafe and unexpected results.

Navigation support for bus routes can be sometimes a bit limited and bus lane assistance and turn-by-turn bus instructions may not be as appropriate as expected.

The TransportMode is determined from the provided Route instance, but the actual SectionTransportMode can vary along a route, for example, when a ferry must be taken. When no route is set, the NavigableLocation assumes a drive scenario.

This class continuously reacts to new locations provided from a location source and acts as a LocationListener. The accuracy of the positioning increases with the update frequency. At least one update per second should be provided. More information can be found at LocationAccuracy.NAVIGATION.

Note: Even without provided locations, for example, while driving through a tunnel, this class can interpolate missing location events and still send NavigableLocation, RouteProgress and maneuver notifications.

Implemented types

NavigatorInterface

Constructors

Navigator(): Creates a new instance of this class.
factory
Navigator.withEngine(SDKNativeEngine sdkEngine): Creates a new instance of this class.
factory

Properties

borderCrossingWarningListener ↔ BorderCrossingWarningListener?: Object to receive notifications about border crossings on the current road. Border crossing notifications are given only if a route is present. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener to receive notifications about border crossings on the current road.
getter/setter pairinherited
borderCrossingWarningOptions ↔ BorderCrossingWarningOptions: Border crossing warning options to be passed to BorderCrossingWarningListener. These options allow the filtering of the border crossing warnings received and set the notification distances. Gets border crossing warning options to be passed to BorderCrossingWarningListener.
getter/setter pairinherited
currentSituationLaneAssistanceViewListener ↔ CurrentSituationLaneAssistanceViewListener?: Object to receive current situation lane assistance view notifications. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener to receive current situation lane assistance view notifications.
getter/setter pairinherited
dangerZoneWarningListener ↔ DangerZoneWarningListener?: Object to receive notification on approaching danger zones. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener to receive current danger zones notifications.
getter/setter pairinherited
destinationReachedListener ↔ DestinationReachedListener?: Object to receive the notification about the arrival at the destination. Destination reached notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener that notify when the destination has been reached.
getter/setter pairinherited
environmentalZoneWarningListener ↔ EnvironmentalZoneWarningListener?: Object to receive notification on approaching environmental zones. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener to receive current environmental zones notifications.
getter/setter pairinherited
eventTextListener ↔ EventTextListener?: Object to receive text notifications when they are available. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Note: In order to receive the text notification emitted for the traffic merge warner, when TrafficMergeWarningOptions.enable_text_notification has been enabled, the sdk.navigation.EventTextListener must be enabled as well. Gets the listener that notifies when a text notification is available.
getter/setter pairinherited
eventTextOptions ↔ EventTextOptions: Options used for text notifications. Notifications are only available if a route is present. Gets the text notification options.
getter/setter pairinherited
hashCode → int: The hash code for this object.
no setterinherited
isEnableTunnelExtrapolation ↔ bool: Defines whether to enable or disable tunnel extrapolation. By default the tunnel extrapolation is enabled. Return true if tunnel extrapolation is enabled otherwise false.
getter/setter pairinherited
isPassthroughWaypointsHandlingEnabled ↔ bool: Defines whether to enable or disable handling of passthrough waypoints. By default the handling of passthrough waypoints is disabled. Return true if handling of passthrough waypoints is enabled, otherwise - false.
getter/setter pairinherited
junctionViewLaneAssistanceListener ↔ JunctionViewLaneAssistanceListener?: Object to receive junction view lane assistance notifications. Junction view lane assistance notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener to receive junction view lane assistance notifications.
getter/setter pairinherited
lowSpeedZoneWarningListener ↔ LowSpeedZoneWarningListener?: Object to receive notifications about low speed zones on the current road. Low speed zone notifications are given regardless if a route is set. This listener is currently available only for Japan. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener to receive notifications about low speed zones on the current road.
getter/setter pairinherited
maneuverNotificationOptions ↔ ManeuverNotificationOptions: Options used for maneuver notifications. Notifications are only available if a route is present. Gets the maneuver notification options.
getter/setter pairinherited
maneuverViewLaneAssistanceListener ↔ ManeuverViewLaneAssistanceListener?: Object to receive maneuver view lane assistance notifications. Maneuver view lane assistance notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener to receive maneuver view lane assistance notifications.
getter/setter pairinherited
milestoneStatusListener ↔ MilestoneStatusListener?: Object to receive notifications about the arrival at each Milestone or missing it. It informs on all waypoints (passed or missed) that are of type MilestoneType.stopover but excludes the starting waypoint. Waypoints of type MilestoneType.passthrough are excluded, by default, but can be included via NavigatorInterface.isPassthroughWaypointsHandlingEnabled. Milestone status notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener that notifies when a Milestone has been reached or missed.
getter/setter pairinherited
navigableLocationListener ↔ NavigableLocationListener?: Object to receive notifications about the current location. It returns null when no listener is set by an user. Gets the listener that notifies current location updates.
getter/setter pairinherited
offRoadDestinationReachedListener ↔ OffRoadDestinationReachedListener?: Object to receive the notification about the arrival at the off-road destination. Off-road destination reached notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener that notifies when the off-road destination has been reached.
getter/setter pairinherited
offRoadProgressListener ↔ OffRoadProgressListener?: Object to receive the notification about the off-road progress. Off-road progress notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener that notifies about off-road progress.
getter/setter pairinherited
postActionListener ↔ PostActionListener?: Object to receive post action notifications, such as a charge action at a charging station. Post actions notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener to receive post action notifications, such as a charge action at a charging station.
getter/setter pairinherited
railwayCrossingWarningListener ↔ RailwayCrossingWarningListener?: Object to receive notifications about railway crossings on the current road. Railway crossing notifications are given regardless if a route is set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener to receive notifications about railway crossings on the current road.
getter/setter pairinherited
realisticViewWarningListener ↔ RealisticViewWarningListener?: Object to receive notifications about junction views on the current road. Setting null value to the listener will unset the listener. This feature requires a map version greater or equal to 67 in order to function properly. It returns null when no listener is set by an user. Gets the listener to receive notifications about junction views on the current road.
getter/setter pairinherited
realisticViewWarningOptions ↔ RealisticViewWarningOptions: Realistic view warning options. It allow to filter realistic views to be passed to RealisticViewWarningListener.
getter/setter pairinherited
roadAttributesListener ↔ RoadAttributesListener?: Object to receive notifications about attributes of the current road. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener to receive notifications about attributes of the current road.
getter/setter pairinherited
roadSignWarningListener ↔ RoadSignWarningListener?: Object to receive notifications about road signs on the current road. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener to receive notifications about road signs on the current road.
getter/setter pairinherited
roadSignWarningOptions ↔ RoadSignWarningOptions: Road sign warning options that allow to filter road sings to be passed to RoadSignWarningListener. Gets road sign warning options that allow to filter road signs to be passed to RoadSignWarningListener.
getter/setter pairinherited
roadTextsListener ↔ RoadTextsListener?: Object to receive notifications about the textual attributes of the current road. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener to receive notifications about the textual attributes of the current road.
getter/setter pairinherited
route ↔ Route?: The route to navigate. Gets and sets the route that is being navigated. If not set, only the current location information will be provided through NavigableLocationListener. If set, both route progress (RouteProgressListener) and route deviation (RouteDeviationListener) will receive notifications on updates. A route may fail to be set if it is generated by an incompatible engine, in which case the operation has no effect. Gets the route that is being navigated.
getter/setter pairinherited
routeDeviationListener ↔ RouteDeviationListener?: Object to receive notifications about deviations from the route if any occurs. Route deviation notifications only occurs if a route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener that notifies when deviation from the route is observed.
getter/setter pairinherited
routeProgressListener ↔ RouteProgressListener?: Object to receive notifications about navigation route progress. Route progress notifications only occurs if the route has been set. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener that notifies when a route progress change occurs.
getter/setter pairinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
safetyCameraWarningListener ↔ SafetyCameraWarningListener?: Object to receive safety camera warner notifications. If a listener is present, notifications about safety speed cameras will be also sent via SafetyCameraWarningListener. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener to receive safety camera warning notifications.
getter/setter pairinherited
safetyCameraWarningOptions ↔ SafetyCameraWarningOptions: Safety camera warning options to be passed to SafetyCameraWarningListener. These options allow the enabling or disabling the text notification for the warner. Gets safety camera warning options to be passed to SafetyCameraWarningListener.
getter/setter pairinherited
schoolZoneWarningListener ↔ SchoolZoneWarningListener?: Object to receive notifications about school zones on the current road. Setting null value to the listener will unset the listener. school zones on the current road. It returns null when no listener is set by an user. Gets the listener to receive notifications about school zones on the current road.
getter/setter pairinherited
schoolZoneWarningOptions ↔ SchoolZoneWarningOptions: School zone warning options It allow to configure school zone notifications to be passed to SchoolZoneWarningListener. Gets school zone warning options that allow to configure school zone notifications to be passed to SchoolZoneWarningListener.
getter/setter pairinherited
speedLimitListener ↔ SpeedLimitListener?: Object to receive notifications about the speed limit of the current road. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener to receive notifications about the speed limit of the current road.
getter/setter pairinherited
speedWarningListener ↔ SpeedWarningListener?: Object to receive notifications when a speed limit on a road is exceeded or driving speed is restored back to normal. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener to receive notifications when a speed limit on a road is exceeded or driving speed is restored back to normal.
getter/setter pairinherited
speedWarningOptions ↔ SpeedWarningOptions: Options used for the speed warning feature. Gets the speed warning options.
getter/setter pairinherited
tollStopWarningListener ↔ TollStopWarningListener?: Object to receive information on the upcoming toll stop. Setting null value to the listener will unset the listener. This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process. Gets the listener to receive notifications about the the upcoming toll stop.
getter/setter pairinherited
trackingTransportProfile ↔ TransportProfile?: Defines the transport profile for the Navigator, when no route is present. Properly setting the transport profile optimizes the navigation experience, and improves resource consumption. For example, a TransportProfile can be defined with a VehicleProfile. A vehicle profile can have several parameters such as VehicleType to set the source of information describing the vehicle. The default is a VehicleType.car profile.
getter/setter pairinherited
trafficMergeWarningListener ↔ TrafficMergeWarningListener?: Object to receive notifications about merging traffic to the current road. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener to receive notifications about merging traffic to the current road.
getter/setter pairinherited
trafficMergeWarningOptions ↔ TrafficMergeWarningOptions: Merging traffic warning options that allow to configure merging traffic notifications to be passed to TrafficMergeWarningListener. Gets merging traffic warning options that allow to configure merging traffic notifications to be passed to TrafficMergeWarningListener.
getter/setter pairinherited
trafficOnRoute ↔ TrafficOnRoute?: Traffic information for the current route. This impacts RouteProgress updates as the duration of the SectionProgress might change. However, the remaining distance and the route geometry will remain unchanged. Gets the traffic information for the current route.
getter/setter pairinherited
truckRestrictionsWarningListener ↔ TruckRestrictionsWarningListener?: Object to receive notifications about truck restrictions on the current road. Setting null value to the listener will unset the listener. It returns null when no listener is set by an user. Gets the listener to receive notifications about truck restrictions on the current road.
getter/setter pairinherited
truckRestrictionsWarningOptions ↔ TruckRestrictionsWarningOptions: Truck restrictions warning options that allow to filter truck restrictions to be passed to TruckRestrictionsWarningListener. Gets truck restrictions warning options that allow to filter truck restrictions to be passed to TruckRestrictionsWarningListener.
getter/setter pairinherited

Methods

calculateRemainingDistanceInMeters(GeoCoordinates coordinates) → int?: This method calculates the distance between the current position and given coordinates.
inherited
getManeuver(int index) → Maneuver?: Returns maneuver at the given index.
inherited
getManeuverNotificationTimingOptionsWithTimingProfile(TransportMode transportMode, TimingProfile timingProfile) → ManeuverNotificationTimingOptions: Returns maneuver notification timing options with default values given the combination of transport mode and timing profile.
inherited
getWarningNotificationDistances(WarningType warningType) → WarningNotificationDistances: Returns the warning notification distances for the requested warning type.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
onLocationUpdated(Location location) → void: Called each time a new location is available.
inherited
repeatLastManeuverNotification() → void: Call of this function is used to trigger the navigator to repeat the last maneuver notification based on the current position.
inherited
setCustomOption(String key, String value) → void: This method sets custom options that controls navigator behavior.
inherited
setManeuverNotificationTimingOptionsWithTimingProfile(TransportMode transportMode, TimingProfile timingProfile, ManeuverNotificationTimingOptions options) → bool: Set timing option values for the combination of transport mode and timing profile.
inherited
setWarningNotificationDistances(WarningType warningType, WarningNotificationDistances warningNotificationDistances) → bool: Set the warning notification distances for the specified warning types.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

getAvailableLanguagesForManeuverNotifications() → List<LanguageCode>: Returns the list of languages for maneuver notification currently available in the SDK.