Colibrio Reader Framework API - Cloud license
    Preparing search index...

    Interface IReaderDocument

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

    interface IReaderDocument {
        fetchContentBlockTree(): Promise<IContentBlockTree>;
        fetchContentLocationForEntireDocument(): Promise<IContentLocation>;
        fetchViewportDimensions(): Promise<IDimensions>;
        getAvailableSyncMediaFormats(): SyncMediaFormat[];
        getContentLocation(): IContentLocation;
        getIndexInSpine(): number;
        getLocator(): Locator;
        getReaderPublication(): IReaderPublication;
        getSourceContentDocument(): IContentDocument;
        isReflowable(): boolean;
        isRenderable(): boolean;
        toJSON(): IReaderDocumentData;
    }

    Hierarchy (View Summary)

    Methods

    • Get the ContentLocation representing the range of the entire ReaderDocument.

      Returns Promise<IContentLocation>

    • Get the document viewport dimensions if this document defines any.

      Returns Promise<IDimensions>

    • The index of this reader document within the parent IReaderPublication spine.

      Returns number

    • Get a locator that points to this document.

      Returns Locator

    • If this document can be reflowed into multiple pages.

      Returns boolean

    • If the document can be rendered using a ReaderView.

      Returns boolean

    Methods