Class Garmin.DeviceDisplayDefaultOptions

Garmin.DeviceDisplayDefaultOptions
Defined in: GarminDeviceDisplay.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Garmin.DeviceDisplayDefaultOptions() The default display options for the generated plug-in elements including booleans for which sub-items to show.

Field Summary
Field Attributes	Field Name and Description
<static>	Garmin.DeviceDisplayDefaultOptions.actionButtonClassName Class name to add for all buttons/links that perform an action
<static>	Garmin.DeviceDisplayDefaultOptions.activityDirectoryClass The classname referencing the element that lists individual activities.
<static>	Garmin.DeviceDisplayDefaultOptions.activityDirectoryDataId The id referencing the table that holds the activity directory data.
<static>	Garmin.DeviceDisplayDefaultOptions.activityDirectoryElementId The id referencing the element that lists individual activities.
<static>	Garmin.DeviceDisplayDefaultOptions.activityDirectoryHeaderDate DEPRECATED Column header for the Date fields in the activity directory.
<static>	Garmin.DeviceDisplayDefaultOptions.activityDirectoryHeaderDuration Column header for the Duration fields in the activity directory.
<static>	Garmin.DeviceDisplayDefaultOptions.activityDirectoryHeaderStatus Column header for the Status fields in the activity directory.
<static>	Garmin.DeviceDisplayDefaultOptions.activityTableHeaderId The id referencing the header of the activity table that lists individual activities.
<static>	Garmin.DeviceDisplayDefaultOptions.activityTableId The id referencing the activity table that lists individual activities.
<static>	Garmin.DeviceDisplayDefaultOptions.autoFindDevices Looks for devices as soon as the page is loaded and the plugin unlocked.
<static>	Garmin.DeviceDisplayDefaultOptions.autoHideUnusedElements Auto-hides elements when they are not in use.
<static>	Garmin.DeviceDisplayDefaultOptions.autoHideUnusedReadElements DEPRECATED - Use autoHideUnusedElements instead! Auto-hides read elements when they are not in use.
<static>	Garmin.DeviceDisplayDefaultOptions.autoReadData Start reading data from the device when one or more device(s) is found.
<static>	Garmin.DeviceDisplayDefaultOptions.autoSelectFirstDevice When more than one device is detected automaticly pick the first device.
<static>	Garmin.DeviceDisplayDefaultOptions.autoWriteData Start writing data to the device when one or more device(s) is found.
<static>	Garmin.DeviceDisplayDefaultOptions.browseComputerButtonClass The classname referencing the button that displays the UI for browsing the user's file system.
<static>	Garmin.DeviceDisplayDefaultOptions.browseComputerButtonId The id referencing the button that displays the UI for browsing the user's file system.
<static>	Garmin.DeviceDisplayDefaultOptions.browseComputerButtonText The text for the button that displays the UI for browsing the user's file system.
<static>	Garmin.DeviceDisplayDefaultOptions.browseComputerContentUrl The url of the iframe to load into the browse computer container.
<static>	Garmin.DeviceDisplayDefaultOptions.browseComputerElementClass The classname for the browse computer container.
<static>	Garmin.DeviceDisplayDefaultOptions.browseComputerElementId The id for the browse computer container.
<static>	Garmin.DeviceDisplayDefaultOptions.browseComputerLabel The text label to display in the browser list for browsing the computer.
<static>	Garmin.DeviceDisplayDefaultOptions.cancelFindDevicesButtonId The id referencing the cancel find devices button.
<static>	Garmin.DeviceDisplayDefaultOptions.cancelFindDevicesButtonText The text for the cancel find device button.
<static>	Garmin.DeviceDisplayDefaultOptions.cancelReadDataButtonId The id referencing the cancel read data button.
<static>	Garmin.DeviceDisplayDefaultOptions.cancelReadDataButtonText The text on the cancel read button.
<static>	Garmin.DeviceDisplayDefaultOptions.cancelReadStatusText The status text that is displayed when user cancels the read progress.
<static>	Garmin.DeviceDisplayDefaultOptions.cancelUploadButtonClass Class name for the cancel upload button.
<static>	Garmin.DeviceDisplayDefaultOptions.cancelUploadButtonId Element ID for the cancel upload button.
<static>	Garmin.DeviceDisplayDefaultOptions.cancelUploadButtonText Text to display on Cancel upload button.
<static>	Garmin.DeviceDisplayDefaultOptions.cancelWriteDataButtonId The id referencing the cancel write data button.
<static>	Garmin.DeviceDisplayDefaultOptions.cancelWriteDataButtonText The text on the cancel write button.
<static>	Garmin.DeviceDisplayDefaultOptions.changeDeviceButtonText The text to display to change the device.
<static>	Garmin.DeviceDisplayDefaultOptions.changeDeviceClass The classname referencing the change device element, which is a link that allows the user to change device in list mode.
<static>	Garmin.DeviceDisplayDefaultOptions.changeDeviceElementId The id referencing the change device element, which is a link that allows the user to change device in list mode.
<static>	Garmin.DeviceDisplayDefaultOptions.connectedDevicesClass The class name referencing the connected devices label displayed when using the device select list.
<static>	Garmin.DeviceDisplayDefaultOptions.connectedDevicesImg The image to display in the connected devices label.
<static>	Garmin.DeviceDisplayDefaultOptions.connectedDevicesLabel The label for connected devices, displayed when using the device select list.
<static>	Garmin.DeviceDisplayDefaultOptions.dataDownloadProcessing Status message exposed for internationalization.
<static>	Garmin.DeviceDisplayDefaultOptions.dataFilters Array of filters to sequencialy apply to activities before being sent or displayed.
<static>	Garmin.DeviceDisplayDefaultOptions.dataFound Status message template exposed for internationalization.
<static>	Garmin.DeviceDisplayDefaultOptions.dataReadProcessing Status message exposed for internationalization.
<static>	Garmin.DeviceDisplayDefaultOptions.detectNewActivities Detect new activities in the activity listing by comparing the device list to a server list.
<static>	Garmin.DeviceDisplayDefaultOptions.deviceBrowserElementClass The classname for the device browser element.
<static>	Garmin.DeviceDisplayDefaultOptions.deviceBrowserElementId The id referencing the device browser element.
<static>	Garmin.DeviceDisplayDefaultOptions.deviceBrowserLabel The text label to display above the device browser list.
<static>	Garmin.DeviceDisplayDefaultOptions.deviceBrowserLabelClass The classname for the device browser text label.
<static>	Garmin.DeviceDisplayDefaultOptions.deviceBrowserLabelId The id referencing the device browser text label.
<static>	Garmin.DeviceDisplayDefaultOptions.deviceBrowserListId The id referencing the device browser list.
<static>	Garmin.DeviceDisplayDefaultOptions.deviceLabelMaxSize The maximum number of characters to display for a device name.
<static>	Garmin.DeviceDisplayDefaultOptions.deviceSelectClass The class name referencing the device select element.
<static>	Garmin.DeviceDisplayDefaultOptions.deviceSelectedElementId The id referencing the element that displays what device was selected.
<static>	Garmin.DeviceDisplayDefaultOptions.deviceSelectedLabel The label for the device selected element.
<static>	Garmin.DeviceDisplayDefaultOptions.deviceSelectedLabelId The id referencing the label for the element that displays what device was selected.
<static>	Garmin.DeviceDisplayDefaultOptions.deviceSelectElementId The id referencing the device select box.
<static>	Garmin.DeviceDisplayDefaultOptions.deviceSelectId The id referencing the device select element.
<static>	Garmin.DeviceDisplayDefaultOptions.deviceSelectLabel The label for the device select box.
<static>	Garmin.DeviceDisplayDefaultOptions.deviceSelectLabelId The id referencing the device select box label.
<static>	Garmin.DeviceDisplayDefaultOptions.downloadAndInstall Request message exposed for internationalization.
<static>	Garmin.DeviceDisplayDefaultOptions.elementClassName The class name used by various parts of the display to make CSS styling easier.
<static>	Garmin.DeviceDisplayDefaultOptions.errorActivitySelect Error message to display when user attempts to upload 0 activities.
<static>	Garmin.DeviceDisplayDefaultOptions.errorHttpResponse Error message to display when there is an error getting the HTTP response back from the HTTP request.
<static>	Garmin.DeviceDisplayDefaultOptions.findCancelled Status message exposed for internationalization.
<static>	Garmin.DeviceDisplayDefaultOptions.findDevicesButtonId The id referencing the find devices button.
<static>	Garmin.DeviceDisplayDefaultOptions.findDevicesButtonText The text for the find device button.
<static>	Garmin.DeviceDisplayDefaultOptions.findDevicesElementId The id referencing the HTML container around the find devices buttons.
<static>	Garmin.DeviceDisplayDefaultOptions.foundDevice Status template exposed for internationalization.
<static>	Garmin.DeviceDisplayDefaultOptions.foundDevices Status template exposed for internationalization.
<static>	Garmin.DeviceDisplayDefaultOptions.gpsData Read data selection option exposed for internationalization.
<static>	Garmin.DeviceDisplayDefaultOptions.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
<static>	Garmin.DeviceDisplayDefaultOptions.installNow Request message exposed for internationalization.
<static>	Garmin.DeviceDisplayDefaultOptions.loadingContentText The text to display on the loading content screen.
<static>	Garmin.DeviceDisplayDefaultOptions.loadTracksWithoutATimestamp Load tracks even if they don't have a timestamp (technically these are routes).
<static>	Garmin.DeviceDisplayDefaultOptions.lookingForDevices Status message exposed for internationalization.
<static>	Garmin.DeviceDisplayDefaultOptions.noDeviceDetectedStatusText The status text that is displayed when no devices are found.
<static>	Garmin.DeviceDisplayDefaultOptions.noFilteredActivities Status text to display when none of the activities from the device meet the filter requirements.
<static>	Garmin.DeviceDisplayDefaultOptions.noParseSupportForType Error message exposed for internationalization.
<static>	Garmin.DeviceDisplayDefaultOptions.notOverwritingFile Status message exposed for internationalization.
<static>	Garmin.DeviceDisplayDefaultOptions.overwritingFile Status message exposed for internationalization.
<static>	Garmin.DeviceDisplayDefaultOptions.pathKeyPairsArray The array of strings that contain the unlock codes for the plugin.
<static>	Garmin.DeviceDisplayDefaultOptions.pluginLatestVersion Sets the latest plugin version number.
<static>	Garmin.DeviceDisplayDefaultOptions.pluginNotUnlocked Status message exposed for internationalization.
<static>	Garmin.DeviceDisplayDefaultOptions.pluginRequiredVersion Sets the required version of the Communicator Plugin that is compatible with the given application.
<static>	Garmin.DeviceDisplayDefaultOptions.pluginUnlocked Status message exposed for internationalization.
<static>	Garmin.DeviceDisplayDefaultOptions.poweredByGarmin Powered-by message.
<static>	Garmin.DeviceDisplayDefaultOptions.previewDeviceClass The classname referencing the preview device element, which displays an image depending on the device selected.
<static>	Garmin.DeviceDisplayDefaultOptions.previewDeviceDefaultImg The default image URL to display for any selected device.
<static>	Garmin.DeviceDisplayDefaultOptions.previewDeviceElementId The id referencing the change device element, which is a link that allows the user to change device in list mode.
<static>	Garmin.DeviceDisplayDefaultOptions.progressBarBackClass The background of the progress bar.
<static>	Garmin.DeviceDisplayDefaultOptions.progressBarBackId The background of the progress bar.
<static>	Garmin.DeviceDisplayDefaultOptions.progressBarClass The class name for the progress bar container element.
<static>	Garmin.DeviceDisplayDefaultOptions.progressBarDisplayClass The class name for the dynamic progress bar that is overlaid on top of the progressBar element.
<static>	Garmin.DeviceDisplayDefaultOptions.progressBarDisplayId The id of the displayed progress element.
<static>	Garmin.DeviceDisplayDefaultOptions.progressBarId The container for the progress bar.
<static>	Garmin.DeviceDisplayDefaultOptions.progressBarTextClass The class name for the progress bar text.
<static>	Garmin.DeviceDisplayDefaultOptions.progressBarTextId The id of the progress bar text.
<static>	Garmin.DeviceDisplayDefaultOptions.progressTextClass The class name for the progress status text.
<static>	Garmin.DeviceDisplayDefaultOptions.progressTextId The id of the HTML element where the progress status text is to be displayed.
<static>	Garmin.DeviceDisplayDefaultOptions.readDataButtonId The id referencing the read data button.
<static>	Garmin.DeviceDisplayDefaultOptions.readDataButtonText The text on the read button.
<static>	Garmin.DeviceDisplayDefaultOptions.readDataElementId The id referencing the box containing read elements.
<static>	Garmin.DeviceDisplayDefaultOptions.readDataType DEPRECATED - Use Garmin.DeviceDisplayDefaultOptions.readDataTypes Tells the plug-in what data type to read from the device.
<static>	Garmin.DeviceDisplayDefaultOptions.readDataTypes OVERRIDES readDataType! Tells the plug-in what data types to read from the device, in order of preference.
<static>	Garmin.DeviceDisplayDefaultOptions.readDataTypesSelectId The id referencing the data type select.
<static>	Garmin.DeviceDisplayDefaultOptions.readGoogleMapId The id referencing the google map display.
<static>	Garmin.DeviceDisplayDefaultOptions.readResultsElementClass The class to set for results elements.
<static>	Garmin.DeviceDisplayDefaultOptions.readResultsSelectClass The class to set for select lists that are displaying results from a read operation.
<static>	Garmin.DeviceDisplayDefaultOptions.readRoutesElementId The id referencing the read routes element.
<static>	Garmin.DeviceDisplayDefaultOptions.readRoutesSelectId The id referencing the route select dropdown.
<static>	Garmin.DeviceDisplayDefaultOptions.readRoutesSelectLabel The label for the read routes select box.
<static>	Garmin.DeviceDisplayDefaultOptions.readRoutesSelectLabelId The id referencing the read routes select box label.
<static>	Garmin.DeviceDisplayDefaultOptions.readSelectedButtonId The id referencing the button for uploading selected activities button.
<static>	Garmin.DeviceDisplayDefaultOptions.readSelectedButtonText The text label for the upload selected data button.
<static>	Garmin.DeviceDisplayDefaultOptions.readTracksElementId The id referencing the read tracks element.
<static>	Garmin.DeviceDisplayDefaultOptions.readTracksSelectId The id referencing the track select dropdown.
<static>	Garmin.DeviceDisplayDefaultOptions.readTracksSelectLabel The label for the read tracks select box.
<static>	Garmin.DeviceDisplayDefaultOptions.readTracksSelectLabelId The id referencing the read tracks select box label.
<static>	Garmin.DeviceDisplayDefaultOptions.readWaypointsElementId The id referencing the read tracks element.
<static>	Garmin.DeviceDisplayDefaultOptions.readWaypointsSelectId The id referencing the waypoint select dropdown.
<static>	Garmin.DeviceDisplayDefaultOptions.readWaypointsSelectLabel The label for the read waypoints select box.
<static>	Garmin.DeviceDisplayDefaultOptions.readWaypointsSelectLabelId The id referencing the read waypoints select box label.
<static>	Garmin.DeviceDisplayDefaultOptions.restrictByDevice Optional - Restricts transfer of data to specifically listed devices ONLY.
<static>	Garmin.DeviceDisplayDefaultOptions.sendDataButtonId The id referencing the send data button.
<static>	Garmin.DeviceDisplayDefaultOptions.sendDataButtonText The text on the read button.
<static>	Garmin.DeviceDisplayDefaultOptions.sendDataElementId The id referencing the box containing send elements.
<static>	Garmin.DeviceDisplayDefaultOptions.sendDataOptions The AJAX request options to use for sending data to a server.
<static>	Garmin.DeviceDisplayDefaultOptions.sendDataUrl The URL to send the data to.
<static>	Garmin.DeviceDisplayDefaultOptions.sendingDataToServer Status text to display when the plugin is sending data to a remote server.
<static>	Garmin.DeviceDisplayDefaultOptions.showAboutElement The choice to display the about ('Powered by.
<static>	Garmin.DeviceDisplayDefaultOptions.showActivityDirectoryElement Displays the activity directory table, which essentially allows users to select individual activities to read from the device.
<static>	Garmin.DeviceDisplayDefaultOptions.showBrowseComputer Allows the user to browse their file system for upload.
<static>	Garmin.DeviceDisplayDefaultOptions.showCancelFindDevicesButton Controls the view of the cancel find devices button.
<static>	Garmin.DeviceDisplayDefaultOptions.showCancelReadDataButton Controls the view of the cancel read data button.
<static>	Garmin.DeviceDisplayDefaultOptions.showCancelWriteDataButton Controls the view of the cancel write data button.
<static>	Garmin.DeviceDisplayDefaultOptions.showDetailedStatus The choice to display more detailed status when transferring data to and from device.
<static>	Garmin.DeviceDisplayDefaultOptions.showDeviceButtonsOnFound Controls the view of the buttons related to find devices (find & cancel) if based on if the plugin finds one or more devices.
<static>	Garmin.DeviceDisplayDefaultOptions.showDeviceButtonsOnLoad If true the buttons will show when the page is rendered.
<static>	Garmin.DeviceDisplayDefaultOptions.showDeviceSelectNoDevice Controls the view of the device select box.
<static>	Garmin.DeviceDisplayDefaultOptions.showDeviceSelectOnLoad Controls the view of the device select box.
<static>	Garmin.DeviceDisplayDefaultOptions.showDeviceSelectOnSingle Controls the view of the device select box.
<static>	Garmin.DeviceDisplayDefaultOptions.showFindDevicesButton Allows granular control to hide the find devices button independent of the showCancelFindDevicesButton cancel button contol.
<static>	Garmin.DeviceDisplayDefaultOptions.showFindDevicesElement Choice to display the find devices area that will search for connected devices.
<static>	Garmin.DeviceDisplayDefaultOptions.showFindDevicesElementOnLoad Choice to display the find devices area that will search for connected devices when the page loads.
<static>	Garmin.DeviceDisplayDefaultOptions.showProgressBar The progress bar is a graphical percentage bar used to display the amount of reading/writing is complete.
<static>	Garmin.DeviceDisplayDefaultOptions.showReadDataButton Controls the view of the read data button.
<static>	Garmin.DeviceDisplayDefaultOptions.showReadDataElement Display the user interface associated with reading from a connected device.
<static>	Garmin.DeviceDisplayDefaultOptions.showReadDataElementOnDeviceFound Controls the view of the read data element.
<static>	Garmin.DeviceDisplayDefaultOptions.showReadDataTypesSelect Display the dropdown select box for selecting what type of data to read from the device.
<static>	Garmin.DeviceDisplayDefaultOptions.showReadGoogleMap Display Google map to show tracks and laps that have been read.
<static>	Garmin.DeviceDisplayDefaultOptions.showReadResultsSelectOnLoad Controls the view of the device select box.
<static>	Garmin.DeviceDisplayDefaultOptions.showReadRoutesSelect Display the route select dropdown.
<static>	Garmin.DeviceDisplayDefaultOptions.showReadTracksSelect Display the track select dropdown.
<static>	Garmin.DeviceDisplayDefaultOptions.showReadWaypointsSelect Display the waypoint select dropdown.
<static>	Garmin.DeviceDisplayDefaultOptions.showSendDataElement Show the element to send data to a remote server.
<static>	Garmin.DeviceDisplayDefaultOptions.showSendDataElementOnDeviceFound Controls the view of the send data element.
<static>	Garmin.DeviceDisplayDefaultOptions.showStatusElement The choice to display the feedback regarding the communications with the device.
<static>	Garmin.DeviceDisplayDefaultOptions.showUploadNewButton Display the user interface associated with uploading new activities from a connected device.
<static>	Garmin.DeviceDisplayDefaultOptions.showWriteDataElement Display the user interface associated with writing to a connected device.
<static>	Garmin.DeviceDisplayDefaultOptions.showWriteDataElementOnDeviceFound Controls the view of the write data element.
<static>	Garmin.DeviceDisplayDefaultOptions.singleDeviceDetectedStatusText The status text that prepends itself to the device name when a single device is found.
<static>	Garmin.DeviceDisplayDefaultOptions.statusCellProcessingImg The innerHTML to use for status while an activity is processing (for upload).
<static>	Garmin.DeviceDisplayDefaultOptions.statusElementId The id of the HTML element where the statusBox is to be rendered.
<static>	Garmin.DeviceDisplayDefaultOptions.statusTextId The id of the HTML element where the status text messages are to be displayed.
<static>	Garmin.DeviceDisplayDefaultOptions.syncDataOptions The AJAX request options to use for posting the parameters to a server.
<static>	Garmin.DeviceDisplayDefaultOptions.syncDataUrl The URL to make the sync request to.
<static>	Garmin.DeviceDisplayDefaultOptions.trackListing Track list box item template exposed for internationalization.
<static>	Garmin.DeviceDisplayDefaultOptions.trainingData Read data selection option exposed for internationalization.
<static>	Garmin.DeviceDisplayDefaultOptions.unlockOnPageLoad Unlock plugin when user lands on containing page which may result in security or plugin-not-installed messages.
<static>	Garmin.DeviceDisplayDefaultOptions.unsupportedDevice Status message for devices that are not in the allowed devices list, or do not support any of the application's supported filetypes.
<static>	Garmin.DeviceDisplayDefaultOptions.unsupportedReadDataType Error message to display when attempting to write to a device that does not support the provided datatype.
<static>	Garmin.DeviceDisplayDefaultOptions.unsupportedWriteDataType Error message to display when attempting to write to a device that does not support the provided datatype.
<static>	Garmin.DeviceDisplayDefaultOptions.uploadCompressedData Upload compressed data.
<static>	Garmin.DeviceDisplayDefaultOptions.uploadingActivities Status message to display when activities are being uploaded.
<static>	Garmin.DeviceDisplayDefaultOptions.uploadingStatusText The text to display above the upload progress bar.
<static>	Garmin.DeviceDisplayDefaultOptions.uploadMaximum Maximum number of activities allowed for upload selection.
<static>	Garmin.DeviceDisplayDefaultOptions.uploadMaximumReached Error message exposed for internationalization.
<static>	Garmin.DeviceDisplayDefaultOptions.uploadNewButtonId The id referencing the button for uploading data to a server.
<static>	Garmin.DeviceDisplayDefaultOptions.uploadNewButtonText The text label for the upload data button.
<static>	Garmin.DeviceDisplayDefaultOptions.uploadProgressBarBackClass The background of the uploadProgress bar.
<static>	Garmin.DeviceDisplayDefaultOptions.uploadProgressBarBackId The background of the uploadProgress bar.
<static>	Garmin.DeviceDisplayDefaultOptions.uploadProgressBarClass The class name for the uploadProgress bar container element.
<static>	Garmin.DeviceDisplayDefaultOptions.uploadProgressBarDisplayClass The class name for the dynamic uploadProgress bar that is overlaid on top of the uploadProgressBar element.
<static>	Garmin.DeviceDisplayDefaultOptions.uploadProgressBarDisplayId The id of the displayed uploadProgress element.
<static>	Garmin.DeviceDisplayDefaultOptions.uploadProgressBarId The container for the uploadProgress bar.
<static>	Garmin.DeviceDisplayDefaultOptions.uploadProgressBarTextClass The class name for the uploadProgress bar text.
<static>	Garmin.DeviceDisplayDefaultOptions.uploadProgressBarTextId The id of the uploadProgress bar text.
<static>	Garmin.DeviceDisplayDefaultOptions.uploadProgressStatusText Templated string used to display the upload progress status.
<static>	Garmin.DeviceDisplayDefaultOptions.uploadProgressTextClass The class name for the uploadProgress status text.
<static>	Garmin.DeviceDisplayDefaultOptions.uploadProgressTextId The id of the HTML element where the upload progress status text is to be displayed.
<static>	Garmin.DeviceDisplayDefaultOptions.uploadSelectedActivities Select activities to upload, rather than all activities read off the device.
<static>	Garmin.DeviceDisplayDefaultOptions.uploadsFinished Status message exposed for internationalization.
<static>	Garmin.DeviceDisplayDefaultOptions.useDeviceBrowser Show the device browser list.
<static>	Garmin.DeviceDisplayDefaultOptions.useDeviceSelectList Display list instead of select drop down.
<static>	Garmin.DeviceDisplayDefaultOptions.useLinks Display link instead of buttons.
<static>	Garmin.DeviceDisplayDefaultOptions.usingDevice Status message exposed for internationalization.
<static>	Garmin.DeviceDisplayDefaultOptions.writeDataButtonId The id referencing the write data button.
<static>	Garmin.DeviceDisplayDefaultOptions.writeDataButtonText The text on the write button.
<static>	Garmin.DeviceDisplayDefaultOptions.writeDataElementId The id referencing the box containing write elements.
<static>	Garmin.DeviceDisplayDefaultOptions.writeDataType DEPRECATED - Use Garmin.DeviceDisplayDefaultOptions.writeDataTypes Tells the plug-in what data type to write to the device.
<static>	Garmin.DeviceDisplayDefaultOptions.writeDataTypes OVERRIDES writeDataType! Tells the plug-in what data type to write to the device.
<static>	Garmin.DeviceDisplayDefaultOptions.writingCancelled Status message exposed for internationalization.
<static>	Garmin.DeviceDisplayDefaultOptions.writingToDevice Status message exposed for internationalization.
<static>	Garmin.DeviceDisplayDefaultOptions.writtenToDevice Status message exposed for internationalization.

Method Summary
Method Attributes	Method Name and Description
<static>	Garmin.DeviceDisplayDefaultOptions.afterFinishFindDevices() The function called when device search completes successfully or unsuccessfully.
<static>	Garmin.DeviceDisplayDefaultOptions.afterFinishReadFromDevice() The function called when data is successfully read from the device.
<static>	Garmin.DeviceDisplayDefaultOptions.afterFinishSendData(response) The callback function that will be passed the AJAX response after making the request.
<static>	Garmin.DeviceDisplayDefaultOptions.afterFinishUploads() The function called after all item uploads complete successfully or unsuccessfully.
<static>	Garmin.DeviceDisplayDefaultOptions.afterFinishWriteToDevice() The function called when data is successfully written to the device.
<static>	Garmin.DeviceDisplayDefaultOptions.afterSelectDevice(deviceNum, devices, deviceXml) The callback function that will be called when the user selects a device from the device browser.
<static>	Garmin.DeviceDisplayDefaultOptions.afterTableInsert(Boolean, activity, statusCell, checkbox, Object, activityMatcher, display) The function called after an activity entry is added to the activity listing table.
<static>	Garmin.DeviceDisplayDefaultOptions.customExceptionHandler() The function called when an error occurs.
<static>	Garmin.DeviceDisplayDefaultOptions.getActivityDirectoryHeaderIdLabel() Column header for the Date/Name fields in the activity directory.
<static>	Garmin.DeviceDisplayDefaultOptions.getBinaryWriteDescription() The function called by the display in order to acquire the data that will be written to the device during the writing operation.
<static>	Garmin.DeviceDisplayDefaultOptions.getGpiWriteDescription() DEPRECATED (see getBinaryWriteDescription) - The function called by the display in order to acquire the data that will be written to the device during the writing operation.
<static>	Garmin.DeviceDisplayDefaultOptions.getSendOptions() The callback function to set the request options when hitting the remote server.
<static>	Garmin.DeviceDisplayDefaultOptions.getWriteData() The function called by the display in order to acquire the data that will be written to the device during the writing operation.
<static>	Garmin.DeviceDisplayDefaultOptions.getWriteDataFileName() The function called by the display in order to acquire the filename of the data that will be written to the device during the writing operation.
<static>	Garmin.DeviceDisplayDefaultOptions.postActivityHandler() The function called when a single activity is finished reading, and the data is ready to post.

Class Detail

Garmin.DeviceDisplayDefaultOptions()

The default display options for the generated plug-in elements including booleans for which sub-items to show. Override specific option values by calling setOptions(optionsHash) on your instance of Garmin.DeviceDisplay to customize your display options.

Field Detail

<static> {String} Garmin.DeviceDisplayDefaultOptions.actionButtonClassName

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

Default Value:: "actionButton"

<static> {String} Garmin.DeviceDisplayDefaultOptions.activityDirectoryClass

The classname referencing the element that lists individual activities. This element includes the data table as well as the related buttons (such as for uploading data). This is useful for CSS customizations.

Default Value:: activityDirectoryClass

<static> {String} Garmin.DeviceDisplayDefaultOptions.activityDirectoryDataId

The id referencing the table that holds the activity directory data. This is useful for CSS customizations.

Default Value:: activityDirectoryData

<static> {String} Garmin.DeviceDisplayDefaultOptions.activityDirectoryElementId

The id referencing the element that lists individual activities. This element includes the data table as well as the related buttons (such as for uploading data). This is useful for CSS customizations.

Default Value:: activityDirectory

<static> Garmin.DeviceDisplayDefaultOptions.activityDirectoryHeaderDate

DEPRECATED Column header for the Date fields in the activity directory. Useful for CSS customizations and internationalization. @type String @deprecated @see Garmin.DeviceDisplayDefaultOptions.getActivityDirectoryHeaderIdLabel

<static> Garmin.DeviceDisplayDefaultOptions.activityDirectoryHeaderDuration

Column header for the Duration fields in the activity directory. Useful for CSS customizations and internationalization. @type String

<static> Garmin.DeviceDisplayDefaultOptions.activityDirectoryHeaderStatus

Column header for the Status fields in the activity directory. Useful for CSS customizations and internationalization. @type String

<static> {String} Garmin.DeviceDisplayDefaultOptions.activityTableHeaderId

The id referencing the header of the activity table that lists individual activities. This is useful for CSS customizations.

Default Value:: activityTableHeader

<static> {String} Garmin.DeviceDisplayDefaultOptions.activityTableId

The id referencing the activity table that lists individual activities. This table contains the activity data. This is useful for CSS customizations.

Default Value:: activityTable

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.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.

Default Value:: false

<static> {String} Garmin.DeviceDisplayDefaultOptions.autoHideUnusedElements

Auto-hides elements when they are not in use. This is used to simulate a UI with different screens, until we design a better way to do this.

Default Value:: false

<static> {String} Garmin.DeviceDisplayDefaultOptions.autoHideUnusedReadElements

DEPRECATED - Use autoHideUnusedElements instead! Auto-hides read elements when they are not in use. This is currently used for the Upload Activities use case.

Default Value:: false

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.autoReadData

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

See:: Garmin.DeviceDisplayDefaultOptions.autoFindDevices; Garmin.DeviceDisplayDefaultOptions.autoWriteData

Default Value:: false

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.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.

See:: Garmin.DeviceDisplayDefaultOptions.showDeviceSelectOnSingle; Garmin.DeviceDisplayDefaultOptions.showDeviceSelectNoDevice; Garmin.DeviceDisplayDefaultOptions.showFindDevicesElement

Default Value:: false

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.autoWriteData

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

See:: Garmin.DeviceDisplayDefaultOptions.autoFindDevices; Garmin.DeviceDisplayDefaultOptions.autoReadData

Default Value:: false

<static> {String} Garmin.DeviceDisplayDefaultOptions.browseComputerButtonClass

The classname referencing the button that displays the UI for browsing the user's file system.

Default Value:: browseComputerButtonClass

<static> {String} Garmin.DeviceDisplayDefaultOptions.browseComputerButtonId

The id referencing the button that displays the UI for browsing the user's file system.

Default Value:: browseComputerButton

<static> {String} Garmin.DeviceDisplayDefaultOptions.browseComputerButtonText

The text for the button that displays the UI for browsing the user's file system.

Default Value:: "Browse Computer"

<static> {String} Garmin.DeviceDisplayDefaultOptions.browseComputerContentUrl

The url of the iframe to load into the browse computer container. The iframe object is generated by the API. See browseComputerElementClass to change the dimensions of the iframe.

<static> {String} Garmin.DeviceDisplayDefaultOptions.browseComputerElementClass

The classname for the browse computer container.

<static> {String} Garmin.DeviceDisplayDefaultOptions.browseComputerElementId

The id for the browse computer container.

<static> {String} Garmin.DeviceDisplayDefaultOptions.browseComputerLabel

The text label to display in the browser list for browsing the computer.

Default Value:: My Computer

<static> {String} Garmin.DeviceDisplayDefaultOptions.cancelFindDevicesButtonId

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

Default Value:: cancelFindDevicesButton

<static> {String} Garmin.DeviceDisplayDefaultOptions.cancelFindDevicesButtonText

The text for the cancel find device button.

Default Value:: "Cancel Find Devices"

<static> {String} Garmin.DeviceDisplayDefaultOptions.cancelReadDataButtonId

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

Default Value:: cancelReadDataButton

<static> {String} Garmin.DeviceDisplayDefaultOptions.cancelReadDataButtonText

The text on the cancel read button.

<static> {String} Garmin.DeviceDisplayDefaultOptions.cancelReadStatusText

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

<static> {String} Garmin.DeviceDisplayDefaultOptions.cancelUploadButtonClass

Class name for the cancel upload button. Useful for CSS customizations.

Default Value:: cancelUploadButtonClass

<static> {String} Garmin.DeviceDisplayDefaultOptions.cancelUploadButtonId

Element ID for the cancel upload button.

Default Value:: 'cancelUploadButton'

<static> {String} Garmin.DeviceDisplayDefaultOptions.cancelUploadButtonText

Text to display on Cancel upload button.

Default Value:: '(Cancel)'

<static> {String} Garmin.DeviceDisplayDefaultOptions.cancelWriteDataButtonId

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

Default Value:: cancelWriteDataButton

<static> {String} Garmin.DeviceDisplayDefaultOptions.cancelWriteDataButtonText

The text on the cancel write button.

<static> {String} Garmin.DeviceDisplayDefaultOptions.changeDeviceButtonText

The text to display to change the device. This is useful for internationalization.

Default Value:: '(Change)'

<static> {String} Garmin.DeviceDisplayDefaultOptions.changeDeviceClass

The classname referencing the change device element, which is a link that allows the user to change device in list mode.

Default Value:: changeDevice

<static> {String} Garmin.DeviceDisplayDefaultOptions.changeDeviceElementId

The id referencing the change device element, which is a link that allows the user to change device in list mode.

Default Value:: changeDevice

<static> {String} Garmin.DeviceDisplayDefaultOptions.connectedDevicesClass

The class name referencing the connected devices label displayed when using the device select list.

Default Value:: connectedDevicesClass

<static> {String} Garmin.DeviceDisplayDefaultOptions.connectedDevicesImg

The image to display in the connected devices label.

<static> {String} Garmin.DeviceDisplayDefaultOptions.connectedDevicesLabel

The label for connected devices, displayed when using the device select list.

Default Value:: 'Connected devices:'

<static> Garmin.DeviceDisplayDefaultOptions.dataDownloadProcessing

Status message exposed for internationalization. When large files are being written to device. @type String

<static> {Array dataFilters} Garmin.DeviceDisplayDefaultOptions.dataFilters

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

[Garmin.FILTERS.historyOnly]

See:: Garmin.FILTERS

<static> Garmin.DeviceDisplayDefaultOptions.dataFound

Status message template exposed for internationalization. @type String

<static> Garmin.DeviceDisplayDefaultOptions.dataReadProcessing

Status message exposed for internationalization. When reading data from the device. @type String

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.detectNewActivities

Detect new activities in the activity listing by comparing the device list to a server list.

Default Value:: true

<static> {String} Garmin.DeviceDisplayDefaultOptions.deviceBrowserElementClass

The classname for the device browser element. This is useful for custom CSS.

Default Value:: deviceBrowserBoxClass

<static> {String} Garmin.DeviceDisplayDefaultOptions.deviceBrowserElementId

The id referencing the device browser element. This is useful for custom CSS.

Default Value:: deviceBrowserList

<static> {String} Garmin.DeviceDisplayDefaultOptions.deviceBrowserLabel

The text label to display above the device browser list. This is useful for custom CSS.

Default Value:: 'Browse devices:'

<static> {String} Garmin.DeviceDisplayDefaultOptions.deviceBrowserLabelClass

The classname for the device browser text label. This is useful for custom CSS.

Default Value:: deviceBrowserLabelClass

<static> {String} Garmin.DeviceDisplayDefaultOptions.deviceBrowserLabelId

The id referencing the device browser text label. This is useful for custom CSS.

Default Value:: deviceBrowserLabelId

<static> {String} Garmin.DeviceDisplayDefaultOptions.deviceBrowserListId

The id referencing the device browser list. This is useful for CSS customizations.

Default Value:: deviceBrowserList

<static> {int} Garmin.DeviceDisplayDefaultOptions.deviceLabelMaxSize

The maximum number of characters to display for a device name.

<static> {String} Garmin.DeviceDisplayDefaultOptions.deviceSelectClass

The class name referencing the device select element. This is useful for CSS customizations.

Default Value:: deviceSelectClass

<static> {String} Garmin.DeviceDisplayDefaultOptions.deviceSelectedElementId

The id referencing the element that displays what device was selected. This is useful for CSS customizations.

Default Value:: deviceSelected

<static> {String} Garmin.DeviceDisplayDefaultOptions.deviceSelectedLabel

The label for the device selected element. This label preceeds the device selected element. This is useful for CSS customizations.

Default Value:: "Previewing "

<static> {String} Garmin.DeviceDisplayDefaultOptions.deviceSelectedLabelId

The id referencing the label for the element that displays what device was selected. This is useful for CSS customizations.

Default Value:: deviceSelectedLabel

<static> {String} Garmin.DeviceDisplayDefaultOptions.deviceSelectElementId

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

Default Value:: deviceSelectBox

<static> {String} Garmin.DeviceDisplayDefaultOptions.deviceSelectId

The id referencing the device select element. This is useful for CSS customizations.

Default Value:: deviceSelect

<static> {String} Garmin.DeviceDisplayDefaultOptions.deviceSelectLabel

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

Default Value:: "Devices: "

<static> {String} Garmin.DeviceDisplayDefaultOptions.deviceSelectLabelId

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

Default Value:: deviceSelectLabel

<static> Garmin.DeviceDisplayDefaultOptions.downloadAndInstall

Request message exposed for internationalization. @type String

<static> {String} Garmin.DeviceDisplayDefaultOptions.elementClassName

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

See:: Garmin.DeviceDisplayDefaultOptions.statusElementId; Garmin.DeviceDisplayDefaultOptions.readDataElementId; Garmin.DeviceDisplayDefaultOptions.findDevicesElementId

Default Value:: "pluginElement"

<static> Garmin.DeviceDisplayDefaultOptions.errorActivitySelect

Error message to display when user attempts to upload 0 activities. @type String

<static> Garmin.DeviceDisplayDefaultOptions.errorHttpResponse

Error message to display when there is an error getting the HTTP response back from the HTTP request. @type String

<static> Garmin.DeviceDisplayDefaultOptions.findCancelled

Status message exposed for internationalization. When user cancels Find Devices.@type String

<static> {String} Garmin.DeviceDisplayDefaultOptions.findDevicesButtonId

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

Default Value:: findDevicesButton

<static> {String} Garmin.DeviceDisplayDefaultOptions.findDevicesButtonText

The text for the find device button.

Default Value:: "Find Devices"

<static> {String} Garmin.DeviceDisplayDefaultOptions.findDevicesElementId

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

Default Value:: deviceBox

<static> Garmin.DeviceDisplayDefaultOptions.foundDevice

Status template exposed for internationalization. When single device is found. @type String

<static> Garmin.DeviceDisplayDefaultOptions.foundDevices

Status template exposed for internationalization. When multiple devices are found. @type String

<static> Garmin.DeviceDisplayDefaultOptions.gpsData

Read data selection option exposed for internationalization. @type String

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.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

Default Value:: false

<static> Garmin.DeviceDisplayDefaultOptions.installNow

Request message exposed for internationalization. @type String

<static> {String} Garmin.DeviceDisplayDefaultOptions.loadingContentText

The text to display on the loading content screen. This is useful for internationalization.

Default Value:: 'Loading content...'

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.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).

