Class Garmin.TrackSegment

Garmin.TrackSegment
Defined in: GarminGpsDataStructures.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Garmin.TrackSegment() Equivalent to a in GPX format

Method Summary
Method Attributes	Method Name and Description
	findNearestValidLocationPoint(index, incDirection) Find the nearest valid point to the index given
	getDuration() Get the total duration for this track segment
	getEnd() Quick method to get the last point
	getEndDate() Get the data/time for the end point of this segment
	getLength() Get the total number of trackpoints in this segment
	getPoint(index) Get the point specified on the track If the number is negative, get's the first If it's larger than possible, get's the last Otherwise it gets the number requested
	getStart() Quick method to get the first point
	getStartDate() Get the data/time for the start point of this segment
	getStartLat() Get the latitude for the start point of this segment
	getStartLng() Get the longitude for the start point of this segment
	toString() String representation

Class Detail

Garmin.TrackSegment()

Equivalent to a in GPX format

Deprecated:
use Garmin.Activity instead

Method Detail

{Garmin.TrackPoint} findNearestValidLocationPoint(index, incDirection)

Find the nearest valid point to the index given

Parameters:
index: is the index
incDirection: is an int in the direction we'd like to look positive nums are forward, negative nums are backwards

Returns:: The nearest point (possibly the index) that has a validLocation

{String} getDuration()

Get the total duration for this track segment

Returns:: String of Duration (hh:mm:ss)

{Garmin.TrackPoint} getEnd()

Quick method to get the last point

Returns:: The last point of this track

{Garmin.DateTimeFormat} getEndDate()

Get the data/time for the end point of this segment

Returns:: Date/time of the last trackpoint

{Number} getLength()

Get the total number of trackpoints in this segment

Returns:: Total number of trackpoints in this segment

{Garmin.TrackPoint} getPoint(index)

Get the point specified on the track If the number is negative, get's the first If it's larger than possible, get's the last Otherwise it gets the number requested

Parameters:
{Number} index: is the point we want

Returns:: A TrackPoint that fits the pattern described above

{Garmin.TrackPoint} getStart()

Quick method to get the first point

Returns:: The first point of this track

{Garmin.DateTimeFormat} getStartDate()

Get the data/time for the start point of this segment

Returns:: date/time of the first trackpoint

{Number} getStartLat()

Get the latitude for the start point of this segment

Returns:: Latitude of the first trackpoint

{Number} getStartLng()

Get the longitude for the start point of this segment

Returns:: Longitude of the first trackpoint

{String} toString()

String representation

Communicator Plugin API Version 1.9

Classes

Class Garmin.TrackSegment