Render archives as HTML, PDF, and image files
Leave feedback
On this page
GroupDocs.Viewer for Node.js via Java allows you to view the contents of archive files in HTML, PDF, PNG, and JPEG formats. You do not need to use third-party file archiver and compression software to display archive file contents within your Node.js application (web or desktop).
To start using the GroupDocs.Viewer API, create a Viewer class instance. Pass an archive file you want to view to the class constructor. You can load the archive from a file or stream. Call one of the Viewer.view method overloads to convert the archive file to HTML, PDF, or image format.
constviewer=newgroupdocs.viewer.Viewer("Documents.zip")// Create an HTML file for top folder and each subfolder in the archive.
// {0} is replaced with the current page number in the file name.
constviewOptions=groupdocs.viewer.HtmlViewOptions.forEmbeddedResources("page_{0}.html")viewer.view(viewOptions)
The following image demonstrates the result:
Specify the number of items to render
GroupDocs.Viewer supports the HtmlViewOptions.getArchiveOptions.setItemsPerPage method that allows you to specify the number of archive items to display on each HTML page. The default property value is 16.
The following example demonstrates how to set this option in code:
constviewer=newgroupdocs.viewer.Viewer("Documents.zip")// Create an HTML file for the top folder and each subfolder in the archive.
// {0} is replaced with the current page number in the output file name.
constviewOptions=groupdocs.viewer.HtmlViewOptions.forEmbeddedResources("page_{0}.html")// Specify the number of items to display on each HTML page.
viewOptions.getArchiveOptions().setItemsPerPage(10)viewer.view(viewOptions)
constviewer=newgroupdocs.viewer.Viewer("Documents.zip")// Create an HTML file for the top folder and each subfolder in the archive.
// {0} is replaced with the current page number in the output file name.
constviewOptions=groupdocs.viewer.HtmlViewOptions.forEmbeddedResources("page_{0}.html")// Specify the number of items to display on each HTML page.
viewOptions.setRenderToSinglePage(true)viewer.view(viewOptions)
The animation below demonstrates the result. You can navigate between the archive folders. Click on a particular folder to see its contents. To go backward, click the required folder name in the navigation bar at the top of the web page.
Render archive files as PDF
Create a PdfViewOptions class instance and pass it to the Viewer.view method to convert an archive file to PDF. The PdfViewOptions class properties allow you to control the conversion process. For instance, you can protect the output PDF file or reorder its pages. Refer to the following documentation section for details: Rendering to PDF.
constviewer=newgroupdocs.viewer.Viewer("Documents.zip")// Specify the PDF file name.
constviewOptions=groupdocs.viewer.PdfViewOptions("output.pdf")viewer.view(viewOptions)
constviewer=newgroupdocs.viewer.Viewer("Documents.zip")// Create a PNG image for the top folder and each subfolder in the archive.
// {0} is replaced with the current page number in the image name.
constviewOptions=groupdocs.viewer.PngViewOptions("output_{0}.png")// Set width and height.
viewOptions.setWidth(950)viewOptions.setHeight(550)viewer.view(viewOptions)
constviewer=newgroupdocs.viewer.Viewer("Documents.zip")// Create a JPG image for the top folder and each subfolder in the archive.
// {0} is replaced with the current page number in the image name.
constviewOptions=groupdocs.viewer.JpgViewOptions("output_{0}.jpg")// Set width and height.
viewOptions.setWidth(950)viewOptions.setHeight(550)viewer.view(viewOptions)
Obtain information about folders in an archive file
Call the Viewer.getViewInfo method, pass the ViewInfoOptions instance to this method as a parameter, and cast the returned object to the ArchiveViewInfo type.
When you convert an archive file to HTML, PDF, or image format, GroupDocs.Viewer renders items from all folders contained in the archive. If you need to render items from a specific folder, use the ArchiveOptions.setFolder method of one of the following classes (depending on the output file format):
When rendering an archive file, GroupDocs.Viewer displays the archive file name in the header of each page. If you need to change or hide this name, use the ArchiveOptions.setFileName method for a target view. You can set this option to one of the following values:
FileName.SOURCE— Returns the name of the source file (this name is used by default).
FileName.EMPTY—Specifies an empty name. Use this value to hide the archive file name in the output file.
A FileName instance with a custom name you want to display in the output file.
The following code snippet demonstrates how to use a custom name when rendering an archive file to HTML: