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

FlipBookRendererOptions

data class FlipBookRendererOptions(val fixDisappearingCharactersInChromeForAndroid: Boolean = false, val hideEmptySpreadSlots: Boolean = true, val pageFoldShadowOpacity: Double = 0.5, val pageTurnShadowMaxOpacity: Double = 0.2, val perspectiveFactor: Double = 2.0, val rendererBackgroundShadowOpacity: Double = 0.2, val rubberBandElasticity: Double = 0.65, val showPageFoldShadow: Boolean = false, val showPageTurnShadow: Boolean = true, val showRendererBackgroundShadow: 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 FlipBookRenderer

Constructors

fun FlipBookRendererOptions(fixDisappearingCharactersInChromeForAndroid: Boolean = false, hideEmptySpreadSlots: Boolean = true, pageFoldShadowOpacity: Double = 0.5, pageTurnShadowMaxOpacity: Double = 0.2, perspectiveFactor: Double = 2.0, rendererBackgroundShadowOpacity: Double = 0.2, rubberBandElasticity: Double = 0.65, showPageFoldShadow: Boolean = false, showPageTurnShadow: Boolean = true, showRendererBackgroundShadow: 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'.

disableAnimations

val disableAnimations: Boolean = false

If animations should be used or not by the renderer.

fixDisappearingCharactersInChromeForAndroid

val fixDisappearingCharactersInChromeForAndroid: Boolean = false

Set to true to enable a bugfix for a specific bug in Chrome on Android. The bug causes content to sometimes disappear when performing pan-zoom gestures.

goToAnimationDurationMs

val goToAnimationDurationMs: Int? = null

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

hideEmptySpreadSlots

val hideEmptySpreadSlots: Boolean = true

Set to false to not hide empty spread slots, such as the empty slot before the first page in the publication.

ignoreAspectRatio

val ignoreAspectRatio: Boolean = false

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

pageBackgroundColor

val pageBackgroundColor: String

A CSS color to use as default page background.

pageFoldShadowOpacity

val pageFoldShadowOpacity: Double = 0.5

A number between 0 and 1, controlling the opacity for the page fold shadow.

pageTurnShadowMaxOpacity

val pageTurnShadowMaxOpacity: Double = 0.2

A value between 0 and 1 describing maximum amount of opacity that is used for the page turn shadow effects. Larger values will give darker shadows.

perspectiveFactor

val perspectiveFactor: Double = 2.0

Sets the perspective factor for page turn animations. The final CSS value is calculated by multiplying this factor with the width (px) of the renderer. A larger value means the viewer is further away.

rendererBackgroundShadowOpacity

val rendererBackgroundShadowOpacity: Double = 0.2

A value between 0 and 1, controlling the opacity for the shadow beneath the renderer.

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 less elasticity.

showPageFoldShadow

val showPageFoldShadow: Boolean = false

If shadows in the fold between the left and right page should be rendered.

showPageTurnShadow

val showPageTurnShadow: Boolean = true

Render shadow effects when turning pages.

showRendererBackgroundShadow

val showRendererBackgroundShadow: Boolean = true

Render shadow effects beneath the renderer.