Colibrio Reader Framework API - Cloud license
    Preparing search index...

    Interface IEpubReflowPluginOptions

    interface IEpubReflowPluginOptions {
        cssForcedPageBreak?: boolean;
        customCssValuePenalizer?: ICustomCssValuePenalizerOptions;
        customElementPenalizer?: ICustomElementPenalizerOptions;
        customForcedPageBreak?: ICustomForcedPageBreakOptions;
        floatingOrphanPenalizer?: IFloatingOrphanPenalizerOptions;
        fragmentableElements?: IFragmentableElementsOptions;
        listBreak?: IListBreakOptions;
        mediaShrink?: IMediaShrinkReflowPluginOptions;
        orphanTextPattern?: IOrphanTextPatternOptions;
        unforcedTextBreak?: IUnforcedTextBreakOptions;
        verticalWhitespacePenalizer?: IVerticalWhitespacePenalizerOptions;
    }

    Properties

    cssForcedPageBreak?: boolean

    If enabled, apply forced page-breaks, or avoid soft page-breaks based on the CSS declarations 'page-break-before', 'page-break-after' if equal to one of: 'left', 'right', 'always', 'page', 'verso', 'recto'

    true
    customCssValuePenalizer?: ICustomCssValuePenalizerOptions

    Add soft page-break penalties based on CSS declarations.

    customElementPenalizer?: ICustomElementPenalizerOptions

    Add soft page-break penalties based on CSS selectors.

    customForcedPageBreak?: ICustomForcedPageBreakOptions

    Add forced page-breaks to elements by selector

    floatingOrphanPenalizer?: IFloatingOrphanPenalizerOptions

    Adds penalties to soft page-breaks immediately after floating elements.

    fragmentableElements?: IFragmentableElementsOptions

    Defines which elements that are allowed to be fragmented.

    listBreak?: IListBreakOptions

    Configures penalties when fragmenting lists.

    mediaShrink?: IMediaShrinkReflowPluginOptions

    Configures how to shrink images to improve page breaks.

    orphanTextPattern?: IOrphanTextPatternOptions

    Configures RegExp to give orphan penalties.

    unforcedTextBreak?: IUnforcedTextBreakOptions

    Configures penalties when fragmenting text.

    verticalWhitespacePenalizer?: IVerticalWhitespacePenalizerOptions

    Configures penalties based on throw much vertical whitespace that is left after applying a page-break.

    Properties