ScrollDirection enum

Copyright © 2018-2026 PSPDFKit GmbH. All rights reserved.

THIS SOURCE CODE AND ANY ACCOMPANYING DOCUMENTATION ARE PROTECTED BY INTERNATIONAL COPYRIGHT LAW AND MAY NOT BE RESOLD OR REDISTRIBUTED. USAGE IS BOUND TO THE PSPDFKIT LICENSE AGREEMENT. UNAUTHORIZED REPRODUCTION OR DISTRIBUTION IS SUBJECT TO CIVIL AND CRIMINAL PENALTIES. This notice may not be removed from this file.

Enums shared across Android, iOS, and Web that are used by NutrientViewConfiguration and its platform sub-configurations. The direction in which pages are scrolled.

Applies to both the horizontal swipe gesture and the continuous-scroll layout. Combine with PageTransition for precise control over how users move through the document.

Platform availability:

• Android: supported via PdfActivityConfiguration$Builder.scrollDirection.
• iOS: supported via PSPDFConfigurationBuilder.scrollDirection.
• Web: supported via initialViewState.scrollMode (HORIZONTAL / VERTICAL).

Inheritance

• Object
• Enum
• ScrollDirection

Available extensions

• EnumName

Values

horizontal → const ScrollDirection

Pages scroll left and right (the default for most readers).

vertical → const ScrollDirection

Pages scroll up and down, similar to a long web page.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

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 setter, inherited

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<ScrollDirection>

A constant List of the values in this enum, in order of their declaration.