Class Garmin.WayPoint

Object
   |
   +--Garmin.WayPoint

class Garmin.WayPoint

Garmin.WayPoint
Defined in GarminGpsDataStructures.js

Constructor Detail

Garmin.WayPoint

Garmin.WayPoint(<Number> lat, <Number> lng, <Number> elev, <String> name, desc, sym)

A waypoint represents a stored location. Equivalent to a in GPX format Note: this class is only used by Garmin.Geocode but otherwise has been replaced by Garmin.Activity.

Parameters:
lat -
lng -
elev -
name -

getDate

Garmin.DateTimeFormat getDate()

Shortcut for directly getting the date/time

Returns:
The DateTimeFormat object for this point

getDescription

String getDescription()

Get waypoint description.

Returns:
A description of this waypoint

getElev

Number getElev()

Shortcut for directly getting the elevation value

Returns:
The value of the elevation for this point

getLat

Number getLat()

Shortcut for directly getting the lat value

Returns:
The value of the latitude for this point

getLng

Number getLng()

Shortcut for directly getting the longitude value

Returns:
The value of the longitude for this point

getName

String getName()

Get waypoint name.

Returns:
The name of this waypoint

getSymbol

String getSymbol()

Get waypoint symbol usually associated with a display icon.

Returns:
The symbol of this waypoint

getType

String getType()

Get waypoint type.

Returns:
The type of this waypoint

initialize

void initialize(lat, lng, elev, name, desc, sym, type)

Prototype constructor

toString

Object toString()