Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Constructors

constructor

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 internalNavigation

internalNavigation: boolean

If the locator points to a ReaderDocument in the ReaderView.

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 locator

locator: Locator

The locator for the navigation.

Readonly propagationStopped

propagationStopped: boolean

True if stopPropagation() was called on this event.

Readonly readerDocument

readerDocument: IReaderDocument

The target ReaderDocument to navigate to. This field is only set if the locator points to a ReaderDocument within a ReaderPublication loaded in the ReadingSystemEngine.

Readonly readerView

readerView: IReaderView

The ReaderView instance this event is related to.

Readonly relatedEvent

relatedEvent: IMouseEngineEvent

The MouseEngineEvent that triggered this navigation intent if available.

Readonly sourceReaderDocument

sourceReaderDocument: IReaderDocument

The source ReaderDocument where the event was triggered. This field is only set if the locator points to a ReaderDocument within a ReaderPublication loaded in the ReadingSystemEngine.

Readonly type

The type of event.

Methods

preventDefault

  • preventDefault(): void

stopImmediatePropagation

  • stopImmediatePropagation(): void

stopPropagation

  • stopPropagation(): void

toJSON

Generated using TypeDoc