Interface IPdfPagesContentPositionTimelineOptions

Options object used when creating ContentPositionTimeline for PDF Publications, using PAGES as unit of measurement.

interface IPdfPagesContentPositionTimelineOptions {
name?: string;
unit: PAGES;
}

Hierarchy (View Summary)

IPdfContentPositionTimelineOptions
- IPdfPagesContentPositionTimelineOptions

Properties

`Optional`name

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.

Native Ignore

unit

unit: PAGES

The unit of measurement used by the ContentPositionTimeline.