@anyline/anyline-js
v54.1.0
Published
Anyline Web SDK
Downloads
2,416
Readme
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
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
- Copy the content of
anylinejs
to your webserver. In some cases you need to configure your webserver to servedata
andwasm.gz
files.
Web SDK has to be served from a web server that supports HTTPS.
- 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;
- 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',
});
- Start scanning
anyline.startScanning().catch((e) => {
alert(e.message);
});
- 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';