scanbotsdk
    Preparing search index...

    Type Alias DocumentCleanupStatus

    DocumentCleanupStatus: "OK" | "OK_BUT_REDUCED_QUALITY" | "ERROR_MASK_TOO_LARGE"

    Status of the document cleanup operation.

    • OK: Cleanup completed.
    • OK_BUT_REDUCED_QUALITY: Cleanup completed, but the configured maxCleanupResolution forced internal downscaling of the cleanup region, so the result quality near the cleanup boundary may be reduced compared to a full-resolution run. If result is not good enough, run undo and try applying cleanup on smaller areas.
    • ERROR_MASK_TOO_LARGE: Cleanup was not performed because the axis-aligned bounding box of the non-zero mask pixels exceeded the configured maxMaskBoundingBoxArea limit. The returned image is the current (unchanged) image and the undo/redo history is left untouched. Retry with a smaller mask or increase maxMaskBoundingBoxArea.

    Type Declaration

    • "OK"

      Cleanup completed.

    • "OK_BUT_REDUCED_QUALITY"

      Cleanup completed, but the configured maxCleanupResolution forced internal downscaling of the cleanup region, so the result quality near the cleanup boundary may be reduced compared to a full-resolution run. If result is not good enough, run undo and try applying cleanup on smaller areas.

    • "ERROR_MASK_TOO_LARGE"

      Cleanup was not performed because the axis-aligned bounding box of the non-zero mask pixels exceeded the configured maxMaskBoundingBoxArea limit. The returned image is the current (unchanged) image and the undo/redo history is left untouched. Retry with a smaller mask or increase maxMaskBoundingBoxArea.