google_navigation_flutter library

Classes

AndroidNavigationSessionAPIImpl

AutoMapOptions

Configuration options for Android Auto and CarPlay map views.

AutoScreenAvailabilityChangedEvent

CameraChangedEvent

Represents camera changed events in a Google Maps view.

CameraPosition

Represents the camera position in a Google Maps view.

CameraUpdate

Defines a camera move, supporting absolute moves as well as moves relative the current position.

Circle

Circle that has beed added to map.

CircleClickedEvent

Event emitted when a circle is clicked.

CircleOptions

Defines CircleOptions for a circle.

ContinueToNextDestinationResponse

Response returned by GoogleMapsNavigator.continueToNextDestination.

CustomNavigationAutoEvent

DashPattern

Class representing a dash used in the stroke pattern for a Polyline or the outline of a Polygon or Circle.

Destinations

Destinations main type.

DotPattern

Class representing a dot used in the stroke pattern for a Polyline or the outline of a Polygon or Circle.

GapPattern

Class representing a gap used in the stroke pattern for a Polyline or the outline of a Polygon or Circle.

GoogleMapsAutoViewController

GoogleMapsBaseMapView

The base view for map view and navigation view. Not to be used by itself.

GoogleMapsMapView

The main map view widget for Google Maps Map View.

GoogleMapsMapViewState

Google Maps Map View.

GoogleMapsNavigationView

The main map view widget for Google Maps Navigation.

GoogleMapsNavigationViewState

Google Maps Navigation.

GoogleMapsNavigator

GoogleMapsNavigator handles general actions of the navigation SDK and allows creating navigation session controller.

GoogleMapViewController

Map View Controller class to handle map view events.

GoogleNavigationViewController

Navigation View Controller class to handle navigation view events.

GpsAvailabilityChangeEvent

GpsAvailabilityChange event message (Android only).

GpsAvailabilityUpdatedEvent

GpsAvailabilityUpdated event message (Android only).

ImageDescriptor

Defines an image. For marker this class can be used to set the image of the marker icon.

IndoorActiveLevelChangedEvent

Event emitted when active indoor level changes.

IndoorBuilding

Represents focused indoor building metadata.

IndoorFocusedBuildingChangedEvent

Event emitted when focused indoor building changes.

IndoorLevel

Represents one indoor level in a focused indoor building.

InfoWindow

Text labels for Marker info window.

Lane

Single lane on the road at the end of a route step.

LaneDirection

One of the possible directions from a lane at the end of a route step, and whether it is on the recommended route.

LatLng

LatLng coordinate object.

LatLngBounds

LatLngBounds bounds object.

MapClickEvent

Represents the click position in a Google Maps view.

MapLongClickEvent

Represents the long click position in a Google Maps view.

MapOptions

Encapsulates the initial configuration required to initialize the google map view.

MapViewInitializationOptions

Encapsulates the initial configuration required to initialize the navigation map view.

MapViewState<T extends GoogleMapsBaseMapView>

Marker

Marker that has beed added to the map.

MarkerAnchor

Specifies the anchor to be at a particular point in the marker image.

MarkerDragEvent

Marker drag event sent from platform side.

MarkerEvent

Marker event sent from platform side.

MarkerOptions

Defines MarkerOptions for a marker.

MyLocationButtonClickedEvent

My location button clicked event.

MyLocationClickedEvent

My location clicked event.

NavigationAudioGuidanceSettings

Navigation audio guidance settings.

NavigationDisplayOptions

Display options.

NavigationHeaderStylingOptions

Styling options for the native navigation header.

NavigationTimeAndDistance

Time and distance to next waypoint.

NavigationUIEnabledChangedEvent

Represents navigation UI changed event in a view.

NavigationViewOptions

Encapsulates the initial configuration required to initialize the navigation view.

NavigationViewRecenterButtonClickedEvent

Navigation view recenter clicked event.

NavigationViewUISettings

Settings for the user interface of the map.

NavigationWaypoint

Navigation waypoint with different constructors based in on type of initialization.

