If this event's default action is cancelable. See respective engine event for its definition of default action.
If this event's default action has been canceled/prevented by a call to preventDefault()
True if stopImmediatePropagation() was called on this event.
If the locator points to a ReaderDocument in the ReaderView.
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".
The locator for the navigation.
True if stopPropagation() was called on this event.
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.
The ReaderView instance this event is related to.
The MouseEngineEvent that triggered this navigation intent if available.
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.
The type of event.
Prevent the event's default action. See the respective engine event for its definition of default action.
Stops this event from propagating to anymore listener.
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.
Get this event as a plain JSON object.
Generated using TypeDoc
EngineEvent used with the "navigationIntent" event type. Fired when a "navigation intent" occurs that was NOT initiated by a call to ReaderView.next(), ReaderView.previous(), ReaderView.goToStart() or ReaderView.goTo().
Some examples are:
The default action by the reading system is to navigate to the intended locator, but only if the locator points to a ReaderDocument assigned to the ReaderView. Otherwise, nothing is done.
To prevent the default behaviour, call preventDefault().