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

SpreadSwipeRendererOptions

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

Options used with the SpreadSwipeRenderer.

Constructors

fun SpreadSwipeRendererOptions(direction: Axis = Axis.X, minMarginBetweenSpreads: Int = 24, rubberBandElasticity: Double = 0.65, useWindowDimensionsForPageContainers: Boolean = true, animationDurationMs: Double? = null, disableAnimations: Boolean = false, goToAnimationDurationMs: Int? = null, ignoreAspectRatio: Boolean = false, pageBackgroundColor: String = "#ffffff")

Types

Companion

object Companion

Functions

serialize

fun serialize(generator: JsonGenerator)

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.

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.

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.

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.