See:: Garmin.DeviceDisplayDefaultOptions._listTracks

Default Value:: true

<static> Garmin.DeviceDisplayDefaultOptions.lookingForDevices

Status message exposed for internationalization. @type String

<static> {String} Garmin.DeviceDisplayDefaultOptions.noDeviceDetectedStatusText

The status text that is displayed when no devices are found. The Find Devices button is displayed to allow the user to try again. To change the button text, set findDevicesButtonText.

Default Value:: "No devices found."

<static> Garmin.DeviceDisplayDefaultOptions.noFilteredActivities

Status text to display when none of the activities from the device meet the filter requirements. @type String

<static> Garmin.DeviceDisplayDefaultOptions.noParseSupportForType

Error message exposed for internationalization. @type String

<static> Garmin.DeviceDisplayDefaultOptions.notOverwritingFile

Status message exposed for internationalization. @type String

<static> Garmin.DeviceDisplayDefaultOptions.overwritingFile

Status message exposed for internationalization. @type String

<static> {String[]} Garmin.DeviceDisplayDefaultOptions.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.

<static> {Array} Garmin.DeviceDisplayDefaultOptions.pluginLatestVersion

Sets the latest plugin version number. This represents the latest version available for download at Garmin. We will attempt to keep the default value of this up to date with each API release, but this is not guaranteed, so set this to be safe or if you don't want to upgrade to the latest API.

