The PDF component for Retool Apps

A content area to embed a PDF.

Settings

PDF includes the following configurable options when building apps in the IDE.

HiddenShow on desktopShow on mobileMaintain space when hiddenMarginFile inputScale page toAlways show in edit modeShow top barSourceSourceStylesHelper text

Properties

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

hidden

boolean

Whether the component is visible.

id

string

The unique identifier.

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

maintainSpaceWhenHidden

boolean

Whether the component takes up space on the canvas if hidden is true.

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

pluginType

string

The plugin type.

retoolFileObject

object

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

retoolStorageDynamicInput

string

Whether retoolStorageFileId is set dynamically.

retoolStorageFileId

string

The Retool Storage file ID if srcType is retoolStorageFileId.

scaleMode

enum

The scaling mode for the PDF.

Values

width	Scale the PDF to fit the width.
fill	Scale the PDF to fit the height.

scrollSnap

boolean

Whether to snap to the nearest page.

showInEditor

boolean

Whether to remain visible in the editor if hidden is true.

showTopBar

boolean

Whether to display a toolbar.

src

string

The data source.

srcType

enum

The source type.

Values

url	URL.
retoolStorageFileId	Retool Storage file.
retoolFileObject	A file object.

style

object

Custom style options in use. Not all style options may be available for all components.

title

string

The text to display as a title.

tooltipText

string

The tooltip text to display.

Methods

JavaScript API methods for interacting with PDF. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

scrollIntoView

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

pdf.scrollIntoView(scrollIntoViewOptions)

Parameters

scrollIntoViewOptions

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values

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

block

enum

The scroll position relative to the component.

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.

setFileUrl

Set the URL of the file.

pdf.setFileUrl(src)

Parameters

src

string

The data source.

setHidden

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

pdf.setHidden(hidden)

Parameters

hidden

boolean

Whether the component is visible.