NavInfo

Contains information about the state of navigation, the current nav step if available, and remaining steps if available.

NavInfoEvent

NavInfo event message

OnArrivalEvent

On arrival event message

PatternItem

Item used in the stroke pattern for a Polyline or the outline of a Polygon or Circle.

PoiClickedEvent

Represents a POI click event in a Google Maps view.

PointOfInterest

Represents a point of interest (POI) on the map. POIs include parks, schools, government buildings, and businesses.

Polygon

Polygon that has beed added to map.

PolygonClickedEvent

Event emitted when a polygon is clicked.

PolygonOptions

Defines PolygonOptions for a polygon.

Polyline

Polyline that has beed added to map.

PolylineClickedEvent

Event emitted when a polyline is clicked.

PolylineOptions

Defines PolylineOptions for a polyline.

PromptVisibilityChangedEvent

Represents prompt visibility changed event in a view.

RemainingTimeOrDistanceChangedEvent

Remaining time or distance change event message.

RoadSnappedLocationUpdatedEvent

RoadSnappedLocationUpdated event message.

RoadSnappedRawLocationUpdatedEvent

RoadSnappedRawLocationUpdated event message (Android only).

RouteSegment

Navigation route segment

RouteSegmentTrafficData

Route segment traffic data.

RouteSegmentTrafficDataRoadStretchRenderingData

Route segment traffic data road strech rendering data type.

RouteTokenOptions

Provides options for routing using a route token in the Google Maps Navigation SDK.

RoutingOptions

Routing options.

SimulationOptions

Navigation simulation options.

SpeedAlertOptions

Speed alert options.

SpeedingUpdatedEvent

SpeedingUpdated event message.

StepImageGenerationOptions

Options for step image generation in turn-by-turn navigation events.

StepInfo

Information about a single step along a navigation route.

StyleSpan

Style and length of a stroke on polyline.

StyleSpanStrokeStyle

Style for stroke of a polyline.

TermsAndConditionsUIParams

UI customization parameters for the Terms and Conditions dialog.

Enums

CameraEventType

Represents the event type for CameraChangedEvent.

CameraPerspective

Parameter given to parameter given to the GoogleNavigationViewController.followMyLocation to specify the orientation of the camera.

CameraUpdateType

Internal camera update type.

DrivingSide

Whether this step is on a drive-on-right or drive-on-left route.

LaneShape

A set of values that specify the shape of the road path continuing from the Lane.

Maneuver

A set of values that specify the navigation action to take.

MapColorScheme

Map color scheme mode.

MapType

Map type.

MarkerDragEventType

Marker drag event types

MarkerEventType

Marker event types

NavigationAlternateRoutesStrategy

Alternative routes strategy.

NavigationAudioGuidanceType

Navigation audio guidance type.

NavigationForceNightMode

Navigation night mode.

NavigationRouteStatus

Status of the navigation routing.

NavigationRoutingStrategy

Routing strategy.

NavigationTravelMode

Travel model for routing options.

NavigationUIEnabledPreference

Determines the initial visibility of the navigation UI on map initialization.

NavState

The state of navigation.

PatternType

Pattern used in the stroke pattern for a Polyline or the outline of a Polygon or Circle.

RegisteredImageType

Registered image type filter for clearing registered images.

RouteSegmentTrafficDataRoadStretchRenderingDataStyle

Route segment traffic data road strech rendering style.

RouteSegmentTrafficDataStatus

Traffic data statuses

SessionInitializationError

Possible errors that GoogleMapsNavigator.initializeNavigationSession can throw.

SpeedAlertSeverity

Type for speed alert severity.

StrokeJointType

Joint types for Polyline and outline of Polygon.

TaskRemovedBehavior

Determines how application should behave when a application task is removed.

TrafficDelaySeverity

Traffic delay severity.

Constants

unsupportedPlatformCode → const String

Platform code for unsupported features.

Functions

clearRegisteredImages({RegisteredImageType? filter}) → Future<void>

Remove all registered bitmaps from image registry.

