IContentPositionTimelineCreateProgressEngineEventDef | Colibrio Reader Framework API

Used when constructing new ContentPositionTimelineCreateProgressEngineEvent instances.

Hierarchy

IEngineEventDef
- IContentPositionTimelineCreateProgressEngineEventDef

Index

Properties

cancelable
done
isTrusted
progress
readerView
timelineName

Properties

Optional cancelable

cancelable?: boolean

done

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.

Optional isTrusted

isTrusted?: boolean

progress

progress: number

A value between 0 and 1 indicating the progress of the ContentPositionTimeline creation.

readerView

readerView: IReaderView

timelineName

timelineName: string

The name of the ContentPositionTimeline this event is related to.

The name of a ContentPositionTimeline is specified in the options object passed to createContentPositionTimeline().