Garmin.DeviceDisplayDefaultOptions

Overview

File

Class

Tree

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Class Garmin.DeviceDisplayDefaultOptions

Object
   |
   +--Garmin.DeviceDisplayDefaultOptions

class Garmin.DeviceDisplayDefaultOptions

Defined in GarminDeviceDisplay.js

Field Summary
`String`	`actionButtonClassName` Class name to add for all buttons/links that perform an action
`Function`	`afterFinishFindDevices` The function called when device search completes successfully or unsuccessfully.
`Function`	`afterFinishReadFromDevice` The function called when data is successfully read from the device.
`Function`	`afterFinishWriteToDevice` The function called when data is successfully writte to the device.
`Boolean`	`autoFindDevices` Looks for devices as soon as the page is loaded and the plugin unlocked.
`Boolean`	`autoReadData` Start reading data from the device when one or more device(s) is found.
`Boolean`	`autoSelectFirstDevice` When more than one device is detected automaticly pick the first device.
`Boolean`	`autoWriteData` Start writing data to the device when one or more device(s) is found.
`String`	`cancelFindDevicesButtonId` The id referencing the cancel find devices button.
`String`	`cancelFindDevicesButtonText` The text for the cancel find device button.
`String`	`cancelReadDataButtonId` The id referencing the cancel read data button.
`String`	`cancelReadDataButtonText` The text on the cancel read button.
`String`	`cancelReadStatusText` The status text that is displayed when user cancels the read progress.
`String`	`cancelWriteDataButtonId` The id referencing the cancel write data button.
`String`	`cancelWriteDataButtonText` The text on the cancel write button.
`Function`	`customExceptionHandler` The function called when an error occurs.
`Array`	`dataFilters` Array of filters to sequencialy apply to activities before being sent or displayed.
`String`	`dataFound` Status message template exposed for internationalization.
`String`	`dataReadProcessing` Status message exposed for internationalization.
`String`	`deviceSelectElementId` The id referencing the device select box.
`String`	`deviceSelectId` The id referencing the device select dropdown.
`String`	`deviceSelectLabel` The label for the device select box.
`String`	`deviceSelectLabelId` The id referencing the device select box label.
`String`	`downloadAndInstall` Request message exposed for internationalization.
`Object`	`elementClassName` The class name used by various parts of the display to make CSS styling easier.
`String`	`findCancelled` Status message exposed for internationalization.
`String`	`findDevicesButtonId` The id referencing the find devices button.
`String`	`findDevicesButtonText` The text for the find device button.
`String`	`findDevicesElementId` The id referencing the HTML container around the find devices buttons.
`String`	`foundDevice` Status template exposed for internationalization.
`String`	`foundDevices` Status template exposed for internationalization.
`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.
`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.
`String`	`gpsData` Read data selection option exposed for internationalization.
`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
`String`	`installNow` Request message exposed for internationalization.
`Boolean`	`loadTracksWithoutATimestamp` Load tracks even if they don't have a timestamp (technically these are routes).
`String`	`lookingForDevices` Status message exposed for internationalization.
`String`	`noDeviceDetectedStatusText` The status text that is displayed when no devices are found.
`String`	`noParseSupportForType` Error message exposed for internationalization.
`String`	`notOverwritingFile` Status message exposed for internationalization.
`String`	`overwritingFile` Status message exposed for internationalization.
`String[]`	`pathKeyPairsArray` The array of strings that contain the unlock codes for the plugin.
`String`	`pluginNotUnlocked` Status message exposed for internationalization.
`String`	`pluginUnlocked` Status message exposed for internationalization.
`String`	`poweredByGarmin` Powered-by message.
`String`	`progressBarDisplayId` The id of the element where the progress bar is to be displayed.
`String`	`progressBarId` The container for the progress bar.
`String`	`readDataButtonId` The id referencing the read data button.
`String`	`readDataButtonText` The text on the read button.
`String`	`readDataElementId` The id referencing the box containing read elements.
`String`	`readDataType` Tells the plug-in what data type to read from the device.
`String`	`readDataTypesSelectId` The id referencing the data type select.
`String`	`readGoogleMapId` The id referencing the google map display.
`String`	`readResultsElementClass` The class to set for results elements.
`String`	`readResultsSelectClass` The class to set for select lists that are displaying results from a read operation.
`String`	`readRoutesElementId` The id referencing the read routes element.
`String`	`readRoutesSelectId` The id referencing the route select dropdown.
`String`	`readRoutesSelectLabel` The label for the read routes select box.
`String`	`readRoutesSelectLabelId` The id referencing the read routes select box label.
`String`	`readTracksElementId` The id referencing the read tracks element.
`String`	`readTracksSelectId` The id referencing the track select dropdown.
`String`	`readTracksSelectLabel` The label for the read tracks select box.
`String`	`readTracksSelectLabelId` The id referencing the read tracks select box label.
`String`	`readWaypointsElementId` The id referencing the read tracks element.
`String`	`readWaypointsSelectId` The id referencing the waypoint select dropdown.
`String`	`readWaypointsSelectLabel` The label for the read waypoints select box.
`String`	`readWaypointsSelectLabelId` The id referencing the read waypoints select box label.
`Boolean`	`showCancelFindDevicesButton` Controls the view of the cancel find devices button.
`Boolean`	`showCancelReadDataButton` Controls the view of the cancel read data button.
`Boolean`	`showCancelWriteDataButton` Controls the view of the cancel write data button.
`Boolean`	`showDeviceButtonsOnFound` Controls the view of the buttons related to find devices (find & cancel) if based on if the plugin finds one or more devices.
`BSoolean`	`showDeviceButtonsOnLoad` If true the buttons will show when the page is rendered.
`Boolean`	`showDeviceSelectNoDevice` Controls the view of the device select box.
`Boolean`	`showDeviceSelectOnLoad` Controls the view of the device select box.
`Boolean`	`showDeviceSelectOnSingle` Controls the view of the device select box.
`Boolean`	`showFindDevicesButton` Allows granular control to hide the find devices button independent of the showCancelFindDevicesButton cancel button contol.
`Boolean`	`showFindDevicesElement` Choice to display the find devices area that will search for connected devices.
`Boolean`	`showProgressBar` The progress bar is a graphical percentage bar used to display the amount of reading/writing is complete.
`Boolean`	`showReadDataElement` Display the user interface associated with reading from a connected device.
`Boolean`	`showReadDataElementOnDeviceFound` Controls the view of the read data element.
`Boolean`	`showReadDataTypesSelect` Display the dropdown select box for selecting what type of data to read from the device.
`Boolean`	`showReadGoogleMap` Display google map.
`Boolean`	`showReadResultsSelectOnLoad` Controls the view of the device select box.
`Boolean`	`showReadRoutesSelect` Display the route select dropdown.
`Boolean`	`showReadTracksSelect` Display the track select dropdown.
`Boolean`	`showReadWaypointsSelect` Display the waypoint select dropdown.
`Boolean`	`showStatusElement` The choice to display the feedback regarding the communications with the device.
`Boolean`	`showWriteDataElement` Display the user interface associated with writing to a connected device.
`Boolean`	`showWriteDataElementOnDeviceFound` Controls the view of the write data element.
`String`	`statusElementId` The id of the HTML element where the statusBox is to be rendered.
`String`	`statusTextId` The id of the HTML element where the status text messages are to be displayed.
`String`	`trackListing` Track list box item template exposed for internationalization.
`String`	`trainingData` Read data selection option exposed for internationalization.
`Boolean`	`unlockOnPageLoad` Unlock plugin when user lands on containing page which may result in security or plugin-not-installed messages.
`Boolean`	`useLinks` Display link instead of buttons.
`String`	`using` Status message exposed for internationalization.
`String`	`writeDataButtonId` The id referencing the write data button.
`String`	`writeDataButtonText` The text on the write button.
`String`	`writeDataType` Tells the plug-in what data type to write to the device.
`String`	`writingCancelled` Status message exposed for internationalization.
`String`	`writingToDevice` Status message exposed for internationalization.
`String`	`writtenToDevice` Status message exposed for internationalization.

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

Method Summary
`Function`	`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.

