Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (dwt) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Cross-platform cross-browser JavaScript library for web document scanning.

Overview

Dynamic Web TWAIN is a TWAIN-based scanning SDK software specifically designed for web applications. With just a few lines of code, you can develop robust applications to scan documents from TWAIN/ICA/SANE-compatible scanners on Windows/macOS/Linux, view and edit the scanned images, then save them to a local/server file system or database. You can even use your mobile devices running iOS | iPadOS | Android with the library starting in 16.1.1!

Installation

The main package

npm install dwt@16.1.1

For TypeScript support

npm install @types/dwt

Quick Start

Step 1 Create a HTML page and load `dynamsoft.webtwain.min.js` into your page:

<!DOCTYPE html>
<html>
<head>
    <title>Hello World</title>
    <script src="dist/dynamsoft.webtwain.min.js"></script>
</head>
<body>
</body>
</html>

Note that a relative path is used. You might want to change it based on where you are putting your code. The best practise is to put all the files on your own server and under the same domain as your web application.

Step 2 Add a script tag and make initial settings:

<!DOCTYPE html>
<html>
<head>
  <title>Hello World</title>
  <script src="dist/dynamsoft.webtwain.min.js"></script>
</head>
<body>
  <script type="text/javascript">
    Dynamsoft.WebTwainEnv.ResourcesPath = "dist";
    Dynamsoft.WebTwainEnv.ProductKey = 't0140cQMAA...';
  </script>
</body>
</html>

Note that ResourcesPath and ProductKey must be set in order to use the library.

ResourcesPath is a relative path to where you put the directory "/dist/" and all the files in it.
If you don't have a valid ProductKey, you can request a trial key to use.

Step 3 Write code to use the package to do a simple document scan

The following code demonstrates the minimum code needed to use the package. Note the addition of HTML elements as well as JavaScript code. For more sophisticated sample or demo, check out the Sample Gallery and our Github Repositories.

<!DOCTYPE html>
<html>
<head>
  <title>Hello World</title>
  <script src="dist/dynamsoft.webtwain.min.js"></script>
</head>
<body>
  <input type="button" value="Scan" onclick="AcquireImage();" />
  <div id="dwtcontrolContainer"></div>
  <script type="text/javascript">
    Dynamsoft.WebTwainEnv.ResourcesPath = "dist";
    Dynamsoft.WebTwainEnv.ProductKey = 't0068MgAAAFgW05zp85JXvbVigG3piPN2/luDlLjQF55OJy48LymLDkYdTg6jZQeQ2SJ3ODHgLtAuKCpANd+NB4SXZQg3yXE='; // Put your own key here
    window.onload = function () {
      Dynamsoft.WebTwainEnv.Load();
    };
    var DWObject;
    function Dynamsoft_OnReady() {
      // dwtcontrolContainer is the id of the DIV to create the WebTwain instance in.
      DWObject = Dynamsoft.WebTwainEnv.GetWebTwain('dwtcontrolContainer');
    }
    function AcquireImage() {
      if (DWObject) {
        DWObject.SelectSource(function () {
          DWObject.OpenSource();
          DWObject.AcquireImage(
            {
              PixelType: Dynamsoft.EnumDWT_PixelType.TWPT_RGB,
              Resolution: 200,
              IfDisableSourceAfterAcquire: true
            },
            function () {
              console.log("Successful!");
            },
            function (settings, errCode, errString) {
              alert(errString)
            }
          );
        }, function () {
          alert('SelectSource failed!');
        });
      }
    }
  </script>
</body>
</html>

Included Samples

AcquireImage.html & CustomScan.html
- Dynamic Web TWAIN core features
PDFRasterizer.html:
- Using the Rasterizer add-on to convert text-based PDF files
OCRADocument.html:
- Scan, Load images and then perform OCR on them (English)
ReadBarcode.html:
- Scan, Load images and then read barcode off them
ScanOrCapture.html:
- Scan documents from scanners or capture documents from webcams

Documentation

Need Help?

Contact Dynamsoft to resolve any issue you encounter with the library.

Versions

Dynamsoft Service (DynamsoftService.exe, 64bit)

v16.1.0 (build version 1, 6, 1, 0728)

Dynamsoft Service Manager (DWASManager_16000428.dll, 64bit)

v16.1.0 (build version 16, 0, 0, 0428)

Dynamic Web TWAIN (dwt_16.1.0.0728.dll, 64bit)

v16.1.0 (build version 16, 1, 0, 0728)

Dynamsoft PDF Rasterizer (DynamicPdfRx64_11.0.0.0428.dll, 64bit)

v16.1.0 (build version 11, 0, 0, 0428)

Dynamsoft OCR Basic Engine (DynamicOCRx64_10.0.0.0618.dll, 64bit)

v16.1.0 (build version 10, 0, 0, 0618)

Dynamsoft Barcode Reader (dbrx64_7.4.0.0428.dll, 64bit)

v7.3.0 (build version 7, 4, 0, 0428)

Dynamsoft Webcam Addon (DynamicWebcamx64_15.0.0.0625.dll, 64bit)

v16.1.0 (build version 15, 0, 0, 0625)

Dynamsoft Upload Module (UploadModule_1.6.0.0428.dll, 64bit)

v16.1.0 (build version 1, 6, 0, 0428)

Features

TWAIN spec 2.3 and below compatible (ActiveX, HTML5 for Windows APIs).
TWAIN spec 1.9 and below compatible (HTML5 for Mac API).
ICA compatible (HTML5 for Mac API).
SANE compatible (HTML5 for Linux).
Optional disk caching mechanism enables high volume document scanning (up to thousands of pages).
Supports Auto Document Feeder (ADF) and multiple image acquisition.
Supports duplex scanning mode if the device supports it.
Supports setting up image acquisition parameters (resolution, pixel type, bit depth, brightness, contrast, page size, unit, etc).
Supports both Native and Disk File Image transfer modes on Windows.
Supports importing existing files in the formats BMP, JPG, PNG, TIF, PDF (image based).
Supports rasterizing text-based PDF files into images.
Supports image viewing and basic editing through APIs like rotate, flip, mirror, crop, etc.
Supports image grouping via tags.
Supports encrypting local files in buffer and automatic removing of files that are no longer needed.
Built-in encoding module to create files in the formats BMP, JPG, PNG, TIF, PDF.
Built-in upload module to easily upload encoded files to FTP or HTTP servers.
Built-in support for secure HTTP (HTTPS).
Built-in Image Editor to easily edit images without additional code.
Webcam Capturing, Barcode reading and OCR with optional addons.
Supports viewing images and most functionalities on Android and iOS | iPadOS.

dwt