Signature

Enterprise Browser 1.4

Overview

creates a rectangular box within which the user can draw by using a finger or the device's stylus to record handwritten data. Common usages for this tag include the capture of client/customer signatures and the input of handwritten text/notations. It is recommended to not to rotate the device when Signature window is shown.

Enabling the API

There are two methods of enabling the Signature API:

  • Include all ebapi modules or
  • Include only the API modules you need

For either of these methods, you'll need to include files from the /Enterprise Browser/JavaScript Files/Enterprise Browser directory on the computer that you installed the Enterprise Browser.

Include all JS API modules

To include all JS APIs, you must copy the ebapi-modules.js file to a location accessible by your app's files and include the JavaScript file in your app. For instance, to include the modules file in your index.html, with the file in the same directory as your index.html, you would add the following line to the section of your index.html:


<script type="text/javascript" charset="utf-8" src="ebapi-modules.js"></script>

Note: that the pathing for this file is relative to the current page.

This will define the EB class within the page. Any page you need to use the modules will need to have the .js file included in this fashion.

Include only the modules you need

To include single APIs, you must first include the ebapi.js in your HTML as well as the API file you want to use. For instance, to use the Signature API, I would add the following code to my HTML file(s), assuming the API files have been copied to the same directory as the HTML.


<script type="text/javascript" charset="utf-8" src="ebapi.js"></script>
<script type="text/javascript" charset="utf-8" src="eb.signature.js"></script>

The ebapi.js file is necessary for all single API inclusions.

Persistence

With the old PocketBrowser APIs, any events, such as signatureCaptureEvent were canceled when a full navigate was performed. The original reason for this was a limitation of the IE engine on WM5 devices. When moving to the common API this was changed so that callbacks are not canceled.

Methods

capture()

Captures the in-line signature area as an image. This function works with a non-modal signature capture area shown inside browser window. All in-line signature capture functions (like this) do not has affect the capture area shown in takeFullScreen (modal full screen capture area).

Parameters

  • callback : CallBackHandler

Callback

Async Callback Returning Parameters: HASH

    • status : STRING

      Whether a signature was captured or the signature capture area was dismissed (Fullscreen version only). Possible values:'ok' or 'cancel'

    • imageUri : STRING

      If the outputFormat is "image", this will be the URI of the captured signature image. If the outputFormat is "dataUri", this will be the DataURI representation of the captured signature image.

    • signature_uri : STRING

      If the outputFormat is "image", this will be the URI of the captured signature image. If the outputFormat is "dataUri", this will be the DataURI representation of the captured signature image.

Returns

Synchronous Return:

  • Void

Platforms

  • Android
  • Windows Mobile

Method Access:

  • Class Method: This method can only be accessed via the API class object.
    • EB.Signature.capture()

clear()

Clears an in-line capture area. This function works with a non-modal signature capture area shown inside browser window. All in-line signature capture functions (like this) do not has affect to capture area shown in takeFullScreen (modal full screen capture area)

Parameters

  • callback : CallBackHandler

Returns

Synchronous Return:

  • Void

Platforms

  • Android
  • Windows Mobile

Method Access:

  • Class Method: This method can only be accessed via the API class object.
    • EB.Signature.clear()

hide()

Hides an in-line capture area from view. It clears the inputed signature for in-line signature areas. In a hidden state, a user cannot interact with the signature capture area. This function work with non-modal signature capture area showed inside browser window. All in-line signature capture functions (like this) do not has affect to capture area showed in takeFullScreen (modal full screen capture area)

Parameters

  • callback : CallBackHandler

Returns

Synchronous Return:

  • Void

Platforms

  • Android
  • Windows Mobile

Method Access:

  • Class Method: This method can only be accessed via the API class object.
    • EB.Signature.hide()

setVectorCallback()

Signature data is formatted into a series of vectors and returned to the application via this callback function. The received data may not represent the entire signature as the vectors will be sent in batches if the signature is large. A single vector (array entry) contains an X, Y coordinate and the beginning / end of the signature is defined by (65535, 65535). This callback is independent of the callback of the capture method, when specified the callback will be called whenever a 'pen up' occurs in the signature box.

Parameters

  • callback : CallBackHandler

Callback

Async Callback Returning Parameters: HASH

    • vectorArray : ARRAY

      JavaScript array of vectors which represent the signature.

Returns

Synchronous Return:

  • Void

Platforms

  • Android
  • Windows Mobile

Method Access:

  • Class Method: This method can only be accessed via the API class object.
    • EB.Signature.setVectorCallback()

show(HASH propertyMap)

Show in-line signature window. This function works with a non-modal signature capture area shown inside browser window. All in-line signature capture functions (like this) do not has affect the capture area shown in takeFullScreen (modal full screen capture area).

Parameters

  • propertyMap : HASH Optional

    Map of signature properties to be set. Valid `properties` for this parameter are the properties available to this API module. Check the property section for applicable properties. Use existing properties from this API.

  • callback : CallBackHandler

Returns

Synchronous Return:

  • Void

Platforms

  • Android
  • Windows Mobile

Method Access:

  • Class Method: This method can only be accessed via the API class object.
    • EB.Signature.show(HASH propertyMap)

takeFullScreen(HASH propertyMap)

Shows a modal window with signature capture area and UI (toolbar with buttons) for cancel / capture and return to main application window. The callback is fired when the signature window is closed (when in full-screen) or when capture is called. On WM/CE, the signature area has visible buttons for 'clear', 'capture' and 'cancel'. On Android, the signature area has images which will behave as buttons for 'clear', 'capture' and 'cancel'. This function opens a modal full screen window therefore, other functions related to in-line signature capture (work with inside browser window area) do not affect the capture window shown by this function.

