Interface IExportEntryRequestImageOptions

Represents the options when exporting the image part of an entry.

interface IExportEntryRequestImageOptions {
    convertPdfAnnotations?: boolean;
    format?: ExportEntryRequestImageFormat;
    includeAnnotations?: boolean;
    includeRedactions?: boolean;
    jPEGCompressionLevel?: number;
    pagePrefix?: string;
    watermark?: ExportEntryRequestWatermark;
}

Implemented by

Properties

convertPdfAnnotations? format? includeAnnotations? includeRedactions? jPEGCompressionLevel? pagePrefix? watermark?

Properties

OptionalconvertPdfAnnotations

convertPdfAnnotations?: boolean

Indicates if the annotations on the image need to be converted to PDF annotations when exporting to PDF format. The default value is true. This option is only applicable when exporting to PDF format and IncludeAnnotations is true.

Optionalformat

format?: ExportEntryRequestImageFormat

The image format to export as. Options include: MultiPageTIFF, SinglePageTIFF, PNG, PDF and JPEG. The default value is MultiPageTIFF. MultiPageTIFF format is a single multi-page TIFF file. SinglePageTIFF format is multiple single-page TIFF files (in a single zip file).

OptionalincludeAnnotations

includeAnnotations?: boolean

Indicates if the annotations need to be included. The default value is true.

OptionalincludeRedactions

includeRedactions?: boolean

Indicates if redactions are included. The default value is true.

OptionaljPEGCompressionLevel

jPEGCompressionLevel?: number

The quality level for JPEG compression when exporting images. The value must be between 0 and 100 (inclusive). The default value is 70.

OptionalpagePrefix

pagePrefix?: string

The page prefix of the individual files, when exporting to multi-file format (e.g.zip). The value must have a length of at most 10 characters and only valid characters that can be included in file names are allowed. The default value is ", Page ".

Optionalwatermark

watermark?: ExportEntryRequestWatermark

The watermark element added to each image. No watermark will be added by default.

Settings

Member Visibility

On This Page

Properties