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

    Interface IContentPositionTimelineCreateProgressEngineEvent

    This event is fired multiple times while a ContentPositionTimeline is created.

    In order to listen to this event, call addEngineEventListener on the ReadingSystemEngine instance where the related ReaderPublication is loaded.

    If you create multiple ContentPositionTimelines, you can use the timelineName property to distinguish which ContentPositionTimeline the event targets. You can specify the name of a ContentPositionTimeline in the options object passed to createContentPositionTimeline().

    As an alternative to this event, you can also specify a progressCallback when calling createContentPositionTimeline().

    interface IContentPositionTimelineCreateProgressEngineEvent {
        cancelable: boolean;
        defaultPrevented: boolean;
        done: boolean;
        immediatePropagationStopped: boolean;
        isTrusted: boolean;
        progress: number;
        propagationStopped: boolean;
        readerView: IReaderView;
        timelineName: string;
        type: keyof IEngineEventTypeMap;
        preventDefault(): void;
        stopImmediatePropagation(): void;
        stopPropagation(): void;
        toJSON(): IContentPositionTimelineCreateProgressEngineEventData;
    }

    Hierarchy (View Summary)

    • IEngineEvent
      • IContentPositionTimelineCreateProgressEngineEvent

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

    done: boolean

    Indicates if the ContentPositionTimeline creation process has finished. When this field is true, no more events will be emitted for the ContentPositionTimeline this event is related to.

    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 ContentPositionTimeline creation.

    propagationStopped: boolean

    True if stopPropagation() was called on this event.

    readerView: IReaderView

    The ReaderView instance this event is related to, if any.

    timelineName: string

    The name of the ContentPositionTimeline this event is related to.

    You can specify the name of a ContentPositionTimeline in the options object passed to createContentPositionTimeline().

    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