Field Detail

actionButtonClassName

String actionButtonClassName

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

afterFinishFindDevices

Function afterFinishFindDevices

} - 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.

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). 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.

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.

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

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.

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

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 = "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

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

showCancelFindDevicesButton

Boolean showCancelFindDevicesButton

false

true

showFindDevicesButton

showDeviceButtonsOnFound

showDeviceButtonsOnLoad

showFindDevicesElement

showCancelReadDataButton

Boolean showCancelReadDataButton

false

true the button's behavior will depend on other settings such as showReadDataButton, and showReadDataElement. default= true

showCancelWriteDataButton

Boolean 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= true

showDeviceButtonsOnFound

Boolean 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.

showDeviceButtonsOnLoad

BSoolean 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.

showDeviceSelectNoDevice

Boolean 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. default = true

showDeviceSelectOnLoad

Boolean 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. default = true

showDeviceSelectOnSingle

Boolean 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. default = false

showFindDevicesButton

Boolean showFindDevicesButton

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

showFindDevicesElement

Boolean showFindDevicesElement

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

showProgressBar

Boolean showProgressBar

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

showReadDataElement

Boolean showReadDataElement

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

showReadDataElementOnDeviceFound

Boolean 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= false

showReadDataTypesSelect

Boolean showReadDataTypesSelect

Display the dropdown select box for selecting what type of data to read from the device. When <

showReadGoogleMap

Boolean showReadGoogleMap

Display google map. When <

showReadResultsSelectOnLoad

Boolean 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. default = false

showReadRoutesSelect

Boolean showReadRoutesSelect

Display the route select dropdown. When <

showReadTracksSelect

Boolean showReadTracksSelect

Display the track select dropdown. When <

showReadWaypointsSelect

Boolean showReadWaypointsSelect

Display the waypoint select dropdown. When <

showStatusElement

Boolean showStatusElement

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

showWriteDataElement

Boolean showWriteDataElement

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

showWriteDataElementOnDeviceFound

Boolean 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= false

statusElementId

String statusElementId

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

statusTextId

String statusTextId

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

trackListing

String trackListing

Track list box item template exposed for internationalization.

trainingData

String trainingData

Read data selection option exposed for internationalization.

unlockOnPageLoad

Boolean 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.

useLinks

Boolean useLinks

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

using

String using

Status message exposed for internationalization.

writeDataButtonId

String writeDataButtonId

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

writeDataButtonText

String writeDataButtonText

The text on the write button.

writeDataType

String 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. default = "gpx"

writingCancelled

String writingCancelled

Status message exposed for internationalization.

writingToDevice

String writingToDevice

Status message exposed for internationalization.

writtenToDevice

String writtenToDevice

Status message exposed for internationalization.

Constructor Detail

Garmin.DeviceDisplayDefaultOptions

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.

Method Detail

getWriteDataFileName

Function 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:
- getWriteData

Overview File Class Tree Index Help

PREV CLASS NEXT CLASS FRAMES NO FRAMES

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Documentation generated by JSDoc on Fri Jul 13 17:08:49 2007