The annotation this event is related to.
If this event's default action is cancelable. See respective engine event for its definition of default action.
The X coordinate of the mouse pointer in local (DOM content) coordinates.
The Y coordinate of the mouse pointer in local (DOM content) coordinates.
Returns true if the control key was down when the mouse event was fired.
If this event's default action has been canceled/prevented by a call to preventDefault()
True if stopImmediatePropagation() was called on this event.
Indicates whether or not the pointer device that created the event is the primary pointer. For more information, see: https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/isPrimary
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".
Returns true if the meta key was down when the mouse event was fired.
The X coordinate of the mouse pointer relative to the whole document.
The Y coordinate of the mouse pointer relative to the whole document.
An identifier assigned to a given pointer event. The identifier is unique, being different from the identifiers of all other active pointer events.
Indicates the device type (mouse, pen, or touch) that caused a given pointer event.
True if stopPropagation() was called on this event.
Describes how the reader document acted on the event.
The ReaderView instance this event is related to.
The client X coordinate relative to the window width. Typically a number between 0 and 1.
The client Y coordinate relative to the window height. Typically a number between 0 and 1.
The global screen X coordinate relative to the screen width. Typically a number between 0 and 1.
The global screen Y coordinate relative to the screen height. Typically a number between 0 and 1.
The X coordinate of the mouse pointer in global (screen) coordinates.
The Y coordinate of the mouse pointer in global (screen) coordinates.
The type of event.
If the event was emitted due to a user generated event.
Note that if this value is true, the engine event listener might still be called in an untrusted execution context due to proxying through iframes, etc. Use isTrusted() to verify if the current execution context is trusted.
If true, a native DOM event with the same type as this engine event will also be fired in your app.
If you are also listening on the corresponding DOM event, use this value to ensure that you are not handling the same event twice.
For example, when performing a "click" inside an EPUB reader document, the DOM "click" event will not be visible to your app because the document is rendered in an iframe. However, a click on the edge of an EPUB reader document will generate a normal DOM "click" event AND also a Colibrio "click" engine 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 for "annotationPointerEnter" and "annotationPointerLeave" Fires when a "pointerenter" or "pointerleave" events occurs on a ReaderViewAnnotation