Options
All
  • Public
  • Public/Protected
  • All
Menu

Options object used when creating ContentPositionTimeline for EPUB Publications, using CHARACTERS as unit of measurement.

Hierarchy

Index

Properties

Optional fetchWithLowPriority

fetchWithLowPriority?: boolean

Fetch operations might impact rendering and animation performance. If this is set to true, the timeline will wait for higher priority tasks to finish instead of executing the fetch operations immediately.

default

false

Optional mappingOptions

Options specifying how characters and media elements should be mapped to timeline positions.

default

IEpubCharactersContentPositionTimelineMappingOptions

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.

nativeignore

Optional serializedData

serializedData?: string

Pass the data from ContentPositionTimeline.toSerializedData() that you saved from a previous instance. Settings this option allows the timeline to be built more quickly.

The passed data will be validated to ensure it has the correct format and that it was created for the same publication. If validation fails, the serializedData is discarded and a new value is recalculated.

nodefault

unit

The unit of measurement used by the ContentPositionTimeline.

Generated using TypeDoc