Constructor Detail

• NavigationView

  NavigationView(Context context)

• NavigationView

  NavigationView(Context context, AttributeSet attrs)

• NavigationView

  NavigationView(Context context, AttributeSet attrs, int defStyleAttr)

Method Detail

• getArrivalBottomSheet

   ArrivalBottomSheet getArrivalBottomSheet()

• getCancelBottomSheet

   CancelBottomSheet getCancelBottomSheet()

• onInstructionListVisibilityChanged

   void onInstructionListVisibilityChanged(boolean visible)

  Triggered when the instruction list is shown or hidden.

  Parameters:

  visible - whether the list is shown or hidden

• onCreate

   void onCreate(@Nullable() Bundle savedInstanceState)

  Uses savedInstanceState as a cue to restore state (if not null).

  Parameters:

  savedInstanceState - to restore state if not null

• onLowMemory

   void onLowMemory()

  Low memory must be reported so the MapView can react appropriately.

• onBackPressed

   boolean onBackPressed()

  If the instruction list is showing and onBackPressed is called, hide the instruction list and do not hide the activity or fragment.

• onSaveInstanceState

   void onSaveInstanceState(@NonNull() Bundle outState)

  Used to store the bottomsheet state and re-center button visibility. As well as anything the MapView needs to store in the bundle.

  Parameters:

  outState - to store state variables

• onRestoreInstanceState

   void onRestoreInstanceState(@NonNull() Bundle savedInstanceState)

  Used to restore the bottomsheet state and re-center button visibility. As well as the MapView position prior to a configuration change.

  Parameters:

  savedInstanceState - to extract state variables

• onStart

   void onStart()

• onResume

   void onResume()

• onPause

   void onPause()

• onStop

   void onStop()

• cleanup

   void cleanup()

• afterNavigation

   void afterNavigation()

• onDestroy

   void onDestroy()

  Called to ensure the MapView is destroyed properly.

  In an Activity this should be in onDestroy().

  In a androidx.fragment.app.Fragment, this should be in onDestroyView.

• getLifecycle

  @NonNull() Lifecycle getLifecycle()

• onMapReady

   void onMapReady(@NonNull() TrimbleMapsMap trimbleMapsMap)

  Fired after the map is ready, this is our cue to finish setting up the rest of the plugins / location engine.

  Also, we check for launch data (coordinates or route).

  Parameters:

  trimbleMapsMap - used for route, camera, and location UI

• setSummaryBehaviorState

   void setSummaryBehaviorState(int state)

• setSummaryBehaviorHideable

   void setSummaryBehaviorHideable(boolean isHideable)

• isSummaryBottomSheetHidden

   boolean isSummaryBottomSheetHidden()

• resetCameraPosition

   void resetCameraPosition()

• showRecenterBtn

   void showRecenterBtn()

• hideRecenterBtn

   void hideRecenterBtn()

• isRecenterButtonVisible

   boolean isRecenterButtonVisible()

• showCancelNavigationBtn

   void showCancelNavigationBtn()

• hideCancelNavigationBtn

   void hideCancelNavigationBtn()

• showSearchButton

   void showSearchButton()

• hideSearchButton

   void hideSearchButton()

• showTripPreviewButton

   void showTripPreviewButton()

• hideTripPreviewButton

   void hideTripPreviewButton()

• showButtons

   void showButtons()

• hideButtons

   void hideButtons()

• isLandscape

   boolean isLandscape()

• show2d3dBtn

   void show2d3dBtn()

• hide2d3dBtn

   void hide2d3dBtn()

• showSoundButton

   void showSoundButton()

• hideSoundButton

   void hideSoundButton()

• isCancelNavigationButtonVisible

   boolean isCancelNavigationButtonVisible()

• drawRoutes

   void drawRoutes(@NonNull() List<DirectionsRoute> directionsRoutes)

• addMarker

   void addMarker(Point position)

• isWayNameVisible

   boolean isWayNameVisible()

  Provides the current visibility of the way name view.

• updateWayNameView

   void updateWayNameView(@NonNull() String wayName)

  Updates the text of the way name view below the navigation icon.

  If you'd like to use this method without being overridden by the default way names values we provide, please disabled auto-query with updateWaynameQueryMap.

  Parameters:

  wayName - to update the view

• setWayNameActive

   void setWayNameActive(boolean isActive)

  Set the auto-query state to provide the default way names value with updateWaynameQueryMap.

  Parameters:

  isActive - true if auto-query is enabled, false otherwise.

• setWayNameVisibility

   void setWayNameVisibility(boolean isVisible)

  Set the visibility state of the way name view.

  Parameters:

  isVisible - true if visible, false otherwise.

• retrieveWayNameText

  @NonNull() String retrieveWayNameText()

  Provides the current text of the way name view.

• takeScreenshot

   void takeScreenshot()

• startCamera

   void startCamera(@NonNull() DirectionsRoute directionsRoute)

  Used when starting this Activity for the first time.

  Zooms to the beginning of the DirectionsRoute.

  Parameters:

  directionsRoute - where camera should move to

• resumeCamera

   void resumeCamera(@NonNull() Location location)

  Used after configuration changes to resume the camera to the last location update from the Navigation SDK.

  Parameters:

  location - where the camera should move to

• updateCameraRouteGeometryOverview

   boolean updateCameraRouteGeometryOverview()

• onFeedbackFlowStatusChanged

   void onFeedbackFlowStatusChanged(int status)

• onGuidanceViewChange

   void onGuidanceViewChange(int left, int top, int width, int height)

• startNavigation

   void startNavigation(@NonNull() NavigationViewOptions options)

• setMapStyleDay

   void setMapStyleDay()

