CPDFPageThumbnailOptions class

Controls how PDF page thumbnails are rendered and cached.

Constructors

CPDFPageThumbnailOptions({int? width, int? height, double scale = 1.0, Color backgroundColor = Colors.white, bool drawAnnot = true, bool drawForm = true, CPDFPageCompression compression = CPDFPageCompression.png, int jpegQuality = 85, CPDFPageThumbnailCachePolicy cachePolicy = CPDFPageThumbnailCachePolicy.memoryAndDisk, Duration? diskCacheTtl, bool preserveAspectRatio = true, int maxPixelCount = 4096 * 4096})
Creates thumbnail options.
const

Properties

backgroundColor Color
Background color used by the native page renderer.
final
cachePolicy CPDFPageThumbnailCachePolicy
Cache behavior.
final
compression CPDFPageCompression
Encoded image format.
final
diskCacheTtl Duration?
Optional disk cache time to live.
final
drawAnnot bool
Whether annotations are included in the thumbnail.
final
drawForm bool
Whether form widgets are included in the thumbnail.
final
hashCode int
The hash code for this object.
no setterinherited
height int?
Target thumbnail height in pixels.
final
jpegQuality int
JPEG quality. PNG ignores this value.
final
maxPixelCount int
Maximum number of pixels allowed for one rendered thumbnail.
final
preserveAspectRatio bool
Whether a missing dimension is calculated from the page aspect ratio.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scale double
Scale used when width and height are not specified.
final
width int?
Target thumbnail width in pixels.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
resolveSize(Size pageSize) CPDFPageThumbnailSize
Resolves the target render size for a page.
toString() String
A string representation of this object.
inherited
validate() → void
Validates option values before rendering.

Operators

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