Class Garmin.DeviceDisplay

Object
   |
   +--Garmin.DeviceDisplay

class Garmin.DeviceDisplay

Garmin.DeviceDisplay
Defined in GarminDeviceDisplay.js

Requires:

- Prototype
- Garmin.DeviceControl

Field Detail

CONST

<static> Object CONST

Garmin.DeviceDisplay

Garmin.DeviceDisplay(<String> mainElement, <Object> 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 - - id of the element in which to generate the contents (can also be a reference to the dom element itself).
options - - Object with options (see Garmin.DeviceDisplayDefaultOptions for descriptions of possible options).

Requires:
- Prototype
- Garmin.DeviceControl

_createElement

Object _createElement(id, text, type, parent)

cancelFindDevices

void cancelFindDevices()

Entry point for cancelling search for connected devices.

clearMapDisplay

void clearMapDisplay()

Clears overlays from map.

displayTrack

void displayTrack(<Garmin.Track> track)

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

Parameters:
track - - the detailed historical route that will be drawn on the map.

displayWayPoint

void displayWayPoint(wpt)

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

Parameters:
waypoint - - the lat/lon position of the point.

getTracks

{Array[Garmin.Track]} getTracks()

Returns an array of tracks.

Returns:
array of tracks

getWaypoints

{Array[Garmin.WayPoint]} getWaypoints()

Returns an array of waypoints.

Returns:
array of waypoints

handleException

void handleException(<Error> error)

Central exception dispatch method, default is to If customExceptionHandler is defined, all error handling is delegated to that method.

Parameters:
error - to process.

hideProgressBar

void hideProgressBar()

Hides progress bar.

initialize

void initialize(mainElement, options)

isUnlocked

Boolean isUnlocked()

Plugin unlock status

onCancelFindDevices

void onCancelFindDevices(json)

Call-back for find device cancelled.

See:
- Garmin.DeviceControl

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.

See:
- Garmin.DeviceControl

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(<String> extension)

Initiation call for reading from a device. 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.

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

resetUI

void resetUI(statusMsg)

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