The PDF web component
A content area to embed a PDF.
Settings
PDF includes the following configurable options when building apps in the IDE.
Show 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.
id
The unique identifier.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
pluginType
The plugin type.
retoolFileObject
The file's data when using a file not stored in Retool Storage.
retoolStorageDynamicInput
Whether retoolStorageFileId
is set dynamically.
retoolStorageFileId
The Retool Storage file ID if srcType
is retoolStorageFileId
.
Values
width | Scale the PDF to fit the width. |
fill | Scale the PDF to fit the height. |
scrollSnap
Whether to snap to the nearest page.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
showTopBar
Whether to display a toolbar.
Values
url | URL. |
retoolStorageFileId | Retool Storage file. |
retoolFileObject | A file object. |
title
The text to display as a title.
tooltipText
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
The scroll options.
Properties
behavior
The scroll behavior.
Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block
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. |
setHidden
Set the hidden
value to toggle whether the component is visible. Defaults to true
without a parameter.
pdf.setHidden(hidden)