Variable ScanbotDocumentEnhancerConst

Type Declaration

• forceCloseDocumentCleanupScreen: function

  • forceCloseDocumentCleanupScreen(): Promise<void>

    Forces the Ready-To-Use UI Document Cleanup screen to close if it is currently open.

    Returns Promise<void>

• startDocumentCleanupScreen: function

  • startDocumentCleanupScreen(
        configuration: DocumentCleanupStandaloneConfiguration,
    ): Promise<ResultWrapper<DocumentData>>

    Opens the Ready-To-Use UI screen to clean up the document using the provided configuration.

    Parameters

    • configuration: DocumentCleanupStandaloneConfiguration

      The configuration to be used for the cleanup RTU-UI.

    Returns Promise<ResultWrapper<DocumentData>>

    • Updated document after cleanup.

• straightenImage: function

  • straightenImage(
        params: {
            image: ImageInput;
            priorCornersNormalized?: Point[];
            straighteningParameters: DocumentStraighteningParameters;
        },
    ): Promise<DocumentStraighteningResult>

    Straightens the document effectively straightening its edges and text.

    Parameters

    • params: {
          image: ImageInput;
          priorCornersNormalized?: Point[];
          straighteningParameters: DocumentStraighteningParameters;
      }

      • image: ImageInput

        The image of the document to straighten.

      • OptionalpriorCornersNormalized?: Point[]

        If the corners are already known (e.g. from a prior detection), they can be provided here. The enhancer may take them into account to locate the document more accurately.

      • straighteningParameters: DocumentStraighteningParameters

        The parameters to use for straightening.

    Returns Promise<DocumentStraighteningResult>

    • The result of the straightening operation.