Class VinScannerResult

constructor

• new VinScannerResult(source?): VinScannerResult

• Parameters

  • Optional source: DeepPartial<VinScannerResult>

  Returns VinScannerResult

Readonly barcodeResult

Readonly textResult

serialize

• serialize(config?): {
      barcodeResult?: {
          extractedVIN?: string;
          rectangle?: (undefined | {
              x?: number;
              y?: number;
          })[];
          status?: VinBarcodeExtractionStatus;
          serialize?: any;
      };
      textResult?: {
          confidence?: number;
          rawText?: string;
          symbolBoxes?: (undefined | {
              boundingRect?: {
                  height?: number;
                  width?: number;
                  x?: number;
                  y?: number;
              };
              recognitionConfidence?: number;
              symbol?: string;
              serialize?: any;
          })[];
          validationSuccessful?: boolean;
          wordBoxes?: (undefined | {
              boundingRect?: {
                  height?: number;
                  width?: number;
                  x?: number;
                  y?: number;
              };
              recognitionConfidence?: number;
              text?: string;
              serialize?: any;
          })[];
          serialize?: any;
      };
      serialize?: any;
  }

• Parameters

  • Optional config: ToJsonConfiguration

  Returns {
      barcodeResult?: {
          extractedVIN?: string;
          rectangle?: (undefined | {
              x?: number;
              y?: number;
          })[];
          status?: VinBarcodeExtractionStatus;
          serialize?: any;
      };
      textResult?: {
          confidence?: number;
          rawText?: string;
          symbolBoxes?: (undefined | {
              boundingRect?: {
                  height?: number;
                  width?: number;
                  x?: number;
                  y?: number;
              };
              recognitionConfidence?: number;
              symbol?: string;
              serialize?: any;
          })[];
          validationSuccessful?: boolean;
          wordBoxes?: (undefined | {
              boundingRect?: {
                  height?: number;
                  width?: number;
                  x?: number;
                  y?: number;
              };
              recognitionConfidence?: number;
              text?: string;
              serialize?: any;
          })[];
          serialize?: any;
      };
      serialize?: any;
  }

  • Optional Readonly barcodeResult?: {
        extractedVIN?: string;
        rectangle?: (undefined | {
            x?: number;
            y?: number;
        })[];
        status?: VinBarcodeExtractionStatus;
        serialize?: any;
    }

    Barcode result of the VIN scanner.

    • Optional Readonly extractedVIN?: string

      Text result of the barcode scanner.

    • Optional Readonly rectangle?: (undefined | {
          x?: number;
          y?: number;
      })[]

      Rectangle of the barcode in the image.

    • Optional Readonly status?: VinBarcodeExtractionStatus

      Status of the barcode extraction.

  • Optional Readonly textResult?: {
        confidence?: number;
        rawText?: string;
        symbolBoxes?: (undefined | {
            boundingRect?: {
                height?: number;
                width?: number;
                x?: number;
                y?: number;
            };
            recognitionConfidence?: number;
            symbol?: string;
            serialize?: any;
        })[];
        validationSuccessful?: boolean;
        wordBoxes?: (undefined | {
            boundingRect?: {
                height?: number;
                width?: number;
                x?: number;
                y?: number;
            };
            recognitionConfidence?: number;
            text?: string;
            serialize?: any;
        })[];
        serialize?: any;
    }

    Text result of the VIN scanner.

    • Optional Readonly confidence?: number

      Confidence of the recognition.

      Default is 0.0

    • Optional Readonly rawText?: string

      Raw recognized string.

    • Optional Readonly symbolBoxes?: (undefined | {
          boundingRect?: {
              height?: number;
              width?: number;
              x?: number;
              y?: number;
          };
          recognitionConfidence?: number;
          symbol?: string;
          serialize?: any;
      })[]

      Boxes for each recognized symbol.

    • Optional Readonly validationSuccessful?: boolean

      Whether the validation was successful.

      Default is false

    • Optional Readonly wordBoxes?: (undefined | {
          boundingRect?: {
              height?: number;
              width?: number;
              x?: number;
              y?: number;
          };
          recognitionConfidence?: number;
          text?: string;
          serialize?: any;
      })[]

      Boxes for each recognized word.