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, addrdetails, desc, sym, type, cmt)

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 -

_initSubArea

void _initSubArea()

Initializes the subadministrative area, as designated by Google Maps API (see http://code.google.com/apis/maps/documentation/services.html#Geocoding_Structured). Apparently some locations have Locality while others don't, so this function takes care of both.

getAddress

String getAddress()

Get waypoint address XML string. Uses the extension element to generate XML address format listed in the GPX Extensions v3 Garmin.WayPoint.prototype.schema = http;://www8.garmin.com/xmlschemas/GpxExtensions/v3/GpxExtensionsv3.xsd

Returns:
The address of this waypoint, as an XML string with the outermost element being gpxx::Address

getCity

String getCity()

Get city that the waypoint is located in, according to Google Maps API. See http://www.google.com/apis/maps/ for details.

Returns:
The city the waypoint is located in.

getComment

String getComment()

Get comment.

Returns:
The value of the comment for this point

getCountry

String getCountry()

Get country that the waypoint is located in, according to Google Maps API. See http://www.google.com/apis/maps/ for details.

Returns:
The country the waypoint is located in.

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

getState

String getState()

Get state that the waypoint is located in, according to Google Maps API. See http://www.google.com/apis/maps/ for details.

Returns:
The state the waypoint is located in.

getStreetAddr

String getStreetAddr()

Get street address that the waypoint is located in, according to Google Maps API. See http://www.google.com/apis/maps/ for details.

Returns:
The street address the waypoint is located in.

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

getZip

String getZip()

Get zip code that the waypoint is located in, according to Google Maps API. See http://www.google.com/apis/maps/ for details.

Returns:
The zip code the waypoint is located in.

initialize

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

Prototype constructor

toString

Object toString()