Default Value:: [2,5,1,0] (for version 2.5.1.0)

<static> Garmin.DeviceDisplayDefaultOptions.pluginNotUnlocked

Status message exposed for internationalization. @type String

<static> {Array} Garmin.DeviceDisplayDefaultOptions.pluginRequiredVersion

Sets the required version of the Communicator Plugin that is compatible with the given application. This value is set using an array of the major and minor build numbers. *

version 2.2.0.1 is given by [2,2,0,1].

Default Value:: [2,2,0,1] (for version 2.2.0.1)

<static> Garmin.DeviceDisplayDefaultOptions.pluginUnlocked

Status message exposed for internationalization. @type String

<static> Garmin.DeviceDisplayDefaultOptions.poweredByGarmin

Powered-by message. Required for plugin license agreement. @type String

<static> {String} Garmin.DeviceDisplayDefaultOptions.previewDeviceClass

The classname referencing the preview device element, which displays an image depending on the device selected.

See:: Garmin.DeviceDisplayDefaultOptions.previewDeviceDefaultImg

Default Value:: previewDevice

<static> {String} Garmin.DeviceDisplayDefaultOptions.previewDeviceDefaultImg

The default image URL to display for any selected device.

See:: Garmin.DeviceDisplayDefaultOptions.previewDeviceId; Garmin.DeviceDisplayDefaultOptions.useDeviceSelectList

