nature2104/cordova-plugin-document-scanner

cordova-plugin-doc-scanner

This plugin defines a global DocScanner object, which provides an API for taking pictures and cropping them.

Installation

cordova plugin add https://github.com/Skydragonsz/cordova-plugin-document-scanner.git

---

API Reference

• DocScanner
  • .takePicture(successCallback, errorCallback, options)
  • [.active] : Boolean
  • [.platform]: String returns the platform on what the plugin is running. (iOS/Android)

---

DocScanner

DocScanner.takePicture(successCallback, errorCallback, options)

Takes a photo using the camera, or retrieves a photo from the device's image gallery. The image is passed to the success callback as a Base64-encoded String, or as the URI for the image file.

The docScanner.takePicture function opens the device's camera application that allows users to snap pictures by default.

The return value is sent to the successCallback callback function, in one of the following formats, depending on the specified scannerOptions:

• A String containing the Base64-encoded photo image.
• A String representing the image file location on local storage (default).

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

Param	Type
successCallback	onSuccess
errorCallback	onError
options	ScannerOptions

Example

DocScanner.takePicture(successCallback, errorCallback, options);

successCallback : function

Example

DocScanner.takePicture(successCallback, errorCallback, options);

function successCallback(image){
    var DOMimage = document.getElementById('myImage');
    DOMimage.src = image;
}

errorCallback : function

Example

DocScanner.takePicture(successCallback, errorCallback, options);

function errorCallback(error){
    console.error("Error",error);
}

scannerOptions : Object

Optional parameters to customize the camera settings.

Properties

Name	Type	Default	Description
quality	number	80	Quality of the saved image, expressed as a range of 0-100, where 100 is typically full resolution with no loss from file compression. (Note that information about the camera's resolution is unavailable.)
targetWidth	number		Width in pixels to scale image. Must be used with targetHeight. Aspect ratio remains constant.
targetHeight	number		Height in pixels to scale image. Must be used with targetWidth. Aspect ratio remains constant.
saveToPhotoAlbum	Boolean	false	Save the image to the photo album on the device after capture.
toBase64	Boolean	false	Gives the Base64 value of the image

---