readium-navigator/org.readium.r2.navigator.epub/EpubPreferences/EpubPreferences

EpubPreferences

constructor(backgroundColor: Color? = null, columnCount: ColumnCount? = null, fontFamily: FontFamily? = null, fontSize: Double? = null, fontWeight: Double? = null, hyphens: Boolean? = null, imageFilter: ImageFilter? = null, language: Language? = null, letterSpacing: Double? = null, ligatures: Boolean? = null, lineHeight: Double? = null, pageMargins: Double? = null, paragraphIndent: Double? = null, paragraphSpacing: Double? = null, publisherStyles: Boolean? = null, readingProgression: ReadingProgression? = null, scroll: Boolean? = null, spread: Spread? = null, textAlign: TextAlign? = null, textColor: Color? = null, textNormalization: Boolean? = null, theme: Theme? = null, typeScale: Double? = null, verticalText: Boolean? = null, wordSpacing: Double? = null)

Parameters

backgroundColor

Default page background color.

columnCount

Number of reflowable columns to display (one-page view or two-page spread).

fontFamily

Default typeface for the text.

fontSize

Base text font size.

fontWeight

Default boldness for the text.

hyphens

Enable hyphenation.

imageFilter

Filter applied to images in dark theme.

language

Language of the publication content.

letterSpacing

Space between letters.

ligatures

Enable ligatures in Arabic.

lineHeight

Leading line height.

pageMargins

Factor applied to horizontal margins.

paragraphIndent

Text indentation for paragraphs.

paragraphSpacing

Vertical margins for paragraphs.

publisherStyles

Indicates whether the original publisher styles should be observed. Many settings require this to be off.

readingProgression

Direction of the reading progression across resources.

scroll

Indicates if the overflow of resources should be handled using scrolling instead of synthetic pagination.

spread

Indicates if the fixed-layout publication should be rendered with a synthetic spread (dual-page).

textAlign

Page text alignment.

textColor

Default page text color.

textNormalization

Normalize text styles to increase accessibility.

theme

Reader theme.

typeScale

Scale applied to all element font sizes.

verticalText

Indicates whether the text should be laid out vertically. This is used for example with CJK languages. This setting is automatically derived from the language if no preference is given.

wordSpacing

Space between words.