Colibrio Reader Framework API - Cloud license
    Preparing search index...

    Interface ISwipeNavigationGestureProgressEngineEvent

    Engine event type used for "swipeNavigationGestureProgress" events.

    interface ISwipeNavigationGestureProgressEngineEvent {
        animationProgress: number;
        cancelable: boolean;
        defaultPrevented: boolean;
        deltaX: number;
        deltaY: number;
        immediatePropagationStopped: boolean;
        isTrusted: boolean;
        pendingNavigationAction: NavigationAction;
        propagationStopped: boolean;
        readerView: IReaderView;
        relativeDeltaClientX: number;
        relativeDeltaClientY: number;
        relativeDeltaScreenX: number;
        relativeDeltaScreenY: number;
        type: keyof IEngineEventTypeMap;
        preventDefault(): void;
        stopImmediatePropagation(): void;
        stopPropagation(): void;
        toJSON(): ISwipeNavigationGestureProgressEngineEventData;
    }

    Hierarchy (View Summary)

    Properties

    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.

    cancelable: boolean

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

    defaultPrevented: boolean

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

    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.

    deltaY: number

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

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

    immediatePropagationStopped: boolean

    True if stopImmediatePropagation() was called on this event.

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

    pendingNavigationAction: NavigationAction

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

    propagationStopped: boolean

    True if stopPropagation() was called on this event.

    readerView: IReaderView

    The ReaderView instance this event is related to.

    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.

    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.

    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.

    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.

    type: keyof IEngineEventTypeMap

    The type of event.

    Methods

    • Prevent the event's default action. See the respective engine event for its definition of default action.

      Returns void

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

      Returns void

    Properties
    Methods