Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
ShowConstantTBT

ShowConstantTBT Class Reference

Constructors

Instance Methods

Constructors

new ShowConstantTBT(parameters)

Initalizes an instance of ShowConstantTBT.

Instance Methods

showConstantTBT.getDistanceToManeuver() ⇒ Number

Get the DistanceToManeuver

Kind: Instance method of ShowConstantTBT
Returns: Number - the KEY_DISTANCE_TO_MANEUVER value

showConstantTBT.getDistanceToManeuverScale() ⇒ Number

Get the DistanceToManeuverScale

Kind: Instance method of ShowConstantTBT
Returns: Number - the KEY_DISTANCE_TO_MANEUVER_SCALE value

showConstantTBT.getEta() ⇒ String

Get the Eta

Kind: Instance method of ShowConstantTBT
Returns: String - the KEY_ETA value

showConstantTBT.getManeuverComplete() ⇒ Boolean

Get the ManeuverComplete

Kind: Instance method of ShowConstantTBT
Returns: Boolean - the KEY_MANEUVER_COMPLETE value

showConstantTBT.getNavigationText1() ⇒ String

Get the NavigationText1

Kind: Instance method of ShowConstantTBT
Returns: String - the KEY_NAVIGATION_TEXT_1 value

showConstantTBT.getNavigationText2() ⇒ String

Get the NavigationText2

Kind: Instance method of ShowConstantTBT
Returns: String - the KEY_NAVIGATION_TEXT_2 value

showConstantTBT.getNextTurnIcon() ⇒ Image

Get the NextTurnIcon

Kind: Instance method of ShowConstantTBT
Returns: Image - the KEY_NEXT_TURN_ICON value

showConstantTBT.getSoftButtons() ⇒ Array.<SoftButton>

Get the SoftButtons

Kind: Instance method of ShowConstantTBT
Returns: Array.<SoftButton> - the KEY_SOFT_BUTTONS value

showConstantTBT.getTimeToDestination() ⇒ String

Get the TimeToDestination

Kind: Instance method of ShowConstantTBT
Returns: String - the KEY_TIME_TO_DESTINATION value

showConstantTBT.getTotalDistance() ⇒ String

Get the TotalDistance

Kind: Instance method of ShowConstantTBT
Returns: String - the KEY_TOTAL_DISTANCE value

showConstantTBT.getTurnIcon() ⇒ Image

Get the TurnIcon

Kind: Instance method of ShowConstantTBT
Returns: Image - the KEY_TURN_ICON value

showConstantTBT.setDistanceToManeuver(maneuver) ⇒ ShowConstantTBT

Set the DistanceToManeuver

Kind: Instance method of ShowConstantTBT
Returns: ShowConstantTBT - The class instance for method chaining.

ParamTypeDescription
maneuver Number Fraction of distance till next maneuver (starting from when AlertManeuver is - The desired DistanceToManeuver. triggered). Used to calculate progress bar.

showConstantTBT.setDistanceToManeuverScale(scale) ⇒ ShowConstantTBT

Set the DistanceToManeuverScale

Kind: Instance method of ShowConstantTBT
Returns: ShowConstantTBT - The class instance for method chaining.

ParamTypeDescription
scale Number Distance till next maneuver (starting from) from previous maneuver. Used to calculate - The desired DistanceToManeuverScale. progress bar.

showConstantTBT.setEta(eta) ⇒ ShowConstantTBT

Set the Eta

Kind: Instance method of ShowConstantTBT
Returns: ShowConstantTBT - The class instance for method chaining.

ParamTypeDescription
eta String The desired Eta.

showConstantTBT.setManeuverComplete(complete) ⇒ ShowConstantTBT

Set the ManeuverComplete

Kind: Instance method of ShowConstantTBT
Returns: ShowConstantTBT - The class instance for method chaining.

ParamTypeDescription
complete Boolean If and when a maneuver has completed while an AlertManeuver is active, the app must - The desired ManeuverComplete. send this value set to TRUE in order to clear the AlertManeuver overlay. If omitted the value will be assumed as FALSE.

showConstantTBT.setNavigationText1(text1) ⇒ ShowConstantTBT

Set the NavigationText1

Kind: Instance method of ShowConstantTBT
Returns: ShowConstantTBT - The class instance for method chaining.

ParamTypeDescription
text1 String The desired NavigationText1.

showConstantTBT.setNavigationText2(text2) ⇒ ShowConstantTBT

Set the NavigationText2

Kind: Instance method of ShowConstantTBT
Returns: ShowConstantTBT - The class instance for method chaining.

ParamTypeDescription
text2 String The desired NavigationText2.

showConstantTBT.setNextTurnIcon(icon) ⇒ ShowConstantTBT

Set the NextTurnIcon

Kind: Instance method of ShowConstantTBT
Returns: ShowConstantTBT - The class instance for method chaining.

ParamTypeDescription
icon Image The desired NextTurnIcon.

showConstantTBT.setSoftButtons(buttons) ⇒ ShowConstantTBT

Set the SoftButtons

Kind: Instance method of ShowConstantTBT
Returns: ShowConstantTBT - The class instance for method chaining.

ParamTypeDescription
buttons Array.<SoftButton> Three dynamic SoftButtons available (first SoftButton is fixed to "Turns"). If - The desired SoftButtons. omitted on supported displays, the currently displayed SoftButton values will not change.

showConstantTBT.setTimeToDestination(destination) ⇒ ShowConstantTBT

Set the TimeToDestination

Kind: Instance method of ShowConstantTBT
Returns: ShowConstantTBT - The class instance for method chaining.

ParamTypeDescription
destination String The desired TimeToDestination.

showConstantTBT.setTotalDistance(distance) ⇒ ShowConstantTBT

Set the TotalDistance

Kind: Instance method of ShowConstantTBT
Returns: ShowConstantTBT - The class instance for method chaining.

ParamTypeDescription
distance String The desired TotalDistance.

showConstantTBT.setTurnIcon(icon) ⇒ ShowConstantTBT

Set the TurnIcon

Kind: Instance method of ShowConstantTBT
Returns: ShowConstantTBT - The class instance for method chaining.

ParamTypeDescription
icon Image The desired TurnIcon.
View on GitHub.com
Previous Section Next Section