Skip to main content

Document Viewer

This page provides an introduction on how to utilize the Document Viewer widget for displaying documents.

Using the Document Viewer Widget

Content properties​

These properties are customizable options present in the property pane of the widget, allowing users to modify the widget according to their preferences.

Data​

Document Link URL / Base64​

This property allows you to include a URL or base64-encoded content to view various file formats. The supported file extensions for the widget are:

  • .txt
  • .pdf
  • .ppt (not supported by base64)
  • .pptx
  • .docx
  • .xlsx

Additionally, you can populate the document by retrieving data from a source such as an API or Datasource Query.

info

When using base64-encoded files larger than 1.5MB, the Document Viewer may encounter rendering issues. It is recommended to use direct URLs or reduce the file size for optimal performance.

Visible Boolean​

This property controls the visibility of the widget. If you turn off this property, the widget would not be visible in view mode. Additionally, you can use JavaScript by clicking on JS next to the Visible property to conditionally control the widget's visibility.

Animate Loading Boolean​

This property controls whether the widget is displayed with a loading animation. When enabled, the widget shows a skeletal animation during the loading process. Additionally, you can control it through JavaScript by clicking on the JS next to the property.

Reference properties​

These properties are not available in the property pane, but can be accessed using the dot operator in other widgets or JavaScript functions. For instance, to get the visibility status, you can use DocumentViewer1.isVisible.

docUrl String​

The docUrl property contains the URL of the uploaded document and is used to display the link to access the document.

isVisible Boolean​

The isVisible property reflects the state of the widget's Visible setting. It is represented by a boolean value, where true indicates that the widget is visible, and false indicates that it is hidden or not displayed on the page.

Watch the following videos to learn how to generate PDF reports using Apitemplate.io and Carbone.io.

Methods​

Widget property setters enable you to modify the values of widget properties at runtime, eliminating the need to manually update properties in the editor.

These methods are asynchronous and return a Promise. You can use the .then() block to ensure execution and sequencing of subsequent lines of code in Appsmith.

setVisibility (param: boolean): Promise​

Sets the visibility of the widget.

Example:

DocumentViewer1.setVisibility(true)

setURL (param: string): Promise​

Updates the URL of the document to be displayed in the Document Viewer widget.

Example:

DocumentViewer1.setURL('<https://example.com/file.txt>')

See also​