PdfView class

Widget for viewing PDF documents

Inheritance

Constructors

PdfView({required PdfController controller, void onPageChanged(int page)?, void onDocumentLoaded(PdfDocument document)?, void onDocumentError(Object error)?, Widget? documentLoader, Widget? pageLoader, PDFViewPageBuilder pageBuilder = _pageBuilder, Widget errorBuilder(Exception error)?, PDFViewPageRenderer renderer = _render, Axis scrollDirection = Axis.horizontal, bool pageSnapping = true, ScrollPhysics? physics, BoxDecoration? backgroundDecoration = const BoxDecoration(), Duration loaderSwitchDuration = const Duration(seconds: 1), Key? key})
const

Properties

backgroundDecoration → BoxDecoration?
Pdf widget page background decoration
final
controller → PdfController
Page management
final
documentLoader → Widget?
Widget showing when pdf document loading
final
errorBuilder → (Widget Function(Exception error)?)
Show document loading error message inside PdfView
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
loaderSwitchDuration → Duration
final
onDocumentError → (void Function(Object error)?)
Called when a document loading error
final
onDocumentLoaded → (void Function(PdfDocument document)?)
Called when a document is loaded
final
onPageChanged → (void Function(int page)?)
Called whenever the page in the center of the viewport changes
final
pageBuilder → PDFViewPageBuilder
Page builder
final
pageLoader → Widget?
Widget showing when pdf page loading
final
pageSnapping → bool
Set to false to disable page snapping, useful for custom scroll behavior.
final
physics → ScrollPhysics?
Determines the physics of a PdfView widget.
final
renderer → PDFViewPageRenderer
Custom PdfRenderer options
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollDirection → Axis
Page turning direction
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