| FoxitPDFSDKforWeb v11.0.6 Archives Foxit PDF SDK for Web

Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 1 2 3 4 5]

►C Action | PDF action object
C EmbeddedGotoAction | EmbeddedGoto action object
C GoToAction | GoTo action object
C HideAction | Hide action object
C JavaScriptAction | JavaScript action object
C LaunchAction | Launch action object
C LaunchAction | Launch action object
C RemoteGotoAction | RemoteGoto action object
C ResetFormAction | ResetForm action object
C SubmitFormAction | SubmitForm action object
C SubmitFormAction | SubmitForm action object
C URIAction | URI action object
C ActionCallback | An interface represents a action callback class for performing PDF actions. Users can implement only part of the callbacks according to actual requirements
C ActionCallbackManager | Action callback manager class, It used to control customized action callbacks. It can be obtained via PDFViewer::getActionCallbackManager() method
C ActionSpecWithTrigger | Represents an action specification with a trigger event. This combines the action specification with the trigger event that will execute the action
►C Activatable | Defines methods for activatable objects. The activatable object need to override its methods to implement the activation and deactivation operations
►C AnnotComponent | You can use the ViewerAnnotManager::registerMatchRule to reset their default behavior
C MarkupAnnotComponent | Markup annot component
C 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!
C AddBookmarkEvent | Represents an event that occurs when a new bookmark is added
C AddBookmarkOptions | Represents options for adding a new bookmark
C AdditionalAction< T > | An annotation, page object, or (beginning with PDF 1.3) interactive form field may include an entry named "AA" which specifies an additional-actions dictionary (PDF 1.2) that extends the set of events that can trigger the execution of an action. In PDF 1.4, the document catalog dictionary may also contain an "AA" entry for trigger events affecting the document as a whole
C AddMarkedStateCollaborationData | Describes the data format of add marked state collaboration action
C AddMarkedStateOperationData | Describes the details of add marked state operation
C AddReplyCollaborationData | Describes the data format of add reply collaboration action
C AddReplyOperationData | Describes the detail of add reply
C AddReviewStateCollaborationData | Describes the data format of add review state collaboration action
C AddReviewStateOperationData | Describes the details of add review state operation
C AlertOptions | An interface represents all options of alert callback
C AlignAnnotController |
C AnnotationPermission | Describes the annotation permission informations
C AnnotComponentConfig | An interface that describes all available configuration properties of AnnotComponent
C AnnotFlag | Class with a flag number used to detect permissions
C AnnotId | Represents a unique identifier for an annotation within a PDF document. The identifier is composed of two components: the page index and the object number, both of which together ensure uniqueness within the document
C AnnotQuery | Represents a query targeting a specific annotation in the PDF. This interface defines the structure for querying a specific annotation
C AnnotRender | PDF annot render
C AnnotTooltip | Defines methods for annotation objects. The AnnotTooltip object need to override its methods to implement the show and hide operations
C AppearanceTab |
►C BasicCreateWidgetOptions | Form filler module, which provides APIs for operating form fields
C CreateCheckBoxOptions | Options for creating a check box field in the PDF form
C CreateComboBoxOptions | Options for creating a combo box field in the PDF form
C CreateDatetimeOptions | Options for creating a datetime field in the PDF form
C CreateListBoxOptions | Options for creating a list box field in the PDF form
►C CreatePushButtonOptions | Options for creating a push button field in the PDF form
C CreateImageButtonOptions | Options for creating an image button field in the PDF form
C CreateRadioButtonOptions | Options for creating a radio button field in the PDF form
C CreateTextFieldOptions | Options for creating a text field in the PDF form
C BlendColorResolverOptions | Options of BlendColorResolver callback
C BookmarkData | Represents a bookmark entry in the document
C BookmarkDataService | Provides functionality for management and manipulation of bookmark-related data
C BookmarkDestination | Represents information about the destination of a bookmark
C BookmarkFontStyle | Represents the font style of a bookmark
C BookmarkProperties | Represents properties of a bookmark
C BookmarkQuery | Represents a query targeting a specific bookmark in the PDF document. This interface defines the structure for querying a specific bookmark
C BookmarkUIService | Bookmark service for manipulating bookmark data at the UIExtension level. Different from BookmarkDataService, the BookmarkUIService also updates the UI and supports undo-redo
C CenterAnnotController |
C ChoiceOptionItem | An option item in a list box or combo box
C CloneWidgetOptions | Clone a widget from one page to another
►C CollaborationCommunicator | An interface defines several methods that user should follow to implement custom CollaborationCommunicator. Collaboration communicator is used to process and generate collaboration sessions, synchronize collaboration data, send collaboration data, and receive collaboration data from other clients
C WebSocketCommunicator | Collaboration implementation based on native WebSocket API. For compatibility information, please refer to this link: Can i use websocket
C CollaborationData | The format of all built-in collaboration data and user-customize data
C CollaborationDataHandler | A collaboration data handler used to process collaboration data received from server
C CollaborationSessionInfo | An interface defines the session info including shareId and the parameters to open PDF file
C Color | Class for processing color-related algorithms such as conversions
C CombinePixelsOptions | Options to handle pixel-diff and combine-pixels algorithms
C ComparePageRange | Range of pages for comparison
►C Component | PDFUI allows you to define a component as a class inherit from Component and register that into a module to provide UI features. Each component has several 'lifecycle methods' that you can override to run code at particular times in the process
►C ButtonComponent | Defines button component,for more details on usage please visit this example page: /examples/UIExtension/tutorials/widgets/button.html Example: <xbutton>i18n.key</xbutton> <xbutton text="i18n.key"></xbutton> <xbutton icon-class="icon-css-class-name">i18n.key</xbutton>
C ContextMenuItemComponent | Defines the <contextmenu-item> component. Example: <contextmenu> <contextmenu-item name="contextmenu-item-0" icon-class="fv__icon-toolbar-fullscreen" shortcut="Ctrl+P">i18n.key0</contextmenu-item> <contextmenu-item name="contextmenu-item-1">i18n.key1</contextmenu-item> </contextmenu>
C FileSelectorComponent | Defines file selector component. It looks the same as xbutton, a system file selector will popup after user clicks, and the change event will be triggered and handle method of controller will be invoked with file object after select a file. Example: <file-selector accept=".pdf" icon-class="icon-css-class-name">i18n.key</file-selector>
►C ContainerComponent | An container is a component to organize widgets. You need to inherit this class and implement some necessary methods to customize your own container components. The features that distinguish from widgets are following:
C BookmarkTreeComponent | Bookmarks tree component for displaying and managing user's bookmarks. The component is used via the following code snippet:
►C CommentListCardComponent | Defined as the super class of CommentCarComponent and ReplyCardComponent, encapsulationed same behaviors of them. CommentListCardComponent
C CommentCardComponent | Defines a comment card component in the comment list tab of the left sidebar. This component are created automatically after loading a PDF page or creating or importing annotations, and after creating this component instance, UIEvents.appendCommentListComment event is fired with the current instance and the annotation
C ReplyCardComponent | Defines a reply card component.ReplyCardComponent
►C DropdownComponent | Defines `<dropdown>` component. Dropdown is toggleable, contextual overlays for displaying lists of `<dropdown-button>`, `<dropdown-item>`, `<xbutton>`, `<file-selector>` or `<li>`. for more details please visit this example page: /examples/UIExtension/tutorials/widgets/dropdown.html
C PageViewDropdownComponent |
C PageViewDropdownComponent |
C DropdownItemComponent | Defines <dropdown-item> component, dropdown item must be an item in the dropdown list. This component can wrapping any other component even dropdown also. For more details please visit /examples/UIExtension/tutorials/widgets/dropdown.html
C FormGroupComponent | <form-group> component, it used to control the display of form itemsExamples:
C GroupComponent | Defines <group> component. When the browser width is adjusted to less than 600, this component will automatically shrink. For more details please visit this example page: /examples/UIExtension/tutorials/widgets/group.html
C GroupListComponent | Defines <group-list> component. Group list is a container of <group>
►C LayerComponent | Defines <layer> component. A layer component can be used to open a floating box above ather element and also can be used as a modal dialog with a optional backdrop. For more details please visit this example page: /examples/UIExtension/tutorials/widgets/layer.html
C ContextMenuComponent | Defines contextmenu component. Example: <contextmenu> <contextmenu-item name="contextmenu-item-0">i18n.key0</contextmenu-item> <contextmenu-separator></contextmenu-separator> <contextmenu-item name="contextmenu-item-1">i18n.key1</contextmenu-item> </contextmenu>
C LoadingComponent | A component for displaying loading state
C TooltipLayerComponent | A tooltip like layer. Here is an example about usage on text-selection: /examples/UIExtension/customize-text-selection-tool/index.html
C LayerHeaderComponent | Defines layer-header component, usually used for the header of a dialog box. For more details on usage, please visit this example page: /examples/UIExtension/tutorials/widgets/layer.html
C LayerToolbarComponent | Defines <layer-toolbar> component. It should be used as the child of <layer> component. This component is usually used as a container of one-line buttons, and is often used as the bottom bar of a dialog box. For more details please visit this example page: /examples/UIExtension/tutorials/widgets/layer.html
C LayerViewComponent | Defines <layer-view> component. It should be used as the child of <layer> component. This component is usually used as a body container for dialog box. For more detail please visit this example page: /examples/UIExtension/tutorials/widgets/layer.html
C OptionGroupComponent | OptionGroupItem multiple: multiple choice selected: default choice Example: <option-group multiple> <option-group-item selected>i18n.key</option-group-item> </option-group>
C PaddleComponent | Defines paddle component, used to toggle content when content overflows to facilitate display of overflowing content. <div class="container" style="width: 768px"> <paddle> <div style="width: 1024px">content</div> </paddle> </div>
C SidebarComponent | Defines sidebar component, It offers the following features:
C SlotComponent | Defines slot component, inherits from ContainerComponent. Slot can accommodate multile child components, and inserting that into the specified position of the target component after mounted to DOM tree. A slot component needs to specify the slot name and target component name, or if the target component name is not specified, then parent component instead. Example: <webpdf> <some-component name="any-component-name"></some-component> <slot component="any-component-name" for="slot-name"> <i class="xxx"></i> </slot> <some-container-component> <slot for="slot-name"> <i class="xxx"></i> </slot> </some-container-component> </webpdf>
C TabItemComponent | Defines tab component. Tab is one of the view of a `tabs` component which used to accommodate any child components
C TabsComponent | Defines <tabs> component. Tabs is a component with a set of `tab`s used to switch different views. For more details on usage please visit this page /examples/UIExtension/tutorials/widgets/tabs.html
C ToolbarComponent | Defines toolbar component. This is just an div with a css class name fv__ui-toolbar. Usually it's used to customize special styles of the component in the toolbar
C TreeComponent | The class that defines the tree component The component is used via the following code snippet:
C TreeNodeComponent | Represents a component for a tree node in a tree structure
C ContextMenuSeparatorComponent | Defines contextmenu separator component. Example: <contextmenu> <contextmenu-item name="contextmenu-item-0">i18n.key0</contextmenu-item> <contextmenu-separator></contextmenu-separator> <contextmenu-item name="contextmenu-item-1">i18n.key1</contextmenu-item> </contextmenu>
C DropdownButtonComponent | Defines <dropdown-button> component, Dropdown button must be an item in <dropdown>'s list, this component may act as a button or a file-selector, for more details please visit /examples/UIExtension/tutorials/widgets/dropdown.html
►C FormFieldComponent | Defined a form field type component
C NumberComponent | Defines number component, which is a text input element that allows only numbers and has a limited range and step size. For more details on usage please visit this example page: /examples/UIExtension/tutorials/widgets/number.html
C NumberComponent | Defines number component, which is a text input element that allows only numbers and has a limited range and step size. For more details on usage please visit this example page: /examples/UIExtension/tutorials/widgets/number.html
C GTabComponent | Defines <gtab> component, GTab is a component used to switch serval views. Different from <tabs> component, <gtab> component's tab and tab-body are separated! This allows us to define tabs more flexibly!
C TextComponent | Defines text component. This component will localize text content via I18Next and generates an text node insert into the DOM tree, You can update content of that text node via TextComponent.setText() API. It acts like data-i18n attribute, but that clears all children elements. For more details on usage please visit this example page: /examples/UIExtension/tutorials/widgets/text.html
►C ComponentOptions | An interface that describes all basic configuration options of a component
C ButtonComponentOptions | An interface that describes all configuration options of a button component
C DropdownComponentOptions | An interface describes all configuration options of dropdown component
►C FormFieldComponentOptions | An interface describes all basic configuration options of a form-field type component
C NumberComponentOptions | An interface describes all configuration options of number component
C FragmentComponentOptions | Component options in fragment config property
C GroupComponentOptions | An interface describes all configuration options of a group component
C LayerComponentOptions | An interface describes all configuration options of layer component
C LayerHeaderComponentOptions | An interface describes all configuration options of layer component
C SidebarPanelComponentOptions | An interface describe all configuiration options of a sidebar-panel component
C TabItemComponentOptions | An interface describes all configuration options of a tab component
C ControllerDirective |
C CreateAnnotAddon | Annotation creates the add-on entry
C CreateAnnotationCollaborationData | Describe the collaboration data format of create annotation action
C CreateAnnotationOperationData | The data used to create annotation that includes annotation information and page index
C CreateSignatureOptions | Options for creating a signature field in the PDF form
C DefaultAppearance | An interface that represents default appearance data, which is used for free text annotations and forms
C DefaultAppearanceFontInfo | Represents the font information of the default appearance
C DeleteBookmarkEvent | Represents an event that occurs when a bookmark is deleted
C DevicePoint | The DevicePoint interface is the point information defined in px, and DevicePoint {x:0,y:0} is in the left-top corner
C DeviceRect | DeviceRect is a definition of a rectangular range in units of physical pixels of the device. Point (0,0) is at the left-top conner
C DigitalStampSize | Represents the size of a digital stamp
C DigitalStampTemplate | Represents a custom digital stamp template
►C Disposable |
►C Annot | PDF annot object
C Link | Link annot object
►C Markup | Markup annot object
C Caret | Caret annot object
C Circle | Circle annot object
C FileAttachment | FileAttachment annot object
C FreeText | Free text annot object
C Ink | Ink annot object
C Line | Line annot object
C Note | Note annot object
C Polygon | Polygon annot object
C PolyLine | PolyLine annot object
C Redact | Redact annot object
C Sound |
C Square | Square annot object
C Stamp | Stamp annot object
►C TextMarkup | Text markup annotation object which contains Highlight, StrikeOut, Squiggly, Underline
C Highlight | Highlight annot object
C Squiggly | Squiggly annot object
C StrikeOut | StrikeOut annot object
C Underline | Underline annot object
C Screen | Screen annot object
C Widget | A class that represents a form widget in a PDF document
C 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
►C Appearance | An appearance like a packed theme. It provides a layout template and also allows to do things related to UE in `beforeMounted` or `afterMounted` method. When the layout template is rewritten, it is best to inherit this class and override the `disableAll` and `enableAll` methods to handle associated logic
C AdaptiveAppearance | Automatically select different appearance based on the current device type
►C UIAppearance | An appearance like a packed theme. It provides a layout template and also allows to do things related to UE in `beforeMounted` or `afterMounted` method. When the layout template is rewritten, it is best to inherit this class and override the `disableAll` and `enableAll` methods to handle associated logic
C MobileAppearance | Appearance for mobile-end
C RibbonAppearance | Appearance for PC
►C Controller | Controller is a base class used to implement UI component business logic. It contains the entire life cycle process of UI components. In these lifecycle methods, you can implement style adjustments to UI components, event monitoring, and destruction. The Controller provides a special handle method. The triggering behavior of the handle is defined by the component itself. It is suitable for simple component event processing, such as the click event of the xbutton and the change event triggered after the file-selector selects a file; Controller provides a special method: handle, The triggering behavior of `handle` is defined by the component itself, for example: the <xbutton> triggers handle on mouse click and the <file-selector> triggers handle on change event. There's two ways to reference a Controller to a Component:
C AddCirclePathObjectController |
C AddImageAdvController |
C AddImageController |
C AddLinePathObjectController |
C AddRoundRectPathObjectController |
C AddShapesController |
C AddSquarePathObjectController |
C AddTextController |
C AddTextStateController |
►C AnnotOperationController | It's a abstract controller class provides an easy way for sub-controller classes to take control the contextmenu-item's visibility and usability before contextmenu shown
C ApplyAllRedactController |
C ApplyRedactController |
C CopyAnnotTextController |
C DeleteAnnotController |
C MediaDownloadController |
C MediaPauseController |
C MediaPlayController |
C ShowActionsController |
C ShowAnnotReplyController |
C ShowRedactPlaceDialogController |
C BoldStyleController |
C CancelCreatingDrawingController |
C CancelCreatingMeasurementController |
C CompleteCreatingDrawingController |
C CompleteCreatingMeasurementController |
C DownloadFileController |
C EditAllObjectsController |
C EditObjectController |
C EditTextController |
C FindReplaceController |
C GotoFirstPageController |
C GotoLastPageController |
C GotoNextPageController |
C GotoPageController |
C GotoPrevPageController |
C ItalicStyleController |
C JoinSplitController |
C OpenLocalFileController |
C OpenRemoteFileController |
C ShowAnnotFormPropertiesController |
C ShowAnnotPropertiesController |
C ShowSearchPanelController |
C SignPropertyController |
►C StatefulController | This Controller class encapsulates the implementation logic for IStateHandler registration and toggle event listening. A customization example: class MyStateHandlerClass extends PDFViewCtrl.IStateHandler { // ... } class MyStateController extends UIExtension.controllers.StatefulController { constructor(component) { super(component, MyStateHandlerClass); } }
C CreateAreaController |
C CreateAreaHighlightController |
C CreateArrowController |
C CreateCalloutController |
C CreateCaretController |
C CreateCircleAreaController |
C CreateCircleController |
C CreateDistanceController |
C CreateFileAttachmentController |
C CreateHighlightController |
C CreateImageController |
C CreateLineController |
C CreateLinkController |
C CreatePencilController |
C CreatePerimeterController |
C CreatePolygonCloudController |
C CreatePolygonController |
C CreatePolylineController |
C CreateReplaceController |
C CreateSquareController |
C CreateSquigglyController |
C CreateStrikeoutController |
C CreateTextboxController |
C CreateTextController |
C CreateTypewriterController |
C CreateUnderlineController |
C HandController |
C LoupeController |
C MarqueeToolController |
C SelectTextAnnotationController |
C TotalPageTextController |
►C ViewModeController | It is an abstract template class for the view mode switching controllers
C ContinuousFacingPageModeController |
C ContinuousPageModeController |
C FacingPageModeController |
C SinglePageModeController |
►C CreateAnnotationService | This is a service interface that defines the function of creating Annotation, and classes that create specific Annotations should inherit it
C CreateFreeTextCalloutService | This is a class that encapsulates the function of creating callout annotations. It is usually used to customize the state handler for creating callout annotations. It can easily implement the process of creating callouts without having to care about more details
C CreateFreeTextCalloutService | This is a class that encapsulates the function of creating callout annotations. It is usually used to customize the state handler for creating callout annotations. It can easily implement the process of creating callouts without having to care about more details
C CreateFreeTextCalloutService | This is a class that encapsulates the function of creating callout annotations. It is usually used to customize the state handler for creating callout annotations. It can easily implement the process of creating callouts without having to care about more details
C CustomOptionsUpdater | Defines the parameters in the customs object of the PDFViewer constructor that can be dynamically updated. The update methods listed here can be called at any time to dynamically update the application state. Please note that instances of this type must be obtained using the PDFViewer.getCustomOptionsUpdater() method
C FormFillerService | Service for handling PDF form filling operations
C IContextMenu | This is an abstract contextmenu class. The various behaviors of the user-customized contextmenu can be encapsulated in its subclasses, and then its subclasses should be created in the XViewerUI::createContextMenu to complete the contextmenu customization.
C IFloatingTooltip | An abstract class used to implement floating box components displayed after text selection or other operations
C IStateHandler | Interface of StateHandler
C PDFDoc |
C PDFForm | ## Represents a PDF form within a document. This class provides various methods for interacting with and manipulating form fields within a PDF document. It integrates with the underlying document and form APIs to perform operations such as submitting, importing, and resetting form fields. The PDFForm class is also responsible for managing form field events and maintaining the form's state
►C PDFFormField |
C PDFSignature | Represents a signature field in a PDF form, providing methods for verification and retrieval of signature information
C PDFFormPropertiesService | Service for retrieving various PDFFormProperty instances for fields/widgets, facilitating UI interactions such as property dialogs
C PDFFormPropertiesService | Service for retrieving various PDFFormProperty instances for fields/widgets, facilitating UI interactions such as property dialogs
►C PDFViewer | Use PDFViewCtrl for the entry file
C PDFUI |
►C ScrollWrap | Scroll bar container component, Controls the scrolling of a pdfviewer view
C DivScrollWrap | A basic class to create custom ScrollWrap with specified element
C TextSelectionTool | This class is used in text selection tools in <tooltip-layer>. For more details on usage please refer to this example: -examples{UIExtension/customize-text-selection-tool/index.html}
C DistributeAnnotController |
C DocQuery | Represents a query targeting the entire PDF document. This interface defines the structure for querying the document level
C DocTextSearch | This class can construct text search in a PDF document
C DownloadFileService | A service to download files
C EmbeddedGotoActionData | Indicates that the destination thread is not in the current document
C EmbeddedGotoTargetData | The object numbers of the visible OCG layer nodes
C EmbeddedGotoTargetFileInfo | Represents the file information of an embedded go-to target
C ExecuteActionData | Represents the data necessary for executing an action within a PDF document. This class extends `ActionSpecification` and adds additional properties needed for action execution
C ExecuteActionOptions | Defines the options required for executing a PDF action in the viewer
C ExportFileProgress | Represents the progress of a task
C ExportFormOptions | Export form options
C ExtFieldType | Extended type information for PDF form fields, with specific properties for different field types
C FieldFlagOptions |
C FileSpec |
C FileSpecData | Represents file specification data used for handling files
C FindReplaceAddon | Provides APIs to find or replace text in the PDF document
C FontMap | PDF page range object
C ForeachDirective |
C FormFieldQuery | Represents a query targeting a specific field in the PDF document. This interface defines the structure for querying a specific form field
C FormInputEvent | Represents a input event within a form
►C FormInteractionEvent | Represents an interaction event with a form
C FormKeyboardEvent | Represents a keyboard event within a form
C FormMouseEvent | Represents a mouse event with a form
C FormMouseWheelEvent | Represents a mouse wheel event within a form
C FormPasteEvent | Represents a paste event within a form
C FormInteractionEventFlags | Represents encapsulates flags for a form interaction event
C FormInteractionEventInterceptorOptions | Options for form interaction event interceptor
C Glyphs | Font glyphs object
C GotoActionData | Represents the data for a goto action, specifying the destination
►C GraphicsObject |
C ImageObject |
C PathObject |
C TextObject |
C HandStateHandlerConfig |
C HeaderFooter | PDF HeaderFooter object
C HideActionData | Represents the data for a hide action, specifying field names to hide and the hide state
►C IAnnotationSummary | Basic annotation summary
C ILinkAnnotationSummary | Summaries of link annotation
►C IMarkupAnnotationSummary | Summaries of markup type annotations
C ICaretAnnotationSummary | Summaries of caret type annotation
C ICircleAnnotationSummary | Summaries of circle type annotation
C IFileAttachmentAnnotationSummary | Summaries of file attachment type annotation
►C IFreeTextAnnotationSummary | Summaries of freetext type annotation
C IFreeTextCalloutAnnotationSummary | Summaries of callout type annotation
C IFreeTextTextBoxAnnotationSummary | Summaries of text box type annotation
C IFreeTextTypewriterAnnotationSummary | Summaries of typewriter type annotation
C ILineAnnotationSummary | Summaries of line annotation
C INoteAnnotationSummary | Summaries of Note annotation
C IPolygonAnnotationSummary | Summaries of polygon annotation
C IPolylineAnnotationSummary | Summaries of polyline annotation
C IRedactAnnotationSummary | Summaries of redact annotation
C ISquareAnnotationSummary | Summaries of square annotation
►C ITextMarkupAnnotationSummary | Summaries of text markup type annotation
C IHighlightAnnotationSummary | Summaries of highlight annotation
C IInkAnnotationSummary | Summaries of ink annotation
C ISquigglyAnnotationSummary | Summaries of squiggly annotation
C IStrikeoutAnnotationSummary | Summaries of squiggly annotation
C IUnderlineAnnotationSummary | Summaries of underline annotation
C IContextMenuItem | This is an abstract contextmenu-item class. The various behaviors of the user-customized contextmenu-item can be encapsulated in its subclasses, and then its subclasses should be obtained from `IContextMenu::getItem` by the name to complete the contextmenu customization
C IDateTimePicker | An abstract class for implementing a date and time picker component.
C IdentityInfo | Represents identity information for digital stamps
C ILayerNode | Describes the PDF layer node
C ImageData | Image data used for overlay comparison, which can be obtained through PDFPage.render or CanvasRenderingContext2D.getImageData or CanvasRenderingContext2D.createImageData
C ImportAnnotationsFileCollaborationData | An interface describes the collaboration data format of import annotation fdf,xfdf files
C ImportAnnotationsFileOperationData | The data used to import annotations that includes base64 format data of the fdf, xfdf file
C ImportDataActionData | Represents the data for an import data action, specifying the file to import
►C ImportFormOptions | Import form options
C ImportFormFromCSVOptions | Import form from CSV/TXT options
C IncludeExcludeMDPActionData | Filtering MDP action data
C InlineColorPickerComponent | Defines an inline color picker component Example: <form-group label="Select Color"> <inline-color-picker></inline-color-picker> </form-group>
C IPopupAnnotationSummary | Popup annotation summary
►C ISignatureField | Interface representing a signature field in a PDF document
►C IFormSignatureField | Interface for handling form signature fields, extending ISignatureField
C PDFSignature | Represents a signature field in a PDF form, providing methods for verification and retrieval of signature information
C IXFASignatureField | Interface for handling XFA signature fields, extending ISignatureField
►C ISignatureUI | Defines the interface for managing signature-related UI elements in document viewer applications
C XSignatureUI | The UIExtension implementation of ISignatureUI for managing signature-related UI elements
C ISignDocDialog | Interface for handling the signature dialog
C ISignedSignaturePropertiesDialog | Interface for displaying the properties of signed signature
C ISignVerifiedResultDialog | Interface for displaying the result of verifing signature
►C IViewerUI | This class provides an ability for user to customize the several UI like contextmenu which may be triggered from `PDFViewCtrl` module, that stuffs should be customized like the example: new PDFViewer({ ...otherOptions, viewerUI: class extends PDFViewCtrl.IViewerUI { ...implementations } })
►C TinyViewerUI | The default built-in UI implementation for `PDFViewCtrl` module
C XViewerUI | This class provides an ability for user to customize the several UI like contextmenu which may be triggered from `PDFViewCtrl` module. You should customize that stuffs like the following example: new PDFUI({ viewerOptions: { viewerUI: new class extends UIExtension.XViewerUI { createContextMenu(owner, anchor, config) { // ... } } } })
C IViewMode | Layout of page view interface
C JavaScriptActionData | Represents the data for a JavaScript action, containing the JavaScript code to execute
C LaunchActionData | Represents the data for a launch action, specifying the file to launch
C LineThicknessValues | The line thickness of each compare type objects. By default, these values are 2 pt
C LoggerFactory | The LoggerFactory is a utility class producing Loggers for various logging APIs
C MarkingColorValues | The marking color(in 0xRRGGBB format) of each compare type objects
C Matrix | PDF matrix for coordinate transformation
C MKCaptionOptions | Options for captions in different widget states
C MKIconBitmap | Icon bitmap data
C MKIconFitOptions | Options for fitting icons to the widget bounds
C MKIconOptions | Icon options for different states of a form widget
C Modular | Modular is an singleton class, you can access that instance via `UIExtension.modular`
C MoveActionOptions | Options for moving an additional action
C MoveAnnotsBetweenPageCollaborationData | Describes the data format used to collaborate the moving annotation action
C MoveAnnotsBetweenPageOperationData | Describes the the fromPageIndex, toPageIndex and annotation's data for move annotation operation
C MoveBookmarkEvent | Represents an event that occurs when a bookmark is moved
C MultimediaPlayer | An interface represents the necessary methods of multimedia player. The MultimediaPlayer object need to override its methods to implement the operations
C OnProgressListener | Register a callback that is used to get data when the progress is updated
C OpacityValues | The opacity of each compare type objects. The opacity is expressed as a percentage, and the default is 100%
C OpenDateTimePickerOption | Options for opening the date and time picker
C OpenFileParameter | Parameters to open file
C OverlayComparisonOptions | Options for OverlayComparisonService.compareImageData
C OverlayComparisonOptionsService |
C OverlayComparisonService | Overlay comparison function entry, this instance must be obtained through PDFViewer.getOverlayComparisonService method
C OverlayComparisonTransformationOptions | Transformation parameters of the target image data
C PageEditorAddon | Provides page edit functionality for document operations within the UIExtension
►C PageGraphicsObject | Represents a graphics object within the PDF page
C ImageGraphicObject | Represents a image object within the Page Editor
C PathGraphicObject | Represents a path object within the Page Editor
C ShadingGraphicObject | Represents a shading object within the Page Editor
C TextGraphicObject | Represents a text object within the Page Editor
►C PageGraphicsObjectProperties | Defines common editable properties for page editing objects
C ImageGraphicObjectProperties | Defines editable properties for image objects in the Page Editor
C PathGraphicObjectProperties | Defines editable properties for path objects in the Page Editor
C ShadingGraphicObjectProperties | Defines editable properties for shading objects in the Page Editor
C TextGraphicObjectProperties | Defines editable properties for text objects in the Page Editor
C PageQuery | Represents a query targeting a specific page in the PDF document. This interface defines the structure for querying a specific page
C PageRange | PDF page range object
C PageTextSearch | Search result extractor
C PagingSealConfig | Represents the information for a paging seal signature
C PasteCutBookmarkInfo | Parameter of the callback function triggered when pasting a cut bookmark
C PDFDate | Represents a date and time in the PDF format. The following table lists the available pattern components for formatting and parsing dates:
C PDFDictionary |
C PDFDocRender | The class that controls PDF document rendering
C PDFDocRendering |
C PDFFormProperty< T > | Represents the properties of a PDF form field, encapsulating details about its availability, visibility, value presence, and the actual value
C PDFPage |
C PDFPageBatchProcessor | Controls the `start`, `flush`, and `end` cycles of a batch processor, and calling property update methods within the batch processor declaration cycle can greatly improve performance
C PDFPageRender | PDF page renderer
C PDFPageRendering |
C PDFPoint | The PDFPoint interface is the point information defined in pt, and PDFPoint {x:0,y:0} is in the left-bottom corner of the PDF page
C PDFRect | PDFRect is a definition of a rectangular range in units of point. Point (0,0) is at the left-bottom conner
►C PDFTextToSpeechSynthesis | The interface of the speech synthesizer. You need to implement all the methods and properties declared below when customizing the speech synthesizer
C AbstractPDFTextToSpeechSynthesis | An abstract class that provides template methods to simplify the implementation of custom speech synthesizers
►C PDFTextToSpeechSynthesisTemplate | Template methods to simplify the implementation of custom speech synthesizers
C AbstractPDFTextToSpeechSynthesis | An abstract class that provides template methods to simplify the implementation of custom speech synthesizers
C PDFTextToSpeechUtterance | The PDFTextToSpeechUtterance represents a speech request, It contains a piece of text content and the page number of the text content in the PDF document, as well as other relevant information
C PDFViewerRendering |
C PDFViewPreference |
C PPOInsertPageCollaborationData | Describes the format of ppo insert page collaboration action
C PPOInsertPageOperationData | Describes the information for PPO_INSERT_PAGE action
C PPOMovePageCollaborationData | Describes the collabroation data format of move page action
C PPOMovePageOperationData | Describes the format of ppo move page collaboration action
C PPORemovePageCollaborationData | Describes the format of ppo remove page collaboration action
C PPORemovePageOperationData | Describes which pageIndex need be removed
C PPORemovePagesCollaborationData | Describes the format of ppo remove page collaboration action
C PPORemovePagesOperationData | Describe the page range that needs to be removed
C PPORotatePageCollaborationData | Describes the format of ppo roate page collaboration action
C PPORotatePageOperationData | Describes the detail of rotate page operation
C PreConfiguredComponent | It's a simple & pre-configured high-order component
C PreviewInterface |
C PrintUIXAddon | Represents the Print Addon in the UIExtension, allowing users to show a print dialog
C ProgressComponent | The ProgressComponent is an interface class that represents a component for displaying the progress of a task. It can be used to provide a visual indication of the progress of a task that may take some time to complete
C Proxy |
C ReadAloudAddon | Represents the Read Aloud Addon in the PDFUI, allowing users to have documents read aloud
C ReadAloudOptions | Interface describing the options of the speech synthesizer, including volume, rate, etc
C ReadAloudService | Read aloud feature service
C ReadAloudTextInformation | Defines an interface for text content page number and text rectangle boundary information
C Rect | Represents a rectangle defined by its left, right, top, and bottom coordinates
C RegisterPrintHandlerCallback | A callback function used to PDFViewer::registerPrintHandler
C RemoteGotoActionData | Represents the data for a remote goto action, specifying the file and destination
C RemoveAnnotationCollaborationData | Describes the data format used to collaborate remove annotation action
C RemoveAnnotationOperationData | Describes the data format for remove annotation
C RemoveReplyCollaborationData | Describes the data format of remove reply collaboration action
C RemoveReplyOperationData | Describes the details of remove reply operation
C ResetFormActionData | Represents the data for a reset form action, specifying form fields and optional flags
C SeniorComponentFactory | The Factory class is used to create high-order components
C SeniorComponentSuperclassOptions | An interface describes configuration options to generate a senior component superclass
C SignatureAnnot | Represents a PDF form signature annotation component in the PDF viewer. This class is responsible for handling the PDF form signature annotation component's lifecycle, rendering, and context menu configuration
C SignatureFlowOptions | An interface that describes all configuration options of customize the signature flow
C SignatureInfomation | An interface declaration containing information related to the signature
C SignatureService | This class provides methods for customizing signature signing/verification behavior
C SignatureVerificationOptions | Options for configuring the verification process of PDF form signatures
C SignatureWorkflowService | This class is used to record the settings information required for signatures and custom verification handlers. The recorded information will be used in the SDK's built-in signature UI
C SignDocInfo | Signing settings for PDF signatures
C SignedFormSignatureInfo | Information regarding a signed form signature
C SignedXFASignatureInfo | Information regarding a signed XFA signature
C SigningSettings | Signing settings for PDF signatures
C SigningTimeFormat | The time format infomation
C SigningTimeFormatTimeZoneOptions | The time zone information
C SimpleEventEmitter |
C SizeAnnotController |
C Snapshot | Snapshot information, including the PDFPageRender it belongs to, the selected area, and the image data stream
C SnapshotInteraction | This is a built-in snapshot interaction class, and the application layer can inherit it to implement custom interaction logic
C SnapshotServer | Custom screenshot image storage service
C StampInfo | This interface describes the stamp infomation
C StampService | A singleton class, which can be obtained via PDFUI.getStampService. It can be used to obtain the currently selected stamp icon and monitor the switching action between stamp icons
C StampStateHandlerParams | An interface represents the parameter of STATE_HANDLER_CREATE_STAMP
C StateHandlerManager |
►C StorageContext | Stores the context used to generate storage space names
C PDFViewerStorageContext | This is an extension of the StorageContext interface. Storage requests triggered by business layer code above the PDFViewerCtrl layer usually carry a PDFViewer instance. Therefore, this interface describes such a StorageContext
►C StorageDriver | Represents a storage driver
C IndexedDBStorageDriver | The default built-in storage driver solution based on IndexedDB since 9.2.0
C LocalStorageDriver | The storage driver solution based on localStorage
C StorageDriverChangeEvent< T > | Represents an event triggered when there is a change in the storage driver. T The type of the old and new values in the storage change event
C StorageDriverRemoveEvent | Represents an event triggered when a stored value is removed in the storage driver
C SubmitFormActionData | Represents the data for a submit form action, specifying form fields and the destination address
C TaskProgress | The TaskProgress interface defines a process manager
C TaskProgress< T extends TaskProgressData > | The TaskProgress interface which defines a process manager
C TaskProgressData | The TaskProgressData interface which defines the data in the progress of the task
C TextSearchMatch | The match result of text search
C TreeNodeData | Represents the data structure for a tree node
C TypingInkSignImageGenerator | An ink signature image generator that generates image data url from specific text content and font. This class provides importFontFamily API to import thirdparty fonts globally from remote what you needed
C UIFragmentOptions | An interface describe configuration options of UI fragment
►C UIXAddon | UIXAddon, an addon that relies on the UIExtension of Foxit PDF SDK for Web, is packaged separately into a JS file. The applications can load this addon as needed. This class defines the method templates what a UIXAddon needs to implement
C CustomDynamicStampAddon | Allows customization and management of dynamic stamps within PDF documents
C DigitalStampUIXAddon | Represents the Digital Stamp Addon in the UIExtension, allowing users to manage digital stamps
C FormDesignerAddon | This addon provides form designer functionality and form widget properties editing functionality
C Thumbnail | Represents a Thumbnail Addon in the PDFUI
C UIXModule | A module constructed by `Modular.module` is collection of components and controllers. You can register a component class or a controller class into a module then you can use your component in template. An example for registering component class and usage:
C UndoRedoAddon | This addon provides comprehensive undo and redo operations at a global level within the document environment. It supports undoing and redoing actions related to bookmarks, annotations, and advanced editing (AdvEdit) functionalities. Users can efficiently revert or reapply changes made to bookmarks, annotations, and advanced editing tasks within the document, enhancing the overall control and flexibility of document management
C Unit | Unit object
C UnsignedFormSignatureInfo | Information regarding an unsigned form signature
C UnsignedXFASignatureInfo | Information regarding an unsigned form signature
C UpdateAnnotationCollaborationData | Describes the data format for update annotation action
C UpdateAnnotationOperationData | The data used to update annotations
C UpdateAnnotContentCollaborationData | Describe the data format of update annotation content collaboration action
C UpdateAnnotContentOperationData | Describes the details of update annotation content operation
C UpdateBookmarkPropertiesEvent | Represents an event that occurs when bookmark properties are updated
C URIActionData | Represents the data for a URI action
C UserCustomizeCollaborationData | The format of user cusomize collaboration data
C UserPermission | Assist in determining the permissions of the User_Permissions
C ViewerAnnotManager | Viewer Annot Manager. The behavior of the default annot can be reset by registerMatchRule
C ViewModeManager | View Mode Manager The default contains the following two viewmode continuous-view-mode: Continuous page mode single-page-view-mode: Single page mode
C VisibleType | Represents the visibility state of a PDF form widget, encapsulating information about whether the widget is hidden, can be printed, or is viewable by the user
C XFAWidgetInfo | An interface represents the information of widget
C ZoomFitBBoxDestinationData | Destination data for zooming to fit the bounding box of the page contents within the window. ZoomFitBBoxDestinationData
C ZoomFitBHorzDestinationData | Destination data for zooming to fit the width of the bounding box of the page contents to the window. The `top` parameter specifies the vertical distance from the page origin to the top edge of the window
C ZoomFitBVertDestinationData | Destination data for zooming to fit the height of the page vertically. The `left` parameter specifies the horizontal distance from the page origin to the left edge of the window. ZoomFitBVertDestinationData
C ZoomFitHorzDestinationData | Destination data for zooming to fit the width of the page to the window. The `top` parameter specifies the vertical distance from the page origin to the top edge of the window. This is equivalent to using a fit rect destination with a rectangle that spans the full width of the page, where both y-coordinates are set to the specified `top` value. ZoomFitHorzDestinationData
C ZoomFitPageDestinationData | Destination data for zooming to fit the entire page within the window. This is equivalent to specifying a fit rect destination where the rectangle corresponds to the crop box of the page, ensuring the entire page is visible
C ZoomFitRectDestinationData | Destination data for zooming to fit a specific rectangular area on the page. ZoomFitRectDestinationData
C ZoomFitVertDestinationData | Destination data for zooming to fit the height of the page to the window. The 'left' parameter specifies the horizontal position from the page origin to the left edge of the window. This is equivalent to a FitRect destination where the rectangle has the full height of the page and both x-coordinates are set to the 'left' value. ZoomFitVertDestinationData
C ZoomXYZDestinationData | Destination data for zooming to a specific position with a defined zoom factor. The 'left' and 'top' parameters specify the distance from the origin of the page to the top-left corner of the window. The 'zoomFactor' parameter specifies the magnification level, where 1.0 represents 100% magnification. If any of the 'left', 'top', or 'zoomFactor' parameters are null, the current value of that parameter is retained. For example, specifying a view destination of `/View [/XYZ NULL NULL NULL]` will navigate to the specified page while maintaining the current horizontal position, vertical position, and zoom level. A 'zoomFactor' of 0 is equivalent to null. ZoomXYZDestinationData

@2025 Foxit Software Incorporated. All rights reserved.