Class VinScannerUiResult

constructor

• new VinScannerUiResult(source?): VinScannerUiResult

• Parameters

  • Optional source: DeepPartial<VinScannerUiResult>

  Returns VinScannerUiResult

Readonly barcodeResult

Readonly textResult

serialize

• serialize(config?): {
      barcodeResult?: {
          extractedVIN?: string;
          rectangle?: Point[];
          status?: VinBarcodeExtractionStatus;
          serialize?(config?): { readonly extractedVIN?: string | undefined; readonly rectangle?: Point[] | undefined; readonly status?: VinBarcodeExtractionStatus | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
      };
      textResult?: {
          confidence?: number;
          rawText?: string;
          symbolBoxes?: {
              boundingRect?: Rectangle;
              recognitionConfidence?: number;
              symbol?: string;
              serialize?(config?): { readonly symbol?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          }[];
          validationSuccessful?: boolean;
          wordBoxes?: {
              boundingRect?: Rectangle;
              recognitionConfidence?: number;
              text?: string;
              serialize?(config?): { readonly text?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          }[];
          serialize?(config?): { readonly rawText?: string | undefined; readonly wordBoxes?: { readonly text?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; readonly symbolBoxes?: ...;
      };
      serialize?(config?): { readonly textResult?: { readonly rawText?: string | undefined; readonly wordBoxes?: { readonly text?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined;...;
  }

• Parameters

  • Optional config: ToJsonConfiguration

  Returns {
      barcodeResult?: {
          extractedVIN?: string;
          rectangle?: Point[];
          status?: VinBarcodeExtractionStatus;
          serialize?(config?): { readonly extractedVIN?: string | undefined; readonly rectangle?: Point[] | undefined; readonly status?: VinBarcodeExtractionStatus | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
      };
      textResult?: {
          confidence?: number;
          rawText?: string;
          symbolBoxes?: {
              boundingRect?: Rectangle;
              recognitionConfidence?: number;
              symbol?: string;
              serialize?(config?): { readonly symbol?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          }[];
          validationSuccessful?: boolean;
          wordBoxes?: {
              boundingRect?: Rectangle;
              recognitionConfidence?: number;
              text?: string;
              serialize?(config?): { readonly text?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          }[];
          serialize?(config?): { readonly rawText?: string | undefined; readonly wordBoxes?: { readonly text?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; readonly symbolBoxes?: ...;
      };
      serialize?(config?): { readonly textResult?: { readonly rawText?: string | undefined; readonly wordBoxes?: { readonly text?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined;...;
  }

  • Optional Readonly barcodeResult?: {
        extractedVIN?: string;
        rectangle?: Point[];
        status?: VinBarcodeExtractionStatus;
        serialize?(config?): { readonly extractedVIN?: string | undefined; readonly rectangle?: Point[] | undefined; readonly status?: VinBarcodeExtractionStatus | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
    }

    Barcode result of the VIN scanner.

    • Optional Readonly extractedVIN?: string

      Text result of the barcode scanner.

    • Optional Readonly rectangle?: Point[]

      Rectangle of the barcode in the image.

    • Optional Readonly status?: VinBarcodeExtractionStatus

      Status of the barcode extraction.

    • serialize?:function

      • serialize(config?): { readonly extractedVIN?: string | undefined; readonly rectangle?: Point[] | undefined; readonly status?: VinBarcodeExtractionStatus | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }

      • Parameters

        • Optional config: ToJsonConfiguration

        Returns { readonly extractedVIN?: string | undefined; readonly rectangle?: Point[] | undefined; readonly status?: VinBarcodeExtractionStatus | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }

  • Optional Readonly textResult?: {
        confidence?: number;
        rawText?: string;
        symbolBoxes?: {
            boundingRect?: Rectangle;
            recognitionConfidence?: number;
            symbol?: string;
            serialize?(config?): { readonly symbol?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
        }[];
        validationSuccessful?: boolean;
        wordBoxes?: {
            boundingRect?: Rectangle;
            recognitionConfidence?: number;
            text?: string;
            serialize?(config?): { readonly text?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
        }[];
        serialize?(config?): { readonly rawText?: string | undefined; readonly wordBoxes?: { readonly text?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; readonly symbolBoxes?: ...;
    }

    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?: {
          boundingRect?: Rectangle;
          recognitionConfidence?: number;
          symbol?: string;
          serialize?(config?): { readonly symbol?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
      }[]

      Boxes for each recognized symbol.

    • Optional Readonly validationSuccessful?: boolean

      Whether the validation was successful.

      Default is false

    • Optional Readonly wordBoxes?: {
          boundingRect?: Rectangle;
          recognitionConfidence?: number;
          text?: string;
          serialize?(config?): { readonly text?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
      }[]

      Boxes for each recognized word.

    • serialize?:function

      • serialize(config?): { readonly rawText?: string | undefined; readonly wordBoxes?: { readonly text?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; readonly symbolBoxes?: ...

      • Parameters

        • Optional config: ToJsonConfiguration

        Returns { readonly rawText?: string | undefined; readonly wordBoxes?: { readonly text?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; readonly symbolBoxes?: ...

  • serialize?:function

    • serialize(config?): { readonly textResult?: { readonly rawText?: string | undefined; readonly wordBoxes?: { readonly text?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined;...

    • Parameters

      • Optional config: ToJsonConfiguration

      Returns { readonly textResult?: { readonly rawText?: string | undefined; readonly wordBoxes?: { readonly text?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined;...