<static> {String} Garmin.DeviceDisplayDefaultOptions.previewDeviceElementId

The id referencing the change device element, which is a link that allows the user to change device in list mode.

Default Value:: changeDevice

<static> {String} Garmin.DeviceDisplayDefaultOptions.progressBarBackClass

The background of the progress bar. This stays static during transfer.

Default Value:: 'progressBarBackClass'

<static> {String} Garmin.DeviceDisplayDefaultOptions.progressBarBackId

The background of the progress bar. This stays static during transfer.

Default Value:: 'progressBarBack'

<static> {String} Garmin.DeviceDisplayDefaultOptions.progressBarClass

The class name for the progress bar container element.

Default Value:: 'progressBarClass'

<static> {String} Garmin.DeviceDisplayDefaultOptions.progressBarDisplayClass

The class name for the dynamic progress bar that is overlaid on top of the progressBar element. This controls the part that 'moves'.

Default Value:: 'progressBarDisplayClass'

<static> {String} Garmin.DeviceDisplayDefaultOptions.progressBarDisplayId

The id of the displayed progress element. This is dynamic during transfer.

Default Value:: 'progressBarDisplay'

<static> {String} Garmin.DeviceDisplayDefaultOptions.progressBarId

The container for the progress bar.

Default Value:: 'progressBar'

<static> {String} Garmin.DeviceDisplayDefaultOptions.progressBarTextClass

The class name for the progress bar text.

Default Value:: progressBarTextClass

<static> {String} Garmin.DeviceDisplayDefaultOptions.progressBarTextId

The id of the progress bar text. This is generally the percentage value text displayed, but could also be in the context of what is being transferred (i.e. 1 of 5 activities).

Default Value:: progressBarText

<static> {String} Garmin.DeviceDisplayDefaultOptions.progressTextClass

The class name for the progress status text. This element will be a child of the statusText element.

<static> {String} Garmin.DeviceDisplayDefaultOptions.progressTextId

The id of the HTML element where the progress status text is to be displayed. This element will be a child of the statusText element.

Default Value:: "progressText"

<static> {String} Garmin.DeviceDisplayDefaultOptions.readDataButtonId

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

Default Value:: readDataButton

<static> {String} Garmin.DeviceDisplayDefaultOptions.readDataButtonText

The text on the read button.

<static> {String} Garmin.DeviceDisplayDefaultOptions.readDataElementId

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

Default Value:: readBox

<static> {String} Garmin.DeviceDisplayDefaultOptions.readDataType

DEPRECATED - Use Garmin.DeviceDisplayDefaultOptions.readDataTypes 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 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 GPX: Define the getWriteData() and getWriteDataFileName() functions in your options section.

