Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files Leave feedback
On this page
GroupDocs.Viewer for Python allows you to render your spreadsheet files in HTML, PDF, PNG, and JPEG formats. You do not need to use Microsoft Excel or other spreadsheet programs to load and view Excel documents within your Python application (web or desktop).
To start with the GroupDocs.Viewer API, create a Viewer class instance. Pass a spreadsheet file you want to view to the class constructor. You can load the document from a file or stream. Call one of the Viewer.view method overloads to convert the document to HTML, PDF, or image format. These methods allow you to render the entire document or specific pages.
GroupDocs.Viewer supports the following spreadsheet file formats:
- Microsoft Excel Workbook (.XLSX)
- Microsoft Excel 97-2003 Workbook (.XLS)
- Microsoft Excel Binary Workbook (.XLSB)
- Microsoft Excel Macro-Enabled Workbook (.XLSM)
- Microsoft Excel Template (.XLTX)
- Microsoft Excel 97-2003 Template (.XLT)
- Microsoft Excel Macro-Enabled Template (.XLTM)
- Microsoft Excel Add-In (.XLAM)
- XML Spreadsheet 2003 (.XML)
- OpenDocument Spreadsheet (.ODS)
- OpenDocument Spreadsheet Template (.OTS)
- OpenDocument Flat XML Spreadsheet (.FODS)
- Comma Separated Values File (.CSV)
- Tab Separated Values File (.TSV)
- StarOffice Calc Spreadsheet (.SXC)
- Apple Numbers Spreadsheet (.NUMBERS)
Create an HtmlViewOptions class instance and pass it to the Viewer.view method to convert a spreadsheet file 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 save all elements of an HTML page (including text, graphics, and stylesheets) into a single file, call the HtmlViewOptions.for_embedded_resources method and specify the output file name.
with gv.Viewer("invoice.xlsx") as viewer:
# Convert the spreadsheet to HTML.
# {0} is replaced with the current page number in the file names.
viewOptions = gvo.HtmlViewOptions.for_embedded_resources("page_{0}.html")
viewer.view(viewOptions)
The following image demonstrates the result:
with gv.Viewer("Products.numbers") as viewer:
# Convert the spreadsheet to HTML.
# {0} is replaced with the current page number in the file names.
viewOptions = gvo.HtmlViewOptions.for_embedded_resources("page_{0}.html")
viewer.view(viewOptions)
The following image demonstrates the result:
If you want to store an HTML file and additional resource files (such as fonts, images, and stylesheets) separately, 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("invoice.xlsx") as viewer:
# Convert the spreadsheet to HTML.
# Specify the HTML file names and location of external resources.
# {0} and {1} are replaced with the current page number and resource name, respectively.
viewOptions = gvo.HtmlViewOptions.for_embedded_resources("page_{0}.html", "page_{0}/resource_{0}_{1}", "page_{0}/resource_{0}_{1}")
viewer.view(viewOptions)
with gv.Viewer("Products.numbers") as viewer:
# Convert the spreadsheet to HTML.
# Specify the HTML file names and location of external resources.
# {0} and {1} are replaced with the current page number and resource name, respectively.
viewOptions = gvo.HtmlViewOptions.for_embedded_resources("page_{0}.html", "page_{0}/resource_{0}_{1}", "page_{0}/resource_{0}_{1}")
viewer.view(viewOptions)
The image below demonstrates the result. External resources are placed in a separate folder.
To convert all worksheets to one HTML file, use the HtmlViewOptions.render_to_single_page method. This feature is supported in both cases - when converting to HTML with embedded and external resources.
with gv.Viewer("Personal_net_worth_calculator.xlsx") as viewer:
# Convert all Excel worksheets to one HTML file.
viewOptions = gvo.HtmlViewOptions.for_embedded_resources("page.html")
# Enable converting all worksheets to one file.
viewOptions.render_to_single_page = True
viewer.view(viewOptions)
The following image demonstrates the result:
Create a PdfViewOptions class instance and pass it to the Viewer.view method to convert a spreadsheet file 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("invoice.xlsx") as viewer:
# Convert the spreadsheet to PDF.
viewOptions = gvo.PdfViewOptions("output.pdf")
viewer.view(viewOptions)
The following image demonstrates the result:
with gv.Viewer("Products.numbers") as viewer:
# Convert the spreadsheet to PDF.
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 a spreadsheet file to PNG. Use the PngViewOptions.height and PngViewOptions.width methods to specify the output image size in pixels.
with gv.Viewer("invoice.xlsx") as viewer:
# Convert the spreadsheet to PNG.
# {0} is replaced with the current page number in the file names.
viewOptions = gvo.PngViewOptions("output_{0}.png")
# Set width and height.
viewOptions.width = 800
viewOptions.height = 900
viewer.view(viewOptions)
with gv.Viewer("Products.numbers") as viewer:
# Convert the spreadsheet to PNG.
# {0} is replaced with the current page number in the file names.
viewOptions = gvo.PngViewOptions("output_{0}.png")
# Set width and height.
viewOptions.width = 800
viewOptions.height = 900
viewer.view(viewOptions)
The following image demonstrates the result:
Create a JpgViewOptions class instance and pass it to the Viewer.view method to convert a spreadsheet file to JPEG. Use the JpgViewOptions.height and JpgViewOptions.width methods to specify the output image size in pixels.
with gv.Viewer("invoice.xlsx") as viewer:
# Convert the spreadsheet to JPEG.
# {0} is replaced with the current page number in the file names.
viewOptions = gvo.JpgViewOptions("output_{0}.jpg")
# Set width and height.
viewOptions.width = 800
viewOptions.height = 900
viewer.view(viewOptions)
with gv.Viewer("Products.numbers") as viewer:
# Convert the spreadsheet to JPEG.
# {0} is replaced with the current page number in the file names.
viewOptions = gvo.JpgViewOptions("output_{0}.jpg")
# Set width and height.
viewOptions.width = 800
viewOptions.height = 900
viewer.view(viewOptions)
If you load a CSV/TSV file to convert it to another format, use the SpreadsheetOptions.detect_separator method for a target view to automatically detect a delimiter used to separate values in the source file.
GroupDocs.Viewer can detect the following separators:
- A comma (the default separator)
- A semicolon
with gv.Viewer("sample.csv") as viewer:
# Convert the spreadsheet to JPEG.
# {0} is replaced with the current page number in the file names.
viewOptions = gvo.HtmlViewOptions.for_embedded_resources("page_{0}.html")
# Detect a CSV/TSV separator.
viewOptions.spreadsheet_options.detect_separator = True
viewer.view(viewOptions)
GroupDocs.Viewer allows you to obtain information about the source spreadsheet file. For example, you can retrieve worksheet names, as described below:
- Create a ViewInfoOptions instance for a specific view.
- Call the Viewer.get_view_info method and pass the
ViewInfoOptionsinstance to this method as a parameter. - Use the pages method of the returned ViewInfo object to access to the list of worksheets and retrieve the worksheet names.
with gv.Viewer("sample.xlsx") as viewer:
view_info_options = gvo.ViewInfoOptions.for_html_view()
# Call this method to create a single page for each worksheet.
view_info_options.spreadsheet_options = gvo.SpreadsheetOptions.for_one_page_per_sheet()
view_info = viewer.get_view_info(view_info_options)
# Print the worksheet names in the console window.
print("Worksheets:")
for page in view_info.pages:
print(f" - Worksheet {page.number} name '{page.name}'")
The following image shows a sample console output:
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
