Options
All
  • Public
  • Public/Protected
  • All
Menu

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 to createContentPositionTimeline().

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

Hierarchy

Index

Properties

cancelable: boolean

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

nativeignore
defaultPrevented: boolean

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

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

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

nativeignore

The type of engine event object this JSON structure represents.

default

CONTENT_POSITION_TIMELINE_CREATE_PROGRESS_ENGINE_EVENT

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.

nativeignore
readerViewName: string

The name of the ReaderView this event is related to, if any.

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

The type of event.

Generated using TypeDoc