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

ReaderViewTransformManagerOptions

data class ReaderViewTransformManagerOptions(val maxPanOffsetHorizontal: Length? = null, val maxPanOffsetVertical: Length? = null, val maxScaleFactor: Double? = null, val removeTransformAnimationDurationMs: Int = 300, val removeTransformOnNavigation: Boolean = true)

Options for the ReaderViewTransformManager.

Constructors

fun ReaderViewTransformManagerOptions(maxPanOffsetHorizontal: Length? = null, maxPanOffsetVertical: Length? = null, maxScaleFactor: Double? = null, removeTransformAnimationDurationMs: Int = 300, removeTransformOnNavigation: Boolean = true)

Types

Companion

object Companion

Functions

serialize

fun serialize(generator: JsonGenerator)

Properties

maxPanOffsetHorizontal

val maxPanOffsetHorizontal: Length? = null

The maximum horizontal pan offset relative to the dimensions of the ReaderView, defined as a CSS string in pixels or percentage.

maxPanOffsetVertical

val maxPanOffsetVertical: Length? = null

The maximum vertical pan offset relative to the dimensions of the ReaderView, defined as a CSS string in pixels or percentage. If a PERCENTAGE value is used, it will be based on the width of the ReaderView's width.

maxScaleFactor

val maxScaleFactor: Double? = null

The maximum allowed scale factor. This applies to both pan-zoom gestures and when calling any method on the ReaderViewTransformManager.

removeTransformAnimationDurationMs

val removeTransformAnimationDurationMs: Int = 300

The default duration of the animation when the active transform is removed.

removeTransformOnNavigation

val removeTransformOnNavigation: Boolean = true

If the ReaderView's active transform should be removed before the ReaderView navigates.