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

PageProgressionTimelineData

data class PageProgressionTimelineData(val timelineType: PageProgressionTimelineType, val totalNumberOfPages: Int, val visibleTimelineRange: PageProgressionTimelineRangeData)

Represents the data in a PageProgressionTimeline.

Constructors

Link copied to clipboard
fun PageProgressionTimelineData(timelineType: PageProgressionTimelineType, totalNumberOfPages: Int, visibleTimelineRange: PageProgressionTimelineRangeData)

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
fun serialize(generator: JsonGenerator)

Properties

Link copied to clipboard
val timelineType: PageProgressionTimelineType

Describes how the timeline data was calculated.

Link copied to clipboard
val totalNumberOfPages: Int

The total number of pages for all of the reader documents inside the ReaderView. Check timelineType to determine if this value is estimated or fixed.

Link copied to clipboard
val visibleTimelineRange: PageProgressionTimelineRangeData

The timeline range describing the positions currently visible in the ReaderView.