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

    Interface IEpubSelectorDocumentSectioningAlgorithm

    Split into sections based on CSS selectors. For example, it can be used to create a new section before <h1> and <h2> elements.

    interface IEpubSelectorDocumentSectioningAlgorithm {
        disableSectioningInsideSelector?: string;
        minimumCharactersPerSection?: number;
        selectors?: IEpubDocumentSectioningSelector[];
        type: SELECTOR;
    }

    Hierarchy (View Summary)

    Properties

    disableSectioningInsideSelector?: string

    Disable sectioning inside elements that match this selector.

    Note: Elements matching IEpubReaderPublicationOptions.reflowOptions.fragmentableElements.blacklistSelectors are also used to prevent sectioning inside them, in addition to the selectors defined here.

    aside, blockquote, details, dialog, dl, figure, form, math, menu, nav, ol, pre, svg, table, ul
    minimumCharactersPerSection?: number

    The minimum number of characters (Unicode code-points) per section.

    20000
    selectors?: IEpubDocumentSectioningSelector[]

    An ordered list of IEpubDocumentSectioningSelector used to find section breaks.

    The algorithm will first find break positions using the first selector. If there are still long sections after that, the second selector will be used to split these up, and so on until all selectors have been considered.

    Defaults to: [ { selector: "h1", breakPosition: SectionBreakPosition.BEFORE }, { selector: "h2", breakPosition: SectionBreakPosition.BEFORE }, { selector: "h3", breakPosition: SectionBreakPosition.BEFORE }, ]

    type: SELECTOR

    The type of document sectioning algorithm. Can be used to determine the subtype of IEpubDocumentSectioningAlgorithm.

    EpubDocumentSectioningAlgorithmType

    Properties