Class DirectionIndicator

This class translates an angle and direction into text.

Hierarchy

DirectionIndicator

Index

Constructors

Methods

getAngle getDirection setAngle setDirection toString getDirectionIndicator

Constructors

constructor

new DirectionIndicator(info, options?): DirectionIndicator
Used for overriding options.
Parameters
- info: Map<string, number>
  
  a map with 'angle' and 'direction' keys and their corresponding values
- options: TurnByTurnDirectionOptions = ...
  
  options for customization
Returns DirectionIndicator

Methods

getAngle

getAngle(): number
Returns number
the angle of the turn, if any

getDirection

getDirection(): string
Returns string
the direction (either left/right/straight)

setAngle

setAngle(angle): void
Parameters
- angle: number
  
  the new angle
Returns void

setDirection

setDirection(direction): void
Parameters
- direction: string
  
  the new direction
Returns void

toString

toString(): string
Returns string
A string representation of this object

`Static` getDirectionIndicator

getDirectionIndicator(info): void
Used for default options.
Parameters
- info: Map<string, number>
  
  a map with 'angle' and 'direction' keys and their corresponding values
Returns void

Generated using TypeDoc