Options
All
  • Public
  • Public/Protected
  • All
Menu

Used by Scroll Renderers to notify the ReaderView of scroll events.

Hierarchy

  • IRendererScrollResult

Index

Properties

scrollDistance

scrollDistance: number

The distance (in CSS pixels) that was scrolled. Can be negative or positive.

scrollTop

scrollTop: number

The scrollTop of the renderer Element.

userGenerated

userGenerated: boolean

true if the latest scroll action was triggered by user input. false if the scroll was triggered internally by the renderer.

In some cases where many scroll events happen in a short amount of time, multiple scroll actions will be merged into a single scroll result. Example: If the renderer started scrolling because of a navigation, but then the user manually scrolled immediately after, the boolean will be true.

Generated using TypeDoc