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

PublicationStyleOptions

data class PublicationStyleOptions(val defaultFontFamily: PublicationStyleOptionsDefaultFontFamily = PublicationStyleOptionsDefaultFontFamily.SERIF, val disableCssAnimations: Boolean = false, val fontSet: PublicationStyleFontSet? = null, val fontSizeScaleFactor: Double = 1.0, val letterSpacing: Length? = null, val lineHeightScaleFactor: Double = 1.0, val pageMargins: RectMargins? = null, val palette: PublicationStylePalette? = null, val hyphens: Hyphens? = null, val removePublicationDefinedHorizontalPageMargins: Boolean = false, val textAlignment: PublicationStyleTextAlignmentOptions? = null, val typographyResetOptions: PublicationStyleTypographyResetOptions = PublicationStyleTypographyResetOptions(), val wordSpacing: Length? = null)

Defines styling options for customizing the appearance of the rendered publication.

Note that support for these options depends on the publication format. By default, they do not apply to fixed-layout formats (such as PDF and fixed-layout EPUB), with the exception of defaultFontFamily (see property documentation for details).

Some of these options can be enabled for fixed-layout EPUBs by configuring IEpubReaderPublicationOptions.fixedLayoutStyleOptions.

Constructors

PublicationStyleOptions

constructor(defaultFontFamily: PublicationStyleOptionsDefaultFontFamily = PublicationStyleOptionsDefaultFontFamily.SERIF, disableCssAnimations: Boolean = false, fontSet: PublicationStyleFontSet? = null, fontSizeScaleFactor: Double = 1.0, letterSpacing: Length? = null, lineHeightScaleFactor: Double = 1.0, pageMargins: RectMargins? = null, palette: PublicationStylePalette? = null, hyphens: Hyphens? = null, removePublicationDefinedHorizontalPageMargins: Boolean = false, textAlignment: PublicationStyleTextAlignmentOptions? = null, typographyResetOptions: PublicationStyleTypographyResetOptions = PublicationStyleTypographyResetOptions(), wordSpacing: Length? = null)

Types

Companion

object Companion

Properties

defaultFontFamily

val defaultFontFamily: PublicationStyleOptionsDefaultFontFamily

The default font-family to use for documents that do not define a font-family. Defaults to 'serif'

disableCssAnimations

val disableCssAnimations: Boolean = false

Determines whether CSS animations and transitions should be disabled in the rendered publication.

fontSet

val fontSet: PublicationStyleFontSet? = null

NOTE: This interface is being simplified to be easier to use and will be released in an upcoming release.

fontSizeScaleFactor

val fontSizeScaleFactor: Double = 1.0

Applies font-size scaling to the rendered publication. This is typically only supported on reflowable content documents and ignored otherwise.

hyphens

val hyphens: Hyphens? = null

Allows overriding the hyphenation behavior of the text in the publication.

letterSpacing

val letterSpacing: Length? = null

Controls the spacing between letters.

lineHeightScaleFactor

val lineHeightScaleFactor: Double = 1.0

Applies line-height scaling to the rendered publication. This is typically only supported on reflowable content documents and ignored otherwise.

pageMargins

val pageMargins: RectMargins? = null

Sets the individual page margins. This is typically only supported on reflowable content documents and ignored otherwise.

palette

val palette: PublicationStylePalette? = null

Allows you to override the palette used for rendering the publication.

removePublicationDefinedHorizontalPageMargins

val removePublicationDefinedHorizontalPageMargins: Boolean = false

When this option is enabled, the horizontal page margin and padding defined in the publication CSS are removed.

textAlignment

val textAlignment: PublicationStyleTextAlignmentOptions? = null

Allows overriding the text alignment used in the publication

typographyResetOptions

val typographyResetOptions: PublicationStyleTypographyResetOptions

Various options for removing publication defined style rules related to fonts and typography.

wordSpacing

val wordSpacing: Length? = null

Controls the spacing between words.

Functions

serialize

fun serialize(generator: JsonGenerator)