IPointerEngineEventDef | Colibrio Reader Framework API

Hierarchy

IMouseEngineEventDef
- IPointerEngineEventDef

Index

Properties

buttons

buttons: number

A number representing which buttons that are pressed on the mouse when a mouse event is triggered. Simultaneous buttons gives a combined value.

0: No button or un-initialized
1: Primary button (usually the left button)
2: Secondary button (usually the right button)
4: Auxiliary button (usually the mouse wheel button or middle button)
8: 4th button (typically the "Browser Back" button)
16 : 5th button (typically the "Browser Forward" button)

Optional cancelable

cancelable?: boolean

clientX

clientX: number

The X coordinate of the mouse pointer in local (DOM content) coordinates.

clientY

clientY: number

The Y coordinate of the mouse pointer in local (DOM content) coordinates.

ctrlKey

ctrlKey: boolean

Returns true if the control key was down when the mouse event was fired.

isPrimary

isPrimary: boolean

Optional isTrusted

isTrusted?: boolean

mediaResource

mediaResource: IEngineEventMediaResource

If the event was related to a media resource in the publication such as an image, audio or video resource. It contains additional information about the media resource and methods to access media content.

metaKey

metaKey: boolean

Returns true if the meta key was down when the mouse event was fired.

pageX

pageX: number

The X coordinate of the mouse pointer relative to the whole document.

pageY

pageY: number

The Y coordinate of the mouse pointer relative to the whole document.

pointerId

pointerId: number

pointerType

pointerType: string

readerDocumentEventState

readerDocumentEventState: ReaderDocumentEventState

Describes how the reader document acted on the event.

readerView

readerView: IReaderView

screenX

screenX: number

The X coordinate of the mouse pointer in global (screen) coordinates.

screenY

screenY: number

The Y coordinate of the mouse pointer in global (screen) coordinates.

target

target: IEngineEventTarget

Contains additional information about the original event target, such as the targeted node in the reader document.

userGenerated

userGenerated: boolean

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.