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

PublicationStyleOptions

data class PublicationStyleOptions(val defaultFontFamily: PublicationStyleOptionsDefaultFontFamily = PublicationStyleOptionsDefaultFontFamily.SERIF, val fontSet: PublicationStyleFontSet? = null, val fontSizeScaleFactor: Double = 1.0, val lineHeightScaleFactor: Double = 1.0, val pageMargins: RectMargins? = null, val palette: PublicationStylePalette? = null, val textAlignment: PublicationStyleTextAlignmentOptions? = null)

Allows you to set styling options of the rendered publication.

Note that support depends on the publication format. Fixed-layout formats such as PDF and fixed-layout EPUB will by default NOT be affected by these options, with the exception of defaultFontFamily (see defaultFontFamily documentation). Some of these options can be enabled for fixed-layout EPUBs by setting IEpubReaderPublicationOptions.fixedLayoutStyleOptions.

Constructors

fun PublicationStyleOptions(defaultFontFamily: PublicationStyleOptionsDefaultFontFamily = PublicationStyleOptionsDefaultFontFamily.SERIF, fontSet: PublicationStyleFontSet? = null, fontSizeScaleFactor: Double = 1.0, lineHeightScaleFactor: Double = 1.0, pageMargins: RectMargins? = null, palette: PublicationStylePalette? = null, textAlignment: PublicationStyleTextAlignmentOptions? = null)

Types

Companion

object Companion

Functions

serialize

fun serialize(generator: JsonGenerator)

Properties

defaultFontFamily

val defaultFontFamily: PublicationStyleOptionsDefaultFontFamily

The default font-family to use for documents that has does not defined a font-family. Defaults to 'serif'

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.

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.

textAlignment

val textAlignment: PublicationStyleTextAlignmentOptions? = null

Allows overriding the text alignment used in the publication