colibrio-reader-framework/com.colibrio.readingsystem.renderer/SingleDocumentScrollRendererOptions

SingleDocumentScrollRendererOptions

data class SingleDocumentScrollRendererOptions(val disableAnimations: Boolean = false, val ignoreAspectRatio: Boolean = false, val insets: RectMargins? = null, val maxWidth: Length? = null, val pageBackgroundColor: String = "#ffffff", val readingAreaOffsetBottom: Length? = null, val readingAreaOffsetTop: Length? = null, val scrollAnimationDurationMs: Int? = null, val scrollAnimationMaxDistance: Length? = null, val scrollbarPosition: ScrollRendererScrollbarPosition = ScrollRendererScrollbarPosition.DOCUMENT, val swipeNavigationGestureThreshold: Length? = null)

Options specific for the SingleDocumentScrollRenderer.

Constructors

constructor(disableAnimations: Boolean = false, ignoreAspectRatio: Boolean = false, insets: RectMargins? = null, maxWidth: Length? = null, pageBackgroundColor: String = "#ffffff", readingAreaOffsetBottom: Length? = null, readingAreaOffsetTop: Length? = null, scrollAnimationDurationMs: Int? = null, scrollAnimationMaxDistance: Length? = null, scrollbarPosition: ScrollRendererScrollbarPosition = ScrollRendererScrollbarPosition.DOCUMENT, swipeNavigationGestureThreshold: Length? = null)

Types

Companion

object Companion

Properties

disableAnimations

val disableAnimations: Boolean = false

If animations should be used or not by the renderer.

ignoreAspectRatio

val ~~ignoreAspectRatio~~: Boolean = false

Ignore the calculated aspectRatio to take up as much of the available view space as possible.

insets

val insets: RectMargins? = null

Configures insets that can be used to allow the user to scroll content below system UI elements like the notch on mobile devices.

maxWidth

val maxWidth: Length? = null

Sets the maximum width of the renderer.

pageBackgroundColor

val pageBackgroundColor: String

A CSS color to use as default page background.

readingAreaOffsetBottom

val readingAreaOffsetBottom: Length? = null

This option describes how far from the bottom of the renderer's visible area the Reading Area will end.

readingAreaOffsetTop

val readingAreaOffsetTop: Length? = null

This option describes how far from the top of the renderer's visible area the Reading Area will start.

scrollAnimationDurationMs

val scrollAnimationDurationMs: Int? = null

The maximum amount of time to spend on scrolling animations. The duration will be shorter for scrolls shorter than one screen height down to a minimum of 50ms for very short scrolls.

scrollAnimationMaxDistance

val scrollAnimationMaxDistance: Length? = null

Sets the maximum scroll distance that will result in an animation. Scroll navigations longer than this distance will instead jump directly to the target location.

scrollbarPosition

val scrollbarPosition: ScrollRendererScrollbarPosition

Controls where the vertical scrollbar is placed.

swipeNavigationGestureThreshold

val swipeNavigationGestureThreshold: Length? = null

Controls the minimum swipe distance required to trigger navigation to the next or previous page. A higher value means the user must swipe farther to turn pages.

Functions

serialize

fun serialize(generator: JsonGenerator)