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

    Interface IPageProgressionTimelineOptions

    Options set using IReaderViewOptions.pageProgressionTimelineOptions

    interface IPageProgressionTimelineOptions {
        delayRecalculationUntilPagesVisible?: boolean;
        enabled?: boolean;
        forceCompleteRendition?: boolean;
    }

    Properties

    delayRecalculationUntilPagesVisible?: boolean

    After ReaderView has been refreshed, delay timeline recalculation until the first visible pages have rendered. ReaderView is typically refreshed on window resize or when changing view options.

    Setting this value to true will cause pages to get rendered to screen faster.

    Setting this value to false will cause the timeline to recalculate faster, but will increase time until pages are rendered to screen.

    true
    enabled?: boolean

    If the PageProgressionTimeline feature should be enabled.

    When this option is false, the PageProgressionTimeline feature is disabled, and ReaderView.getPageProgressionTimeline() will always return null.

    It is recommended to keep this option false and use a ContentPositionTimeline instead.

    false
    forceCompleteRendition?: boolean

    Renders all reflowable content documents in the ReaderView in order to calculate the exact number of pages for the current ReaderView configuration and view dimensions. (Number of pages for fixed layout documents are already known).

    WARNING: This is a very expensive operation that will take a long time to complete on large reflowable publications.

    The resulting rendition is highly volatile and will be invalidated on any change to ReaderView configuration (such as font-size change), or view dimensions (such as window resizing or orientation change).

    false
    Properties