Render images as HTML, PDF, PNG, and JPEG files Leave feedback

GroupDocs.Viewer for Python via .NET allows you to load images in various formats and convert them to HTML, PDF, PNG, and JPEG. Incorporate this library into your Python application (web or desktop) to build your own image viewer.

To start with the GroupDocs.Viewer API, create a Viewer class instance. Pass an image you want to view to the class constructor. You can load the image from a file or stream. Call one of the Viewer.view method overloads to convert the image to HTML, PDF, PNG, or JPEG format. For multipage images (such as TIFF, CDR, DICOM, WebP, and so on), you can specify the pages to render.

View image files online View demos and examples on GitHub

GroupDocs.Viewer supports the following image file formats:

• .AI (Adobe Illustrator Artwork)
• .APNG (Animated Portable Network Graphic)
• .BMP (Bitmap Image)
• .CDR (CorelDRAW Image File)
• .CGM (Computer Graphics Metafile)
• .CMX (Corel Presentation Exchange Image)
• .DCM (DICOM Image)
• .DIB (Device Independent Bitmap File)
• .DJVU (DjVu Image)
• .DNG (Digital Negative Image)
• .EMF (Enhanced Windows Metafile)
• .EMZ (Windows Compressed Enhanced Metafile)
• .EPS (Encapsulated PostScript File)
• .FODG (OpenDocument Flat XML Graphics)
• .GIF (Graphical Interchange Format)
• .ICO (Icon File)
• .J2C (JPEG 2000 Code Stream)
• .J2K (JPEG 2000 Image)
• .JP2 (JPEG 2000 Core Image File)
• .JPC (JPEG 2000 Code Stream File)
• .JPEG / .JPG (JPEG Image)
• .JPF (JPEG 2000 Image)
• .JPM (JPEG 2000 Multi-layer Image Format)
• .JPX (JPEG 2000 Image File)
• .JLS (JPEG-LS Image)
• .ODG (OpenDocument Graphics File)
• .OTG (OpenDocument Graphic Template)
• .PCL (Printer Command Language Document)
• .PNG (Portable Network Graphics)
• .PS (PostScript File)
• .PSB (Photoshop Large Document Format)
• .PSD (Adobe Photoshop Document)
• .SVG (Scalable Vector Graphics File)
• .SVGZ (Compressed SVG File)
• .TGA (TARGA Graphics)
• .TIF / .TIFF (Tagged Image File Format)
• .WEBP (WebP Image)
• .WMF (Windows Metafile)
• .WMZ (Compressed Windows Metafile)

Create an HtmlViewOptions class instance and pass it to the Viewer.view method to convert an image to HTML. The HtmlViewOptions class properties allow you to control the conversion process. For instance, you can embed all external resources in the generated HTML file, minify the output file, and optimize it for printing. Refer to the following documentation section for details: Rendering to HTML.

To embed an image in an HTML page, call the HtmlViewOptions.for_embedded_resources method and specify the output file name.

with gv.Viewer("vector-image.svg") as viewer:
    # Specify the HTML file name.
    viewOptions = gvo.HtmlViewOptions.for_embedded_resources("output.html")
    viewer.view(viewOptions)

The following image demonstrates the result:

To save an image to a separate folder, call the HtmlViewOptions.for_external_resources method and pass the following parameters:

• The output file path format
• The path format for the folder with external resources
• The resource URL format

with gv.Viewer("vector-image.svg") as viewer:
    # Specify the HTML file name and location of external resources.
    # {0} is replaced with the resource name in the output file name.
    viewOptions = gvo.HtmlViewOptions.for_external_resources("output.html", "output/resource_{0}", "output/resource_{0}")
    viewer.view(viewOptions)

The result is shown below. The image is placed in a separate folder.

Create a PdfViewOptions class instance and pass it to the Viewer.view method to convert an image to PDF. The PdfViewOptions class properties allow you to control the conversion process. For instance, you can protect the output PDF file, reorder its pages, and specify the quality of document images. Refer to the following documentation section for details: Rendering to PDF.

with gv.Viewer("vector-image.svg") as viewer:
    # Create a PDF file.
    viewOptions = gvo.PdfViewOptions("output.pdf")
    viewer.view(viewOptions)

The following image demonstrates the result:

Create a PngViewOptions class instance and pass it to the Viewer.view method to convert an image to PNG. Use the PngViewOptions.height and PngViewOptions.width methods to specify the output image size in pixels.

with gv.Viewer("vector-image.svg") as viewer:
    # Create a PNG image.
    viewOptions = gvo.PngViewOptions("output.png")
    # Set width and height.
    viewOptions.width = 950
    viewOptions.height = 550
    viewer.view(viewOptions)

The following image demonstrates the result:

Create a JpgViewOptions class instance and pass it to the Viewer.view method to convert an image to JPEG. Use the JpgViewOptions.height and JpgViewOptions.width methods to specify the output image size in pixels.

with gv.Viewer("vector-image.svg") as viewer:
    # Create a JPG image for the letter.
    viewOptions = gvo.JpgViewOptions("output.jpg")
    # Set width and height.
    viewOptions.width = 950
    viewOptions.height = 550
    viewer.view(viewOptions)

When you render a PSD file with custom fonts, you can specify a folder that contains necessary fonts to prevent font substitution during rendering. To do this, follow the steps below:

1. Create a FolderFontSource class instance and specify a path to the folder that stores custom fonts. Pass a SearchOption enumeration member to the class constructor to define the search scope. The following options are available:

   • TOP_FOLDER_ONLY—Searches for the fonts only in the current folder.
   • ALL_FOLDERS—Searches for the fonts in the current folder and its subfolders.

2. Call the FontSettings.set_font_sources static method and pass the specified font source to this method as a parameter. This method allows you to specify multiple font sources.

You can also use the ViewOptions.default_font_name method to specify the default font that should be used when a particular font is not found.

import GroupDocs.Viewer as gv
import GroupDocs.Viewer.fonts as gvf
import GroupDocs.Viewer.options as gvo
# Create font sources.
# Add custom fonts folder to look for fonts recursively. (look into subfolders too).
folderFontSource = [gvf.FolderFontSource(".../custom_fonts_folder", gvf.SearchOption.ALL_FOLDERS)]
# Add custom fonts folder to look for fonts only in this folder (wihout subfolders).
additionalFontSource = [gvf.FolderFontSource(".../custom_additional_fonts_folder", gvf.SearchOption.TOP_FOLDER_ONLY)]
# Call SetFontSources method and supply font sources as arguments.
gvf.FontSettings.set_font_sources(folderFontSource, additionalFontSource)

with gv.Viewer("sample.psd") as viewer:
    # Create a JPG image for the letter.
    viewOptions = gvo.JpgViewOptions("output.jpg")
    viewOptions.default_font_name("Arial")
    viewer.view(viewOptions)