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

ReaderViewOptions

data class ReaderViewOptions(val defaultPageAspectRatio: Double = 0.66666666666, val defaultPageProgressionDirection: ReaderViewPageProgressionDirection = ReaderViewPageProgressionDirection.LTR, val defaultStartPageSpreadSlot: ReaderViewOptionsDefaultStartPageSpreadSlot = ReaderViewOptionsDefaultStartPageSpreadSlot.AUTO, val emitPointerMoveEventsOnHover: Boolean = false, val forcePageAspectRatio: Double? = null, val forcePageProgressionDirection: ReaderViewPageProgressionDirection? = null, val gestureOptions: ReaderViewGestureOptions = ReaderViewGestureOptions(), val pageProgressionTimelineOptions: PageProgressionTimelineOptions = PageProgressionTimelineOptions(), val publicationStyleOptions: PublicationStyleOptions = PublicationStyleOptions(), val refreshDelayMs: Int = 200, val rendererTransitionAnimationDurationMs: Int? = null, val rendererTransitionTimeoutMs: Int = 500, val transformManagerOptions: ReaderViewTransformManagerOptions = ReaderViewTransformManagerOptions())

Options for changing the behavior and appearance of a ReaderView.

Constructors

Link copied to clipboard
fun ReaderViewOptions(defaultPageAspectRatio: Double = 0.66666666666, defaultPageProgressionDirection: ReaderViewPageProgressionDirection = ReaderViewPageProgressionDirection.LTR, defaultStartPageSpreadSlot: ReaderViewOptionsDefaultStartPageSpreadSlot = ReaderViewOptionsDefaultStartPageSpreadSlot.AUTO, emitPointerMoveEventsOnHover: Boolean = false, forcePageAspectRatio: Double? = null, forcePageProgressionDirection: ReaderViewPageProgressionDirection? = null, gestureOptions: ReaderViewGestureOptions = ReaderViewGestureOptions(), pageProgressionTimelineOptions: PageProgressionTimelineOptions = PageProgressionTimelineOptions(), publicationStyleOptions: PublicationStyleOptions = PublicationStyleOptions(), refreshDelayMs: Int = 200, rendererTransitionAnimationDurationMs: Int? = null, rendererTransitionTimeoutMs: Int = 500, transformManagerOptions: ReaderViewTransformManagerOptions = ReaderViewTransformManagerOptions())

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
fun serialize(generator: JsonGenerator)

Properties

Link copied to clipboard
val defaultPageAspectRatio: Double = 0.66666666666

The default page aspect ratio as (width / height) to use when it cannot be detected from the publication.

Link copied to clipboard
val defaultPageProgressionDirection: ReaderViewPageProgressionDirection

The default page progression direction to use if not defined by the publication.

Link copied to clipboard
val defaultStartPageSpreadSlot: ReaderViewOptionsDefaultStartPageSpreadSlot

The default PageSpreadSlot to use for the first content document in publications if the publication does not define it. This option has no effect if the publication defines a SpreadSlot for the first content document, or when the activeRenderer cannot display spreads.

Link copied to clipboard
val emitPointerMoveEventsOnHover: Boolean = false

If set to false, "pointermove" events are only emitted between "pointerdown" and "pointerup" events. If set to true, all "pointermove" events will be emitted, for example when moving the mouse without pressing any button.

Link copied to clipboard
val forcePageAspectRatio: Double? = null

Force a page aspect ratio (width / height).

Link copied to clipboard
val forcePageProgressionDirection: ReaderViewPageProgressionDirection? = null

Force a specific page progression direction to be used.

Link copied to clipboard
val gestureOptions: ReaderViewGestureOptions

Options related to gestures (such as pan-zoom) in the ReaderView.

Link copied to clipboard
val pageProgressionTimelineOptions: PageProgressionTimelineOptions

Options related with the PageProgressionTimeline.

Link copied to clipboard
val publicationStyleOptions: PublicationStyleOptions

Allows to set various styling options when rendering the publication such as fonts and color palettes.

Link copied to clipboard
val refreshDelayMs: Int = 200

The delay in milliseconds until a call to refresh() will actually cause a refresh. Multiple calls to refresh() within this delay will be merged into a single refresh call.

Link copied to clipboard
val rendererTransitionAnimationDurationMs: Int? = null

A renderer transition happens when the activeRenderer changes, or a refresh() call requires the activeRenderer to re-layout its content. Normally the renderer transition will start when visible content has finished rendering.

Link copied to clipboard
val rendererTransitionTimeoutMs: Int = 500

A renderer transition happens when the activeRenderer changes, or a refresh() call requires the activeRenderer to re-layout its content. Normally the renderer transition will start when visible content has finished rendering.

Link copied to clipboard
val transformManagerOptions: ReaderViewTransformManagerOptions

Options related to the transform manager.