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

    Interface IPageProgressionTimelineRecalculatingEvent

    EngineEvent used for "pageProgressionTimelineRecalculating". This event is fired when a PageProgressionTimeline is being recalculated due to a ReaderView configuration change such as a window resize or if ReaderViewOptions changes.

    This event is fired multiple times while the timeline is being recalculated with the progress of the operation. The timeline is not available during this process.

    The timeline recalculation operation is finished when a "pageProgressionTimelineRecalculated" event is fired.

    interface IPageProgressionTimelineRecalculatingEvent {
        cancelable: boolean;
        defaultPrevented: boolean;
        immediatePropagationStopped: boolean;
        isTrusted: boolean;
        progress: number;
        propagationStopped: boolean;
        readerView: IReaderView;
        type: keyof IEngineEventTypeMap;
        preventDefault(): void;
        stopImmediatePropagation(): void;
        stopPropagation(): void;
        toJSON(): IPageProgressionTimelineRecalculatingEventData;
    }

    Hierarchy (View Summary)

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

    progress: number

    A value between 0 and 1 indicating the progress of the recalculation.

    propagationStopped: boolean

    True if stopPropagation() was called on this event.

    readerView: IReaderView

    The ReaderView instance this event is related to.

    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