Nutrient Web SDK

ReferenceExportPDFFlags

Type Alias ExportPDFFlags

Export options object *

Type Alias

Properties

boolean

Whether the document annotations should be exported.

Default Value

false

flatten

Optional
boolean

Whether the document annotations should be converted to PDF content and therefore not editable in the future.

Default Value

false

includeComments

OptionalServer
boolean

Default Value

true

incremental

OptionalStandalone
boolean

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

OptionalServer
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

false

outputFormat

Optional
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

false

permissions

Optional
{ … }

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.

PropertyDescription
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.

saveForPrinting

OptionalStandalone
boolean

Default Value

false