pspdfkit library
Copyright © 2018-2025 PSPDFKit GmbH. All rights reserved.
THIS SOURCE CODE AND ANY ACCOMPANYING DOCUMENTATION ARE PROTECTED BY INTERNATIONAL COPYRIGHT LAW AND MAY NOT BE RESOLD OR REDISTRIBUTED. USAGE IS BOUND TO THE PSPDFKIT LICENSE AGREEMENT. UNAUTHORIZED REPRODUCTION OR DISTRIBUTION IS SUBJECT TO CIVIL AND CRIMINAL PENALTIES. This notice may not be removed from this file.
Classes
- Action
- Base class for all annotation actions
- AnalyticsEventsCallback
- Annotation
- Base class for all Nutrient annotations
- AnnotationAttachment
- Represents an attachment for an annotation
- AnnotationCollection
- Helper class to handle collections of annotations
- AnnotationColors
- Predefined colors for annotations
- AnnotationConfiguration
- Copyright © 2019-2025 PSPDFKit GmbH. All rights reserved.
- AnnotationToolsGroup
- ButtonFormField
- CaretAnnotation
- Caret annotation
- CheckBoxFormField
- CircleAnnotation
- Circle annotation
- ComboBoxFormField
- DocumentSaveOptions
- EmbeddedFile
- Represents an embedded file that can be attached to a FileAnnotation
- FileAnnotation
- File attachment annotation
- FormFieldData
- FreeTextAnnotation
- Free text annotation
- FreeTextAnnotationConfiguration
- Annotation configuration class for FreeText annotation. FreeText annotations include: FreeText and FreeTextCallOut.
- GoToAction
- Action to navigate to a specific page and position
- HighlightAnnotation
- Represents a highlight annotation in PSPDFKit
- ImageAnnotation
- Image annotation
- InkAnnotation
- Represents an ink annotation in PSPDFKit
- InkAnnotationConfiguration
- Annotation configuration class for ink annotation. Ink annotations include: InkPen, MagicInk, Highlighter, Eraser and Signature.
- InkLines
- Represents the lines data in an ink annotation
- LineAnnotation
- Line annotation for drawing straight lines on a page
- LineAnnotationConfiguration
- Annotation configuration class for line annotation. Line annotations include: Line, Arrow, PolyLine and Distance Measurement.
- LineCaps
- Line caps for line annotations
- LineEnd
- LinkAnnotation
- Link annotation
- ListBoxFormField
- MarkupAnnotationConfiguration
- Annotation configuration class for TextMarkup annotation. TextMarkup annotations include: Highlight, Underline, StrikeOut and Squiggly.
- MeasurementScale
- The scale of the document. The scale is used to convert between real world measurements and points. The default scale is 1 inch = 1 inch.
- MeasurementValueConfiguration
- NewPage
- Copyright © 2018-2025 PSPDFKit GmbH. All rights reserved.
- NoteAnnotation
- Represents a note annotation in PSPDFKit
- NoteAnnotationConfiguration
- Annotation configuration class for Note annotation.
- NutrientEventsCallbacks
- PageInfo
- PagePattern
- Copyright © 2018-2025 PSPDFKit GmbH. All rights reserved.
- PagePosition
- Copyright © 2018-2025 PSPDFKit GmbH. All rights reserved.
- PageSize
- Copyright © 2018-2025 PSPDFKit GmbH. All rights reserved.
- PageZOrder
- Copyright © 2018-2025 PSPDFKit GmbH. All rights reserved.
- PdfConfiguration
- A class representing the configuration options for a PDF document.
- PdfDocument
- PdfDocumentApi
- PdfFormField
- PdfFormOption
- PdfImagePage
- Copyright © 2018-2025 PSPDFKit GmbH. All rights reserved.
- PdfPage
- Copyright © 2018-2025 PSPDFKit GmbH. All rights reserved.
- PdfRect
- PdfTextFormField
- PdfWebConfiguration
- This is the Configuration class for flutter web. It is used to group the configuration options for Flutter web.
- PointF
- PolygonAnnotation
- Polygon annotation
- PolylineAnnotation
- Polyline annotation
- PopupAnnotation
- Popup annotation
- Pspdfkit
- PSPDFKit plugin to load PDF and image documents on both platform iOS and Android.
- PspdfkitAnnotationToolbarItemsCallbackOptions
- PspdfkitApi
- The API for interacting with a PDF document.
- PspdfkitFlutterApiCallbacks
- PspdfkitProcessor
- This class is used to generate PDF documents from HTML,templates, patterns and images.
- PspdfkitWebAnnotationToolbarItem
- PspdfkitWebToolbarItem
- Represents a toolbar item in the PSPDFKit Web toolbar. See PSPDFKit.ToolbarItem
- PspdfkitWidget
- PspdfkitWidgetCallbacks
- PspdfkitWidgetController
- A controller for a PSPDFKit widget.
- PspdfkitWidgetControllerApi
- RadioButtonFormField
- RedactionAnnotation
- Redaction annotation
- ReductionAnnotationConfigurations
- Annotation configuration class for Redaction annotation.
- RichMediaAnnotation
- Rich media annotation
- ScreenAnnotation
- Screen annotation
- ShapeAnnotation
- Shape annotation base class for square, circle, and polygon annotations
- ShapeAnnotationConfiguration
- Annotation configuration class for ShapeAnnotations annotation. Shape annotations include: Square, Circle, Polygon and Area Measurement.
- SignatureFormField
- SoundAnnotation
- Sound annotation
- SquareAnnotation
- Square annotation
- SquigglyAnnotation
- Squiggly annotation
- StampAnnotation
- Stamp annotation
- StampAnnotationConfiguration
- Annotation configuration class for Stamp annotation. Stamp annotations include: Stamp and Image Annotation.
- StrikeoutAnnotation
- Strikeout annotation
- SubmitFormAction
- Action to submit form data to a URL
- TextContent
- Text content for annotations
- TextMarkupAnnotation
- Base class for text markup annotations (highlight, underline, strikeout, squiggly)
- Type3DAnnotation
- 3D annotation
- UnderlineAnnotation
- Underline annotation
- UriAction
- Action to open a URL in a web browser
- WatermarkAnnotation
- Watermark annotation
- WidgetAnnotation
- Widget annotation (form fields)
Enums
- AndroidPermissionStatus
- AnnotationConfigurationProperty
- Annotation configuration property enum. Used to configure annotation presets.
- AnnotationFlag
- Flags that control the behavior and appearance of annotations. See the PDF Reference for details.
- AnnotationProcessingMode
- AnnotationTool
- AnnotationToolbarItem
- Copyright © 2024-2025 PSPDFKit GmbH. All rights reserved.
- AnnotationToolVariant
- AnnotationType
- Represents the native annotation type.
- BlendMode
- Blend mode for annotations
- BorderEffect
- BorderStyle
- Represents the border style for annotations.
- DocumentPermissions
- FileIconName
- HorizontalTextAlignment
- Text alignment options for free text annotations
- LineCapType
- Line cap type for line annotations
- LineEndingStyle
- Line ending style enum. Used to configure line ending style for line annotation.
- MeasurementPrecision
- Copyright © 2023-2025 PSPDFKit GmbH. All rights reserved.
- NoteIcon
- Note icon types
- NutrientEvent
- PdfFormFieldTypes
- PdfVersion
- The PDF version of a document.
- PspdfkitAppearanceMode
- An enum representing the appearance mode options for PSPDFKit.
- PspdfkitAutoSaveMode
- PspdfkitPageLayoutMode
- Enum representing the different page layout modes in PSPDFKit.
- PspdfkitPageTransition
- Enum representing the available page transition modes in PSPDFKit.
- PspdfkitScrollDirection
- Copyright © 2023-2025 PSPDFKit GmbH. All rights reserved.
- PspdfkitSidebarMode
- Enum representing the different sidebar modes available in PSPDFKit.
- PspdfkitSpreadFitting
- An enum representing the different types of spread fitting modes in PSPDFKit.
- PspdfkitThumbnailBarMode
- Enum representing the different modes for the thumbnail bar in PSPDFKit. This is only available on iOS and Android.
- PspdfkitToolbarMenuItems
- Enum representing the available menu items for the PSPDFKit toolbar.
- PspdfKitToolbarPlacement
- An enum to represent the placement of the PSPDFKit toolbar.
- PspdfkitUserInterfaceViewMode
- Enum representing the different user interface view modes for PSPDFKit.
- PspdfkitWebAnnotationToolbarItemType
- Copyright © 2024-2025 PSPDFKit GmbH. All rights reserved.
- PspdfkitWebInteractionMode
- Defines the available interaction modes for the PSPDFKit Flutter plugin on the web platform.
- PspdfkitWebToolbarItemType
- Copyright © 2024-2025 PSPDFKit GmbH. All rights reserved.
- PspdfkitZoomMode
- Enum representing the different zoom modes available in PSPDFKit.
- ShowSignatureValidationStatusMode
- An enum that represents the mode for showing signature validation status.
- StampType
- TextAlignment
- Represents the text alignment for free text annotations.
- TextFormat
- Text format for annotations
- ToolbarItems
- Copyright © 2024-2025 PSPDFKit GmbH. All rights reserved.
- UnitFrom
- Copyright © 2023-2025 PSPDFKit GmbH. All rights reserved.
- UnitTo
- VerticalAlignment
- Vertical alignment options for free text annotations
Mixins
- HasAttachment
- Mixin for annotations that can have attachments
Extensions
- AnnotationExtensions on Annotation
-
Extension methods for annotation classes providing
copyWithfunctionality - AnnotationFlagExtension on AnnotationFlag
- Extension on AnnotationFlag to convert between enum values and strings.
- AnnotationToolWebExtension on AnnotationTool
- Extension on AnnotationTool to provide web-specific name conversions
- AnnotationTypeExtension on AnnotationType
- Extension on AnnotationType to provide additional functionality
- CaretAnnotationExtensions on CaretAnnotation
- Extension methods for CaretAnnotation
- CircleAnnotationExtensions on CircleAnnotation
- Extension methods for CircleAnnotation
- ColorExtension on Color
- ColorToHex on Color?
- Extension to convert Color to hex string
- FileAnnotationExtensions on FileAnnotation
- Extension methods for FileAnnotation
- FileIconNameExtension on FileIconName
- FreeTextAnnotationExtensions on FreeTextAnnotation
- Extension methods for FreeTextAnnotation
- HexToColor on String
- Extension to convert hex string to Color
- HighlightAnnotationExtensions on HighlightAnnotation
- Extension methods for HighlightAnnotation
- InkAnnotationExtensions on InkAnnotation
- Extension methods for InkAnnotation
- LineAnnotationExtensions on LineAnnotation
- Extension methods for LineAnnotation
- LinkAnnotationExtensions on LinkAnnotation
- Extension methods for LinkAnnotation
- MeasurementPrecisionExtension on MeasurementPrecision
- NoteAnnotationExtensions on NoteAnnotation
- Extension methods for NoteAnnotation
- NoteIconExtension on NoteIcon
- PolygonAnnotationExtensions on PolygonAnnotation
- Extension methods for PolygonAnnotation
- PolylineAnnotationExtensions on PolylineAnnotation
- Extension methods for PolylineAnnotation
- PopupAnnotationExtensions on PopupAnnotation
- Extension methods for PopupAnnotation
- RedactionAnnotationExtensions on RedactionAnnotation
- Extension methods for RedactionAnnotation
- RichMediaAnnotationExtensions on RichMediaAnnotation
- Extension methods for RichMediaAnnotation
- ScreenAnnotationExtensions on ScreenAnnotation
- Extension methods for ScreenAnnotation
- SoundAnnotationExtensions on SoundAnnotation
- Extension methods for SoundAnnotation
- SquareAnnotationExtensions on SquareAnnotation
- Extension methods for SquareAnnotation
- SquigglyAnnotationExtensions on SquigglyAnnotation
- Extension methods for SquigglyAnnotation
- StampAnnotationExtensions on StampAnnotation
- Extension methods for StampAnnotation
- StampTypeExtension on StampType
- StrikeoutAnnotationExtensions on StrikeoutAnnotation
- Extension methods for StrikeoutAnnotation
- Type3DAnnotationExtensions on Type3DAnnotation
- Extension methods for Type3DAnnotation
- UnderlineAnnotationExtensions on UnderlineAnnotation
- Extension methods for UnderlineAnnotation
- UnitFromExtension on UnitFrom
- UnitToExtension on UnitTo
- WatermarkAnnotationExtensions on WatermarkAnnotation
- Extension methods for WatermarkAnnotation
- WebAnnotationToolbarTypeX on PspdfkitWebAnnotationToolbarItemType
- WebAppearanceMode on PspdfkitAppearanceMode
- WebAutoSaveMode on PspdfkitAutoSaveMode
- WebPageLayoutMode on PspdfkitPageLayoutMode
- WebPageTransition on PspdfkitPageTransition
- WebShowSignatureValidationStatusMode on ShowSignatureValidationStatusMode
- WebSidebarMode on PspdfkitSidebarMode
- WebToolbarItemTypeX on PspdfkitWebToolbarItemType
- WebToolbarPlacement on PspdfKitToolbarPlacement
- WebWebInteractionMode on PspdfkitWebInteractionMode
- WebZoomMode on PspdfkitZoomMode
- WidgetAnnotationExtensions on WidgetAnnotation
- Extension methods for WidgetAnnotation
Constants
- androidConvertorBaseUrl → const String
- androidConvertorIsJavascriptEnabled → const String
- androidDarkThemeResource → const String
- androidDefaultThemeResource → const String
- androidEnableBookmarkList → const String
- androidEnableDocumentEditor → const String
- androidGrayScale → const String
- androidImmersiveMode → const String
- androidSettingsMenuItems → const String
- androidShowAnnotationListAction → const String
- androidShowBookmarksAction → const String
- androidShowDocumentInfoView → const String
- androidShowOutlineAction → const String
- androidShowPrintAction → const String
- androidShowSearchAction → const String
- androidShowThumbnailGridAction → const String
- appearanceMode → const String
- appearanceModeDefault → const String
- appearanceModeNight → const String
- appearanceModeSepia → const String
- convertorDocumentTitle → const String
- Copyright © 2018-2025 PSPDFKit GmbH. All rights reserved.
- disableAutosave → const String
- documentLabelEnabled → const String
- enableAnnotationEditing → const String
- Annotation, Forms and Bookmark Options
- enableInstantComments → const String
- enableMeasurementMagnifier → const String
- enableMeasurementTools → const String
- enableMeasurementToolSnapping → const String
- enableTextSelection → const String
- firstPageAlwaysSingle → const String
- fitPageToWidth → const String
- grayScale → const String
- horizontal → const String
- Deprecated Strings
- immersiveMode → const String
- inlineSearch → const String
- User Interface Options
- invertColors → const String
- iOSAllowToolbarTitleChange → const String
- iosConvertorPageNumber → const String
- iOSLeftBarButtonItems → const String
- iOSRightBarButtonItems → const String
- iOSSettingsMenuItems → const String
- isFirstPageAlwaysSingle → const String
- measurementUnit → const String
- pageLayoutMode → const String
- pageLayoutModeAutomatic → const String
- pageLayoutModeDouble → const String
- pageLayoutModeSingle → const String
- pageMode → const String
- Document Presentation Options
- pageScrollContinuous → const String
- pageScrollDirection → const String
- Deprecated Options - These options will be removed in a future release. Please use the suggested alternatives instead.
- pageScrollDirectionHorizontal → const String
- pageScrollDirectionVertical → const String
- pageTransition → const String
- password → const String
- pdfGenerationConfigurationHeight → const String
- pdfGenerationConfigurationImagePath → const String
- pdfGenerationConfigurationName → const String
- pdfGenerationConfigurationOverride → const String
- pdfGenerationConfigurationWidth → const String
- scrollContinuous → const String
- scrollDirection → const String
- Copyright © 2018-2025 PSPDFKit GmbH. All rights reserved.
- scrollPerSpread → const String
- settingsMenuItems → const String
- showDocumentInfoView → const String
- showDocumentLabel → const String
- showPageLabels → const String
- showPageNumberOverlay → const String
- showThumbnailBar → const String
- Thumbnail Options
- showThumbnailBarFloating → const String
- showThumbnailBarNone → const String
- showThumbnailBarPinned → const String
- showThumbnailBarScrollable → const String
- spreadFitting → const String
- startPage → const String
- toolbarTitle → const String
- userInterfaceViewMode → const String
- userInterfaceViewModeAlwaysHidden → const String
- userInterfaceViewModeAlwaysVisible → const String
- userInterfaceViewModeAutomatic → const String
- userInterfaceViewModeAutomaticBorderPages → const String
- vertical → const String
Functions
-
annotationTypeFromString(
String annotationString) → AnnotationType -
wrapResponse(
{Object? result, PlatformException? error, bool empty = false}) → List< Object?>
Typedefs
- PageChangedCallback = void Function(int pageIndex)
- PageClickedCallback = void Function(String documentId, int pageIndex, PointF? point, dynamic annotation)
- PdfDocumentLoadedCallback = void Function(PdfDocument document)
- PdfDocumentLoadFailedCallback = void Function(String error)
- PdfDocumentSavedCallback = void Function(String documentId, String? path)
-
PspdfkitWebAnnotationToolbarItemsCallback
= List<
PspdfkitWebAnnotationToolbarItem> Function(Map<String, dynamic> annotation, PspdfkitAnnotationToolbarItemsCallbackOptions options) - PspdfkitWidgetCreatedCallback = void Function(PspdfkitWidgetController view)
Exceptions / Errors
- MissingPlatformDirectoryException
- An exception thrown when a directory that should always be available on the current platform cannot be obtained.