|
4 | 4 |
|
5 | 5 | - <a id="properties/images"></a>**`images`** _(array, required)_: The images.
|
6 | 6 | - <a id="properties/images/items"></a>**Items** _(string)_
|
7 |
| -- <a id="properties/args"></a>**`args`**: Refer to _[#/definitions/args](#definitions/args)_. |
| 7 | +- <a id="properties/args"></a>**`args`** _(required)_: Refer to _[#/definitions/args](#definitions/args)_. |
8 | 8 | - <a id="properties/progress"></a>**`progress`** _(boolean)_: Run in progress mode. Default: `false`.
|
9 | 9 | - <a id="properties/steps"></a>**`steps`** _(array)_: The carried out steps description.
|
10 | 10 | - <a id="properties/steps/items"></a>**Items** _(object)_: Cannot contain additional properties.
|
|
16 | 16 | - <a id="properties/assisted_split/items"></a>**Items** _(object)_: Assisted split configuration. Cannot contain additional properties.
|
17 | 17 | - <a id="properties/assisted_split/items/properties/source"></a>**`source`** _(string)_
|
18 | 18 | - <a id="properties/assisted_split/items/properties/destinations"></a>**`destinations`** _(array)_
|
19 |
| - - <a id="properties/assisted_split/items/properties/destinations/items"></a>**Items** _(['integer', 'string'])_ |
| 19 | + - <a id="properties/assisted_split/items/properties/destinations/items"></a>**Items** _(integer or string)_ |
20 | 20 | - <a id="properties/assisted_split/items/properties/image"></a>**`image`** _(string)_
|
21 | 21 | - <a id="properties/assisted_split/items/properties/limits"></a>**`limits`** _(array)_: The (proposed) limits to do the assisted split, You should keep only the right one.
|
22 | 22 | - <a id="properties/assisted_split/items/properties/limits/items"></a>**Items** _(object)_: Cannot contain additional properties.
|
|
34 | 34 | - <a id="properties/intermediate_error/items/properties/traceback/items"></a>**Items** _(string)_
|
35 | 35 | - <a id="properties/images_config"></a>**`images_config`** _(object)_: Can contain additional properties.
|
36 | 36 | - <a id="properties/images_config/additionalProperties"></a>**Additional properties** _(object)_: Cannot contain additional properties.
|
37 |
| - - <a id="properties/images_config/additionalProperties/properties/angle"></a>**`angle`** _(['number', 'null'])_: The used angle to deskew, can be change, restart by deleting one of the generated images. |
| 37 | + - <a id="properties/images_config/additionalProperties/properties/angle"></a>**`angle`** _(number or null)_: The used angle to deskew, can be change, restart by deleting one of the generated images. |
38 | 38 | - <a id="properties/images_config/additionalProperties/properties/status"></a>**`status`** _(object)_: Cannot contain additional properties.
|
39 | 39 | - <a id="properties/images_config/additionalProperties/properties/status/properties/angle"></a>**`angle`** _(number)_: The measured deskew angle.
|
40 | 40 | - <a id="properties/images_config/additionalProperties/properties/status/properties/size"></a>**`size`** _(array)_: The image dimensions.
|
|
62 | 62 | - <a id="definitions/auto_mask/properties/buffer_level"></a>**`buffer_level`** _(integer)_: The threshold level used in buffer on the blurry image. Default: `20`.
|
63 | 63 | - <a id="definitions/args"></a>**`args`** _(object)_
|
64 | 64 | - <a id="definitions/args/properties/level"></a>**`level`** _(object)_: The level configuration.
|
65 |
| - - <a id="definitions/args/properties/level/properties/value"></a>**`value`** _(['boolean', 'integer'])_: true: => do level on 15% - 85% (under 15 % will be black above 85% will be white), false: => 0% - 100%, <number>: => (0 + <number>)% - (100 - number)%. Default: `false`. |
| 65 | + - <a id="definitions/args/properties/level/properties/value"></a>**`value`** _(boolean or integer)_: true: => do level on 15% - 85% (under 15 % will be black above 85% will be white), false: => 0% - 100%, <number>: => (0 + <number>)% - (100 - number)%. Default: `false`. |
66 | 66 | - <a id="definitions/args/properties/level/properties/auto"></a>**`auto`** _(boolean)_: If no level specified, do auto level. Default: `false`.
|
67 | 67 | - <a id="definitions/args/properties/level/properties/min"></a>**`min`** _(number)_: Min level if no level end no auto-level. Default: `0`.
|
68 | 68 | - <a id="definitions/args/properties/level/properties/max"></a>**`max`** _(number)_: Max level if no level end no auto-level. Default: `100`.
|
|
117 | 117 | - <a id="definitions/args/properties/mask"></a>**`mask`** _(object)_: The mask configuration, the a is used to mask the image on crop and skew calculation. Default: `{"enabled": false}`.
|
118 | 118 | - <a id="definitions/args/properties/mask/properties/enabled"></a>**`enabled`** _(boolean)_: Enable the mask. Default: `true`.
|
119 | 119 | - <a id="definitions/args/properties/mask/properties/auto_mask"></a>**`auto_mask`**: Refer to _[#/definitions/auto_mask](#definitions/auto_mask)_.
|
120 |
| - - <a id="definitions/args/properties/mask/properties/additional_filename"></a>**`additional_filename`** _(['string', 'null'])_: An image file used to add on the mask. |
| 120 | + - <a id="definitions/args/properties/mask/properties/additional_filename"></a>**`additional_filename`** _(string or null)_: An image file used to add on the mask. |
121 | 121 | - <a id="definitions/args/properties/cut"></a>**`cut`** _(object)_: The cut configuration, a mask is used to definitively mask the source image. Default: `{"enabled": false}`.
|
122 | 122 | - <a id="definitions/args/properties/cut/properties/enabled"></a>**`enabled`** _(boolean)_: Enable the cut. Default: `true`.
|
123 | 123 | - <a id="definitions/args/properties/cut/properties/auto_mask"></a>**`auto_mask`**: Refer to _[#/definitions/auto_mask](#definitions/auto_mask)_.
|
124 |
| - - <a id="definitions/args/properties/cut/properties/additional_filename"></a>**`additional_filename`** _(['string', 'null'])_: An image file used to add on the mask. |
| 124 | + - <a id="definitions/args/properties/cut/properties/additional_filename"></a>**`additional_filename`** _(string or null)_: An image file used to add on the mask. |
125 | 125 | - <a id="definitions/args/properties/no_remove_to_continue"></a>**`no_remove_to_continue`** _(boolean)_: Don't wait for the deletion of the REMOVE_TO_CONTINUE file before exporting the PDF. Default: `false`.
|
126 | 126 | - <a id="definitions/args/properties/deskew"></a>**`deskew`** _(object)_: The deskew configuration.
|
127 | 127 | - <a id="definitions/args/properties/deskew/properties/min_angle"></a>**`min_angle`** _(number)_: The minimum angle to detect the image skew [degree]. Default: `-45`.
|
|
0 commit comments