Class Garmin.DeviceDisplayDefaultOptions

Object
   |
   +--Garmin.DeviceDisplayDefaultOptions

class Garmin.DeviceDisplayDefaultOptions

Defined in GarminDeviceDisplay.js

Field Detail

actionButtonClassName

String actionButtonClassName

Class name to add for all buttons/links that perform an action

activityDirectoryDataId

Object activityDirectoryDataId

activityDirectoryElementId

Object activityDirectoryElementId

activityDirectoryHeaderDate

Object activityDirectoryHeaderDate

activityDirectoryHeaderDuration

Object activityDirectoryHeaderDuration

afterFinishFindDevices

Function afterFinishFindDevices

The function called when device search completes successfully or unsuccessfully. The function should have two arguments: devices {Array} - an array of device descriptors or an empty array in none were found. display {Garmin.DeviceDisplay} - the current instance of the DeveiceDisplay

afterFinishReadFromDevice

Function afterFinishReadFromDevice

The function called when data is successfully read from the device. The function should have three arguements: dataString - the xml received from the device in String format dataDoc - the xml received from the device in Document format extension - the file type extension of the data, used to determine the type of data received. activities - list of <

afterFinishWriteToDevice

Function afterFinishWriteToDevice

The function called when data is successfully writte to the device. This method takes two parameters: success {Boolean} - true if data was written display {Garmin.DeviceDisplay} - the current instance of the DeveiceDisplay

autoFindDevices

Boolean autoFindDevices

Looks for devices as soon as the page is loaded and the plugin unlocked. This might be particularly annoying in many situations since the plugin requires the user to authorize access to device information via a dialog box.

autoHideUnusedReadElements

Object autoHideUnusedReadElements

autoReadData

Boolean autoReadData

Start reading data from the device when one or more device(s) is found. default = false

autoSelectFirstDevice

Boolean autoSelectFirstDevice

When more than one device is detected automaticly pick the first device. This allows single button interfaces to avoid having to ask the user to choose the device and keeps the deviceSelect hidden. default = false

autoWriteData

Boolean autoWriteData

Start writing data to the device when one or more device(s) is found. default = false

cancelFindDevicesButtonId

String cancelFindDevicesButtonId

The id referencing the cancel find devices button. This is useful for CSS customizations. default = cancelFindDevicesButton

cancelFindDevicesButtonText

String cancelFindDevicesButtonText

The text for the cancel find device button.

cancelReadDataButtonId

String cancelReadDataButtonId

The id referencing the cancel read data button. This is useful for CSS customizations. default = cancelReadDataButton

cancelReadDataButtonText

String cancelReadDataButtonText

The text on the cancel read button.

cancelReadStatusText

String cancelReadStatusText

The status text that is displayed when user cancels the read progress.

cancelWriteDataButtonId

String cancelWriteDataButtonId

The id referencing the cancel write data button. This is useful for CSS customizations. default = cancelWriteDataButton

cancelWriteDataButtonText

String cancelWriteDataButtonText

The text on the cancel write button.

customExceptionHandler

Function customExceptionHandler

The function called when an error occurs. This is here to allow custom error handling logic. The function should accept an arguement of type Error (Javascript Error Object) and a second arguement for the DeviceDisplay instance. Error.name - the type of the error in a String format. Error.message - the detailed message of the error. Some Errors: PluginNotInstalledException - the plugin is not installed OutOfDatePluginException - the plugin is out of date BrowserNotSupportedException - the browser is not support by the site

dataFilters

Array dataFilters

Array of filters to sequencialy apply to activities before being sent or displayed.

dataFound

String dataFound

Status message template exposed for internationalization.

dataReadProcessing

String dataReadProcessing

Status message exposed for internationalization.

deviceSelectedElementId

Object deviceSelectedElementId

deviceSelectedLabel

Object deviceSelectedLabel

deviceSelectedLabelId

Object deviceSelectedLabelId

deviceSelectElementId

String deviceSelectElementId

The id referencing the device select box. This is useful for CSS customizations. default = deviceSelectBox

deviceSelectId

String deviceSelectId

The id referencing the device select dropdown. This is useful for CSS customizations. default = deviceSelect

deviceSelectLabel

String deviceSelectLabel

The label for the device select box. Shows up next to the device select box.

deviceSelectLabelId

String deviceSelectLabelId

The id referencing the device select box label. This is useful for CSS customizations. default = deviceSelectLabel