convertPlatformException(Object exception, StackTrace stacktrace) → Object

Converts exception to GoogleMapsNavigationPlatformException if exception is a PlatformException.

getRegisteredImage(ImageDescriptor imageDescriptor) → Future<Image?>

Get registered PNG image data from image registry anc convert it to Image.

getRegisteredImages() → Future<List<ImageDescriptor>>

Get all registered bitmaps from image registry.

registerBitmapImage({required ByteData bitmap, double imagePixelRatio = 1.0, double? width, double? height}) → Future<ImageDescriptor>

Register bitmap image to image registry. Returns ImageDescriptor that can be used to reference the bitmap when creating MarkerOptions. bitmap is the bytes of bitmap to be registered, in PNG format. Set imagePixelRatio if bitmap is larger tha it's intended display size. For example, if image width is 64 pixels and it need's to be displayed in 32 logical pixel size, set imagePixelRatio to 2. Optionally specify wanted logical pixel size with width or height. If only width or height is specified the other dimension is scaled according to the aspect ratio of the bitmap.

unregisterImage(ImageDescriptor imageDescriptor) → Future<void>

Delete previously registered bitmap from image registry.

Typedefs

AnimationFinishedCallback = void Function(bool success)

Called when the camera animation finishes.

OnArrivalEventCallback = void Function(OnArrivalEvent onArrivalEvent)

Called during arriving to destination event.

OnCameraIdle = void Function(CameraPosition position)

Called when the camera movement has ended, there are no pending animations and the user has stopped interacting with the map.

OnCameraMove = void Function(CameraPosition position)

Called repeatedly as the camera continues to move after the OnCameraMoveStarted call. The method may be called as often as once every frame.

OnCameraMoveStarted = void Function(CameraPosition position, bool gesture)

Called when the camera starts moving after it has been idle or when the reason for the camera motion has changed.

OnCameraStartedFollowingLocation = void Function(CameraPosition position)

Called when the camera starts following current location, typically will get called in response to GoogleNavigationViewController.followMyLocation. Only applicable on Android.

OnCameraStoppedFollowingLocation = void Function(CameraPosition position)

Called when the camera stops following current location. A camera already following location will exit the follow mode if the camera is moved via user gesture or an API call, e.g. GoogleNavigationViewController.moveCamera or GoogleNavigationViewController.animateCamera. Only applicable on Android.

OnCircleClicked = void Function(String circleId)

Called during circle clicked event.

OnGpsAvailabilityChangeEventCallback = void Function(GpsAvailabilityChangeEvent gpsAvailabilityChangeEvent)

Called during GPS availability change event. (Android only).

OnGpsAvailabilityEventCallback = void Function(GpsAvailabilityUpdatedEvent gpsAvailabilityUpdatedEvent)

Called during GPS availability event. (Android only).

OnIndoorActiveLevelChanged = void Function(IndoorBuilding? building)

Called when the active indoor level changes.

OnIndoorFocusedBuildingChanged = void Function(IndoorBuilding? building)

Called when the focused indoor building changes.

OnMapClicked = void Function(LatLng position)

Called during map clicked event.

OnMapLongClicked = void Function(LatLng position)

Called during map long clicked event.

OnMapViewCreatedCallback = void Function(GoogleMapViewController controller)

On Google Map view created callback.

OnMarkerClicked = void Function(String circleId)

Called during marker click event.

OnMarkerDrag = void Function(String markerId, LatLng newPosition)

Called during marker drag event.

OnMarkerDragEnd = void Function(String markerId, LatLng newPosition)

Called during marker drag end event.

OnMarkerDragStart = void Function(String markerId, LatLng newPosition)

Called during marker drag start event.

OnMarkerInfoWindowClicked = void Function(String circleId)

Called during marker info window clicked event.

OnMarkerInfoWindowClosed = void Function(String circleId)

Called during marker info window closed event.

OnMarkerInfoWindowLongClicked = void Function(String circleId)

Called during marker info window long clicked event.

OnMyLocationButtonClicked = void Function(MyLocationButtonClickedEvent)

