Options
All
  • Public
  • Public/Protected
  • All
Menu

Event used when a scroll action has ended in a scrolling renderer such as the SingleDocumentScrollRenderer.

Hierarchy

Index

Properties

Readonly cancelable

cancelable: boolean

If this event's default action is cancelable. See respective engine event for its definition of default action.

Readonly defaultPrevented

defaultPrevented: boolean

If this event's default action has been canceled/prevented by a call to preventDefault()

Readonly immediatePropagationStopped

immediatePropagationStopped: boolean

True if stopImmediatePropagation() was called on this event.

Readonly isTrusted

isTrusted: boolean

If this event runs in a "trusted" context, i.e. the event callback is executed during a user-generated event such as "click" or "pointerdown".

Readonly propagationStopped

propagationStopped: boolean

True if stopPropagation() was called on this event.

Readonly readerView

readerView: IReaderView

The ReaderView instance this event is related to.

Readonly scrollDistance

scrollDistance: number

If it's a userGenerated scroll event, describes how far the user has scrolled.

Readonly scrollTop

scrollTop: number

The number of pixels that a renderer's content is scrolled vertically.

Readonly type

The type of event.

Readonly userGenerated

userGenerated: boolean

If the event was triggered by a user scrolling the renderer element.

Methods

preventDefault

  • preventDefault(): void

stopImmediatePropagation

  • stopImmediatePropagation(): void

stopPropagation

  • stopPropagation(): void
  • Stops this event from propagating to listeners on the ReadingSystemEngine instance, if called from a listener added to a ReaderView instance. If the event has already propagated to the ReadingSystemEngine instance, calling this method has no effect.

    Returns void

toJSON

Generated using TypeDoc