For GPI: Define the getWriteData() and getWriteDataFileName() functions in your options section. The getGpiWriteDescription() function replaces getWriteData().

See:: Garmin.DeviceDisplayDefaultOptions.showReadDataElement; Garmin.DeviceControl.FILE_TYPES; Garmin.DeviceDisplayDefaultOptions.readDataTypes

Default Value:: Garmin.DeviceControl.FILE_TYPES.gpx

<static> {Array} Garmin.DeviceDisplayDefaultOptions.readDataTypes

OVERRIDES readDataType! Tells the plug-in what data types to read from the device, in order of preference. Options for this are currently constants listed in Garmin.DeviceControl.FILE_TYPES.

["FitnessHistory", "GPSData"]

See:: Garmin.DeviceDisplayDefaultOptions.showReadDataElement; Garmin.DeviceControl.FILE_TYPES

Default Value:: TCX, GPX

<static> {String} Garmin.DeviceDisplayDefaultOptions.readDataTypesSelectId

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

Default Value:: readDataTypesSelect

<static> {String} Garmin.DeviceDisplayDefaultOptions.readGoogleMapId

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

Default Value:: readMap

<static> {String} Garmin.DeviceDisplayDefaultOptions.readResultsElementClass

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

Default Value:: readResultsElement

<static> {String} Garmin.DeviceDisplayDefaultOptions.readResultsSelectClass

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

Default Value:: readResultsSelect

<static> {String} Garmin.DeviceDisplayDefaultOptions.readRoutesElementId

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

Default Value:: readRoutesElement

<static> {String} Garmin.DeviceDisplayDefaultOptions.readRoutesSelectId

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

Default Value:: readRoutesSelect

<static> {String} Garmin.DeviceDisplayDefaultOptions.readRoutesSelectLabel

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

<static> {String} Garmin.DeviceDisplayDefaultOptions.readRoutesSelectLabelId

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

Default Value:: readRoutesSelectLabel

<static> {String} Garmin.DeviceDisplayDefaultOptions.readSelectedButtonId

The id referencing the button for uploading selected activities button. This is useful for CSS customizations.

Default Value:: readSelectedButton

<static> {String} Garmin.DeviceDisplayDefaultOptions.readSelectedButtonText

The text label for the upload selected data button. This is useful for CSS customizations.

Default Value:: Upload Selected

<static> {String} Garmin.DeviceDisplayDefaultOptions.readTracksElementId

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

Default Value:: readTracksElement

<static> {String} Garmin.DeviceDisplayDefaultOptions.readTracksSelectId

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

Default Value:: readTracksSelect

<static> {String} Garmin.DeviceDisplayDefaultOptions.readTracksSelectLabel

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

<static> {String} Garmin.DeviceDisplayDefaultOptions.readTracksSelectLabelId

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

Default Value:: deviceSelectLabel

<static> {String} Garmin.DeviceDisplayDefaultOptions.readWaypointsElementId

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

Default Value:: readTracksElement

<static> {String} Garmin.DeviceDisplayDefaultOptions.readWaypointsSelectId

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

Default Value:: readWaypointsSelect

<static> {String} Garmin.DeviceDisplayDefaultOptions.readWaypointsSelectLabel

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

<static> {String} Garmin.DeviceDisplayDefaultOptions.readWaypointsSelectLabelId

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

Default Value:: readWaypointsSelectLabel

<static> {Array} Garmin.DeviceDisplayDefaultOptions.restrictByDevice

Optional - Restricts transfer of data to specifically listed devices ONLY. This is an array list of device part numbers, which can be found in the GarminDevice.XML.

["006-B1018-00"] // Forerunner 310 only

<static> {String} Garmin.DeviceDisplayDefaultOptions.sendDataButtonId

The id referencing the send data button. This is useful for CSS customizations.

Default Value:: sendDataButton

<static> {String} Garmin.DeviceDisplayDefaultOptions.sendDataButtonText

The text on the read button.

<static> {String} Garmin.DeviceDisplayDefaultOptions.sendDataElementId

The id referencing the box containing send elements. This is useful for CSS customizations.

Default Value:: sendBox

<static> {Object} Garmin.DeviceDisplayDefaultOptions.sendDataOptions

The AJAX request options to use for sending data to a server. To be used in conjunction with sendDataUrl . See the AJAX options page for configurable options and default values.

<static> {String} Garmin.DeviceDisplayDefaultOptions.sendDataUrl

The URL to send the data to.

<static> Garmin.DeviceDisplayDefaultOptions.sendingDataToServer

Status text to display when the plugin is sending data to a remote server. @type String

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showAboutElement

The choice to display the about ('Powered by...') element

Default Value:: true

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.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.

See:: Garmin.DeviceDisplayDefaultOptions.showReadDataElement

Default Value:: true

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showBrowseComputer

Allows the user to browse their file system for upload. uploadSelectedActivities must be set to true for this option to take effect.

Default Value:: false

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.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 Value:: false

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.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 Value:: true

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showCancelWriteDataButton

Controls the view of the cancel write 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 showWriteDataButton , and showWriteDataElement .

Default Value:: true

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showDetailedStatus

The choice to display more detailed status when transferring data to and from device.

Default Value:: false

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showDeviceButtonsOnFound

Controls the view of the buttons related to find devices (find & cancel) if based on if the plugin finds one or more devices. When set to false and used with showDeviceButtonsOnLoad =false and autoFindDevices =true these buttons will only show up if a device is not found (minimizing confusion for the user).

More granular control is provided on each of the device buttons showFindDevicesButton and showCancelFindDevicesButton .

See:: Garmin.DeviceDisplayDefaultOptions.showFindDevicesElement

Default Value:: true

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showDeviceButtonsOnLoad

If true the buttons will show when the page is rendered. If false, the buttons will not be displayed until the plugin detects that a device is not found. If you choose not to see the buttons at all (regardless if device is found or not) then showFindDevicesElement should be set to false.

See:: Garmin.DeviceDisplayDefaultOptions.showDeviceButtonsOnFound; Garmin.DeviceDisplayDefaultOptions.showFindDevicesElement

Default Value:: true

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showDeviceSelectNoDevice

Controls the view of the device select box. When set to true the select device box will show even when no device is found. When set to false the select device box will hide when no device is found. When showFindDevicesElement is set to false, the device select box will never show.

See:: Garmin.DeviceDisplayDefaultOptions.showDeviceSelectOnSingle; Garmin.DeviceDisplayDefaultOptions.showDeviceSelectOnLoad; Garmin.DeviceDisplayDefaultOptions.showFindDevicesElement

Default Value:: true

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showDeviceSelectOnLoad

Controls the view of the device select box. When set to true the select device box will show when the display loads. When set to false the select device box will never be visible. When showFindDevicesElement is set to false, the device select box will never show.

