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

    Class DocumentDataExtractionResult

    Contains the result of running the document data extractor.

    Index

    Constructors

    constructor

    Properties

    croppedImage document documentDetectionResult status

    Methods

    encodeImages release serialize

    Constructors

    Properties

    croppedImage: ImageRef | null

    Crop of the document if it was detected.

    document: GenericDocument | null

    The extracted document.

    documentDetectionResult: DocumentDetectionResult

    Result of the document detection in the input image.

    status: DocumentDataExtractionStatus

    The status of the extraction process.

    Methods

    • Returns Promise<void>

    • Returns void

    • Parameters

      Returns Promise<
          {
              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;
              document?: | {
                  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;
              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?: ToJsonConfiguration,
                      ) => { readonly start?: Point | undefined; readonly end?: Point | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                      start?: Point;
                  }[];
                  horizontalLinesNormalized?: {
                      end?: Point;
                      serialize?: (
                          config?: ToJsonConfiguration,
                      ) => { readonly start?: Point | undefined; readonly end?: Point | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                      start?: Point;
                  }[];
                  points?: Point[];
                  pointsNormalized?: Point[];
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => { readonly status?: DocumentDetectionStatus | undefined; readonly detectionScores?: { readonly totalScore?: number | undefined; readonly distanceScore?: number | undefined; ... 6 more ...; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined; ... 10 more ...; serialize?: ((confi...;
                  status?: DocumentDetectionStatus;
                  verticalLines?: {
                      end?: Point;
                      serialize?: (
                          config?: ToJsonConfiguration,
                      ) => { readonly start?: Point | undefined; readonly end?: Point | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                      start?: Point;
                  }[];
                  verticalLinesNormalized?: {
                      end?: Point;
                      serialize?: (
                          config?: ToJsonConfiguration,
                      ) => { readonly start?: Point | undefined; readonly end?: Point | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                      start?: Point;
                  }[];
              };
              encodeImages?: () => Promise<void>;
              release?: () => void;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => Promise<{ readonly status?: DocumentDataExtractionStatus | undefined; readonly document?: ({ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | ... 1 more ... | undefined; serialize?: ((config?: ToJ...;
              status?: DocumentDataExtractionStatus;
          },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods