Options
All
  • Public
  • Public/Protected
  • All
Menu

Event used for various changed to the state of a IPageProgressionTimeline.

pageProgressionTimelineRecalculated

This event is fired when a PageProgressionTimeline has been recalculated and can be retrieved from the ReaderView. This may happen due to a change of the ReaderView configuration such as window resizing and ReaderViewOptions changes.

pageProgressionTimelineVisibleRangeChanged

This event is fired when the visible range of a PageProgressionTimeline has changed. This happens when navigating the ReaderView.

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 pageProgressionTimeline

pageProgressionTimeline: IPageProgressionTimeline

The related PageProgressionTimeline instance.

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 type

The type of event.

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