Interface IRendererScrollEngineEventData

Event data object used when a scroll action has ended in a scrolling renderer such as the SingleDocumentScrollRenderer.

interface IRendererScrollEngineEventData {
    cancelable: boolean;
    defaultPrevented: boolean;
    immediatePropagationStopped: boolean;
    isTrusted: boolean;
    objectType: EngineEventDataObjectType;
    propagationStopped: boolean;
    readerViewName: string;
    scrollDistance: number;
    scrollTop: number;
    type: keyof IEngineEventTypeMap;
    userGenerated: boolean;
}

Properties

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()

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

The type of engine event object this JSON structure represents.

RENDERER_SCROLL_ENGINE_EVENT

propagationStopped: boolean

True if stopPropagation() was called on this event.

readerViewName: string

The name of the ReaderView this event is related to.

scrollDistance: number

If it's a userGenerated scroll event, describes how far the user has scrolled.

scrollTop: number

The number of pixels that a renderer's content is scrolled vertically.

The type of event.

userGenerated: boolean

If the event was triggered by a user scrolling the renderer element.