PDFTron WebViewer

Class: ViewerOptimizedOptions

Core.PDFNet.PDFDoc. ViewerOptimizedOptions

new ViewerOptimizedOptions()

An object containing options for PDFDoc.saveViewerOptimized function

Methods

setMinimumInitialThumbnails(initial_thumbs)

Set the number of pages starting from the first for which to guarantee thumbnails regardless of page complexity. This can help improve the viewing experience on the first few pages without increasing the file size dramatically. If this number is greater than the number of pages in the document all of the pages will have thumbnails.
Parameters:
Name Type Description
initial_thumbs number The number of pages starting with the first which are guaranteed to have thumbnails. The default value is 1, which means only the first page is guaranteed to have a thumbnail.
Returns:
this object, for call chaining
Type
Core.PDFNet.PDFDoc.ViewerOptimizedOptions

setOverprint(mode)

Enable or disable support for overprint and overprint simulation in generated thumbnails. Overprint is a device dependent feature and the results will vary depending on the output color space and supported colorants (i.e. CMYK, CMYK+spot, RGB, etc). Default is e_op_pdfx_on.
Parameters:
Name Type Description
mode number 
PDFNet.PDFRasterizer.OverprintPreviewMode = {
	e_op_off : 0
	e_op_on : 1
	e_op_pdfx_on : 2
}
e_op_on: always enabled; e_op_off: always disabled; e_op_pdfx_on: enabled for PDF/X files only.
Returns:
this object, for call chaining
Type
Core.PDFNet.PDFDoc.ViewerOptimizedOptions

setThumbnailRenderingThreshold(threshold)

For any pages that are not forced to include thumbnails this function adjusts whether we should include them depending on the complexity of the page. This can be used to include fewer or more thumbnails as required by the use case. In particular reducing this value will tend to increase the number of page thumbnails included and vice versa.
Parameters:
Name Type Description
threshold number A number from 0 (include all thumbnails) to 100 (include only the first thumbnail) representing the complexity at which SaveViewerOptimized would include the thumbnail. The default value is 50.
Returns:
this object, for call chaining
Type
Core.PDFNet.PDFDoc.ViewerOptimizedOptions

setThumbnailSize(size)

The maximum allowed length for the thumbnail's height/width. The default thumbnail size is 1024.
Parameters:
Name Type Description
size number the maximum dimension (width or height) that thumbnails will have.
Returns:
this object, for call chaining
Type
Core.PDFNet.PDFDoc.ViewerOptimizedOptions