colibrio-reader-framework/com.colibrio.readingsystem.formatadapter.epub/EpubContentProcessingOptions

EpubContentProcessingOptions

data class EpubContentProcessingOptions(val horizontalOverflowMathMLStrategy: EpubContentOverflowStrategy = EpubContentOverflowStrategy.SCROLL, val horizontalOverflowMitigationMinFontSize: Double = 16.0, val horizontalOverflowTableStrategy: EpubContentOverflowStrategy = EpubContentOverflowStrategy.SCROLL, val skipUnusedImagesInScriptedPublicationCss: Boolean = false, val verticalOverflowMitigationStrategy: EpubContentOverflowStrategy = EpubContentOverflowStrategy.SCROLL)

Constructors

constructor(horizontalOverflowMathMLStrategy: EpubContentOverflowStrategy = EpubContentOverflowStrategy.SCROLL, horizontalOverflowMitigationMinFontSize: Double = 16.0, horizontalOverflowTableStrategy: EpubContentOverflowStrategy = EpubContentOverflowStrategy.SCROLL, skipUnusedImagesInScriptedPublicationCss: Boolean = false, verticalOverflowMitigationStrategy: EpubContentOverflowStrategy = EpubContentOverflowStrategy.SCROLL)

Types

Companion

object Companion

Properties

horizontalOverflowMathMLStrategy

val horizontalOverflowMathMLStrategy: EpubContentOverflowStrategy

Which strategy to use for MathML elements that don't fit horizontally.

horizontalOverflowMitigationMinFontSize

val horizontalOverflowMitigationMinFontSize: Double = 16.0

When a word is too wide to fit on the page, it can either be broken into multiple lines or scaled down. This option sets the minimum font size to scale down to (independent of font scaling options set in the ReaderView). Note that the scale is applied to the element that contains the word, meaning that any text around it will also be scaled. If scaling to the minimum is not enough to fit the word, the style overflow-wrap: break-word; will also be applied, allowing the word to be broken up over more than one line.

horizontalOverflowTableStrategy

val horizontalOverflowTableStrategy: EpubContentOverflowStrategy

Which strategy to use for table elements that don't fit horizontally.

skipUnusedImagesInScriptedPublicationCss

val skipUnusedImagesInScriptedPublicationCss: Boolean = false

If set to true, background-images defined in the publication CSS that aren't used by any element in the initial DOM will be skipped. This can significantly reduce load time and memory usage for some publications.

verticalOverflowMitigationStrategy

val verticalOverflowMitigationStrategy: EpubContentOverflowStrategy

When a document has been paginated, there are some edge cases where the content will overflow vertically. This option allows you to control how those cases should be handled.

Functions

serialize

fun serialize(generator: JsonGenerator)