IF this event's default action is cancelable. See respective engine event for its definition of default action.
If this event's default action has been canceled/prevented by a call to preventDefault()
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.
True if stopImmediatePropagation() was called on this event.
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.
A value between 0 and 1 indicating the progress of the ContentPositionTimeline creation.
True if stopPropagation() was called on this event.
The name of the ReaderView this event is related to, if any.
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()
.
The type of event.
Generated using TypeDoc
The plain JSON version of
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 tocreateContentPositionTimeline()
.As an alternative to this event, you can also specify a
progressCallback
when callingcreateContentPositionTimeline()
.