PDF Annotation Library for iOS
PSPDFKit for iOS is a 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
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
Annotation Replies and Reviews
Learn about annotation replies and reviews
Flatten Annotations
How to flatten annotations and burn them into a PDF
Freeform Annotation Rotation
Learn about annotation rotation and how to configure it
Magic Ink
How to add and configure the Magic Ink tool
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
Programmatic Creation, Editing, or Removal
How to programmatically create, edit, or remove annotations
Stamp Configuration
How to create a custom stamp
Link Annotations
How to create, detect, and customize link annotations
Undo and Redo
Learn about the undo and redo functionality for annotations
Annotate on an Image
How to annotate a PNG, JPG, or TIFF
Video Annotations
How to embed video into a PDF
Detect Changes to Annotations
How to detect annotation changes that originate from the UI
Annotation Flags
How to configure annotation behavior and capabilities
Image Picker
How to configure the image picker for adding an image annotation
Annotation Author Name
How to configure the author name for annotations
Attach a File
How to programmatically create a file annotation with an embedded file
Disable Annotation Editing
How to disable the modification of individual annotations or types
Create Annotations via Drag and Drop
Learn about dragging and dropping elements onto a page
Annotation Blend Modes
How to set blend modes for annotations
Annotation Z-Index
How to change the z-index of an annotation
Customization
Customize Appearance Streams
How to render existing appearance streams
Hiding Annotations
How to hide individual annotations or annotation types
Customize Default Properties
How to configure the default value for annotation properties
Customize Annotation Color Presets
How to customize the default color presets in the style inspector
Customize the Note Icon
How to customize or hide the note icon
Fixed Annotation Size
How to create an annotation that has a fixed size and doesn’t scale
Store Custom Data in an Annotation
How to store and process custom data inside an annotation
More Annotation Guides
Annotation Object Model
How to use the Annotation and FormElement classes
Stamp a Document with Built-In Stamps
How to stamp a document programmatically or with the UI
Multimedia Annotations
How to display multimedia/gallery annotations
Image Document Specification
Learn how PNGs, JPGs, and TIFFs are annotated by PSPDFKit
Annotation State Manager
How to programmatically set the states used for annotation creation
PDF Actions Support
Learn about the PDF actions supported by PSPDFKit