PdfViewerParams class

Annotations

Constructors

PdfViewerParams({int? pageNumber, double? padding, LayoutPagesFunc? layoutPages, BuildPageContentFunc? buildPagePlaceholder, BuildPageContentFunc? buildPageOverlay, BoxDecoration? pageDecoration, Axis scrollDirection = Axis.vertical, PanAxis panAxis = PanAxis.free, bool alignPanAxis = false, EdgeInsets boundaryMargin = EdgeInsets.zero, double maxScale = 20, double minScale = 0.1, bool allowAntialiasingIOS = true, GestureScaleEndCallback? onInteractionEnd, GestureScaleStartCallback? onInteractionStart, GestureScaleUpdateCallback? onInteractionUpdate, bool panEnabled = true, bool scaleEnabled = true, OnPdfViewerControllerInitialized? onViewerControllerInitialized, double? scrollByMouseWheel = 0.1, double interactionEndFrictionCoefficient = 0.0000135, OnClickOutsidePageViewer? onClickOutSidePageViewer})
Initializes the parameters.
const

Properties

alignPanAxis → bool
See InteractiveViewer for more info.
final
allowAntialiasingIOS → bool
Whether to allow use of antialiasing on iOS Quartz PDF rendering.
final
boundaryMargin → EdgeInsets
See InteractiveViewer for more info.
final
buildPageOverlay → BuildPageContentFunc?
Custom overlay that is shown on page.
final
buildPagePlaceholder → BuildPageContentFunc?
Custom page placeholder that is shown until the page is fully loaded.
final
hashCode → int
The hash code for this object.
no setteroverride
interactionEndFrictionCoefficient → double
Changes the deceleration behavior after a gesture.
final
layoutPages → LayoutPagesFunc?
Custom page layout logic if you need it.
final
maxScale → double
See InteractiveViewer for more info.
final
minScale → double
See InteractiveViewer for more info.
final
onClickOutSidePageViewer → OnClickOutsidePageViewer?
Listen event click outside page document viewer
final
onInteractionEnd → GestureScaleEndCallback?
See InteractiveViewer for more info.
final
onInteractionStart → GestureScaleStartCallback?
See InteractiveViewer for more info.
final
onInteractionUpdate → GestureScaleUpdateCallback?
See InteractiveViewer for more info.
final
onViewerControllerInitialized → OnPdfViewerControllerInitialized?
Callback that is called on viewer initialization.
final
padding → double?
Padding for the every page.
final
pageDecoration → BoxDecoration?
Custom page decoration such as drop-shadow.
final
pageNumber → int?
Page number to show on the first time.
final
panAxis → PanAxis
final
panEnabled → bool
See InteractiveViewer for more info.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scaleEnabled → bool
See InteractiveViewer for more info.
final
scrollByMouseWheel → double?
Set the scroll amount ratio by mouse wheel. The default is 0.1.
final
scrollDirection → Axis
Scrolling direction.
final

Methods

copyWith({int? pageNumber, double? padding, LayoutPagesFunc? layoutPages, BuildPageContentFunc? buildPagePlaceholder, BuildPageContentFunc? buildPageOverlay, BoxDecoration? pageDecoration, Axis? scrollDirection, PanAxis? panAxis, bool? alignPanAxis, EdgeInsets? boundaryMargin, bool? panEnabled, bool? scaleEnabled, double? maxScale, double? minScale, GestureScaleEndCallback? onInteractionEnd, GestureScaleStartCallback? onInteractionStart, GestureScaleUpdateCallback? onInteractionUpdate, OnPdfViewerControllerInitialized? onViewerControllerInitialized, double? scrollByMouseWheel, OnClickOutsidePageViewer? onClickOutSidePageViewer}) → PdfViewerParams
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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