Class Garmin.WayPoint

Garmin.WayPoint
Defined in: GarminGpsDataStructures.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Garmin.WayPoint(lat, lng, elev, name, addrdetails, desc, sym, type, cmt) A waypoint represents a stored location.

Method Summary
Method Attributes	Method Name and Description
	getAddress() Get waypoint address XML string.
	getCity() Get city that the waypoint is located in, according to Google Maps API.
	getComment() Get comment.
	getCountry() Get country that the waypoint is located in, according to Google Maps API.
	getDate() Shortcut for directly getting the date/time
	getDescription() Get waypoint description.
	getElev() Shortcut for directly getting the elevation value
	getLat() Shortcut for directly getting the lat value
	getLng() Shortcut for directly getting the longitude value
	getName() Get waypoint name.
	getState() Get state that the waypoint is located in, according to Google Maps API.
	getStreetAddr() Get street address that the waypoint is located in, according to Google Maps API.
	getSymbol() Get waypoint symbol usually associated with a display icon.
	getType() Get waypoint type.
	getZip() Get zip code that the waypoint is located in, according to Google Maps API.
	initialize(lat, lng, elev, name, addrdetails, desc, sym, type, cmt) Prototype constructor

Class Detail

Garmin.WayPoint(lat, lng, elev, 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:
{Number} lat
{Number} lng
{Number} elev
{String} name
addrdetails
desc
sym
type
cmt

Method Detail

{String} getAddress()

Get waypoint address XML string. Uses the extension element to generate XML address format listed in the GPX Extensions v3 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

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

{String} getComment()

Get comment.

Returns:: The value of the comment for this point

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

{Garmin.DateTimeFormat} getDate()

Shortcut for directly getting the date/time

Returns:: The DateTimeFormat object for this point

{String} getDescription()

Get waypoint description.

Returns:: A description of this waypoint

{Number} getElev()

Shortcut for directly getting the elevation value

Returns:: The value of the elevation for this point

{Number} getLat()

Shortcut for directly getting the lat value

Returns:: The value of the latitude for this point

{Number} getLng()

Shortcut for directly getting the longitude value

Returns:: The value of the longitude for this point

{String} getName()

Get waypoint name.

Returns:: The name of this waypoint

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

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

{String} getSymbol()

Get waypoint symbol usually associated with a display icon.

Returns:: The symbol of this waypoint

{String} getType()

Get waypoint type.

Returns:: The type of this waypoint

{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(lat, lng, elev, name, addrdetails, desc, sym, type, cmt)

Prototype constructor

Parameters:
lat
lng
elev
name
addrdetails
desc
sym
type
cmt

Communicator Plugin API Version 1.9

Classes

Class Garmin.WayPoint