Class Garmin.DeviceDisplay

Object
   |
   +--Garmin.DeviceDisplay

class Garmin.DeviceDisplay

Garmin.DeviceDisplay
Defined in GarminDeviceDisplay.js

Requires:

- Garmin.DeviceControl

Field Detail

LINKS

<static> Object LINKS

Constant defining links referenced in the DeviceDisplay

Garmin.DeviceDisplay

Garmin.DeviceDisplay(mainElement, options)

Provides the easiest avenue for getting a working instance of the plug-in onto your page. Generates the UI elements and places them on the page.

Parameters:
mainElement - - (String) id of the element in which to generate the contents (can also be a reference to the dom element itself).
options - - (Object) Object with options (see Garmin.DeviceDisplayDefaultOptions for descriptions of possible options). requires Prototype

Requires:
- Garmin.DeviceControl

_addToActivityTable

void _addToActivityTable(index, activity)

The activityTable object is the HTML table element on the demo page. This function adds the necessary row to the table with the activity data.

_applyDataFilters

void _applyDataFilters()

_buildDescriptiveStatusString

Object _buildDescriptiveStatusString(statusText)

Builds a descriptive string from the status response (typically JSON, but also can be a plain ol' string).

_checkAllDirectory

void _checkAllDirectory()

Selects all checkboxes in the activity directory, which selects all activities to be read from the device.

_clearActivityTable

void _clearActivityTable()

_createActivityDirectory

void _createActivityDirectory()

Creates the activity directory of all activities (activity IDs) on the device of the user-selected type. Most recent entries are first.

_createElement

Object _createElement(id, text, type, parent)

_directoryHasSelected

Object _directoryHasSelected()

Checks if any activities in directory listing are selected. Returns true if so, false otherwise.

_finishReadProcessing

void _finishReadProcessing(json)

_generateActivityDirectoryElement

void _generateActivityDirectoryElement()

_generateActivityTableElement

void _generateActivityTableElement()

_generateActivityTableHeader

void _generateActivityTableHeader()

_generateSendDataElement

void _generateSendDataElement()

_listActivities

void _listActivities(activities)

_listDirectory

void _listDirectory(activities)

Lists the directory and returns summary data (# of tracks).

_populateActivityQueue

void _populateActivityQueue()

Creates the activity queue of selected activities. This should be called only after the user has finished selecting activities. The queue is an Array that is constructed and then reversed to simulate a queue.

_postActivityToServer

void _postActivityToServer()

Posts the last read activity data from the activityQueue using the method defined in this.options.postActivityHandler . After the entire queue is read (and posted), the status is changed to designate that all uploads have been finished.

_readNextSelected

void _readNextSelected()

Reads the user-selected activities from the device by using the activity queue.

_restrictByDevice

Object _restrictByDevice()

Checks the connected device against those listed in this.options.restrictByDevice and displays a status message if the connected device is not supported by the application.

Returns:
true if the connected device is supported, false otherwise.

_seriesFromSelect

Garmin.Series _seriesFromSelect(select)

Retreive the two index string value from the selected index. Activities are stored in Select objects as strings with 2 Garmin.DeviceDisplay.prototype.numbers = "(index of array), (index of series)"; for Garmin.DeviceDisplay.prototype.example = "1,1";.

Parameters:
Select - select - the Select DOM instance

Returns:
a Series instance

cancelFindDevices

void cancelFindDevices()

Entry point for cancelling search for connected devices.

clearMapDisplay

void clearMapDisplay()

Clears overlays from map.

defaultExceptionHandler

void defaultExceptionHandler(<Error> error)

Default exception handler method handles plug-in support/downloads/upgrades. If options.showStatusElement is true then put error messages in the status div otherwise put it in a alert popup.

Parameters:
error - to process.

displayTrack

void displayTrack(series)

Draws a simple line on the map using the Garmin.MapController.

Parameters:
Garmin - .Series series - that contains a track.

displayWaypoint

void displayWaypoint(series)

Draws a point (usualy as a thumb tack) on the map using the Garmin.MapController.

Parameters:
Garmin - .Series series - that contains the lat/lon position of the point.

handleException

void handleException(<Error> error)

Central exception dispatch method will delegate to options.customExceptionHandler if defined or call defaultExceptionHandler otherwise.

Parameters:
error - to process.

hideProgressBar

void hideProgressBar()

Hides progress bar.

isUnlocked

Boolean isUnlocked()

Plugin unlock status

onCancelFindDevices

void onCancelFindDevices(json)

Call-back for find device cancelled.

onCancelReadFromDevice

void onCancelReadFromDevice(json)

Call-back for device read cancelled. see Garmin.DeviceControl

onCancelWriteToDevice

void onCancelWriteToDevice(json)

Call-back triggered when write has been cancelled.

See:
- Garmin.DeviceControl

onException

void onException(json)

Call-back for asynchronous method exceptions. see Garmin.DeviceControl

onFinishFindDevices

void onFinishFindDevices(json)

Call-back triggered after plugin has completed its search for devices.

See:
- Garmin.DeviceControl
- startFindDevices()

onFinishReadFromDevice

void onFinishReadFromDevice(json)

Call-back for device read. see Garmin.DeviceControl

onFinishWriteToDevice

void onFinishWriteToDevice(json)

onProgressReadFromDevice

void onProgressReadFromDevice(json)

Call-back for device read progress.

onProgressWriteToDevice

void onProgressWriteToDevice(json)

onStartFindDevices

void onStartFindDevices(json)

Call-back triggered before plugin searches for connected devices.

See:
- Garmin.DeviceControl
- startFindDevices()

onStartWriteToDevice

void onStartWriteToDevice(json)

Call-back triggered before writing to a device.

See:
- Garmin.DeviceControl

onWaitingWriteToDevice

void onWaitingWriteToDevice(json)

Call-back when the device already has a file with this name on it. Do we want to override? 1 is yes, 2 is no

See:
- Garmin.DeviceControl

readFromDevice

void readFromDevice()

Initiation call for reading from a device. If a fitness device is detected reads TCX otherwise reads GPX. Upon completion if the afterFinishReadFromDevice method is defined it will be called. At this time you may also obtain location data using the getTracks and getWaypoints methods.

readSpecificTypeFromDevice

void readSpecificTypeFromDevice(readDataType)

Generic read method, supporting GPX, TCX, Courses, Workouts, User Profiles, TCX activity directory, and TCX course directory reads.

Upon completion if the afterFinishReadFromDevice method is defined it will be called. At this time you may also obtain location data using the getTracks and getWaypoints methods.

Fitness detail reading (one specific activity) is not supported by this read method, refer to readDetailFromDevice for that.

Parameters:
extension - - the file extension of the type to Garmin.DeviceDisplay.prototype.read = gpx;or tcx

resetUI

void resetUI()

Resets UI widgets based on state of application.

Parameters:
String - > optional status message.

setOptions

void setOptions(<Object> options)

Sets options for this display object. Any options that are set will override the default values.

Parameters:
options - - Object with options.

Throws:
- InvalidOptionException
See:
- for possible options and default values.

setStatus

void setStatus(statusText)

Set status text if showStatusElement is visible.

Parameters:
text - to display.

showProgressBar

void showProgressBar()

Makes progress bar visible.

startFindDevices

void startFindDevices()

Entry point for searching for connected devices. Will attempt to unlock the plugin if necessary.

updateProgressBar

void updateProgressBar(value)

Update percentage representation of progress bar.

Parameters:
percentage - Garmin.DeviceDisplay.prototype.completion = 0;-100

writeToDevice

void writeToDevice()

Writes any supported data to the device. Requires that the option writeDataType field be set correctly to any of the following values located in Garmin.DeviceControl.FILE_TYPES: gpx, crs, or gpi

Throws:
- InvalidTypeException