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

CalculatedFromPublication

data class CalculatedFromPublication(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.

When the publication lacks both fixed-layout pages and cover image, the configurable fallback value is used instead.

Note: When this type is used, additional publication data might need to be fetched. This may negatively impact the time until first page rendered if the publication is streamed over the internet.

Constructors

CalculatedFromPublication

constructor(fallbackAspectRatio: Double = 0.66666666666)

Types

Companion

object Companion

Properties

fallbackAspectRatio

val fallbackAspectRatio: Double = 0.66666666666

The aspect-ratio for Content Display Areas to use as fallback if the publication has no cover image. Defined as (width / height).

type

val type: ContentDisplayAreaType

Identifies the type of Content Display Area options.

Functions

serialize

open override fun serialize(generator: JsonGenerator)