pdftools_sdk.pdf2_image.profiles.viewing

Classes

The profile to convert PDF documents to JPEG or PNG images for viewing

class pdftools_sdk.pdf2_image.profiles.viewing.Viewing[source]

Bases: Profile

The profile to convert PDF documents to JPEG or PNG images for viewing

This profile is suitable for converting PDFs to rasterized images for using in web and desktop viewing applications or as thumbnails.

By default, pdftools_sdk.pdf2_image.profiles.viewing.Viewing.image_options is set to pdftools_sdk.pdf2_image.png_image_options.PngImageOptions which uses the output format PNG and lossless compression. If set to pdftools_sdk.pdf2_image.jpeg_image_options.JpegImageOptions , the output format is JPEG.

__init__()[source]

property image_options: ImageOptions

The settings for the output image

Supported types are:

pdftools_sdk.pdf2_image.png_image_options.PngImageOptions to create PNG images
pdftools_sdk.pdf2_image.jpeg_image_options.JpegImageOptions to create JPEG images

Default is pdftools_sdk.pdf2_image.png_image_options.PngImageOptions

Returns:: pdftools_sdk.pdf2_image.image_options.ImageOptions

property image_section_mapping: ImageSectionMapping

The image section mapping

This property specifies how a PDF page is placed onto the target image.

Supported types are:

pdftools_sdk.pdf2_image.render_page_at_resolution.RenderPageAtResolution to define the resolution of the output images.
pdftools_sdk.pdf2_image.render_page_to_max_image_size.RenderPageToMaxImageSize to define the maximum image size of the output images.

Default is pdftools_sdk.pdf2_image.render_page_at_resolution.RenderPageAtResolution with 150 DPI.

Returns:: pdftools_sdk.pdf2_image.image_section_mapping.ImageSectionMapping