Package-level declarations

Types

Link copied to clipboard
data class ContinuousScrollRendererOptions(val disableAnimations: Boolean = false, val goToAnimationDurationMs: Int? = null, 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)

Options specific for the ContinuousScrollRenderer.

Link copied to clipboard
data class FlipBookRendererOptions(val animationDurationMs: Double? = null, val disableAnimations: Boolean = false, val fixDisappearingCharactersInChromeForAndroid: Boolean = false, val goToAnimationDurationMs: Int? = null, val hideEmptySpreadSlots: Boolean = true, val ignoreAspectRatio: Boolean = false, val insets: RectMargins? = null, val pageBackgroundColor: String = "#ffffff", 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 swipeNavigationGestureThreshold: Length? = null)

Options used with the FlipBookRenderer

Link copied to clipboard
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.

Link copied to clipboard
data class SinglePageSwipeRendererOptions(val animationDurationMs: Double? = null, val direction: Axis = Axis.X, val disableAnimations: Boolean = false, val goToAnimationDurationMs: Int? = null, val ignoreAspectRatio: Boolean = false, val insets: RectMargins? = null, val minMarginBetweenPages: Int = 24, val pageBackgroundColor: String = "transparent", val rubberBandElasticity: Double = 0.65, val showPageBackgroundShadow: Boolean = false, val swipeNavigationGestureThreshold: Length? = null, val useWindowDimensionsForPageContainers: Boolean = true)

Options used with the SinglePageSwipeRenderer.

Link copied to clipboard
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.

Link copied to clipboard
data class StackRendererOptions(val animationDurationMs: Double? = null, val disable3dPerspective: Boolean = false, val disableAnimations: Boolean = false, val fixDisappearingCharactersInChromeForAndroid: Boolean = false, val goToAnimationDurationMs: Int? = null, val ignoreAspectRatio: Boolean = false, val insets: RectMargins? = null, val pageBackgroundColor: String = "#ffffff", val pageTurnShadowMaxOpacity: Double = 0.5, val perspectiveFactor: Double = 2.0, val rendererBackgroundShadowOpacity: Double = 0.2, val rubberBandElasticity: Double = 0.65, val showPageTurnShadow: Boolean = true, val showRendererBackgroundShadow: Boolean = true, val swipeNavigationGestureThreshold: Length? = null)

Options used with the StackRenderer.