Ng-naat-scanner NPM

Getting started

Installation

npm install ng-naat-scanner

Import

In the file app.module import the module:

import { ScannerModule } from 'ng-naat-scanner';
.
.
.
... imports: [
       ...,
       ScannerModule
    ]...

Usage

HTML

Add the selector inside some component and configure the input parameters:

  <app-scanner
      [configuration]="configuration"
      [url]="url"
      [typeToken]="typeToken"
      [token]="token"
      [ocr]="ocr"
      [urlOcr]="urlOcr"
      [documentType]="documentType"
      orientation="portrait"
      [aspectRatio]="0.6279"
      [buttonManual]="true"
      [timer]="45"
      (getaAcceptCamera)="acceptCamera()"
      (getData)="getData($event)"
      (getImage)="getImage($event)"
      (getError)="getError($event)">
    </app-scanner>

Typescript

Listen to the events and fill input parameters:

  configuration = [
    { title: 'Frontal', subtitle1: 'Utiliza un fondo negro', subtitle2: 'evita reflejos', guidesImagePath: './assets/id/guides-front.svg' },
    { title: 'Posterior', subtitle1: 'Utiliza un fondo negro', subtitle2: 'evita reflejos', guidesImagePath: './assets/id/guides-back.svg' },
  ];

  url='https://example.services/detection/square';
  typeToken='bearer';
  token='eyJhbGciOiJSUeyJhdWQiOlsib2F1dGgyLXJlc291cmNlIl0sImV4cCI6MTU5M...'
  orc = true;
  urlOcr='https://example.services/detection/getDocumentsInfoEx';
  documentType='ine';

  acceptCamera() {
    // accept camera 
  }

  getData(data: ScannerResult) {
    // data (images and ocr)
  }

  getError(error: ModuleErrorResponse) {
    // some error
  }

  async selectCamera() {
    let devices = await navigator.mediaDevices.enumerateDevices();
    devices = devices.filter(res => res.kind === 'videoinput');
    this.mediaVideoDevice = devices['index of your camera'].deviceId;
  }

Inputs

Name	Type	Required	Default	Description
configuration	DocumentStep[]	true	null	Array with the steps to scan
aspectRatio	number	true	null	Aspect ratio of the document to scan
url	string	true	null	Service url to to detect squares
typeToken	string	true	null	Type of authorization for services (Bearer, Basic, API, etc)
token	string	true	null	Token of authorization
ocr	boolean	false	false	Flag to extract the ocr
urlOcr	string	false	null	if ocr is required, this field is necesary
documentType	string	false	null	if ocr is required, is the ocr type
orientation	string	false	both	orientation allowed, values: portrait, landscape or both
buttonManual	boolean	false	false	button to manual take
maxWidthResult	number	false	1000px	Max width size of the image result
timer	number	false	null	Time in seconds to completed every capture
mediaVideoDevice	string	false	null	Camera selected

Outputs

Name	Return	Description
getData	image(s) and ocr if it is required	Fires when scanning was completed
getCloseScanner	void	Fires when the scanner closes
getaAcceptCamera	void	Fires when the user accepts the camera permissions
getError	ModuleErrorResponse	Fires when an error happens

tslib

@infinitebrahmanuniverse/nolb-ng-n @everything-registry/sub-chunk-2274 @zalastax/nolb-ng-n

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago