DisplayOptions

public class DisplayOptions extends Object

Defines the options used by the Navigator for displaying a route to a destination.

By default, traffic lights and stop signs are shown along the route during navigation. You can use the showTrafficLights(boolean) and showStopSigns(boolean) methods to change this setting. However, note that these methods are deprecated and will be removed in the next major release.

Public Constructor Summary

DisplayOptions()

Public Method Summary

boolean
getHideDestinationMarkers()
Returns a boolean indicating whether destination markers will be hidden.
boolean
getShowStopSigns()
This method is deprecated. Will be removed in the next major release.
boolean
getShowTrafficLights()
This method is deprecated. Will be removed in the next major release.
DisplayOptions
hideDestinationMarkers(boolean hideDestinationMarkers)
Configures whether to hide destination markers when displaying a route.
DisplayOptions
showStopSigns(boolean showStopSigns)
This method is deprecated. Will be removed in the next major release and stop signs will be displayed by default.
DisplayOptions
showTrafficLights(boolean showTrafficLights)
This method is deprecated. Will be removed in the next major release and traffic lights will be displayed by default.

Inherited Method Summary

Public Constructors

public DisplayOptions ()

Public Methods

public boolean getHideDestinationMarkers ()

Returns a boolean indicating whether destination markers will be hidden.

Returns
  • true if destination markers will be hidden

public boolean getShowStopSigns ()

This method is deprecated.
Will be removed in the next major release.

Returns a boolean indicating whether stop signs are shown along the route during navigation.

Returns
  • true if stop signs are shown along the route during navigation.

public boolean getShowTrafficLights ()

This method is deprecated.
Will be removed in the next major release.

Returns a boolean indicating whether traffic lights are shown along the route during navigation.

Returns
  • true if traffic lights are shown along the route during navigation.

public DisplayOptions hideDestinationMarkers (boolean hideDestinationMarkers)

Configures whether to hide destination markers when displaying a route.

Parameters
hideDestinationMarkers If true, destination markers will be hidden.
Returns
  • the object for which the method was called, with the updated marker hiding setting

public DisplayOptions showStopSigns (boolean showStopSigns)

This method is deprecated.
Will be removed in the next major release and stop signs will be displayed by default.

Configures whether to show stop signs along the route during navigation.

Changes to this setting take effect only in subsequent route requests.

Once the setting is applied, the user interface shows the first 3 upcoming traffic lights or stop signs at any time during navigation, provided the data is available.

Parameters
showStopSigns If true, shows stop signs.
Returns
  • this DisplayOptions object with the updated showStopSigns setting.

public DisplayOptions showTrafficLights (boolean showTrafficLights)

This method is deprecated.
Will be removed in the next major release and traffic lights will be displayed by default.

Configures whether to show traffic lights along the route during navigation.

Changes to this setting take effect only in subsequent route requests.

Once the setting is applied, the user interface shows the first 3 upcoming traffic lights or stop signs at any time during navigation, provided the data is available.

Parameters
showTrafficLights If true, show traffic lights.
Returns
  • this DisplayOptions object with the updated showTrafficLights setting.