Destroy this instance, allowing used resources to be garbage collected.
The default layout for content documents in this publication.
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 items defined in this publication.
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 PdfContentDocuments.
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.
Creates a new PdfPublication from an ArrayBuffer containing the PDF file data.
If the PDF is password protected, you must also provide a password in the passed options object.
Otherwise, the returned Promise is rejected with a PdfPublicationError with errorType set to PASSWORD_REQUIRED.
If an incorrect password is provided, the errorType is set to PASSWORD_INCORRECT.
Creates a new PdfPublication from a Blob containing the PDF file data.
If the PDF is password protected, you must also provide a password in the passed options object.
Otherwise, the returned Promise is rejected with a PdfPublicationError with errorType set to PASSWORD_REQUIRED.
If an incorrect password is provided, the errorType is set to PASSWORD_INCORRECT.
Creates a new PdfPublication from a IRandomAccessDataSource implementation returning chunks of PDF file data. Using this method, the framework will download only the requested portions of the publication, thus minimizing load times and data usage.
If the PDF is password protected, you must also provide a password in the passed options object.
Otherwise, the returned Promise is rejected with a PdfPublicationError with errorType set to PASSWORD_REQUIRED.
If an incorrect password is provided, the errorType is set to PASSWORD_INCORRECT.
Generated using TypeDoc
Describes a source PDF publication that can be loaded into a ReadingSystemEngine. Uses pdf.js for parsing and rendering the PDF document.