Options
All
  • Public
  • Public/Protected
  • All
Menu

Describes a source publication that can be loaded into a ReadingSystemEngine.

Hierarchy

Index

Methods

destroy

  • destroy(): void
  • Destroy this instance, allowing used resources to be garbage collected.

    Returns void

getDefaultLayout

getHashSignature

  • getHashSignature(): string
  • 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.

    Returns string

getMediaType

  • Get the media type for this publication

    deprecated

    Please use getType() instead.

    Returns MediaType

getMetadata

getPageProgressionDirection

  • 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.

    Returns PageProgressionDirection

getPreferredFlowMode

  • 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.

    Returns ContentDocumentFlowMode

getPreferredOrientation

getPreferredSyntheticSpreadBehavior

  • Get in which orientations the reading system should present this content document in spread mode.

    Returns SyntheticSpreadBehavior

getSpine

  • Get the publication spine as an ordered list of ContentDocuments.

    Returns IContentDocument[]

getType

  • 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.

    Returns PublicationType

isDestroyed

  • isDestroyed(): boolean
  • If this Publication instance has been destroyed.

    Returns boolean

toJSON

Generated using TypeDoc