| FoxitPDFSDKforWeb v11.0.5 Archives Foxit PDF SDK for Web

Modules | Classes | Variables
PDFViewCtrl

The namespace that controls the drawing and rendering of PDF. PDF is used to modifying PDF data.
In this module, without clear declaring, APIs default to be supported in both JR and SR. More...

## Modules
| actions
| DeviceInfo
| A namespace containing variables used to determine the current device type.
| commons
| The common module provides the basic functionalities for the viewer.
| Log
| shared
| It's a module that contains some utility classes which encapsulates common operations such as Unit object processor.
| stamp
| This is a namespace containing the stamp API.
| add_ons
| A module includes all PDFViewerCtrl's add-ons.
| bookmark
| A module containing bookmark APIs for managing PDF viewer bookmarks.
| collab
| renderers
| Please access these objects by getter functions of PDFViewer or other object instead of their constructors.
| form
| stateHandler
| pdfjs
| overlayComparison
| This module contains the API related to the overlay comparison function.
| constants
| A module includes all PDFViewerCtrl's constants.
| interfaces
| annotCompontents
| This module contains some interface types used to declare AnnotComponent, these types will be used in the callback parameter of ViewerAnnotManager.registerMatchRule to customize some behaviors.
| readAloud
| creation
| storage
| The storage API within this namespace is responsible for storing and retrieving data. If the default driver is not meet your needs, the StorageDriver interface offers a standardized approach to implement a customized storage solution.
| viewerui
| viewMode

## Classes
class | ActionCallbackManager
| Action callback manager class, It used to control customized action callbacks. It can be obtained via PDFViewer::getActionCallbackManager() method. More...
class | ActivationGroup
| ActivationGroup class is extended from Activatable and used to implement multiple activation operations. Example: var activatable1 = pdfViewer.getAnnotRender(0, '<annotation id 1>').getComponent(); var activatable2 = pdfViewer.getAnnotRender(0, '<annotation id 2>').getComponent(); var activatable3 = pdfViewer.getAnnotRender(0, '<annotation id 3>').getComponent(); var group = new PDFViewCtrl.ActivationGroup(); group.add(activatable1); group.add(activatable2); pdfViewer.activateElement(group); // both activatable1 and activatable2 are going to be activated! group.add(activatable3); // activatable3 will also be activated! group.remove(activatable2); // activatable2 will be unactivated! pdfViewer.deactivateElement(group) // All activatables in group are going to be unactivated! . More...
class | AnnotationAuthorityManager
| Annotation Authority manager class, It used to control the permission of each annotations in the PDF document. It can be obtained via Viewer.PDFViewer::getAnnotAuthorityManager() method. More...
class | AnnotationPermission
| Describes the annotation permission informations. More...
class | Disposable
class | DivScrollWrap
| A basic class to create custom ScrollWrap with specified element. More...
class | PDFViewer
| Use PDFViewCtrl for the entry file. More...
class | SnapshotServer
| Custom screenshot image storage service. More...
class | UserPermission
| Assist in determining the permissions of the User_Permissions. More...

## Variables
type | GetAnnotPermissionsCallback = (annot: Annot) => Promise<string[]|null|undefined>
| Describes the type of function used to generate a list of permissions based on annotation information. More...

## Detailed Description

The namespace that controls the drawing and rendering of PDF. PDF is used to modifying PDF data.
In this module, without clear declaring, APIs default to be supported in both JR and SR.

## Variable Documentation

## ◆ GetAnnotPermissionsCallback

type GetAnnotPermissionsCallback = (annot: Annot) => Promise<string[]|null|undefined>

Describes the type of function used to generate a list of permissions based on annotation information.

See also
  AnnotationAuthorityManager.setAnnotPermissionCallback

Since
  9.0.0

@2025 Foxit Software Incorporated. All rights reserved.