com.tomtom.sdk.navigation:ui/com.tomtom.sdk.navigation.ui.view/NavigationView

NavigationView

class NavigationView @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null) : ConstraintLayout

An Android view that displays the navigation UI components. It provides the UI that can show information about the oncoming maneuvers, route parameters (like ETA and remaining distance), current speed, and the speed limit.

Important: This is a Public Preview API. It may be changed or removed at any time.

Constructors

NavigationView

@JvmOverloads

constructor(context: Context, attrs: AttributeSet? = null)

Functions

addGuidanceViewBoundariesChangeListener

fun addGuidanceViewBoundariesChangeListener(listener: GuidanceViewBoundariesChangeListener)

Adds a GuidanceViewBoundariesChangeListener which is notified when the navigation guidance view boundaries change.

hideArrivalView

fun hideArrivalView()

Hides arrival view component.

hideCombinedInstructionView

fun hideCombinedInstructionView()

Hides combined instruction view component.

hideGuidanceView

fun hideGuidanceView()

Hides guidance view component.

hideRouteUpdatedView

fun hideRouteUpdatedView()

Hides route updated view component.

hideSpeedView

fun hideSpeedView()

Hides speed view component.

hideStreetView

fun hideStreetView()

Hides street view component.

removeGuidanceViewBoundariesChangeListener

fun removeGuidanceViewBoundariesChangeListener(listener: GuidanceViewBoundariesChangeListener)

Removes the GuidanceViewBoundariesChangeListener.

setArrivalDescription

fun setArrivalDescription(description: String)

Sets the description which is shown on arrival view. This could be an address or the name of the current location.

setArrivalTime

fun setArrivalTime(calendar: Calendar)

Sets the arrival time.

setArrivalViewButtonClickListener

fun setArrivalViewButtonClickListener(listener: View.OnClickListener)

Sets View.OnClickListener which is notified when the button on arrival view is clicked. It can be used to finish navigation or start the next step.

setAudioState

fun setAudioState(enabled: Boolean)

Sets the audio icon state.

setAudioToggleButtonClickListener

fun setAudioToggleButtonClickListener(listener: View.OnClickListener)

Sets View.OnClickListener which is notified when the audio toggle button is clicked.

setBottomPanelsGone

fun setBottomPanelsGone()

Sets a container with guidance view and arrival view gone.

setBottomPanelsVisible

fun setBottomPanelsVisible()

Sets a container with guidance view and arrival view visible.

setCancelButtonClickListener

fun setCancelButtonClickListener(listener: View.OnClickListener)

Sets View.OnClickListener which is notified when the close button is clicked.

setCombinedInstruction

fun setCombinedInstruction(instruction: GuidanceInstruction)

Sets the next instruction to be combined with the current one.

setCurrentSpeed

fun setCurrentSpeed(currentSpeed: Speed, speedUnit: UnitSystem)

Sets the current speed.

setCurrentSpeedClickListener

fun setCurrentSpeedClickListener(listener: View.OnClickListener)

Sets View.OnClickListener which is notified when the current speed component is clicked.

setDistanceToDestination

fun setDistanceToDestination(distance: Distance, units: UnitSystem)

Sets the distance to destination.

setDistanceToManeuver

fun setDistanceToManeuver(distance: Distance, units: UnitSystem)

Sets the distance to the nearest maneuver.

setGuidanceInstructionText

fun setGuidanceInstructionText(instructionText: String)

Sets the text that describes the nearest guidance instruction.

setLanes

fun setLanes(lanes: List<Lane>)

Sets the lanes of the route.

setMotorwayExit

fun setMotorwayExit(exit: String)

Sets the motorway exit.

setNextInstruction

fun setNextInstruction(instruction: GuidanceInstruction?, inFollowPhase: Boolean = false)

Sets the maneuver icon.

setRoadShields

fun setRoadShields(roadShields: List<String>)

Sets the road shields.

setRouteLineProgress

fun setRouteLineProgress(routeLength: Distance, traveledDistance: Distance)

Sets the current progress of the route.

setSpeedBubbleBackground

fun setSpeedBubbleBackground(units: UnitSystem)

Sets the background for the speed bubble view and speed shield icon. Circle speed bubble background and icon for metric system, for imperial - rectangle.

setSpeedLimit