JpgViewOptions class

JpgViewOptions class

Provides options for rendering documents into JPG format.

The JpgViewOptions type exposes the following members:

Constructors

Constructor Description
init Initializes an instance of the JpgViewOptions class.
init Initializes an instance of the JpgViewOptions class.
init Initializes an instance of the JpgViewOptions class.
init Initializes a JpgViewOptions instance.
init Initializes a new instance of JpgViewOptions.

Methods

Method Description
rotate_page Applies the clockwise rotation to a page. (inherited from ViewOptions)
rotate_page_int32 (inherited from ViewOptions)

Properties

Property Description
extract_text The property enables text extraction.
height The height of the output image in pixels.
max_height The maximum height of an output image in pixels.
max_width The maximum width of an output image in pixels.
quality The quality of the output image.
width The width of the output image in pixels.
archive_options The archive files view options. (inherited from BaseViewOptions)
cad_options The CAD drawing view options. (inherited from BaseViewOptions)
default_font_name The default font for a document used during rendering when a required font is missing. (inherited from BaseViewOptions)
email_options The email messages view options. (inherited from BaseViewOptions)
mail_storage_options The mail storage data files view options. (inherited from BaseViewOptions)
outlook_options The Microsoft Outlook data files view options. (inherited from BaseViewOptions)
page_rotations The page rotation. (inherited from ViewOptions)
pdf_options The PDF document view options. (inherited from BaseViewOptions)
presentation_options The presentation files view options. (inherited from BaseViewOptions)
project_management_options The project management files view options. (inherited from BaseViewOptions)
remove_comments The property disables rendering comments when set to True. By default it is False, so all comments are displayed. (inherited from BaseViewOptions)
render_comments The property enables or disables rendering comments. (inherited from BaseViewOptions)
render_hidden_pages The property enables rendering of hidden pages. (inherited from BaseViewOptions)
render_notes The property enables rendering notes and annotations for some formats. (inherited from BaseViewOptions)
spreadsheet_options The spreadsheet files view options. (inherited from BaseViewOptions)
text_options The text options for rendering text files. (inherited from BaseViewOptions)
visio_rendering_options The Visio files view options. (inherited from BaseViewOptions)
watermark The text watermark to be applied to each page. (inherited from ViewOptions)
web_document_options The Web files view options. (inherited from BaseViewOptions)
word_processing_options The Word processing files view options. (inherited from BaseViewOptions)

Example

from groupdocs.viewer import Viewer
from groupdocs.viewer.options import JpgViewOptions

def render_to_jpg():
    # Load a document (e.g., Excel, Numbers, or image)
    with Viewer("invoice.xlsx") as viewer:
        # Create JPG view options with an output file pattern.
        # {0} will be replaced by the page number.
        view_options = JpgViewOptions("output_{0}.jpg")
        # Set the desired output image size in pixels.
        view_options.width = 800
        view_options.height = 900
        # Render the document to JPEG files.
        viewer.view(view_options)

if __name__ == "__main__":
    render_to_jpg()

See Also