To Top

To Bottom

ShowConstantTBT Class Reference

Constructors

ShowConstantTBT(parameters)

Instance Methods

getDistanceToManeuver() ⇒ Number
getDistanceToManeuverScale() ⇒ Number
getEta() ⇒ String
getManeuverComplete() ⇒ Boolean
getNavigationText1() ⇒ String
getNavigationText2() ⇒ String
getNextTurnIcon() ⇒ Image
getSoftButtons() ⇒ Array.<SoftButton>
getTimeToDestination() ⇒ String
getTotalDistance() ⇒ String
getTurnIcon() ⇒ Image
setDistanceToManeuver(maneuver) ⇒ ShowConstantTBT
setDistanceToManeuverScale(scale) ⇒ ShowConstantTBT
setEta(eta) ⇒ ShowConstantTBT
setManeuverComplete(complete) ⇒ ShowConstantTBT
setNavigationText1(text1) ⇒ ShowConstantTBT
setNavigationText2(text2) ⇒ ShowConstantTBT
setNextTurnIcon(icon) ⇒ ShowConstantTBT
setSoftButtons(buttons) ⇒ ShowConstantTBT
setTimeToDestination(destination) ⇒ ShowConstantTBT
setTotalDistance(distance) ⇒ ShowConstantTBT
setTurnIcon(icon) ⇒ ShowConstantTBT

Constructors

new ShowConstantTBT(parameters)

Initializes 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.

Param	Type	Description
maneuver	`Number`	Distance (in meters) until next maneuver. May be used to calculate progress bar. - The desired DistanceToManeuver. {'num_min_value': 0.0, 'num_max_value': 1000000000.0}

showConstantTBT.setDistanceToManeuverScale(scale) ⇒ `ShowConstantTBT`

Set the DistanceToManeuverScale

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

Param	Type	Description
scale	`Number`	Distance (in meters) from previous maneuver to next maneuver. May be used to calculate progress bar. - The desired DistanceToManeuverScale. {'num_min_value': 0.0, 'num_max_value': 1000000000.0}

showConstantTBT.setEta(eta) ⇒ `ShowConstantTBT`

Set the Eta

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

Param	Type	Description
eta	`String`	The desired Eta. {'string_min_length': 0, 'string_max_length': 500}

showConstantTBT.setManeuverComplete(complete) ⇒ `ShowConstantTBT`

Set the ManeuverComplete

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

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

showConstantTBT.setNavigationText1(text1) ⇒ `ShowConstantTBT`

Set the NavigationText1

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

Param	Type	Description
text1	`String`	The desired NavigationText1. {'string_min_length': 0, 'string_max_length': 500}

showConstantTBT.setNavigationText2(text2) ⇒ `ShowConstantTBT`

Set the NavigationText2

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

Param	Type	Description
text2	`String`	The desired NavigationText2. {'string_min_length': 0, 'string_max_length': 500}

showConstantTBT.setNextTurnIcon(icon) ⇒ `ShowConstantTBT`

Set the NextTurnIcon

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

Param	Type	Description
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.

Param	Type	Description
buttons	`Array.<SoftButton>`	Three dynamic SoftButtons available (first SoftButton is fixed to "Turns"). If omitted on supported displays, the currently displayed SoftButton values will not change. - The desired SoftButtons. {'array_min_size': 0, 'array_max_size': 3}

showConstantTBT.setTimeToDestination(destination) ⇒ `ShowConstantTBT`

Set the TimeToDestination

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

Param	Type	Description
destination	`String`	The desired TimeToDestination. {'string_min_length': 0, 'string_max_length': 500}

showConstantTBT.setTotalDistance(distance) ⇒ `ShowConstantTBT`

Set the TotalDistance

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

Param	Type	Description
distance	`String`	The desired TotalDistance. {'string_min_length': 0, 'string_max_length': 500}

showConstantTBT.setTurnIcon(icon) ⇒ `ShowConstantTBT`

Set the TurnIcon

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

Param	Type	Description
icon	`Image`	The desired TurnIcon.

View on GitHub.com

Previous Section Next Section