PageLayoutMode enum

Page layout mode — single page, double-page spread, or automatic.

Controls how many pages are shown side-by-side in the viewport.

Platform availability:

  • Android: supported via PdfActivityConfiguration$Builder.layoutMode.
  • iOS: supported via PSPDFConfigurationBuilder.pageMode.
  • Web: supported via the pageLayout load option. Use PageLayoutModeWebName.webName to convert a value to the Web SDK string ('SINGLE', 'DOUBLE', 'AUTOMATIC').
Inheritance
Available extensions

Values

single → const PageLayoutMode

Display one page at a time.

double → const PageLayoutMode

Display two pages side-by-side (book/magazine spread view).

automatic → const PageLayoutMode

Let the SDK decide based on screen width and orientation.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
webName → String?

Available on PageLayoutMode, provided by the PageLayoutModeWebName extension

Returns the Web SDK pageLayout string for this layout mode.
no setter

Methods

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.
inherited

Constants

values → const List<PageLayoutMode>
A constant List of the values in this enum, in order of their declaration.