PdfViewerParams class
- Annotations
Constructors
- PdfViewerParams.new({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, double scrollOffsetRatio = 1.0, double fullPurgeDistThreshold = 66, double partialRemovalDistThreshold = 30, int realSizeOverlayUpdateBufferDuration = 20, bool allowAntialiasingIOS = true, GestureScaleEndCallback? onInteractionEnd, GestureScaleStartCallback? onInteractionStart, GestureScaleUpdateCallback? onInteractionUpdate, bool panEnabled = true, bool scaleEnabled = true, OnPdfViewerControllerInitialized? onViewerControllerInitialized, double interactionEndFrictionCoefficient = 0.0000135})
-
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
- fullPurgeDistThreshold → double
-
Used to adjust page memory retention.
The higher the value, the worse for performance
Use with caution.
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
- 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
- partialRemovalDistThreshold → double
-
Used to adjust page memory retention.
The higher the value, the worse for performance
Use with caution.
final
- realSizeOverlayUpdateBufferDuration → int
-
On relayout, text can become pixelated.
Use this to adjust (Was 100ms by default, now 20ms)
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scaleEnabled → bool
-
See InteractiveViewer for more info.
final
- scrollDirection → Axis
-
Scrolling direction.
final
- scrollOffsetRatio → double
-
Used to adjust the scroll granularity.
Specifically, on Flutter Web there is some page loading jank that this
attempts to smooth out.
final
Methods
-
copyWith(
{int? pageNumber, double? padding, LayoutPagesFunc? layoutPages, BuildPageContentFunc? buildPagePlaceholder, BuildPageContentFunc? buildPageOverlay, BoxDecoration? pageDecoration, double? scrollOffsetRatio, Axis? scrollDirection, PanAxis? panAxis, bool? alignPanAxis, EdgeInsets? boundaryMargin, bool? panEnabled, bool? scaleEnabled, double? maxScale, double? minScale, GestureScaleEndCallback? onInteractionEnd, GestureScaleStartCallback? onInteractionStart, GestureScaleUpdateCallback? onInteractionUpdate, OnPdfViewerControllerInitialized? onViewerControllerInitialized}) → 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