Skip to main content
Version: Version 5 beta

Interface: PdfToolsViewerApi

API for interacting with the PDF Viewer, exposing core functionalities for document interaction, event handling, and UI management.

Other​

stickyNotes​

stickyNotes: StickyNotes

Groups all the sticky notes-related API actions.

Catergory​

stickyNotes

PdfToolsViewerApi​

hideElements()​

hideElements: (viewerEl, components) => void

Hides specified UI elements in the Viewer.

Parameters​

• viewerEl: PdfToolsViewer

The Viewer DOM element.

• components: HideableComponentConfigName[]

List of components to hide.

Returns​

void

Example​

PdfToolsViewerApi.hideElements(['icon-button-print']);

showElements()​

showElements: (viewerEl, components) => void

Shows specified UI elements in the Viewer.

Parameters​

• viewerEl: PdfToolsViewer

The Viewer DOM element.

• components: HideableComponentConfigName[]

List of components to show.

Returns​

void

Example​

PdfToolsViewerApi.showElements(['toolbar', 'icon-button-hamburger']);

contextualMenus​

contextualMenus​

contextualMenus: ContextualMenus

Groups all the contextual menu-related API actions.

dialogs​

dialogs​

dialogs: Dialogs

Groups all the dialog-related API actions.

document​

document​

document: Document

Groups all the document-related API actions.

documentView​

documentView​

documentView: DocumentView

Groups all the documentView-related API actions.

file​

file​

file: Files

Groups all the file-related API actions.

search​

search: Search

Groups all the search-related API actions.

toolbar​

toolbar​

toolbar: Toolbar

Groups all the toolbar-related API actions.

topbar​

topbar​

topbar: Topbar

Groups all the topbar-related API actions.