@anyline/anyline-js
TypeScript icon, indicating that this package has built-in type declarations

51.3.1 • Public • Published

Web SDK

Anyline is a mobile OCR SDK, which can be customized to scan all kinds of numbers, characters, text and codes.

Web SDK is a standalone Anyline version for the browser.

Visit js.anyline.com for an official demo of Web SDK.

Supported Usecases

  • Tire Size
  • Commercial Tire ID
  • Tire Identification Number
  • Vehicle Identification Number (VIN)
  • Shipping Container (Horizontal and Vertical)
  • 1D and 2D Barcodes
  • Serial Number
  • License Plate
  • MRZ
  • Austrian and German Drivers Licenses
  • Meter Scanning

Content

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

Documentation

API documentation

For full documentation visit: https://documentation.anyline.com/web-sdk-component/latest/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.

Web SDK has to be served from a web server that supports HTTPS.

  1. Import Web SDK
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 Web SDK
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((e) => {
  alert(e.message);
});
  1. Handle the scan result
anyline.onResult = (result) => {
  console.log(result)
};

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

Go to https://anyline.com/request/contact for a test-license When you've received a license for your domain, edit your host file to route your domain to localhost. Then:

npm run demo

Visit http://yourdomain.com: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).

Typescript support

You can access the types by importing the Types object

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

Available links:


Demo link -- https://js.anyline.com

Package Sidebar

Install

npm i @anyline/anyline-js

Weekly Downloads

90

Version

51.3.1

License

SEE LICENSE IN LICENSE.md

Unpacked Size

53.4 MB

Total Files

146

Last publish

Collaborators

  • igor.graca
  • michaelanyline
  • aldrichanyline
  • cloudio-anyline
  • florin-anyline
  • bremal_
  • balazs_anyline
  • patrickanyline
  • berndkamplanyline
  • david.dengg
  • adam-anyline
  • danielalbertini
  • jonaslaux
  • mohammad.nasiri
  • peter.sperl_anyline