IEpubSelectorDocumentSectioningAlgorithm | Colibrio Reader Framework API

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

Hierarchy

IEpubDocumentSectioningAlgorithm
- IEpubSelectorDocumentSectioningAlgorithm

Index

Properties

Optional disableSectioningInsideSelector

disableSectioningInsideSelector?: string

Disable sectioning inside elements that match this selector.

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

Optional minimumCharactersPerSection

minimumCharactersPerSection?: number

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

int
default: 10000

Optional selectors

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 }, ]

nodefault

type

type: SELECTOR

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