Properties
excludeAnnotations
Whether the document annotations should be exported.
Default Value
falseflatten
Whether the document annotations should be converted to PDF content and therefore not editable in the future.
Default Value
falseflattenElectronicSignatures
incremental
Whether the document should be exported using "full" or "incremental" saving. Default: false, or true if the document is digitally signed and the license includes the Digital Signatures component.
optimize
boolean | { … }
If set to true the exported document will have a default set of options:
{
documentFormat: 'pdf',
grayscaleText: false,
grayscaleGraphics: false,
grayscaleFormFields: false,
grayscaleAnnotations: false,
grayscaleImages: false,
disableImages: false,
mrcCompression: false,
imageOptimizationQuality: 2,
linearize: false,
}
Otherwise, you can pass the above options object customised with your own values instead of a boolean value.
Default Value
falseoutputFormat
boolean | { … }
If set to true, a default set of options will be applied to the exported document:
{
conformance: NutrientViewer.Conformance.PDFA_2B,
vectorization: true,
rasterization: true,
}
Instead of a boolean value you can pass your own object ith custom values for the properties above.
Default Value
falsepermissions
{ … }
Contain the userPassword and ownerPassword to encrypt the PDF along with the documentPermissions.
In server-backed mode only password stripping is supported: all three fields must be empty
(userPassword: '', ownerPassword: '', documentPermissions: []). Setting non-empty
values throws a PSPDFKitError.
| Property | Description |
|---|---|
| documentPermissions | An Array that specifies what users can do with the output PDF. |
| ownerPassword | The owner password to encrypt the PDF. |
| userPassword | The user password to encrypt the PDF. |
Export options object *