PrizmDoc® v14.3 Release - Updated January 14, 2025
PrizmDoc
/
API Reference
/
Viewer Control
/ External: jQuery
Collapse All
Expand All
In This Topic
jQuery
Namespaces
Is this page helpful?
Yes
No
Thanks for your feedback.
How can we improve?
Submit
PrizmDoc
Get Started
Release Notes
Supported File Formats
System Requirements
Evaluate
PrizmDoc
Sample Applications
Integrate into Your Web App
Architecture Overview
Illustrating the Viewing Sequence
1. Integrating PrizmDoc
2. Choosing a Backend & Creating a Viewing Session
3. Setting up a Reverse Proxy
Developer Guide
Implement our Top Features
Get Started with Hybrid Viewing
License & Create PDF Viewing Packages
Create On-Demand Viewing Packages
AI Features
Scaling up for Better Performance
Work Effectively with Large Documents
PrizmDoc
Architecture & Design
Design Basics
Architecture Basics
Integrate PrizmDoc Releases with Your Code
Configure PrizmDoc
Configuration Options
Initialization Parameters
uiElements
Configure the Comments Panel
Define the View Mode
Digital Rights Management Configuration
Enable Content Encryption
How to Use Pre-defined Search
Localize PrizmDoc
Use a Custom Resource Path
Add Custom Image Stamps
How to Customize PrizmDoc
Add a Custom Button
Add Keyboard Shortcuts
Build a Custom User Interface
Change the Position of the Menu Bar
Create a Custom Mouse Tool
Create a Custom Tab
Customize the Markup
Customize the Mouse Tools
Customize the Styles
Disable the Print Button
Enable Multiple Redaction Reasons
Reorganize Menus
Scroll the Viewer Programmatically
Set the Initial Zoom Factor
Subscribe to Events
Work with Annotations
Change Annotation Default Values
Load Annotations from the Web Tier
Work with Annotation Layers
Work with Annotations Programmatically
Work with Document Comparison Programmatically
Modify viewer.js
PrizmDoc Application Services (PAS)
Set up Your Database for use with PAS
Store Annotations in a Database
Handle Specific Routes with PAS
Compare Documents with PAS
Pre-Convert Documents
Pre-Populate Fields in the E-Signature Viewer
Work with Viewing Packages
PrizmDoc Server
Use the PrizmDoc Server API
Markup Burner XML Specification
Markup JSON Specification
How To Examples
Compare Documents
Convert Content with Content Conversion Service
Content Conversion Demo
How to Configure and Run the Demo on Windows
How to Run the Demo in Docker
Perform Auto-Redaction
Set up a Viewing Session for a CAD Drawing which has XREF Dependencies
Use the Markup JSON Schema
Use a Viewing Session
Watermark Content in a Viewing Session
Pre-Convert Documents to PDF
Administrator Guide
Security Guidance
Kubernetes
Supported Kubernetes Versions
Deployment to Kubernetes Guidance
PrizmDoc Server
Server Sizing
Migrate from PrizmDoc Cloud Servers to PrizmDoc Self-Hosted Servers
Document Rendering Specifics
Installing
Using Docker
Migrate to Docker
Install on Windows
Install on Windows
Registry Changes
Natively Render MSO Documents
Unattended Install & Uninstall
Uninstall PrizmDoc Server on Windows
Check PrizmDoc Server Health
Upgrade PrizmDoc Viewer
Configure a Cluster
Licensing
Metered License
Offline Metered Licensing
OEM License
Configuring
Central Configuration
PCCIS Configuration
Implement Caching Strategies
Adjust Caching Parameters
Change Encryption Keys for Public use Token Generation
Configure Microsoft Office Conversion Connectivity
Configure Custom CAD Fonts
Substitute Fonts for Office Rendering Fidelity
Upgrade from Legacy Configuration
Configure the Central Database
Enable Pre-Conversion to PDF
Configure Date & Time Headers in Email Documents
Supported Time Zones
Clustering
Optimize Cache Performance for Cluster Environments (Server)
Affinity Tokens & Cluster Mode
Starting & Stopping
Linux
Windows
PrizmDoc Application Services
Server Sizing
Installing
Using Docker
Install on Windows
Unattended Install & Uninstall
Check the Connection to PrizmDoc Server
Licensing
Configuring
PAS Configuration
PAS Database Administration & Maintenance
How & When to use CORS
Clustering
Optimize Cache Performance for Cluster Environments (PAS)
Run PAS on Clusters
Starting & Stopping
Linux
Windows
Error Reporting
Accusoft Policy on Log Changes
Search Tips
Packaging Log Files for Support
API Reference
Viewer Control
External: jQuery
Namespace: fn
Namespace: PCCViewer
Class: AjaxResponse
Class: BurnRequest
Class: Comment
Class: Conversation
Class: ConversionRequest
Class: DocumentClassificationRequest
Class: DocumentHyperlink
Class: DocumentQueryRequest
Class: DocumentSummarizationRequest
Class: DocumentTagRequest
Class: Error
Class: Event
Class: ImageStamps
Class: LoadMarkupLayersRequest
Class: Mark
Class: MarkupLayer
Class: MarkupLayerCollection
Class: MouseTool
Class: ObservableCollection
Class: PiiDetectionRequest
Class: PiiEntity
Class: PrintRequest
Class: Promise
Class: Revision
Class: RevisionsRequest
Class: SearchRequest
Class: SearchResult
Class: SearchTask
Class: SearchTaskResult
Class: Signature Control
Class: SignatureDisplay
Class: ThumbnailControl
Class: Viewer
Class: ViewerControl
Mixin: Data
Mixin: SessionData
Namespace: Ajax
Namespace: Language
Namespace: MouseTools
Namespace: Signatures
Namespace: Util
Namespace: MarkSchema
Namespace: MarkupLayerSchema
E-Signature Controls
External: jQuery.fn
Class: ESigner
Class: TemplateDesigner
Module: button-set
Module: checkbox-collection
Module: data-persist
Module: date-picker
Module: download-signed-form-trigger
Module: download-signed-form
Module: dropdown
Module: event-store
Module: field-edit
Module: field-list
Module: fill-checklist
Module: fill-form-controller
Module: fill-main-toolbar
Module: fill-progress
Module: form-controller
Module: form-extraction
Module: form-summary
Module: form-tools
Module: global-settings-menu
Module: global-settings-trigger
Module: keyboard-controller
Module: multiple-selection
Module: notification
Module: page-navigation
Module: profile-manager
Module: state-store
Module: svg-icons
Module: template-io
Module: template-manager
Module: template-name-header
Module: text-input
Module: zoom-fit
Cloud Authentication
Authenticating Requests
OAuth
PAS REST API
General Information
Base URL for PAS
API Data Types
Back-end Proxy
Application Development
Viewing Sessions
Viewing Package Creators
Viewing Packages
Self-Hosted Administration
Health
Viewer Support
Attachments
Content Converters
Content Converters (Deprecated)
Document Classifiers
Document Queriers
Document Summarizers
Document Taggers
Form Definitions
Form Extractors
Image Stamps
Legacy Create Session
Markup Burners
Markup Layers
Markup XML
PII Detectors
Search Tasks
PrizmDoc Server REST API
General Information
Base URL for PrizmDoc Server
Offline Metered License Usage Report
Application Development
Content Conversion Service
Markup Burners
Plain Text Redactors
Redaction Creators
PII Detectors
Search Contexts
Search Tasks
Work Files
Self-Hosted Administration
Health Status
Cluster Management
Viewer Support
Attachments
Document Classifiers
Document Queriers
Document Summarizers
Document Taggers
Form Extractors
HTML5 Viewing
Viewing Sessions
Pre-Conversion to PDF Support
"v3" Viewing Package Creators
"v3" Viewing Packages
"v3" Viewing Sessions
Unsupported Routes
Unsupported Routes
PrizmDoc Server .NET SDK
Configure Postman Collections
Support & Troubleshooting
Accusoft Support
Document Viewing Issues
Office Files
Text Files
CAD Files
PDF Files
Viewing Package Issues
Redaction & Annotation Issues
Form Field Detector Error Messages
Log File Growth
Memory Consumption Issues
PrizmDoc Server Health Issues
Windows Installation & Upgrade Issues
Legal
Copyright Information
Software License Agreement
Third-Party Attributions
Licenses
highlight.js
pdfjs-license
Glossary
Definitions
New Terms
PrizmDoc Video
PrizmDoc OCR API
External: jQuery
In This Topic
jQuery
Namespaces
jQuery
The jQuery Plugin namespace.
See:
jQuery Plugins
Namespaces
fn