Destroy this instance, allowing used resources to be garbage collected.
Fetches and parses a EPUB Media Overlay by its URL.
Resolved with the parsed Media Overlay, or rejected if the no Media Overlay was found.
Fetches the EPUB NCX or Navigation as an XML document. Use ReaderPublication.fetchPublicationNavigation() to fetch a parsed and generalized navigation structure.
Allows you to get any HTML/XHTML or SVG resource in the manifest by URL as an IEpubContentDocument.
The url must be relative the EpubOcfResourceProvider.getBaseUrl(). Example: let url = new URL('book/chapter-1.html', ocfResourceProvider.getBaseUrl());
Get the cover image resource for this publication.
The default layout for content documents in this publication.
Get the EpubResourceProvider for this publication. This can be used to retrieve resources that are part of the EPUB package.
Get vendor specific extensions to the EPUB format.
Get a generated hash signature of the publication, intended to uniquely identify this publication. The hash signature is not the same as the publication id as the hash signature always changes when the publication data changes in any way. The uniqueness of the signature depends on how the publication was loaded. Please refer the implementation responsible for loading this instance. For example, for EPUB see OcfResourceProvider.
Get the media type for this publication
Get all metadata extracted from the publication.
Get the source OPF Document for this publication.
Get the URL to the OPF Document.
Get the global direction in which the Publication content flows. Please note that this is not same as the writing direction. A publication's pages can be ordered from right-to-left, but its text written left-to-right.
Get the default preferred flow mode for content documents in the publication. In other words, it specifies how the publication content should be presented by the reading system.
Get which orientation the author intends the Publication to be rendered in.
Get in which orientations the reading system should present this content document in spread mode.
Get the publication spine as an ordered list of EpubContentDocuments.
Get the type of publication this instance represents.
This allows you to cast an IPublication instance to a more specific subtype.
See PublicationType for how values map to specific IPublication types.
If this Publication instance has been destroyed.
Get this instance as a plain JSON object.
Generated using TypeDoc
Represents an EPUB source publication that can be loaded into a ReadingSystemEngine.