Class VinScannerResult

constructor

• new VinScannerResult(source?: DeepPartial<VinScannerResult>): VinScannerResult

  Parameters

  • Optionalsource: DeepPartial<VinScannerResult>

  Returns VinScannerResult

ReadonlybarcodeResult

ReadonlytextResult

serialize

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

  Parameters

  • Optionalconfig: ToJsonConfiguration

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

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

    Barcode result of the VIN scanner.

    • Optional ReadonlyextractedVIN?: string

      Text result of the barcode scanner.

    • Optional Readonlyrectangle?: Point[]

      Rectangle of the barcode in the image.

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

    • Optional Readonlystatus?: VinBarcodeExtractionStatus

      Status of the barcode extraction.

  • Optionalserialize?: (
        config?: ToJsonConfiguration,
    ) => { 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 ReadonlytextResult?: {
        confidence?: number;
        rawText?: string;
        serialize?: (
            config?: ToJsonConfiguration,
        ) => { 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?: ...;
        symbolBoxes?: {
            boundingRect?: Rectangle;
            recognitionConfidence?: number;
            serialize?: (
                config?: ToJsonConfiguration,
            ) => { readonly symbol?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
            symbol?: string;
        }[];
        validationSuccessful?: boolean;
        wordBoxes?: {
            boundingRect?: Rectangle;
            recognitionConfidence?: number;
            serialize?: (
                config?: ToJsonConfiguration,
            ) => { readonly text?: string | undefined; readonly boundingRect?: Rectangle | undefined; readonly recognitionConfidence?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
            text?: string;
        }[];
    }

    Text result of the VIN scanner.

    • Optional Readonlyconfidence?: number

      Confidence of the recognition.

      Default is 0.0

    • Optional ReadonlyrawText?: string

      Raw recognized string.

    • Optionalserialize?: (
          config?: ToJsonConfiguration,
      ) => { 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?: ...

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

      Boxes for each recognized symbol.

    • Optional ReadonlyvalidationSuccessful?: boolean

      Whether the validation was successful.

      Default is false

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

      Boxes for each recognized word.