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

ContentDisplayAreaOptions

sealed interface ContentDisplayAreaOptions

Base interface for all types of Content Display Area options.

Inheritors

Types

Link copied to clipboard
data class AspectRatio(val insets: RectMargins? = null, val aspectRatio: Double = 0.66666666666) : ContentDisplayAreaOptions

Restrict the Content Display Area based on a fixed aspect-ratio.

Link copied to clipboard
data class CalculatedFromPublication(val insets: RectMargins? = null, val fallbackAspectRatio: Double = 0.66666666666) : ContentDisplayAreaOptions

Content Display Areas are based on the aspect-ratio derived from the publication's fixed-layout documents, if any exist. Otherwise, the aspect ratio is derived from the publication's cover image.

Link copied to clipboard
data class Fill(val insets: RectMargins? = null) : ContentDisplayAreaOptions

Content Display Areas fill the ReaderView element.

Properties

Link copied to clipboard
abstract val insets: RectMargins?

Configures insets that reserve space along the edges of the ReaderView, typically set to match the device's safe area insets to keep content clear of camera notches, rounded corners, or system UI elements.

Link copied to clipboard
abstract val type: ContentDisplayAreaType

Identifies the type of Content Display Area options.

Functions

Link copied to clipboard
abstract fun serialize(generator: JsonGenerator)