colibrio-reader-framework/com.colibrio.readingsystem.base/PageProgressionTimelineOptions

PageProgressionTimelineOptions

data class PageProgressionTimelineOptions(val delayRecalculationUntilPagesVisible: Boolean = true, val enabled: Boolean = true, val forceCompleteRendition: Boolean = false)

Options set using IReaderViewOptions.pageProgressionTimelineOptions

Constructors

fun PageProgressionTimelineOptions(delayRecalculationUntilPagesVisible: Boolean = true, enabled: Boolean = true, forceCompleteRendition: Boolean = false)

Types

Companion

object Companion

Functions

serialize

fun serialize(generator: JsonGenerator)

Properties

delayRecalculationUntilPagesVisible

val delayRecalculationUntilPagesVisible: Boolean = true

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.

enabled

val enabled: Boolean = true

If the PageProgressionTimeline feature should be enabled.

forceCompleteRendition

val forceCompleteRendition: Boolean = false

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