PDFView class

Inheritance

Constructors

PDFView({Key? key, String? filePath, Uint8List? pdfData, PDFViewCreatedCallback? onViewCreated, RenderCallback? onRender, PageChangedCallback? onPageChanged, ErrorCallback? onError, PageErrorCallback? onPageError, LinkHandlerCallback? onLinkHandler, Set<Factory<OneSequenceGestureRecognizer>>? gestureRecognizers, bool enableSwipe = true, bool swipeHorizontal = false, String? password, bool nightMode = false, bool autoSpacing = true, bool pageFling = true, bool pageSnap = true, bool fitEachPage = true, int defaultPage = 0, FitPolicy fitPolicy = FitPolicy.WIDTH, bool preventLinkNavigation = false})
const

Properties

autoSpacing → bool
Indicates whether or not the PDF viewer automatically adds spacing between pages. If set to true, spacing is added.
final
defaultPage → int
Represents the default page to display when the PDF document is loaded.
final
enableSwipe → bool
Indicates whether or not the user can swipe to change pages in the PDF document. If set to true, swiping is enabled.
final
filePath → String?
The initial URL to load.
final
fitEachPage → bool
fitEachPage
final
fitPolicy → FitPolicy
FitPolicy that determines how the PDF pages are fit to the screen. The FitPolicy enum can take on the following values:
final
gestureRecognizers → Set<Factory<OneSequenceGestureRecognizer>>?
Which gestures should be consumed by the pdf view.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
nightMode → bool
Indicates whether or not the PDF viewer is in night mode. If set to true, the viewer is in night mode
final
onError → ErrorCallback?
Invokes on error that handled on native code
final
onLinkHandler → LinkHandlerCallback?
Used with preventLinkNavigation=true. It's helpful to customize link navigation
final
onPageChanged → PageChangedCallback?
Return current page and page count as a parameter
final
onPageError → PageErrorCallback?
Invokes on page cannot be rendered or something happens
final
onRender → RenderCallback?
Return PDF page count as a parameter
final
onViewCreated → PDFViewCreatedCallback?
If not null invoked once the PDFView is created.
final
pageFling → bool
Indicates whether or not the user can "fling" pages in the PDF document. If set to true, page flinging is enabled.
final
pageSnap → bool
Indicates whether or not the viewer snaps to a page after the user has scrolled to it. If set to true, snapping is enabled.
final
password → String?
Represents the password for a password-protected PDF document. It can be nullable
final
pdfData → Uint8List?
The binary data of a PDF document
final
preventLinkNavigation → bool
Indicates whether or not clicking on links in the PDF document will open the link in a new page. If set to true, link navigation is prevented.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
swipeHorizontal → bool
Indicates whether or not the user can swipe horizontally to change pages in the PDF document. If set to true, horizontal swiping is enabled.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → _PDFViewState
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited