Options
All
  • Public
  • Public/Protected
  • All
Menu

EngineEvent used for "navigationStarted". Fired when a new navigation action has started, or replaces an existing ongoing navigation in a ReaderView.

Hierarchy

Index

Properties

cancelable: boolean

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

defaultPrevented: boolean

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

dueToRenderingConfigChanged: boolean

The navigation started due to a rendering configuration change such such as updated ReaderViewOptions or Renderer switch.

immediatePropagationStopped: boolean

True if stopImmediatePropagation() was called on this event.

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".

navigationAction: NavigationAction

The type of navigation action that started.

propagationStopped: boolean

True if stopPropagation() was called on this event.

readerView: IReaderView

The ReaderView instance this event is related to.

replacedOngoingNavigation: boolean

If this navigation replaced an already ongoing navigation action.

The type of event.

Methods

  • preventDefault(): void
  • stopImmediatePropagation(): void
  • 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

Generated using TypeDoc