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

SpreadSwipeRendererOptions

data class SpreadSwipeRendererOptions(val animationDurationMs: Double? = null, val direction: Axis = Axis.X, val disableAnimations: Boolean = false, val enablePageSpreadCenterSupport: Boolean = true, val goToAnimationDurationMs: Int? = null, val ignoreAspectRatio: Boolean = false, val insets: RectMargins? = null, val minMarginBetweenSpreads: Int = 24, val pageBackgroundColor: String = "transparent", val rubberBandElasticity: Double = 0.65, val swipeNavigationGestureThreshold: Length? = null, val useWindowDimensionsForPageContainers: Boolean = true)

Options used with the SpreadSwipeRenderer.

Constructors

constructor(animationDurationMs: Double? = null, direction: Axis = Axis.X, disableAnimations: Boolean = false, enablePageSpreadCenterSupport: Boolean = true, goToAnimationDurationMs: Int? = null, ignoreAspectRatio: Boolean = false, insets: RectMargins? = null, minMarginBetweenSpreads: Int = 24, pageBackgroundColor: String = "transparent", rubberBandElasticity: Double = 0.65, swipeNavigationGestureThreshold: Length? = null, useWindowDimensionsForPageContainers: Boolean = true)

Types

Companion

object Companion

Properties

animationDurationMs

val animationDurationMs: Double? = null

How long the animations to next/previous will be. Default is null which will use specific values dependent on the presentation mode and platform types: 'mobile', 'tablet' or 'desktop'.

direction

val direction: Axis

The swipe direction to use. Default value is Axis.X

disableAnimations

val disableAnimations: Boolean = false

If animations should be used or not by the renderer.

enablePageSpreadCenterSupport

val enablePageSpreadCenterSupport: Boolean = true

Enables support for center spread in pages

goToAnimationDurationMs

val goToAnimationDurationMs: Int? = null

The goTo animation duration when fading in. The default value null will use platform specific duration.

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.

minMarginBetweenSpreads

val minMarginBetweenSpreads: Int = 24

Minimum margin between spreads in pixels.

pageBackgroundColor

val pageBackgroundColor: String

A CSS color to use as default page background.

rubberBandElasticity

val rubberBandElasticity: Double = 0.65

A number between 0 and 1 configuring the rubberband effect when trying to swipe before the first page or after the last page. Lower value means stronger rubberband effect.

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.

useWindowDimensionsForPageContainers

val useWindowDimensionsForPageContainers: Boolean = true

Use full window dimensions when calculating spread container sizes. This option should be true if the ReaderView element allows content to overflow.

Functions

serialize

fun serialize(generator: JsonGenerator)