Parameters

  • propertyMap : HASH Optional

    Map of signature properties to be set Valid `properties` for this parameter are the properties available to this API module. Check the property section for applicable properties. Use already set properties

  • callback : CallBackHandler

Callback

Async Callback Returning Parameters: HASH

    • status : STRING

      Whether a signature was captured or the signature capture area was dismissed (Fullscreen version only). Possible values:'ok' or 'cancel'

    • imageUri : STRING

      If the outputFormat is "image", this will be the URI of the captured signature image. If the outputFormat is "dataUri", this will be the DataURI representation of the captured signature image.

    • signature_uri : STRING

      If the outputFormat is "image", this will be the URI of the captured signature image. If the outputFormat is "dataUri", this will be the DataURI representation of the captured signature image.

Returns

Synchronous Return:

  • Void

Platforms

  • Android
  • Windows Mobile

Method Access:

  • Class Method: This method can only be accessed via the API class object.
    • EB.Signature.takeFullScreen(HASH propertyMap)

Properties

bgColor

Type

STRING

Description

RGB or ARGB value that sets the background color of the signature capture area.

Params

Default: #FFFFFFFF

Access

  • Class: This property can only be accessed via the API class object.
    • EB.Signature.bgColor

Platforms

  • Android
  • Windows Mobile

border

Type

BOOLEAN

Description

Shows or hides a border for the rectangular capture area. Not applicable to full-screen signature capture area.

Params

Default: true

Access

  • Class: This property can only be accessed via the API class object.
    • EB.Signature.border

Platforms

  • Android
  • Windows Mobile

compressionFormat

Type

STRING

Description

Replaces:imageFormat Compression format of the image file for the captured signature. On WM/CE, irrespective of setting any format, the output format will be of bitmap type. On WM/CE, when compressionFormat is queried, it will be of bitmap type always.

Values

Possible Values (STRING):

  • Constant: EB.Signature.COMPRESSION_FORMAT_JPG - String: jpg JPEG file format (Not available on WM/CE).
  • Constant: EB.Signature.COMPRESSION_FORMAT_PNG - String: png Portable Network Graphics file (Not available on WM/CE).
  • Constant: EB.Signature.COMPRESSION_FORMAT_BMP - String: bmp Bitmap image file.

Access

  • Class: This property can only be accessed via the API class object.
    • EB.Signature.compressionFormat

Platforms

  • Android
  • Windows Mobile

fileName

Type

STRING

Description

Replaces:name The filename in which to store the signature image, if "image" is used as the outputFormat. The file extension is determined by the compressionFormat used.

Params

Default: signature

Access

  • Class: This property can only be accessed via the API class object.
    • EB.Signature.fileName

Platforms

  • Android
  • Windows Mobile

height

Type

INTEGER

Description

The height of the signature capture area in pixels. Not applicable to full-screen signature capture area.

Params

Default: 150

Access

  • Class: This property can only be accessed via the API class object.
    • EB.Signature.height

Platforms

  • Android
  • Windows Mobile

left

Type

INTEGER

Description

The coordinates in pixels of the left side of the signature capture area. Not applicable to full-screen signature capture area.

Params

Default: 15

Access

  • Class: This property can only be accessed via the API class object.
    • EB.Signature.left

Platforms

  • Android
  • Windows Mobile

outputFormat

Type

STRING

Description

The return type of the saved signature capture image.

Params

Default: image

Values

Possible Values (STRING):

  • Constant: EB.Signature.OUTPUT_FORMAT_IMAGE - String: image Outputs the signature capture image into an image file. The compression method and extension of the image file can be specified in compressionFormat.
  • Constant: EB.Signature.OUTPUT_FORMAT_DATAURI - String: dataUri Outputs the signature capture image as a DataURI string.

Access

  • Class: This property can only be accessed via the API class object.
    • EB.Signature.outputFormat

Platforms

  • Android
  • Windows Mobile

penColor

Type

STRING

Description

RGB or ARGB value that sets the color of the stylus pen ink using HTML web colors.

Params

Default: #FF000000

Access

  • Class: This property can only be accessed via the API class object.
    • EB.Signature.penColor

Platforms

  • Android
  • Windows Mobile

penWidth

Type

INTEGER

Description

Sets the width of the pen line in pixels when using the device's stylus. On Android this setting will also be applied to any previously drawn signature currently displayed. It is advised that you keep this at 5 or less.

Params

Default: 3

Access

  • Class: This property can only be accessed via the API class object.
    • EB.Signature.penWidth

Platforms

  • Android
  • Windows Mobile

top

Type

INTEGER

Description

The coordinates in pixels of the top side of the signature capture area. Not applicable to full-screen signature capture area.

Params

Default: 60

Access

  • Class: This property can only be accessed via the API class object.
    • EB.Signature.top

Platforms

  • Android
  • Windows Mobile

width

Type

INTEGER

Description

The width of the signature capture area in pixels. Not applicable to full-screen signature capture area.

Params

Default: 200

Access

  • Class: This property can only be accessed via the API class object.
    • EB.Signature.width

Platforms

  • Android
  • Windows Mobile

Remarks

Fullscreen and In-line

The signature capture feature can work in two visual modes, Full-screen and In-line. The full-screen variant has buttons to capture, clear and cancel the signature capture box, so the methods: "clear", "hide", "capture" don't need to be used. Whereas with the in-line signature capture, there are no such buttons so these will have to be designed into the app itself.

Parameters which clear the signature

The signature capture area is designed to be set up prior to capturing the signature, as such the following parameters will clear any current signature: "width", "height", "penColor", "bgColor".

In Android, the state of the signature will not be cleared on page navigation whereas in Windows, the state of the signature is cleared.

Persistent Behavior

While using "takeFullScreen" method, if we press Home button and re-launch the application the state won't be persisted in Android platform.