@jatahworx/cordova-plugin-document-scanner

1.0.1 • Public • Published

cordova-plugin-document-scanner

This plugin defines a global scan object, which provides an API for scan the document from taking pictures and choosing image from the system's library.

Although the object is attached to the global scoped window, it is not available until after the deviceready event.

document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
    console.log(scan);
}

Installation

This requires cordova 5.0+

cordova plugin add cordova-plugin-document-scanner

scan.scanDoc(sourceType, successCallback, errorCallback)

Takes a photo using the scan, or retrieves a photo from the device's image gallery. The image is passed to the document scanner and the scanned image passed to success callback as the URI for the image file.

The scan.scanDoc function opens the device's default scan application that allows users to snap pictures by default - this behavior occurs, when sourceType equals 1. Once the user snaps the photo, the scan application closes and the application is restored.

If sourceType is 0, then a dialog displays that allows users to select an existing image.

The return value is sent to the scanSuccess callback function, in the fileUri formats.

You can do whatever you want with the URI, for example:

  • Render the image in an <img> tag.

Supported Platforms

  • Android

Example

scan.scanDoc(sourceType, scanSuccess, scanError);

scan.scanDoc

Take a photo and retrieve the image's file location:

scan.scanDoc(0, onSuccess, onFail);

function onSuccess(imageURI) {
    var image = document.getElementById('myImage');
    image.src = imageURI;
}

function onFail(message) {
    alert('Failed because: ' + message);
}

Package Sidebar

Install

npm i @jatahworx/cordova-plugin-document-scanner

Weekly Downloads

0

Version

1.0.1

License

ISC

Unpacked Size

14.1 kB

Total Files

7

Last publish

Collaborators

  • jatahworx