PDFPreferences class

PDF reader preferences.

Submitting these replaces all PDF preferences: omitted fields fall back to the platform default, so always send the full set.

Implemented types

• JSONable

Annotations

• @immutable

Constructors

PDFPreferences({PDFLayout? layout, PDFReadingProgression? readingProgression, double? pageSpacing, PDFFit? fit, bool? offsetFirstPage, PDFSpread? spread, bool? visibleScrollbar})

const

PDFPreferences.fromJson(Map<String, dynamic> json)

factory

Properties

fit → PDFFit?

How pages should be fitted in the viewport.

final

hashCode → int

The hash code for this object.

no setter, inherited

layout → PDFLayout?

Page layout / scroll mode. Unifies the scroll + scrollAxis knobs of iOS PDFKit and Android Pdfium into one cross-platform setting. Defaults to PDFLayout.paginated on both platforms. See PDFLayout for the per-platform mapping.

final

offsetFirstPage → bool?

When true, the first page is displayed alone rather than paired in a two-up (spread) view. Useful when the cover page occupies page 1.

final

pageSpacing → double?

Spacing between pages.

final

props → List<Object?>

The list of properties that will be used to determine whether two instances are equal.

no setter

readingProgression → PDFReadingProgression?

Direction of the reading progression.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

spread → PDFSpread?

Whether the publication is rendered with a synthetic spread (dual-page view).

final

stringify → bool?

If set to true, the toString method will be overridden to output this instance's props.

no setter, inherited

visibleScrollbar → bool?

Whether the scroll indicator is visible while scrolling.

final

Methods

copyWith({Object? layout = unset, Object? readingProgression = unset, Object? pageSpacing = unset, Object? fit = unset, Object? offsetFirstPage = unset, Object? spread = unset, Object? visibleScrollbar = unset}) → PDFPreferences

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Serializes the object to its JSON representation.

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited