PageTransition enum

The page transition animation used when changing pages.

Not all transitions are supported on every platform. Unsupported values silently fall back to the platform default.

Platform availability:

  • Android: maps to PdfActivityConfiguration$Builder.pageTransition.
  • iOS: maps to PSPDFConfigurationBuilder.pageTransition.
  • Web: a subset of values is mapped via PageTransitionWebName.webName. Only scrollContinuous, scrollPerSpread, and disabled produce distinct Web SDK values ('CONTINUOUS', 'PER_SPREAD', 'DISABLED'); all other values fall back to 'PER_SPREAD'.
Inheritance
Available extensions

Values

scrollContinuous → const PageTransition

Continuous scroll — pages flow together without a visible gap.

scrollPerSpread → const PageTransition

Scroll one spread at a time, snapping between page boundaries.

curl → const PageTransition

Curl animation that mimics turning a physical page (iOS only).

slideHorizontal → const PageTransition

Slide the new page in from the right/left.

slideVertical → const PageTransition

Slide the new page in from the top/bottom.

cover → const PageTransition

Cover animation — new page slides over the existing one.

fade → const PageTransition

Cross-fade between pages.

scrollContinuousPerPage → const PageTransition

Continuous scroll but advancing one page at a time.

auto → const PageTransition

Let the SDK choose the transition automatically.

disabled → const PageTransition

No animation — pages switch instantly.

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 PageTransition, provided by the PageTransitionWebName extension

Returns the Web SDK layoutMode string for this transition, or null when the transition is not expressible in the Web SDK.
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<PageTransition>
A constant List of the values in this enum, in order of their declaration.