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

    Class DocumentScanningResult

    Result of the document detection followed by cropping of the found document.

    Index

    Constructors

    constructor

    Properties

    croppedImage detectionResult

    Methods

    encodeImages release serialize

    Constructors

    Properties

    croppedImage: ImageRef | null

    Cropped document image.

    detectionResult: DocumentDetectionResult

    Result of the document contour detection.

    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;
              detectionResult?: {
                  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 detectionResult?: { readonly status?: DocumentDetectionStatus | undefined; readonly detectionScores?: { readonly totalScore?: number | undefined; readonly distanceScore?: number | undefined; ... 6 more ...; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined;...;
          },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods