IEpubContentProcessingOptions | Colibrio Reader Framework API

Hierarchy

IEpubContentProcessingOptions

Index

Properties

Optional horizontalOverflowMathMLStrategy

horizontalOverflowMathMLStrategy?: EpubContentOverflowStrategy

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

If set to SCROLL: Math elements ( $or elements with$ display: math) will be allowed to scroll horizontally when they are overflowing.

If set to SCALE: The elements will instead be scaled down to fit on the screen.

default: EpubContentOverflowStrategy.SCROLL

Optional horizontalOverflowMitigationMinFontSize

horizontalOverflowMitigationMinFontSize?: number

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.

double
default: 16

Optional horizontalOverflowTableStrategy

horizontalOverflowTableStrategy?: EpubContentOverflowStrategy

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

If set to SCROLL: Table elements (

or elements with display: table or display: inline-table) will be allowed to scroll horizontally when they are overflowing.

If set to SCALE: The elements will instead be scaled down to fit on the screen.

default: SCROLL

Optional skipUnusedImagesInScriptedPublicationCss

skipUnusedImagesInScriptedPublicationCss?: boolean

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.

This option should be set to false if the publication contains scripted content documents that inserts elements into the document dynamically.

Note: If you set this option to true, and scripted content documents adds elements or classes that references CSS background-images, then those images will not load.

This option only affects scripted content documents. For non-scripted documents, unused background-images in the CSS are always skipped.

default: false

Optional verticalOverflowMitigationStrategy

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.

If set to SCALE, the page will be scaled down until all content fits in the viewport.

If set to SCROLL, the page will be allowed to scroll vertically so that all content can be viewed.

default: SCROLL

Generated using TypeDoc