The PDF component for Retool Apps

A content area to embed a PDF.

Version: Cloud and 3.179 Edge

For more information about this component, refer to the Embedded media guide.

Demo

Properties

All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance Method setHidden()
Default	false

Examples

true

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector
Default	pdf1

Examples

query1

button1

---

retoolFileObject

The file's data when using a file not stored in Retool Storage.

Type	object
Mutability	Read-only

---

retoolStorageDynamicInput

Whether retoolStorageFileId is set dynamically.

Type	string
Mutability	Read-only

---

retoolStorageFileId

The Retool Storage file ID if srcType is retoolStorageFileId.

Type	string
Mutability	Control Usage Retool UI Inspector

---

scaleMode

The scaling mode for the PDF.

Type	string
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description width Scale the PDF to fit the width. fill Scale the PDF to fit the height.

---

scrollSnap

Whether to snap to the nearest page.

Type	boolean
Mutability	Read-only

---

showRotateButton

Whether to show the rotate button.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

showTopBar

Whether to display a toolbar.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

showZoomControls

Whether to show the zoom controls.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

src

The data source.

Type	string
Mutability	Control Usage Retool UI Inspector Method setFileUrl()

---

srcType

The source type.

Type	string
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description src URL. retoolStorageFileId Retool Storage file. retoolFileObject Retool file object. dbBlobId Database blob. storageBlobId Storage blob.

---

style

Custom style options.

Type	object
Mutability	Control Usage Retool UI Inspector > Appearance

---

title

The title text to display.

Type	string
Mutability	Control Usage Retool UI Inspector

---

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

pdf.scrollIntoView()

Scrolls the canvas or parent container so that the selected component appears in the visible area.

Definition

pdf.scrollIntoView(options)

Parameters

options Required

object

The scroll options.

Object Properties

behavior Required

string

The scroll behavior.

Supported Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

block Required

string

The scroll position relative to the component.

Supported Values

nearest	Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view.
start	Scrolls to position the component at the top of the visible area.
center	Scrolls to position the component in the middle of the visible area.
end	Scrolls to position the component at the bottom of the visible area.

Examples

Scroll the minimum amount to immediately bring pdf into view.

pdf.scrollIntoView({behavior: 'auto', block: 'nearest'});

---

pdf.setFileUrl()

Set the URL of the file.

Definition

pdf.setFileUrl(src)

Parameters

src

string

The data source.

Examples

Set the URL of the file for pdf.

pdf.setFileUrl('https://example.com/example.png');

---

pdf.setHidden()

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

Definition

pdf.setHidden(hidden)

Parameters

hidden

boolean

Whether this object is hidden from view.

Examples

Hide pdf.

pdf.setHidden(true);

Unhide pdf.

pdf.setHidden(false);

---

Events

Events triggered by user interactions. Use event handlers to trigger queries or other actions in response to events.