capacitor-plugin-scanbot-sdk
    Preparing search index...

    Class CheckScanningResult

    The result of check scanning.

    Index

    Constructors

    constructor

    Properties

    check croppedImage documentDetectionResult status

    Methods

    encodeImages release serialize

    Constructors

    Properties

    check: GenericDocument | null

    Generic document containing check data. Not present, if status is FAIL.

    croppedImage: ImageRef | null

    Crop of the check if documentDetectionMode is set to DETECT_AND_CROP_DOCUMENT. Will be non-empty, only if check recognition succeeded.

    documentDetectionResult: DocumentDetectionResult | null

    The result of document detection. Will be set only if detectDocument in the configuration is set to true. Check scanning may still succeed even if the whole document is not visible in the input image and the complete document could not be located.

    status: CheckMagneticInkStripScanningStatus

    Magnetic ink strip scanning status.

    Default is ERROR_NOTHING_FOUND

    Methods

    • Returns Promise<void>

    • Returns void

    • Parameters

      Returns Promise<
          {
              check?: | {
                  children?: {
                      children?: { readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined; ... 9 more ...; encodeImages?: (() ...;
                      confidence?: number;
                      confidenceWeight?: number;
                      crop?: | {
                          buffer?: ...;
                          clear?: ...;
                          encodeImage?: ...;
                          encodeInPlace?: ...;
                          hibernate?: ...;
                          info?: ...;
                          isRetained?: ...;
                          release?: ...;
                          retain?: ...;
                          saveImage?: ...;
                          serialize?: ...;
                          uniqueId?: ...;
                      } & {}
                      | null;
                      encodeImages?: () => Promise<(...)>;
                      fields?: {
                          confidenceWeight?: ...;
                          encodeImages?: ...;
                          image?: ...;
                          parsedData?: ...;
                          polygonInRoot?: ...;
                          release?: ...;
                          serialize?: ...;
                          type?: ...;
                          validationStatus?: ...;
                          value?: ...;
                      }[];
                      quad?: Point[];
                      quadInRoot?: Point[];
                      release?: () => void;
                      serialize?: (config?: (...) | (...)) => Promise<(...)>;
                      type?: {
                          fullName?: (...) | (...);
                          listIndex?: (...) | (...) | (...);
                          name?: (...) | (...);
                          normalizedName?: (...) | (...);
                          serialize?: (...) | (...);
                      };
                  }[];
                  confidence?: number;
                  confidenceWeight?: number;
                  crop?: | {
                      buffer?: string;
                      clear?: () => Promise<(...)>;
                      encodeImage?: (options?: (...) | (...)) => Promise<(...)>;
                      encodeInPlace?: () => Promise<(...)>;
                      hibernate?: () => Promise<(...)>;
                      info?: () => Promise<(...)>;
                      isRetained?: () => boolean;
                      release?: () => void;
                      retain?: () => void;
                      saveImage?: (path: string, options?: (...) | (...)) => Promise<(...)>;
                      serialize?: (
                          imageSerializationMode: ImageSerializationMode,
                      ) => Promise<(...)>;
                      uniqueId?: string;
                  } & {}
                  | null;
                  encodeImages?: () => Promise<void>;
                  fields?: {
                      confidenceWeight?: number;
                      encodeImages?: () => Promise<(...)>;
                      image?:
                          | {
                              buffer?: ...;
                              clear?: ...;
                              encodeImage?: ...;
                              encodeInPlace?: ...;
                              hibernate?: ...;
                              info?: ...;
                              isRetained?: ...;
                              release?: ...;
                              retain?: ...;
                              saveImage?: ...;
                              serialize?: ...;
                              uniqueId?: ...;
                          } & {}
                          | null;
                      parsedData?: { serialize?: ...; type?: ...; value?: ... }[];
                      polygonInRoot?: Point[];
                      release?: () => void;
                      serialize?: (config?: (...) | (...)) => Promise<(...)>;
                      type?: {
                          commonType?: (...) | (...) | (...);
                          fullName?: (...) | (...);
                          listIndex?: (...) | (...) | (...);
                          name?: (...) | (...);
                          normalizedName?: (...) | (...);
                          serialize?: (...) | (...);
                      };
                      validationStatus?: FieldValidationStatus;
                      value?: { confidence?: ...; serialize?: ...; text?: ... } & {}
                      | null;
                  }[];
                  quad?: Point[];
                  quadInRoot?: Point[];
                  release?: () => void;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => Promise<
                      {
                          children?: (...)[];
                          confidence?: number;
                          confidenceWeight?: number;
                          crop?: (...) & (...) | null;
                          encodeImages?: () => ...;
                          fields?: (...)[];
                          quad?: (...)[];
                          quadInRoot?: (...)[];
                          release?: () => ...;
                          serialize?: ((config?: ToJsonConfiguration | undefined) => Promise<{ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | ... 1 more ... | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ......;
                          type?: {
                              fullName?: ...;
                              listIndex?: ...;
                              name?: ...;
                              normalizedName?: ...;
                              serialize?: ...;
                          };
                      },
                  >;
                  type?: {
                      fullName?: string;
                      listIndex?: number
                      | null;
                      name?: string;
                      normalizedName?: string;
                      serialize?: (
                          config?: ToJsonConfiguration,
                      ) => { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                  };
              } & {}
              | null;
              croppedImage?: | {
                  buffer?: string;
                  clear?: () => Promise<void>;
                  encodeImage?: (options?: EncodeImageOptions) => Promise<string | null>;
                  encodeInPlace?: () => Promise<void>;
                  hibernate?: () => Promise<void>;
                  info?: () => Promise<ImageInfo | null>;
                  isRetained?: () => boolean;
                  release?: () => void;
                  retain?: () => void;
                  saveImage?: (
                      path: string,
                      options?: SaveImageOptions,
                  ) => Promise<boolean>;
                  serialize?: (
                      imageSerializationMode: ImageSerializationMode,
                  ) => Promise<
                      | (
                          { readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<(... & {}) | null>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; } & {}
                      )
                      | null,
                  >;
                  uniqueId?: string;
              } & {}
              | null;
              documentDetectionResult?: | {
                  aspectRatio?: number;
                  averageBrightness?: number;
                  detectionScores?: {
                      angleScore?: number;
                      aspectRatioScore?: number;
                      distanceScore?: number;
                      heightScore?: number;
                      lineCoverageScore?: number;
                      serialize?: (
                          config?: ToJsonConfiguration,
                      ) => { readonly totalScore?: number | undefined; readonly distanceScore?: number | undefined; readonly angleScore?: number | undefined; readonly sizeScore?: number | undefined; readonly aspectRatioScore?: number | undefined; readonly lineCoverageScore?: number | undefined; readonly widthScore?: number | undefined; readon...;
                      sizeScore?: number;
                      totalScore?: number;
                      widthScore?: number;
                  };
                  displacement?: DocumentDisplacement;
                  displacementVector?: Point;
                  horizontalLines?: {
                      end?: Point;
                      serialize?: (
                          config?: (...) | (...),
                      ) => { readonly start?: Point | undefined; readonly end?: Point | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                      start?: Point;
                  }[];
                  horizontalLinesNormalized?: {
                      end?: Point;
                      serialize?: (
                          config?: (...) | (...),
                      ) => { readonly start?: Point | undefined; readonly end?: Point | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                      start?: Point;
                  }[];
                  points?: Point[];
                  pointsNormalized?: Point[];
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => {
                      aspectRatio?: number;
                      averageBrightness?: number;
                      detectionScores?: {
                          angleScore?: (...) | (...);
                          aspectRatioScore?: (...) | (...);
                          distanceScore?: (...) | (...);
                          heightScore?: (...) | (...);
                          lineCoverageScore?: (...) | (...);
                          serialize?: (...) | (...);
                          sizeScore?: (...) | (...);
                          totalScore?: (...) | (...);
                          widthScore?: (...) | (...);
                      };
                      displacement?: DocumentDisplacement;
                      displacementVector?: Point;
                      horizontalLines?: { end?: ...; serialize?: ...; start?: ... }[];
                      horizontalLinesNormalized?: { end?: ...; serialize?: ...; start?: ... }[];
                      points?: Point[];
                      pointsNormalized?: Point[];
                      serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly status?: DocumentDetectionStatus | undefined; readonly detectionScores?: { ...; } | undefined; ... 10 more ...; serialize?: ... | undefined; }) | undefined;
                      status?: DocumentDetectionStatus;
                      verticalLines?: { end?: ...; serialize?: ...; start?: ... }[];
                      verticalLinesNormalized?: { end?: ...; serialize?: ...; start?: ... }[];
                  };
                  status?: DocumentDetectionStatus;
                  verticalLines?: {
                      end?: Point;
                      serialize?: (
                          config?: (...) | (...),
                      ) => { readonly start?: Point | undefined; readonly end?: Point | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                      start?: Point;
                  }[];
                  verticalLinesNormalized?: {
                      end?: Point;
                      serialize?: (
                          config?: (...) | (...),
                      ) => { readonly start?: Point | undefined; readonly end?: Point | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                      start?: Point;
                  }[];
              } & {}
              | null;
              encodeImages?: () => Promise<void>;
              release?: () => void;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => Promise<{ readonly status?: CheckMagneticInkStripScanningStatus | undefined; readonly check?: ({ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | ... 1 more ... | undefined; serialize?: ((config?:...;
              status?: CheckMagneticInkStripScanningStatus;
          },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods