PdfViewer class

A widget to display PDF document.

To create a PdfViewer widget, use one of the following constructors:

Or otherwise, you can pass PdfDocumentRef to PdfViewer constructor.

Inheritance

Constructors

PdfViewer(PdfDocumentRef documentRef, {Key? key, PdfViewerController? controller, PdfViewerParams params = const PdfViewerParams(), int initialPageNumber = 1})
Create PdfViewer from a PdfDocumentRef.
const
PdfViewer.asset(String assetName, {PdfPasswordProvider? passwordProvider, bool firstAttemptByEmptyPassword = true, Key? key, PdfViewerController? controller, PdfViewerParams params = const PdfViewerParams(), int initialPageNumber = 1})
Create PdfViewer from an asset.
PdfViewer.custom({required int fileSize, required FutureOr<int> read(Uint8List buffer, int position, int size), required String sourceName, PdfPasswordProvider? passwordProvider, bool firstAttemptByEmptyPassword = true, Key? key, PdfViewerController? controller, PdfViewerParams params = const PdfViewerParams(), int initialPageNumber = 1})
Create PdfViewer from a custom source.
PdfViewer.data(Uint8List data, {required String sourceName, PdfPasswordProvider? passwordProvider, bool firstAttemptByEmptyPassword = true, Key? key, PdfViewerController? controller, PdfViewerParams params = const PdfViewerParams(), int initialPageNumber = 1})
Create PdfViewer from a byte data.
PdfViewer.file(String path, {PdfPasswordProvider? passwordProvider, bool firstAttemptByEmptyPassword = true, Key? key, PdfViewerController? controller, PdfViewerParams params = const PdfViewerParams(), int initialPageNumber = 1})
Create PdfViewer from a file.
PdfViewer.uri(Uri uri, {PdfPasswordProvider? passwordProvider, bool firstAttemptByEmptyPassword = true, Key? key, PdfViewerController? controller, PdfViewerParams params = const PdfViewerParams(), int initialPageNumber = 1, bool preferRangeAccess = false, Map<String, String>? headers})
Create PdfViewer from a URI.

Properties

controller → PdfViewerController?
Controller to control the viewer.
final
documentRef → PdfDocumentRef
PdfDocumentRef that represents the PDF document.
final
hashCode → int
The hash code for this object.
no setterinherited
initialPageNumber → int
Page number to show initially.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
params → PdfViewerParams
Parameters to customize the display of the PDF document.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<PdfViewer>
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