IUserOptions interface

Image properties available for single image capture process configuration. All the settings are optional.

interface IUserOptions

Properties

Name Type Description
aspectRatioMin* number

Lower limit of the document's aspect ratio.

This property is used in pair with the aspectRatioMax, defining an interval of acceptable aspect ratio values of the document to be captured. Setting aspect ratio will help to improve boundary detection accuracy.

If only aspectRatioMax is set, aspectRatioMin will be set to 1.

By default the property is set to 0 (aspect ratio is not set).

aspectRatioMax* number

Upper limit of document's aspect ratio.

This property is used in pair with the aspectRatioMin, defining an interval of acceptable aspect ratio values of the document to be captured. Setting aspect ratio will help to improve boundary detection accuracy.

If only aspectRatioMin is set, aspectRatioMax will be set to Number.MAX_SAFE_INTEGER.

By default the property is set to 0 (aspect ratio is not set).

documentSize IDocumentSizeType

The physical size of the document to be captured. The module captures documents with defined aspect ratio and uses this parameter to restore document proportions on saving the result.

Predefined values from an enumeration are used.

* Note: Aspect ratio is calculated by division of the upper limit to lower limit and is expected to be greater than or equal to 1 (or 0 if not set).

03.04.2023 17:06:08

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.