@anyline/anyline-js

anyline sdk in the browser

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@anyline/anyline-js
15241.0.12 months ago2 years agoMinified + gzip package size for @anyline/anyline-js in KB

Readme

AnylineJS
Anyline is a mobile OCR SDK, which can be customized to scan all kinds of numbers, characters, text and codes.
AnylineJS is a standalone Anyline version for the browser.
Visit js.anyline.com for an official demo of AnylineJS.

Supported Usecases

  • Vehicle identification number (VIN),
  • shipping container (Horizontal and Vertical),
  • Barcode,
  • Serial number,
  • license plate,
  • MRZ,
  • EHIC (eCard),
  • german ID front,
  • austrian, german and UK drivers licenses
  • meter scanning

Content

  • anylinejs: Contains the files needed to self-host AnylineJS
  • demo: Contains AnylineJS implementation examples
  • LICENSE: The Third Party License Agreements
  • README: Information about the repository

Documentation

API documentation
For full documentation visit: https://documentation.anyline.com/toc/platforms/javascript/index.html
To test Anyline download the Example Sheets with testing material: https://anyline.com/samples

Install

npm install @anyline/anyline-js

Usage

  1. Copy the content of anylinejs to your webserver. In some cases you need to configure your webserver to serve data and wasm.gz files.

AnylineJS has to be served from a web server that supports HTTPS.
  1. Import AnylineJS

import { init } from '@anyline/anyline-js';

Alternatively you can also directly import anyline.js using a script tag:
<script src="anyline.js"></script>

This will expose anylinejs to the window scope:
const { init } = window.anylinejs;

  1. Initialize AnylineJS

const anyline = init({
  preset: 'meter', // id, ocr, ehic, ...
  license: 'enter_your_license_key_here',
  // html container where anylineJS should be mounted to
  element: document.getElementById('root'),
  // location of the data files from step 1 (can also be an https link)
  anylinePath: '../anylinejs',
});

  1. Start scanning

anyline.startScanning().catch(console.error);

  1. Handle the scan result

anyline.onResult((data) => {
  console.log(data)
});

Preload assets

In order to use preloading update your configuration as shown below and call the preload method. Example
const anyline = init({
  ...
  preload: true,
  ...
});

anyline.preload();

Try it locally

npm run demo
Visit http://127.0.0.1:8080/demo.
or
npm run demo:network
In this case the HTTPS server uses a self-generated certificate so you might need to bypass the security measures of your browser. With a proper test-license issued for your internal ip-address you can test it on other devices on the network (i.E. for smartphone testing).
The license included in the demo only allows AnylineJS to run on 127.0.0.1

Typescript support

You can access the types by importing the Types object
import { Types } from '@anyline/anyline-js';

Available links:


Worker Demo link -- https://js.anyline.com/release/41.0.0/demo/index.html
Worker Archive link -- https://js.anyline.com/release/41.0.0/anylinejs.zip
Worker CDN link -- https://js.anyline.com/release/41.0.0/anyline.js