JavaScript PDF Annotation Library
PSPDFKit for Web is a JavaScript library for creating, removing, and editing PDF annotations. It offers developers a robust API for programmatic annotation management, as well as a beautiful UI for working with 17 PDF annotation types.
Key Capabilities
Highlight, text, ink, note, shape, and more
Programmatically or by using the UI
Manage annotations in XFDF or JSON files
Trigger workflows or automations
Cloudy border effect
Replace or enhance annotation rendering
To a server, multiple users, devices, or sessions
Hide annotation types or create custom tooltips
Add signing, editing, forms, and more
What Are Annotations?
Content displayed as a PDF page isn’t suitable for easy editing, but the PDF specification defines a comprehensive set of objects that can be added to PDF pages without changing the page content. These objects are called annotations, and their purpose ranges from marking up page content to implementing interactive features such as forms.
Essential Guides
Supported Annotation Types
Learn about the types of annotations supported by PSPDFKit
Annotation Data Formats
Learn about using external files to manage annotations
Geometry Primitives
Learn about the basic geometry data types exposed by PSPDFKit
Working with Annotations
Learn how PSPDFKit loads annotations
Annotation Replies and Reviews
Learn about displaying annotation replies as threaded conversations
Flatten Annotations
How to flatten annotations and burn them into a PDF
Synchronization
Saving and Storing Annotations
Saving Annotations Overview
Learn the two ways PSPDFKit allows making changes to documents
Embed Annotations into a PDF
How to embed annotations into a PDF document
Save Annotations to External Storage
How to save annotations to external storage
Auto Save Annotations
How to configure the way changes are automatically saved
Import and Export
Create, Edit, Remove
Create an Annotation
How to create an annotation
Edit an Annotation
How to edit an annotation
Remove an Annotation
How to remove an annotation
Annotation Permissions
How to configure annotation editing permissions
Add an Image Annotation
How to add an image to a PDF as an annotation
Detect Changes to Annotations
How to detect annotation changes that originate from the UI
Annotation Flags
How to configure annotation behavior and capabilities/
Undo and Redo
Learn about the undo and redo functionality for annotations
Annotation Author Name
How to configure the author name for annotations
Stamp Configuration
How to create a custom stamp
Link Annotations
How to create, detect, and customize link annotations
Annotate on an Image
How to annotate a PNG, JPG, or TIFF
Customization
Customize Annotation Display Logic
How to configure the logic used to display annotations in the viewer
Customize Appearance Streams
How to render existing appearance streams
Annotation Customization
How to create a custom annotation
Hiding Annotations
How to hide individual annotations or annotation types
Customize Default Properties
How to configure the default value for annotation properties
Store Custom Data in an Annotation
How to store and process custom data inside an annotation
More Annotation Guides
PDF Actions Support
Learn about the PDF actions supported by PSPDFKit
Stamp a Document with Built-In Stamps
How to stamp a document programmatically or with the UI
Image Document Specification
Learn how PNGs, JPGs, and TIFFs are annotated by PSPDFKit
Headless Annotation
How to annotate PDFs without presenting the UI
Integrations
PSPDFKit for Web is compatible with SharePoint, Microsoft Teams, Microsoft OneDrive, and Salesforce.