Capture OnTheGo API

As of Connect 1.8, cotg-2.0.0.js has replaced the cotg-1.x.js versions of the Capture OnTheGo (COTG) plugin, introducing events and options for COTG widgets. This topic lists all available options and custom events for widgets, as well as their initialization function.

How to use the COTG plugin is explained in the following topic: Using the COTG plugin: cotg-2.0.0.js.
To learn how to create widgets in code, see Dynamically adding COTG widgets and Saving and restoring custom data and widgets.

For a list of all COTG elements and their intended use, see COTG Elements.

Barcode Scanner

cotgBarcode()

Initializing a Barcode Scanner element prepares it for user interaction.
Example: $('myScanner').cotgBarcode();

Events

The Barcode Scanner listens for the following events.

The Barcode Scanner broadcasts the following events.

Camera

cotgPhotoWidget([options])

options

Optional. An array containing the desired settings, e.g. {quality: 50, height: 1024, width: 1024}. For any unspecified options the default settings will be used.

Initialize the new Camera element with any settings that you want to be different from the defaults.
Example: $('#myCamera').cotgPhotoWidget({quality: 50, height: 1024});

How to change the default settings is explained in another topic: Changing default settings for widgets.

Events

The Camera listens for the following custom events.

The Camera broadcasts the following events.

Date and Formatted Date

cotgDatePicker()

Initializing a Date or Formatted Date element prepares it for user interaction.
Example: $('myDatePicker').cotgDatePicker();

Note that the difference between a Date and a Formatted Date is laid down in the HTML structure of the element.

Events

The Date and Formatted Date elements listen for the following custom events.

Device Info

cotgDeviceInfo()

Initializing a Device Info element puts information about the device (phone or tablet) that displays the form, in the hidden input of the element.
Example: $('#myDeviceInfo').cotgDeviceInfo();

Events

The Device Info element listens for the following event.

The Device Info element broadcasts the following event.

Document ID

cotgDocumentId()

Initializing a new Document ID puts the current Document ID in the hidden input of the element.
Example: $('#myDocID').cotgDocumentId();

Events

The Document ID element listens for the following event.

The Document ID element broadcasts the following event.

Fields Table

The Fields Table element itself is just a table, so it doesn't have to be initialized. However, after dynamically adding it to a Form, you still have to add the correct event handlers to the Add and Delete buttons, as follows (replace myTable by the ID of your table):

$("#myTable [role=cotg-add-row-button]").on("click", function(){
	$(this).closest('table').cotgAddRow(true);
});

$("myTable").on("click", "[role=cotg-delete-row-button]", function(){
	$(this).closest('tr').cotgDeleteRow();
});

Geolocation

cotgGeolocation([options])

options

Optional. An array containing the desired settings, e.g. {enableHighAccuracy: true, timeout: 3000}. For any unspecified options the default settings will be used.

Call cotgGeolocation([options]) on the new Geolocation element with any settings that you want to be different from the defaults.
Example: $('#myGeolocation').cotgGeolocation({timeout: 6000});

How to change the default settings is explained in another topic: Changing default settings for widgets.

Events

The Geolocation element listens for the following events.

Image & Annotation

cotgNoteOnImage()

Initializing a new Image & Annotation element prepares it for user interaction.
Example: $('#myNoteOnImage').cotgNoteOnImage();

The Image & Annotation element listens for the following events.

The Image & Annotation element broadcasts the following events.

Locale

cotgLocale()

Initializing a new Locale element sets it to the device's locale.
Example: $('#myLocale').cotgLocale();

Events

The Locale element listens for the following event.

The Locale element broadcasts the following event.

Repository ID

cotgRepositoryId()

Initializing a new Repository ID puts the current Repository ID in the hidden input of this element. The Repository ID is based on the currently logged on COTG user.
Example: $('#myRepID').cotgRepositoryId();

Events

The Repository ID element listens for the following custom events.

The Repository ID element broadcasts the following event.

Signature

cotgSignature()

Initializing a new Signature element prepares it for user interaction.
Example: $('#mySignature').cotgSignature();

Events

The Signature element listens for the following custom events.

The Signature element broadcasts the following events.

Time and Formatted Time

cotgTimePicker()

Initializing a new (Formatted) Time element prepares it for user interaction.
Example: $('#myTimePicker').cotgTimePicker();

Note that the difference between a Time and a Formatted Time is laid down in the HTML structure of the element.

Events

The Time and Formatted Time elements listen for the following custom events.

User Account

cotgUserAccount()

Initializing a new User Account element puts the account of the current user in the hidden input of this element.
Example: $('#myUser').cotgUserAccount();

Events

The User Account element listens for the following custom event.

The User Account element broadcasts the following event.

• Last Topic Update: 22, November, 2017 10:29 AM
• Last Published: 23, May, 2019 01:55 PM