Options
All
  • Public
  • Public/Protected
  • All
Menu

Engine event type used for "swipeNavigationGestureProgress" events.

colibrioexports

Hierarchy

Index

Properties

animationProgress

animationProgress: number

A value between [-1, 0] indicates an animation progress from the current page to the previous page. A value between [0, 1] indicating an animation progress from the current page to the next page.

The animationProgress may be different from the pointer movement. This is because the animation may use an easing curve to look more natural.

A value of zero means no swiping progress, i.e. showing current page/spread. A value of -1 means showing the previous page/spread. A value of 1 means showing the next page/spread.

double

cancelable

cancelable: boolean

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

nativeignore

defaultPrevented

defaultPrevented: boolean

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

nativeignore

deltaX

deltaX: number

The total X movement from the pointer start position in pixels.

A positive number means that the pointer is moving to the right. A negative number means that the pointer is moving to the left.

double

deltaY

deltaY: number

The total Y movement from the pointer start position in pixels.

double

immediatePropagationStopped

immediatePropagationStopped: boolean

True if stopImmediatePropagation() was called on this event.

nativeignore

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

nativeignore

objectType

The type of engine event object this JSON structure represents.

default

SWIPE_NAVIGATION_GESTURE_PROGRESS_ENGINE_EVENT

pendingNavigationAction

pendingNavigationAction: NavigationAction

The type of navigation action that will occur on "pointerup".

propagationStopped

propagationStopped: boolean

True if stopPropagation() was called on this event.

nativeignore

readerViewName

readerViewName: string

The name of the ReaderView this event is related to.

nativeignore

relativeDeltaClientX

relativeDeltaClientX: number

The total X movement relative to the window width. Typically a number between 0 and 1.

A positive number means that the pointer is moving to the right. A negative number means that the pointer is moving to the left.

double

relativeDeltaClientY

relativeDeltaClientY: number

The total Y movement relative to the window height. Typically a number between 0 and 1.

A positive number means that the pointer is moving downwards. A negative number means that the pointer is moving upwards.

double

relativeDeltaScreenX

relativeDeltaScreenX: number

The total X movement relative to the screen width. Typically a number between 0 and 1.

A positive number means that the pointer is moving to the right. A negative number means that the pointer is moving to the left.

double

relativeDeltaScreenY

relativeDeltaScreenY: number

The total Y movement relative to the screen height. Typically a number between 0 and 1.

A positive number means that the pointer is moving downwards. A negative number means that the pointer is moving upwards.

double

type

The type of event.

Generated using TypeDoc