See:: Garmin.DeviceDisplayDefaultOptions.showDeviceSelectOnSingle; Garmin.DeviceDisplayDefaultOptions.showDeviceSelectNoDevice; Garmin.DeviceDisplayDefaultOptions.showFindDevicesElement

Default Value:: true

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showDeviceSelectOnSingle

Controls the view of the device select box. When set to true the select device box will show even when only one device is found. When set to false the select device box will hide when only one device is found. When showFindDevicesElement is set to false, the device select box will never show.

See:: Garmin.DeviceDisplayDefaultOptions.showDeviceSelectNoDevice; Garmin.DeviceDisplayDefaultOptions.showDeviceSelectOnLoad; Garmin.DeviceDisplayDefaultOptions.showFindDevicesElement

Default Value:: false

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showFindDevicesButton

Allows granular control to hide the find devices button independent of the showCancelFindDevicesButton cancel button contol.

Default Value:: true

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showFindDevicesElement

Choice to display the find devices area that will search for connected devices.

Default Value:: true

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showFindDevicesElementOnLoad

Choice to display the find devices area that will search for connected devices when the page loads.

Default Value:: true

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showProgressBar

The progress bar is a graphical percentage bar used to display the amount of reading/writing is complete.

Default Value:: true

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showReadDataButton

Controls the view of the 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 showReadDataElement .

Default Value:: true

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showReadDataElement

Display the user interface associated with reading from a connected device.

Default Value:: true

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showReadDataElementOnDeviceFound

Controls the view of the read data element. When set to true the element will only show after a device has been found. When set to false the element will show on page load. Behavior will depend on other settings such as and showReadDataElement .

Default Value:: false

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showReadDataTypesSelect

Display the dropdown select box for selecting what type of data to read from the device. When <@link showReadDataElement> is set to false, this device type select will not show.

See:: Garmin.DeviceDisplayDefaultOptions.showReadDataElement

Default Value:: false

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showReadGoogleMap

Display Google map to show tracks and laps that have been read. When <@link showReadDataElement> is set to false, the Google map will not show.

See:: Garmin.DeviceDisplayDefaultOptions.showReadDataElement

Default Value:: false

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showReadResultsSelectOnLoad

Controls the view of the device select box. When set to true the select device box will show when the display loads. When set to false the select device box will hide when the display loads. When showReadDataElement is set to false, the results select box will never show.

See:: Garmin.DeviceDisplayDefaultOptions.showReadDataElement

Default Value:: false

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showReadRoutesSelect

Display the route select dropdown. When <@link showReadDataElement> is set to false, the select track dropdown will not show.

See:: Garmin.DeviceDisplayDefaultOptions.showReadDataElement

Default Value:: true

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showReadTracksSelect

Display the track select dropdown. When <@link showReadDataElement> is set to false, the select track dropdown will not show.

See:: Garmin.DeviceDisplayDefaultOptions.showReadDataElement

Default Value:: true

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showReadWaypointsSelect

Display the waypoint select dropdown. When <@link showReadDataElement> is set to false, the select waypoint dropdown will not show.

See:: Garmin.DeviceDisplayDefaultOptions.showReadDataElement

Default Value:: true

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showSendDataElement

Show the element to send data to a remote server.

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showSendDataElementOnDeviceFound

Controls the view of the send data element. When set to true the element will only show after a device has been found. When set to false the element will show on page load. Behavior will depend on other settings such as and showSendDataElement .

Default Value:: false

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showStatusElement

The choice to display the feedback regarding the communications with the device.

Default Value:: true

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showUploadNewButton

Display the user interface associated with uploading new activities from a connected device.

Default Value:: true

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showWriteDataElement

Display the user interface associated with writing to a connected device.

Default Value:: false

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.showWriteDataElementOnDeviceFound

Controls the view of the write data element. When set to true the element will only show after a device has been found. When set to false the element will show on page load. Behavior will depend on other settings such as and showWriteDataElement .

Default Value:: false

<static> {String} Garmin.DeviceDisplayDefaultOptions.singleDeviceDetectedStatusText

The status text that prepends itself to the device name when a single device is found.

Default Value:: "Found "

<static> {String} Garmin.DeviceDisplayDefaultOptions.statusCellProcessingImg

The innerHTML to use for status while an activity is processing (for upload). Define using the img tag if you wish to use an image.

Default Value:: '' which is an animated loader image. You can customize this to be text instead of an image by not using the image tags.

<static> {String} Garmin.DeviceDisplayDefaultOptions.statusElementId

The id of the HTML element where the statusBox is to be rendered.

Default Value:: "statusBox"

<static> {String} Garmin.DeviceDisplayDefaultOptions.statusTextId

The id of the HTML element where the status text messages are to be displayed.

Default Value:: "statusText"

<static> {Object} Garmin.DeviceDisplayDefaultOptions.syncDataOptions

The AJAX request options to use for posting the parameters to a server. To be used in conjunction with syncDataUrl . See the AJAX options page for configurable options and default values.

<static> {String} Garmin.DeviceDisplayDefaultOptions.syncDataUrl

The URL to make the sync request to. To be used in conjuntion with syncDataOptions. detectNewActivities must be set to true.

<static> Garmin.DeviceDisplayDefaultOptions.trackListing

Track list box item template exposed for internationalization. @type String

<static> Garmin.DeviceDisplayDefaultOptions.trainingData

Read data selection option exposed for internationalization. @type String

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.unlockOnPageLoad

Unlock plugin when user lands on containing page which may result in security or plugin-not-installed messages. Set to false to supress plugin acivity until user initiates an action.

Default Value:: true

<static> Garmin.DeviceDisplayDefaultOptions.unsupportedDevice

Status message for devices that are not in the allowed devices list, or do not support any of the application's supported filetypes. @type String

<static> Garmin.DeviceDisplayDefaultOptions.unsupportedReadDataType

Error message to display when attempting to write to a device that does not support the provided datatype. Useful for CSS customizations and internationalization. @type String

<static> Garmin.DeviceDisplayDefaultOptions.unsupportedWriteDataType

Error message to display when attempting to write to a device that does not support the provided datatype. Useful for CSS customizations and internationalization. @type String

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.uploadCompressedData

Upload compressed data. Compressed data is gzip base 64 encoded. Compression is supported for fitness history activities only.

Default Value:: false

<static> Garmin.DeviceDisplayDefaultOptions.uploadingActivities

Status message to display when activities are being uploaded. @type String

<static> {String} Garmin.DeviceDisplayDefaultOptions.uploadingStatusText

The text to display above the upload progress bar. This is a static string.

Default Value:: "Uploading activities..."

<static> {int} Garmin.DeviceDisplayDefaultOptions.uploadMaximum

Maximum number of activities allowed for upload selection. Users are notified during the selection process if they try to exceed this value. uploadSelectedActivities must be set to true for this to work. Note that if this value is > 0, the 'select all activities' feature will not be available. Set this value to 0 for no limit with NO 'select all activities' checkbox.

See:: Garmin.DeviceDisplayDefaultOptions.uploadSelectedActivities

Default Value:: -1 (no limit with 'select all' checkbox)

<static> Garmin.DeviceDisplayDefaultOptions.uploadMaximumReached

Error message exposed for internationalization. When maximum selection for upload is reached. @type String

<static> {String} Garmin.DeviceDisplayDefaultOptions.uploadNewButtonId

The id referencing the button for uploading data to a server. This is useful for CSS customizations.

Default Value:: uploadNewButton

<static> {String} Garmin.DeviceDisplayDefaultOptions.uploadNewButtonText

The text label for the upload data button. This is useful for CSS customizations.

Default Value:: activityDirectory

<static> {String} Garmin.DeviceDisplayDefaultOptions.uploadProgressBarBackClass

The background of the uploadProgress bar. This stays static during transfer.

Default Value:: 'uploadProgressBarBackClass'

<static> {String} Garmin.DeviceDisplayDefaultOptions.uploadProgressBarBackId

The background of the uploadProgress bar. This stays static during transfer.

Default Value:: 'uploadProgressBarBack'

<static> {String} Garmin.DeviceDisplayDefaultOptions.uploadProgressBarClass

The class name for the uploadProgress bar container element.

Default Value:: 'uploadProgressBarClass'

<static> {String} Garmin.DeviceDisplayDefaultOptions.uploadProgressBarDisplayClass

The class name for the dynamic uploadProgress bar that is overlaid on top of the uploadProgressBar element. This controls the part that 'moves'.

Default Value:: 'uploadProgressBarDisplayClass'

<static> {String} Garmin.DeviceDisplayDefaultOptions.uploadProgressBarDisplayId

The id of the displayed uploadProgress element. This is dynamic during transfer.

Default Value:: 'uploadProgressBarDisplay'

<static> {String} Garmin.DeviceDisplayDefaultOptions.uploadProgressBarId

The container for the uploadProgress bar.

Default Value:: 'uploadProgressBar'

