IEpubContentBlockOptions | Colibrio Reader Framework API

Options used for configuring ContentBlocks in EpubReaderPublications.

Hierarchy

IEpubContentBlockOptions

Index

Properties

Optional attributeNamesThatCreateContentBlocks

attributeNamesThatCreateContentBlocks?: string[]

Attribute names that should always trigger a new ContentBlock to be created. Attributes defined in this list will be available even if disableDefaultAttributeFiltering is set to false.

NOTE: If you use TTS and you have multilingual documents, you should include lang and xml:lang so that this data is passed to the TtsSynthesizer.

NOTE: This option can only be set when calling ReadingSystemEngine.loadPublication(). It is NOT possible to change this option using ReaderPublication.setOptions().

If this field is null, then the following attributes will cause a new content block to be created:

'epub:type'
'role'
'lang'
'xml:lang'
'itemscope'
'itemprop'
'itemid'
'itemref'
'itemtype'
'vocab'
'typeof'
'property'
'id'

default: null

Optional disableDefaultAttributeFiltering

disableDefaultAttributeFiltering?: boolean

If set to true, the default attribute filtering is disabled. This means that all attributes will be available in ContentBlocks.

Attributes set in attributeNamesThatCreateContentBlocks are always available regardless of this option.

NOTE: This option can only be set when calling ReadingSystemEngine.loadPublication(). It is NOT possible to change this option using ReaderPublication.setOptions().

default: false

Optional includeMathMlContentBlocks

includeMathMlContentBlocks?: boolean

If set to true, the ContentBlockTree will include MathML related content blocks. NOTE: This option can only be set when calling ReadingSystemEngine.loadPublication(). It is NOT possible to change this option using ReaderPublication.setOptions().

default: false

Optional includePreContentBlocks

includePreContentBlocks?: boolean

If set to true, the ContentBlockTree will include

content blocks. NOTE: This option can only be set when calling ReadingSystemEngine.loadPublication(). It is NOT possible to change this option using ReaderPublication.setOptions().

default: false