• setMapStyleNight

   void setMapStyleNight()

• setMapStyleSatellite

   void setMapStyleSatellite()

• stopNavigation

   void stopNavigation()

  Call this when the navigation session needs to end navigation without finishing the whole view

• onRecenterClick

   void onRecenterClick()

• initialize

   void initialize(OnNavigationReadyCallback onNavigationReadyCallback)

  Should be called after onCreate.

  This method adds the OnNavigationReadyCallback, which will fire the ready events for this view.

  Parameters:

  onNavigationReadyCallback - to be set to this view

• initialize

   void initialize(OnNavigationReadyCallback onNavigationReadyCallback, @NonNull() CameraPosition initialMapCameraPosition)

  Should be called after onCreate.

  This method adds the OnNavigationReadyCallback, which will fire the ready events for this view.

  This method also accepts a CameraPosition that will be set as soon as the map is ready. Note, this position is ignored during a configuration change in favor of the last known map position.

  Parameters:

  onNavigationReadyCallback - to be set to this view

  initialMapCameraPosition - to be shown once the map is ready

• retrieveNavigationMap

  @Nullable() NavigationTrimbleMapsMap retrieveNavigationMap()

  Gives the ability to manipulate the map directly for anything that might not currently be supported. This returns null until the view is initialized.

  The NavigationTrimbleMapsMap gives direct access to the map UI (location marker, route, etc.).

• retrieveNavigation

  @Nullable() TrimbleMapsNavigation retrieveNavigation()

  Returns the instance of TrimbleMapsNavigation powering the NavigationView once navigation has started. Will return null if navigation has not been started with startNavigation.

• retrieveRouteProgress

   LiveData<RouteProgress> retrieveRouteProgress()

• retrieveSoundButton

   NavigationButton retrieveSoundButton()

  Returns the sound button used for muting instructions

• retrieveRoute2d3dOverviewBtn

   Route2d3dOverviewButton retrieveRoute2d3dOverviewBtn()

• retrieveTripPreviewBtn

   FloatingActionButton retrieveTripPreviewBtn()

• retrieveSearchBtn

   FloatingActionButton retrieveSearchBtn()

• retrieveFeedbackButton

   NavigationButton retrieveFeedbackButton()

  Returns the feedback button for sending feedback about navigation

• retrieveRecenterButton

   NavigationButton retrieveRecenterButton()

  Returns the re-center button for recentering on current location

• retrieveCancelNavigationButton

   FloatingActionButton retrieveCancelNavigationButton()

• retrieveAlertView

   NavigationAlertView retrieveAlertView()

  Returns the NavigationAlertView that is shown during off-route events with "Report a Problem" text.

• isVoiceGuidanceMuted

   boolean isVoiceGuidanceMuted()

  Returns the state of speech player whether it is muted or unmuted

• toggleMute

   void toggleMute()

  This method toggles the mute state of speech player. It also updates the UI to reflect the new state of speech player.

  Should be called after startNavigation. Otherwise, it does nothing.

  Can check the current mute state by calling isVoiceGuidanceMuted

• showToast

   Unit showToast(String message)

• setOnSettingsClickListener

   void setOnSettingsClickListener(SettingsClickListener listener)

• onFinalDestinationArrival

   void onFinalDestinationArrival(boolean enableDetailedFeedbackFlowAfterTbt, boolean enableArrivalExperienceFeedback)

• updateRouteViewStateCamera

   void updateRouteViewStateCamera()

• changeCameraTo2D

   void changeCameraTo2D()

• changeCameraTo3D

   void changeCameraTo3D()

• changeCameraToRouteOverview

   void changeCameraToRouteOverview()

• getTrip

   TrimbleMapsTrip getTrip()

• setRoutesRequestCallback

   void setRoutesRequestCallback(RoutesRequestCallback routesRequestCallback)

• setIsRunning

   void setIsRunning(boolean isRunning)

• onMultiStopCancelNavigation

   void onMultiStopCancelNavigation()

• showNavigationViewButtons

   void showNavigationViewButtons()

• hideNavigationViewButtons

   void hideNavigationViewButtons()

• acceptFasterRoute

   void acceptFasterRoute(DirectionsResponse fasterRoutes)

• isAnyBottomSheetShowing

   boolean isAnyBottomSheetShowing()

• getInstructionLayoutLocation

   Array<int> getInstructionLayoutLocation()

• getSearchButtonLocation

   Array<int> getSearchButtonLocation()

• getSoundButtonLocation

   Array<int> getSoundButtonLocation()

• getRouteViewButtonLocation

   Array<int> getRouteViewButtonLocation()

• getTripPreviewButtonLocation

   Array<int> getTripPreviewButtonLocation()

• getBottomSheetLocation

   Array<int> getBottomSheetLocation()

• getCancelButtonLocation

   Array<int> getCancelButtonLocation()

• getNavigationButtonWidth

   int getNavigationButtonWidth()

• setArrivalBottomSheetButtonCallback

   void setArrivalBottomSheetButtonCallback(ArrivalBottomSheetButtonCallback callback)

• setExternalClearStopListener

   void setExternalClearStopListener(CancelBottomSheet.OnClearStopListener listener)

• setIsSubscribed

   void setIsSubscribed(boolean isSubscribed)

• setSettingDisplaySpeedLimit

   void setSettingDisplaySpeedLimit(boolean newSetting)

• setSettingDisplaySpeedAlert

   void setSettingDisplaySpeedAlert(boolean newSetting)

• setSettingsTheme

   void setSettingsTheme(int setting)

• setDisplaySearchButton

   void setDisplaySearchButton(boolean visibility)