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

SingleDocumentScrollRendererOptions

data class SingleDocumentScrollRendererOptions(val maxWidth: Length? = null, val readingAreaOffsetBottom: Length? = null, val readingAreaOffsetTop: Length? = null, val ignoreAspectRatio: Boolean = false, val pageBackgroundColor: String = "#ffffff")

Options specific for the SingleDocumentScrollRenderer. See IRendererOptions for additional options that can be used with any Renderer.

Constructors

SingleDocumentScrollRendererOptions

fun SingleDocumentScrollRendererOptions(maxWidth: Length? = null, readingAreaOffsetBottom: Length? = null, readingAreaOffsetTop: Length? = null, ignoreAspectRatio: Boolean = false, pageBackgroundColor: String = "#ffffff")

Types

object Companion

Functions

fun serialize(generator: JsonGenerator)

Properties

ignoreAspectRatio

val ignoreAspectRatio: Boolean = false

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

val maxWidth: Length? = null

Sets the maximum width of the renderer.

pageBackgroundColor

val pageBackgroundColor: String

A CSS color to use as default page background.

readingAreaOffsetBottom

val readingAreaOffsetBottom: Length? = null

This option describes how far from the bottom of the renderer's visible area the Reading Area will end.

readingAreaOffsetTop

val readingAreaOffsetTop: Length? = null

This option describes how far from the top of the renderer's visible area the Reading Area will start.