Called during my location button clicked event.

OnMyLocationClicked = void Function(MyLocationClickedEvent)

Called during my location clicked event.

OnNavigationUIEnabledChanged = void Function(bool success)

Called when the GoogleNavigationViewController.isNavigationUIEnabled status changes.

OnNavigationViewCreatedCallback = void Function(GoogleNavigationViewController controller)

On Google Navigation view created callback.

OnNavInfoEventCallback = void Function(NavInfoEvent onNavInfo)

Called on navigation info event.

OnNewNavigationSessionCallback = void Function()

Called on new navigation session event.

OnPoiClicked = void Function(PointOfInterest pointOfInterest)

Called when a user taps on a point of interest (POI) on the map. POIs include parks, schools, government buildings, and businesses.

OnPolygonClicked = void Function(String circleId)

Called during polygon clicked event.

OnPolylineClicked = void Function(String circleId)

Called during polyline clicked event.

OnPromptVisibilityChanged = void Function(bool success)

Called when the visibility of navigation prompts changes.

OnRecenterButtonClicked = void Function(NavigationViewRecenterButtonClickedEvent)

Called during recenter button click event.

OnRemainingTimeOrDistanceChangedEventCallback = void Function(RemainingTimeOrDistanceChangedEvent onRemainingTimeOrDistanceChangedEvent)

Called during remaining time or distance changed event.

OnReroutingEventCallback = void Function()

Called during rerouting event. (Android only)

OnRoadSnappedLocationUpdatedEventCallback = void Function(RoadSnappedLocationUpdatedEvent onRoadSnappedLocationUpdatedEvent)

Called during road snapped location event.

OnRoadSnappedRawLocationUpdatedEventCallback = void Function(RoadSnappedRawLocationUpdatedEvent onRoadSnappedRawLocationUpdatedEvent)

Called during road snapped raw location event (Android only).

OnRouteChangedEventCallback = void Function()

Called during route changed event.

OnSpeedingUpdatedEventCallback = void Function(SpeedingUpdatedEvent onSpeedingUpdatedEvent)

Called during speeding event.

OnTrafficUpdatedEventCallback = void Function()

Called during traffic updated event. (Android only)

Exceptions / Errors

CircleNotFoundException

GoogleNavigationViewController.updateCircles or GoogleNavigationViewController.removeCircles failed to find the circle given to the method.

GoogleMapsNavigationPlatformException

Abstract base class for specific platform exceptions derived from this plugin.

ImageDecodingFailedException

registerBitmapImage failed to decode bitmap from byte array.

IndoorLevelActivationException

GoogleNavigationViewController.activateIndoorLevel failed.

MapStyleException

GoogleNavigationViewController.setMapStyle failed to set the map style.

MarkerNotFoundException

GoogleNavigationViewController.updateMarkers or GoogleNavigationViewController.removeMarkers failed to find the marker given to the method.

MaxZoomRangeException

GoogleNavigationViewController.setMaxZoomPreference failed to set zoom level.

MinZoomRangeException

GoogleNavigationViewController.setMinZoomPreference failed to set zoom level.

PolygonNotFoundException

GoogleNavigationViewController.updatePolygons or GoogleNavigationViewController.removePolygons failed to find the polygon given to the method.

PolylineNotFoundException

GoogleNavigationViewController.updatePolylines or GoogleNavigationViewController.removePolylines failed to find the polyline given to the method.

ResetTermsAndConditionsException

Exception thrown by GoogleMapsNavigator.resetTermsAccepted, when attempting to reset the terms and conditions after the session has already been initialized.

RouteTokenMalformedException

GoogleMapsNavigator.setDestinations method call has failed, because the RouteTokenOptions.routeToken is malformed. (Android only)

SessionInitializationException

Exception thrown by GoogleMapsNavigator.initializeNavigationSession.

SessionNotInitializedException

GoogleMapsNavigator navigation method call has failed, because the navigation session hasn't yet been successfully initialized.

ViewNotFoundException

Exception thrown when a platform view is not found.