Interface IPdfContentPositionTimelineOptions

Base interface for all options types that can be used when creating ContentPositionTimeline for EPUB Publications.

unit

interface IPdfContentPositionTimelineOptions {
name?: string;
unit: ContentPositionTimelineUnit;
}

Properties

name?: string

The name to use for the timeline.

The name is used by the framework when emitting contentPositionTimelineCreateProgress events to refer to which timeline the event is related to.

If the name is left empty, the framework will generate a name for the timeline.

The unit of measurement used by the ContentPositionTimeline.