pspdfkit library

Copyright © 2018-2024 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

AnnotationConfiguration
Annotation configuration class. Used to configure annotation presets.
AnnotationToolsGroup
ButtonFormField
CheckBoxFormField
ComboBoxFormField
DocumentSaveOptions
Options for saving/exporting a document.
FreeTextAnnotationConfiguration
Annotation configuration class for FreeText annotation. FreeText annotations include: FreeText and FreeTextCallOut.
InkAnnotationConfiguration
Annotation configuration class for ink annotation. Ink annotations include: InkPen, MagicInk, Highlighter, Eraser and Signature.
LineAnnotationConfiguration
Annotation configuration class for line annotation. Line annotations include: Line, Arrow, PolyLine and Distance Measurement.
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-2024 PSPDFKit GmbH. All rights reserved.
NoteAnnotationConfiguration
Annotation configuration class for Note annotation.
PagePattern
Copyright © 2018-2024 PSPDFKit GmbH. All rights reserved.
PagePosition
Copyright © 2018-2024 PSPDFKit GmbH. All rights reserved.
PageSize
Copyright © 2018-2024 PSPDFKit GmbH. All rights reserved.
PageZOrder
Copyright © 2018-2024 PSPDFKit GmbH. All rights reserved.
PdfConfiguration
A class representing the configuration options for a PDF document.
PdfDocument
PdfFormField
PdfFormOption
Copyright © 2024 PSPDFKit GmbH. All rights reserved.
PdfImagePage
Copyright © 2018-2024 PSPDFKit GmbH. All rights reserved.
PdfPage
Copyright © 2018-2024 PSPDFKit GmbH. All rights reserved.
PdfTextFormField
PdfWebConfiguration
This is the Configuration class for flutter web. It is used to group the configuration options for Flutter web.
Pspdfkit
PSPDFKit plugin to load PDF and image documents on both platform iOS and Android.
PspdfkitAnnotationToolbarItemsCallbackOptions
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
PspdfkitWidgetController
A controller for a PSPDFKit widget.
RadioButtonFormField
ReductionAnnotationConfigurations
Annotation configuration class for Redaction annotation.
ShapeAnnotationConfiguration
Annotation configuration class for ShapeAnnotations annotation. Shape annotations include: Square, Circle, Polygon and Area Measurement.
SignatureFormField
StampAnnotationConfiguration
Annotation configuration class for Stamp annotation. Stamp annotations include: Stamp and Image Annotation.

Enums

AndroidPermissionStatus
Permission status enumeration used only by Android platform.
AnnotationConfigurationProperty
Annotation configuration property enum. Used to configure annotation presets.
AnnotationTool
Available annotation tools.
AnnotationToolbarItem
AnnotationType
BlendMode
Annotation intent enum. Used to configure annotation BlendMode preset.
BorderEffect
Annotation BorderEffect enum. Used to configure annotation BorderEffect preset.
BorderStyle
Annotation BorderStyle enum. Used to configure annotation BorderStyle preset.
DocumentPermissions
Copyright © 2024 PSPDFKit GmbH. All rights reserved.
LineEndingStyle
Line ending style enum. Used to configure line ending style for line annotation.
MeasurementPrecision
Copyright © 2023-2024 PSPDFKit GmbH. All rights reserved.
PdfFormFieldTypes
Copyright © 2024 PSPDFKit GmbH. All rights reserved.
PdfVersion
Copyright © 2024 PSPDFKit GmbH. All rights reserved.
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 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 PSPDFKit GmbH. All rights reserved.
PspdfkitWebInteractionMode
Defines the available interaction modes for the PSPDFKit Flutter plugin on the web platform.
PspdfkitWebToolbarItemType
Copyright © 2024 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.
ToolbarItems
UnitFrom
Copyright © 2023-2024 PSPDFKit GmbH. All rights reserved.
UnitTo

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
androidShowShareAction → const String
androidShowThumbnailGridAction → const String
appearanceMode → const String
appearanceModeDefault → const String
appearanceModeNight → const String
appearanceModeSepia → const String
convertorDocumentTitle → const String
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
iOSShowActionNavigationButtonLabels → 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-2024 PSPDFKit GmbH. All rights reserved.
scrollPerSpread → const String
settingsMenuItems → const String
showActionNavigationButtons → 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

Exceptions / Errors

MissingPlatformDirectoryException
An exception thrown when a directory that should always be available on the current platform cannot be obtained.