Apryse WebViewer

Class: TiffOutputOptions

Core.PDFNet.Convert. TiffOutputOptions

new TiffOutputOptions()

An object containing options for ToTiff functions

Methods

setAnnots(enable)

Enables or disables drawing of annotations. This option is enabled by default.
Parameters:
Name Type Description
enable boolean
Returns:
this object, for call chaining
Type
Core.PDFNet.Convert.TiffOutputOptions

setBox(type)

Specifies the page box/region to rasterize. By default, page crop region will be rasterized.
Parameters:
Name Type Description
type number 
PDFNet.Page.Box = {
	e_media : 0
	e_crop : 1
	e_bleed : 2
	e_trim : 3
	e_art : 4
}
Returns:
this object, for call chaining
Type
Core.PDFNet.Convert.TiffOutputOptions

setClip(x1, y1, x2, y2)

User definable clip box. By default, the clip region is identical to current page 'box'.
Parameters:
Name Type Description
x1 number
y1 number
x2 number
y2 number
Returns:
this object, for call chaining
Type
Core.PDFNet.Convert.TiffOutputOptions

setCMYK(enable)

Render and export the image in CMYK mode. By default, the image is rendered and exported in RGB color space.
Parameters:
Name Type Description
enable boolean
Returns:
this object, for call chaining
Type
Core.PDFNet.Convert.TiffOutputOptions

setDither(enable)

Enables dithering when the image is exported in palletized or monochrome mode. This option is disabled by default.
Parameters:
Name Type Description
enable boolean
Returns:
this object, for call chaining
Type
Core.PDFNet.Convert.TiffOutputOptions

setDPI(dpi)

The output resolution, from 1 to 1000, in Dots Per Inch (DPI). The higher the DPI, the larger the image. Resolutions larger than 1000 DPI can be achieved by rendering image in tiles or stripes. The default resolution is 92 DPI.
Parameters:
Name Type Description
dpi number
Returns:
this object, for call chaining
Type
Core.PDFNet.Convert.TiffOutputOptions

setGamma(gamma)

Sets the gamma factor used for anti-aliased rendering. Typical values are in the range from 0.1 to 3. Gamma correction can be used to improve the quality of anti-aliased image output and can (to some extent) decrease the appearance common anti-aliasing artifacts (such as pixel width lines between polygons). The default gamma is 0.
Parameters:
Name Type Description
gamma number
Returns:
this object, for call chaining
Type
Core.PDFNet.Convert.TiffOutputOptions

setGray(enable)

Render and export the image in grayscale mode. Sets pixel format to 8 bits per pixel grayscale. By default, the image is rendered and exported in RGB color space.
Parameters:
Name Type Description
enable boolean
Returns:
this object, for call chaining
Type
Core.PDFNet.Convert.TiffOutputOptions

setHRes(hres)

Sets the width of the output image, in pixels.
Parameters:
Name Type Description
hres number
Returns:
this object, for call chaining
Type
Core.PDFNet.Convert.TiffOutputOptions

setMono(enable)

Export the rendered image as 1 bit per pixel (monochrome) image. The image will be compressed using G4 CCITT compression algorithm. By default, the image is not dithered. To enable dithering use 'SetDither' option. This option is disabled by default.
Parameters:
Name Type Description
enable boolean
Returns:
this object, for call chaining
Type
Core.PDFNet.Convert.TiffOutputOptions

setOverprint(mode)

Enable or disable support for overprint and overprint simulation. 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
}
Returns:
this object, for call chaining
Type
Core.PDFNet.Convert.TiffOutputOptions

setPages(page_desc)

Specifies the list of pages to convert. "1" for only the first page. "1-5" for pages 1 to 5. "1, 5, 7" for pages 1, 5, and 7. "odd" for all odd pages. "even" for all even pages. By default, all pages are converted.
Parameters:
Name Type Description
page_desc string
Returns:
this object, for call chaining
Type
Core.PDFNet.Convert.TiffOutputOptions

setPalettized(enable)

Enabled the output of palettized TIFFs. This option is disabled by default.
Parameters:
Name Type Description
enable boolean
Returns:
this object, for call chaining
Type
Core.PDFNet.Convert.TiffOutputOptions

setPrintmode(enable)

Renders annotations in the print mode. This option can be used to render 'Print Only' annotations and to hide 'Screen Only' annotations. This option is disabled by default.
Parameters:
Name Type Description
enable boolean
Returns:
this object, for call chaining
Type
Core.PDFNet.Convert.TiffOutputOptions

setRotate(rotation)

Rotates all pages by a given number of degrees counterclockwise. The allowed values are 0, 90, 180, and 270. The default value is 0.
Parameters:
Name Type Description
rotation number 
PDFNet.Page.Rotate = {
	e_0 : 0
	e_90 : 1
	e_180 : 2
	e_270 : 3
}
Returns:
this object, for call chaining
Type
Core.PDFNet.Convert.TiffOutputOptions

setSmooth(enable)

Enables or disables image smoothing (default: enabled).
Parameters:
Name Type Description
enable boolean
Returns:
this object, for call chaining
Type
Core.PDFNet.Convert.TiffOutputOptions

setTransparentPage(enable)

Sets the page color to transparent. By default, Convert assumes that the page is drawn directly on an opaque white surface. Some applications may need to draw the page on a different backdrop. In this case any pixels that are not covered during rendering will be transparent. This option is disabled by default.
Parameters:
Name Type Description
enable boolean
Returns:
this object, for call chaining
Type
Core.PDFNet.Convert.TiffOutputOptions

setVRes(vres)

Sets the height of the output image, in pixels.
Parameters:
Name Type Description
vres number
Returns:
this object, for call chaining
Type
Core.PDFNet.Convert.TiffOutputOptions