Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a source content document in a Publication.

Hierarchy

  • IContentDocumentData

Index

Properties

contentUrl

contentUrl: string

Returns the URL from where the content document resource can be fetched. This URL may or may not be a browser supported URL depending on how the publication was loaded. For example, an EPUB loaded from a local file requires content URLs to be used together with the ResourceProvider that loaded the publication.

hasRemoteResources

hasRemoteResources: boolean

If the publication metadata indicates that this resource internally contains references to other resources outside of this publication.

inLinearContent

inLinearContent: boolean

Indicates whether the content contributes to the primary reading order and has to be read sequentially, or auxiliary content that enhances or augments the primary content and can be accessed out of sequence. Examples of auxiliary content include: notes, descriptions and answer keys.

indexInSpine

indexInSpine: number

The index of the content document within the parent publication spine.

int

layout

If this ContentDocument has been designed as a fixed-layout document, or if it can be reflowed/paginated.

mediaType

mediaType: string

The media type of this content document.

pageSpreadSlot

pageSpreadSlot: PageSpreadSlot

If the content document should be rendered in the left-hand slot, the right-hand slot or if synthetic spread mode should be overridden and a single viewport rendered and positioned at the center of the screen.

scripted

scripted: boolean

If the publication metadata indicates that this resource contains scripted content or forms.

syntheticSpreadBehavior

syntheticSpreadBehavior: SyntheticSpreadBehavior

Get in which orientations the reading system should present this content document in spread mode. If not defined by the content document, it defaults to publication.preferredSyntheticSpreadBehavior.

Generated using TypeDoc