Creates a new ContentPosition timeline using the specified list of ReaderDocuments. A ContentPositionTimeline is used for describing positions in ReaderPublication content as integers. The timeline starts at position 0 and its length can be retrieved using getLength().
The ContentPositionTimeline can be configured with different units of measurement. At this moment, CHARACTERS are not available as a unit of measurement for PDFs. By default, PAGES will be used as unit of measurement.
The timeline is created by counting all pages in the provided list of ReaderDocuments. Each position in the timeline points to the start of a page.
The timeline is created by counting all provided ReaderDocuments.
The passed list of ReaderDocuments is validated according to the following rules:
If the passed list of ReaderDocuments fails validation, the returned Promise will be rejected with an error.
Some examples:
const spine = readerPublication.getSpine();
readerPublication.createContentPositionTimeline(spine); // OK!
readerPublication.createContentPositionTimeline(spine.slice(1, 4)) // OK!
readerPublication.createContentPositionTimeline(spine.reverse()); // ERROR!
The reader documents that should be part of the timeline.
Options to use for the timeline.
A function called several times indicating the create progress as a value between 0 and 1. You can also listen on the event 'contentPositionTimelineCreateProgress' to get this information.
Creates a TTS SyncMediaTimeline using the ContentBlocks from the specified reader documents.
The returned promise is rejected if this PDF does not contain any text, i.e. if the resulting timeline is empty.
The reader documents that should be part of the timeline.
Options to use when building the timeline.
A function called several times indicating the create progress as a value between 0 and 1. You can also listen on the event 'contentPositionTimelineCreateProgress' to get this information.
Destroy this instance, allowing used resources to be garbage collected. This method has the same effect as calling readingSystemEngine.unloadPublication(),
Fetch the resolved IContentLocation from a locator, ILocatorData, URL, URI, URN, IRI.
In contrast to UnresolvedContentLocation, a ContentLocation knows its position within the publication content and can thereby be used to compare and sort ContentLocation instances synchronously.
See IContentLocation for more information
Fetch the preferred aspect ratio of pages in this publication defined as (width / height)
Fetch the complete publication navigation as defined in the source publication.
Fetches an UnresolvedContentLocation from a Locator, ILocatorData, URL, URI, URN, IRI. Can be used for extracting various publication data related with the Locator.
The units of measure that can be used when creating ContentPositionTimeline objects using this publication.
See IEpubReaderPublication.createContentPositionTimeline() and IPdfReaderPublication.createContentPositionTimeline()
for how to create ContentPositionTimeline objects.
The sync media formats available in this publication.
The base URL used when creating Locators pointing to content in this publication.
Get the LocatorFactory used when creating new Locators.
Get a copy of the IReaderPublicationOptions used for this instance.
Get the IReaderPublicationStorage instance for this publication. Use the returned instance to manage the publication's storage, such as 'localStorage' for EPUB. This allows applications to save and restore the state of the IReaderPublicationStorage across reading-sessions and devices.
Get the IReadingSystemEngine that created this instance.
Get the source publication this instance is using.
Get an ordered list of IReaderDocument instances that are part of this publication.
If destroy() has been called on this instance.
If the source URL of the locator, (that is URL without the hash) matches the any source URL in the Publication.
If this method returns true, the locator MAY target content in the publication, depending on selectors inside the Locator. If this method return false, the locator DOES NOT target any content in the publication.
Sets new IReaderPublicationOptions for this instance. Existing properties are preserved if they aren't defined in the passed options object. Properties explicitly set to undefined will be restored to their default values.
Changes affecting the appearance or behavior of the ReaderPublication when used with a ReaderView will not take effect until ReaderView.refresh() is called.
Get this instance as a JSON serializable object.
Generated using TypeDoc
Format specific API for a PDF ReaderPublication.