downloadAndInstall

String downloadAndInstall

Request message exposed for internationalization.

elementClassName

Object elementClassName

The class name used by various parts of the display to make CSS styling easier.

errorActivitySelect

Object errorActivitySelect

findCancelled

String findCancelled

Status message exposed for internationalization.

findDevicesButtonId

String findDevicesButtonId

The id referencing the find devices button. This is useful for CSS customizations. default = findDevicesButton

findDevicesButtonText

String findDevicesButtonText

The text for the find device button.

findDevicesElementId

String findDevicesElementId

The id referencing the HTML container around the find devices buttons. This is useful for CSS customizations.

default = deviceBox

foundDevice

String foundDevice

Status template exposed for internationalization. When single device is found.

foundDevices

String foundDevices

Status template exposed for internationalization. When multiple devices are found.

getGpiWriteDescription

Function getGpiWriteDescription

The function called by the display in order to acquire the data that will be written to the device during the writing operation. This function should return an array of strings where adjacent items indicate the source (URL) of the gpi to be written and the destination (device path and filename) to write to the device. e.g.: [SOURCE,DESTINATION,SOURCE2,DESTINATION2] add as many source/destination pairs as you'd like.

getWriteData

Function getWriteData

The function called by the display in order to acquire the data that will be written to the device during the writing operation. This function should return a String.

gpsData

String gpsData

Read data selection option exposed for internationalization.

hideIfBrowserNotSupported

Boolean hideIfBrowserNotSupported

Action to take if browser is not supported: if true on't display the application, else if status bar is visible, display message, otherwise popup an alert dialog

installNow

String installNow

Request message exposed for internationalization.

loadTracksWithoutATimestamp

Boolean loadTracksWithoutATimestamp

Load tracks even if they don't have a timestamp (technically these are routes). Set to false if you need to do synchronization with existing track log database (like MotionBased does). default = true

lookingForDevices

String lookingForDevices

Status message exposed for internationalization.

noDeviceDetectedStatusText

String noDeviceDetectedStatusText

The status text that is displayed when no devices are found.

noParseSupportForType

String noParseSupportForType

Error message exposed for internationalization.

notOverwritingFile

String notOverwritingFile

Status message exposed for internationalization.

overwritingFile

String overwritingFile

Status message exposed for internationalization.

pathKeyPairsArray

String[] pathKeyPairsArray

The array of strings that contain the unlock codes for the plugin. [URL1,KEY1,URL2,KEY2] add as many url/key pairs as you'd like.

pluginNotUnlocked

String pluginNotUnlocked

Status message exposed for internationalization.

pluginUnlocked

String pluginUnlocked

Status message exposed for internationalization.

postActivityHandler

Function postActivityHandler

The function called when a single activity is finished reading, and the data is ready to post. The function will be provided with one param, the activity XML read. activityXml {String} - The XML datastring of the activity read from the device.

poweredByGarmin

String poweredByGarmin

Powered-by message. Required for plugin license agreement.

progressBarDisplayId

String progressBarDisplayId

The id of the element where the progress bar is to be displayed.

progressBarId

String progressBarId

The container for the progress bar.

readDataButtonId

String readDataButtonId

The id referencing the read data button. This is useful for CSS customizations. default = readDataButton

readDataButtonText

String readDataButtonText

The text on the read button.

readDataElementId

String readDataElementId

The id referencing the box containing read elements. This is useful for CSS customizations. default = readBox

readDataType

String readDataType

Tells the plug-in what data type to read from the device. Options for this are currently constants listed in Garmin.DeviceControl.FILE_TYPES, and the values Garmin.DeviceDisplayDefaultOptions.prototype.are = crs; gpx, gpi, or null to skip this option altogether and get the default data type from the device.

This property works in conjunction with the following functions, based on the datatype:

For CRS and Garmin.DeviceDisplayDefaultOptions.prototype.GPX = Define;the getWriteData() and getWriteDataFileName() functions in your options section.

For Garmin.DeviceDisplayDefaultOptions.prototype.GPI = Define;the getWriteData() and getWriteDataFileName() functions in your options section. The getGpiWriteDescription() function replaces getWriteData().

default value = Garmin.DeviceControl.FILE_TYPES.gpx

readDataTypesSelectId

String readDataTypesSelectId

The id referencing the data type select. This is useful for CSS customizations. default = readDataTypesSelect

readGoogleMapId

String readGoogleMapId

The id referencing the google map display. This is useful for CSS customizations. default = readMap

readResultsElementClass

String readResultsElementClass

The class to set for results elements. This is useful for CSS customizations. default = readResultsElement

readResultsSelectClass

String readResultsSelectClass

The class to set for select lists that are displaying results from a read operation. This is useful for CSS customizations. default = readResultsSelect

readRoutesElementId

String readRoutesElementId

The id referencing the read routes element. This is useful for CSS customizations. default = readRoutesElement

readRoutesSelectId

String readRoutesSelectId

The id referencing the route select dropdown. This is useful for CSS customizations. default = readRoutesSelect

readRoutesSelectLabel

String readRoutesSelectLabel

The label for the read routes select box. Shows up next to the read routes select box.

readRoutesSelectLabelId

String readRoutesSelectLabelId

The id referencing the read routes select box label. This is useful for CSS customizations. default = readRoutesSelectLabel

readSelectedButtonId

Object readSelectedButtonId

readSelectedButtonText

Object readSelectedButtonText

readTracksElementId

String readTracksElementId

The id referencing the read tracks element. This is useful for CSS customizations. default = readTracksElement

readTracksSelectId

String readTracksSelectId

The id referencing the track select dropdown. This is useful for CSS customizations. default = readTracksSelect

readTracksSelectLabel

String readTracksSelectLabel

The label for the read tracks select box. Shows up next to the read tracks select box.

readTracksSelectLabelId

String readTracksSelectLabelId

The id referencing the read tracks select box label. This is useful for CSS customizations. default = deviceSelectLabel

readWaypointsElementId

String readWaypointsElementId

The id referencing the read tracks element. This is useful for CSS customizations. default = readTracksElement

readWaypointsSelectId

String readWaypointsSelectId

The id referencing the waypoint select dropdown. This is useful for CSS customizations. default = readWaypointsSelect

readWaypointsSelectLabel

String readWaypointsSelectLabel

The label for the read waypoints select box. Shows up next to the read tracks select box.

readWaypointsSelectLabelId

String readWaypointsSelectLabelId

The id referencing the read waypoints select box label. This is useful for CSS customizations. default = deviceSelectLabel

showActivityDirectoryElement

Boolean showActivityDirectoryElement

Displays the activity directory table, which essentially allows users to select individual activities to read from the device. showReadDataElement must be true for this to display. default = true

showCancelFindDevicesButton

Boolean showCancelFindDevicesButton

Controls the view of the cancel find devices button. When set to false the button will never show. When set to true the button's behavior will depend on other settings such as showFindDevicesButton, showDeviceButtonsOnFound, showDeviceButtonsOnLoad, and showFindDevicesElement. default= false

showCancelReadDataButton

Boolean showCancelReadDataButton

Controls the view of the cancel read data button. When set to false the button will never show. When set to true the button's behavior will depend on other settings such as showReadDataButton, and showReadDataElement. default= true

Boolean showCancelWriteDataButton

Boolean showDeviceButtonsOnFound

BSoolean showDeviceButtonsOnLoad

Boolean showDeviceSelectNoDevice

Boolean showDeviceSelectOnLoad

Boolean showDeviceSelectOnSingle

Boolean showFindDevicesButton

Boolean showFindDevicesElement

Boolean showProgressBar

Boolean showReadDataElement

Boolean showReadDataElementOnDeviceFound

Boolean showReadDataTypesSelect

Boolean showReadGoogleMap

Boolean showReadResultsSelectOnLoad

Boolean showReadRoutesSelect

Boolean showReadTracksSelect

Boolean showReadWaypointsSelect

Boolean showStatusElement

Boolean showWriteDataElement

Boolean showWriteDataElementOnDeviceFound

Object singleDeviceDetectedStatusText

Object statusCellProcessingImg

String statusElementId

String statusTextId

String trackListing

String trainingData

Boolean unlockOnPageLoad

Object updateActivityStatus

Object uploadDataButtonId

Object uploadDataButtonText

Object uploadingActivities

Object uploadSelectedActivities

Object uploadsFinished

Boolean useLinks

String using

String writeDataButtonId

String writeDataButtonText

String writeDataType

String writingCancelled

String writingToDevice

String writtenToDevice

Garmin.DeviceDisplayDefaultOptions()

Function getWriteDataFileName()