Options
All
  • Public
  • Public/Protected
  • All
Menu

A content document that has been processed by an EPUB format adapter to be used by the Reading System.

Hierarchy

Index

Methods

createRenderableDocument

createRenderableDocumentPageIterator

fetchContentBlockTree

fetchContentBlocks

fetchContentLocationForEntireDocument

fetchEstimatedHeight

fetchEstimatedNumberOfPages

fetchLocatorForContentBlockData

  • fetchLocatorForContentBlockData(contentBlockData: IContentBlockData, charOffset?: number, charLength?: number): Promise<ILocator>
  • Fetch the locator for the complete or partial content block. NOTE: This method still exists for the legacy search API.

    deprecated

    since 0.28.0 - Please use fetchContentBlockTree(), and use IContentBlock.getLocator() instead.

    Parameters

    • contentBlockData: IContentBlockData

      The content block data to retrieve locator for.

    • Optional charOffset: number

      The character offset within textBlock.textContent. Defaults to 0.

    • Optional charLength: number

      The number of characters after charOffset to include in the locator. Defaults to end of textContent if omitted.

    Returns Promise<ILocator>

fetchViewportDimensions

getAvailableSyncMediaFormats

getContentLocation

getIndexInSpine

  • getIndexInSpine(): number

getLocator

getReaderPublication

getSourceContentDocument

isReflowable

  • isReflowable(): boolean

isRenderable

  • isRenderable(): boolean

toJSON

Generated using TypeDoc