Options
All
  • Public
  • Public/Protected
  • All
Menu

Options set using IReaderViewOptions.pageProgressionTimelineOptions

Hierarchy

  • IPageProgressionTimelineOptions

Index

Properties

Optional delayRecalculationUntilPagesVisible

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.

default

true

Optional enabled

enabled?: boolean

If the PageProgressionTimeline feature should be enabled.

Settings this option to false will disable the PageProgressionTimeline feature and cause ReaderView.getPageProgressionTimeline() to always return null.

If you are using ContentPositionTimelines instead of PageProgressionTimelines, it is recommended to set this option to false to improve performance.

default

true

Optional forceCompleteRendition

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

default

false

Generated using TypeDoc