<static> {String} Garmin.DeviceDisplayDefaultOptions.uploadProgressBarTextClass

The class name for the uploadProgress bar text.

Default Value:: uploadProgressBarTextClass

<static> {String} Garmin.DeviceDisplayDefaultOptions.uploadProgressBarTextId

The id of the uploadProgress bar text. This is generally the percentage value text displayed, but could also be in the context of what is being transferred (i.e. 1 of 5 activities).

Default Value:: uploadProgressBarText

<static> {String} Garmin.DeviceDisplayDefaultOptions.uploadProgressStatusText

Templated string used to display the upload progress status. The template parameters currentUpload and totalUploads must be included to work properly, as the default value does.

Default Value:: #{currentUpload} of #{totalUploads} completed.

<static> {String} Garmin.DeviceDisplayDefaultOptions.uploadProgressTextClass

The class name for the uploadProgress status text. This element will be a child of the statusText element.

Default Value:: "uploadProgressTextClass"

<static> {String} Garmin.DeviceDisplayDefaultOptions.uploadProgressTextId

The id of the HTML element where the upload progress status text is to be displayed. This element will be a child of the statusText element.

Default Value:: "uploadProgressText"

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.uploadSelectedActivities

Select activities to upload, rather than all activities read off the device.

Default Value:: false

<static> Garmin.DeviceDisplayDefaultOptions.uploadsFinished

Status message exposed for internationalization. When uploads have completed. @type String

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.useDeviceBrowser

Show the device browser list. Currently the browser list is only available when activity directory reading is on (readDataType = Garmin.DeviceControl.FILE_TYPES.tcxDir).

See:: Garmin.DeviceDisplayDefaultOptions.uploadSelectedActivities

Default Value:: true

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.useDeviceSelectList

Display list instead of select drop down.

Default Value:: false

<static> {Boolean} Garmin.DeviceDisplayDefaultOptions.useLinks

Display link instead of buttons. Currently this only applies to the 'Find Devices' button.

Default Value:: false

<static> {String} Garmin.DeviceDisplayDefaultOptions.usingDevice

Status message exposed for internationalization. Prepended to the device name after user selects which device to use. i.e. "Using Diana's Forerunner 305"

Default Value:: "Using "

<static> {String} Garmin.DeviceDisplayDefaultOptions.writeDataButtonId

The id referencing the write data button. This is useful for CSS customizations.

Default Value:: writeDataButton

<static> {String} Garmin.DeviceDisplayDefaultOptions.writeDataButtonText

The text on the write button.

<static> {String} Garmin.DeviceDisplayDefaultOptions.writeDataElementId

The id referencing the box containing write elements. This is useful for CSS customizations.

Default Value:: writeBox

<static> {String} Garmin.DeviceDisplayDefaultOptions.writeDataType

DEPRECATED - Use Garmin.DeviceDisplayDefaultOptions.writeDataTypes Tells the plug-in what data type to write to the device. Options are "gpx" which will use getWriteData to get the data or "gpi" which will use getGpiWriteDescription to get the data to save to the device.

See:: Garmin.DeviceDisplayDefaultOptions.showWriteDataElement; Garmin.DeviceDisplayDefaultOptions.getWriteData; Garmin.DeviceDisplayDefaultOptions.getGpiWriteDescription; Garmin.DeviceDisplayDefaultOptions.writeDataTypes

Default Value:: Garmin.DeviceControl.FILE_TYPES.gpx

<static> {Array} Garmin.DeviceDisplayDefaultOptions.writeDataTypes

OVERRIDES writeDataType! Tells the plug-in what data type to write to the device. Options are "gpx" which will use getWriteData to get the data or "gpi" which will use getGpiWriteDescription to get the data to save to the device.

See:: Garmin.DeviceDisplayDefaultOptions.showWriteDataElement; Garmin.DeviceDisplayDefaultOptions.getWriteData; Garmin.DeviceDisplayDefaultOptions.getGpiWriteDescription

Default Value:: Garmin.DeviceControl.FILE_TYPES.gpx

<static> Garmin.DeviceDisplayDefaultOptions.writingCancelled

Status message exposed for internationalization. @type String

<static> Garmin.DeviceDisplayDefaultOptions.writingToDevice

Status message exposed for internationalization. @type String

<static> Garmin.DeviceDisplayDefaultOptions.writtenToDevice

Status message exposed for internationalization. @type String

Method Detail

<static> {function} Garmin.DeviceDisplayDefaultOptions.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

function(devices){...}

<static> {function} Garmin.DeviceDisplayDefaultOptions.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 <@link Garmin.Activity> parsed from the xml.
display - the display object

function(dataString, dataDoc, extension, activities, display){...}

See:: Garmin.DeviceDisplayDefaultOptions.Garmin.Activity

<static> {function} Garmin.DeviceDisplayDefaultOptions.afterFinishSendData(response)

The callback function that will be passed the AJAX response after making the request. The display object is passed in, so you can make follow-up read or write calls if so desired.

function(response){}

Parameters:
response: object (see Ajax.Response for response attributes)

See:: Garmin.DeviceDisplayDefaultOptions.sendDataUrl; Garmin.DeviceDisplayDefaultOptions.getSendOptions

<static> {function} Garmin.DeviceDisplayDefaultOptions.afterFinishUploads()

The function called after all item uploads complete successfully or unsuccessfully. The function will have one argument: display {Garmin.DeviceDisplay - the current instance of the DeviceDisplay

function(display) {...}

<static> {function} Garmin.DeviceDisplayDefaultOptions.afterFinishWriteToDevice()

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

function(success, display) {...}

<static> {function} Garmin.DeviceDisplayDefaultOptions.afterSelectDevice(deviceNum, devices, deviceXml)

The callback function that will be called when the user selects a device from the device browser.

function(deviceXml){...}

Parameters:
deviceNum: the device number of the selected device
devices: an array of the detected devices
deviceXml: the device xml of the selected device

<static> {function} Garmin.DeviceDisplayDefaultOptions.afterTableInsert(Boolean, activity, statusCell, checkbox, Object, activityMatcher, display)

The function called after an activity entry is added to the activity listing table. Useful for updating the status cell in a unique way.

function(index, activity, statusCell, checkbox, row, this.activityMatcher, this) {...}

Parameters:
Boolean: index - the index in the table where the activity was added
{Garmin.Activity} activity
{Element} statusCell: - the status td element associated with the activity
{Element} checkbox: - the checkbox input element associated with the activity
Object: row - the table row element associated with the activity
{Garmin.ActivityMatcher} activityMatcher: - the activity matcher object, if available.
{Garmin.DeviceDisplay} display: - the current instance of the display object

<static> {function} Garmin.DeviceDisplayDefaultOptions.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

function(error, display){ display.defaultExceptionHandler(error); }

<static> Garmin.DeviceDisplayDefaultOptions.getActivityDirectoryHeaderIdLabel()

Column header for the Date/Name fields in the activity directory. Useful for CSS customizations and internationalization. Default to Date if nothing is specified @type String

<static> {function} Garmin.DeviceDisplayDefaultOptions.getBinaryWriteDescription()

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 binary data 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.

function() { return ["http://connect.garmin.com/SampleGpi.gpi", "Garmin\\POI\\Test.gpi"] }

<static> {function} Garmin.DeviceDisplayDefaultOptions.getGpiWriteDescription()

DEPRECATED (see getBinaryWriteDescription) - 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.

function() { return ["http://connect.garmin.com/SampleGpi.gpi", "Garmin\\POI\\Test.gpi"] }

<static> {function} Garmin.DeviceDisplayDefaultOptions.getSendOptions()

The callback function to set the request options when hitting the remote server. This function is passed these parameters: options - The options object. Use this object to set the property values. Some may already be set by sendDataOptions. getSendOptions will overwrite any existing ones. deviceXml - the active device's XML data - read data from the device, if any Don't forget to return the options object!

function(options, deviceXml, data) {}

<static> {function} Garmin.DeviceDisplayDefaultOptions.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.

function() { return $("myTextAreaId").value; }

See:: Garmin.DeviceDisplayDefaultOptions.getWriteDataFileName

<static> {function} Garmin.DeviceDisplayDefaultOptions.getWriteDataFileName()

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

See:: Garmin.DeviceDisplayDefaultOptions.getWriteData

<static> {function} Garmin.DeviceDisplayDefaultOptions.postActivityHandler()

The function called when a single activity is finished reading, and the data is ready to post. Use this if you need a custom way of uploading data to your server (advanced users).

Otherwise, if you just need an AJAX call, use Send Data. (See this.options.sendDataUrl and this.options.sendDataOptions.) Parameters to this function:

datastring String - The XML datastring of the activity read from the device.

display {GarminDeviceDisplay} - the display object

function(datastring, display){...}

Classes

Class Garmin.DeviceDisplayDefaultOptions