exportImagesToPdf method
Exports images to PDF format. An array of images can be exported, see options description for details.
export async function exportImagesToPdf(settings)
Parameters
- settings
- Object specifying parameters of the image export to PDF (see Options).
Return values
The method returns result depending on how the scenario finished (see Result).
Options
The table below describes parameters that you can pass as the settings argument to change image export to PDF settings. Omitting a parameter means that a default setting will be used.
Parameter | Value type | Description |
---|---|---|
licenseFileName | string |
The name of the license file. This file must be located in the /assets/ directory in your project. Default: "MobileCapture.License". |
images | object[] |
Array of images for export with corresponding information. Each image can have the following parameters:
|
result | object |
Result PDF file description, represented by the following parameters:
|
pdfInfo | object |
Extra information corresponding to the PDF file. This object can have the following parameters:
|
Result
This section describes the object that represents image capture results. Returned parameters depend on the scenario.
Parameter | Value type | Description |
---|---|---|
pdfUri | string | Result URI, corresponding to the description in the passed result parameter. If the PDF file destination was 'File', this parameter value corresponds to the filePath parameter value with 'file://' prefix. |
Example of a result JSON.
3/2/2022 12:59:15 PM