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

    Interface IEpubReaderPublicationOptions

    Options related to processing and presentation of EPUB publications.

    interface IEpubReaderPublicationOptions {
        additionalLocatorUrls?: string[];
        allowAudioElementAutoplay?: boolean;
        allowDocumentScripting?: boolean;
        allowVideoElementAutoplay?: boolean;
        clipboardOptions?: IReaderPublicationClipboardOptions;
        contentBlockOptions?: IEpubContentBlockOptions;
        contentProcessingOptions?: IEpubContentProcessingOptions;
        customPublicationCss?: IEpubReaderPublicationCustomCssOptions;
        defaultLocatorUrl?: string;
        documentSectioningOptions?: IEpubDocumentSectioningOptions;
        elementWhitelistOptions?: IEpubElementWhitelistOptions;
        enableMediaStreaming?: boolean;
        fixedLayoutStyleOptions?: IEpubFixedLayoutStyleOptions;
        includeContentLocationInPointerMoveEvents?: boolean;
        mediaOverlayOptions?: IEpubMediaOverlayOptions;
        pageCountEstimationAlgorithm?: EpubPageCountEstimationAlgorithm;
        preventDefaultContextMenu?: boolean;
        preventDefaultContextMenuOnMediaElements?: boolean;
        preventDragAndDropActions?: boolean;
        reflowOptions?: IEpubReflowOptions;
        remoteResourcesNonScriptedDocumentsOptions?: IEpubRemoteResourceOptions;
        remoteResourcesScriptedDocumentsOptions?: IEpubRemoteResourceOptions;
        textSplitOptions?: IEpubTextNodeSplitOptions;
    }

    Hierarchy (View Summary)

    Properties

    additionalLocatorUrls?: string[]

    Additional locator URLs that should resolve to the ReaderPublication when calling methods with locator parameters, such as ReaderView.goTo(), ReaderViewAnnotationLayer.createAnnotation()

    This can be useful when loading Locator data such as web annotation data from third party services or other applications.

    []
    allowAudioElementAutoplay?: boolean

    If <audio> elements are allowed to autoplay if they have the "autoplay" attribute.

    true
    allowDocumentScripting?: boolean

    Sets if content document scripting should be allowed. Content documents with scripts executes inside a sandbox iframe.

    true
    allowVideoElementAutoplay?: boolean

    If <video> elements are allowed to autoplay if they have the "autoplay" attribute.

    true
    clipboardOptions?: IReaderPublicationClipboardOptions

    Options controlling clipboard actions.

    IReaderPublicationClipboardOptions
    contentBlockOptions?: IEpubContentBlockOptions

    Options used for configuring ContentBlocks in this ReaderPublication.

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

    IEpubContentBlockOptions
    contentProcessingOptions?: IEpubContentProcessingOptions

    A collection of options related to content processing that do not belong in any specific category.

    IEpubContentProcessingOptions
    customPublicationCss?: IEpubReaderPublicationCustomCssOptions

    Extra CSS to inject into all content documents of the publication. This can be used to fix publications with problematic CSS.

    IEpubReaderPublicationCustomCssOptions
    defaultLocatorUrl?: string

    The base URL that should be used by the ReaderPublication when it creates new Locators.

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

    If not specified, it will be generated based on the Publication's hash signature. (See IPublication.getHashSignature()) See the publication format implementation (EpubReaderPublication, PdfReaderPublication, etc) for details on how the defaultLocatorUrl is generated.

    documentSectioningOptions?: IEpubDocumentSectioningOptions

    Options controlling how reflowable documents can be split into sections prior to reflowing. This can greatly increase performance for publications with very long content documents. The downside is that each split will look like a page break in the rendered content. To mitigate the impact of these page breaks on the reading experience, you can control where and how often these breaks will occur by using these options.

    IEpubDocumentSectioningOptions
    elementWhitelistOptions?: IEpubElementWhitelistOptions

    All Elements and Attributes in reflowable content-documents are processed through a whitelist filter to prevent unsafe scripting.

    The built-in whitelist contains all HTML, SVG elements and attributes that Colibrio has determined as safe. This option object allows you to define additional elements and attributes that should be whitelisted.

    IEpubElementWhitelistOptions
    enableMediaStreaming?: boolean

    If streaming of audio and video using the Media Source Extensions API (MSE) should be used. See https://developer.mozilla.org/en-US/docs/Web/API/Media_Source_Extensions_API

    If set to true, audio and video will be streamed if:

    • The Media Source Extensions API is available in the browser.
    • The media resource is encoded in a format supported by the browser and the ReadingSystemEngine.
    false
    fixedLayoutStyleOptions?: IEpubFixedLayoutStyleOptions

    Options controlling which publicationStyleOptions set by calling ReaderView.setOptions() that should apply to fixed-layout documents.

    IEpubFixedLayoutStyleOptions
    includeContentLocationInPointerMoveEvents?: boolean

    If "pointermove" PointerEngineEvents should include the contentLocation property.

    Defaults to false.

    false
    mediaOverlayOptions?: IEpubMediaOverlayOptions

    Options related with EPUB media overlays

    IEpubMediaOverlayOptions
    pageCountEstimationAlgorithm?: EpubPageCountEstimationAlgorithm

    The algorithm to use for estimating the number of pages in content documents. Note: This option is only checked when calling load publication.

    IEpubFileSizePageCountEstimationAlgorithm
    preventDefaultContextMenu?: boolean

    If set to true, the reading system will prevent the default "right-click" and "long-press" context menus to be shown for publication content.

    In order to prevent the default "right-click" and "long-press" context menus for your app content, you need to listen on the browser contextmenu event and call event.preventDefault();

    IMPORTANT: Please note that this option does not work on iOS and iPadOS. There is no Web API available to prevent the context menu from being shown on those platforms. A workaround is to disable user content selection with ReaderView.setContentSelectionEnabled(false).

    If you are using the Colibrio Reader Framework for iOS, then please use ColibrioReadingSystemView.setAllowedCalloutActions() instead.

    false
    preventDefaultContextMenuOnMediaElements?: boolean

    If the default context-menu should be prevented when right-clicking or long pressing: images, video or audio elements

    false
    preventDragAndDropActions?: boolean

    Sets if users should be able to "drag-and-drop" content from the publication.

    true
    reflowOptions?: IEpubReflowOptions

    Options configuring how the reflow engine divide content documents into pages. These options will be further documented in a future version of the framework.

    IEpubReflowOptions
    remoteResourcesNonScriptedDocumentsOptions?: IEpubRemoteResourceOptions

    Options for controlling remote resources in the publication for non-scripted content-documents.

    Please note that you may need to specify directives in your app's Content-Security-Policy as a element or as an HTTP header as well since these are inherited by child iframes used for rendering content-documents.

    IEpubRemoteResourceOptions
    remoteResourcesScriptedDocumentsOptions?: IEpubRemoteResourceOptions

    Options for controlling remote resources in the publication for scripted content-documents.

    Please note that you may need to specify directives in your app's Content-Security-Policy as a element or as an HTTP header as well since these are inherited by child iframes used for rendering content-documents.

    IEpubRemoteResourceOptions
    textSplitOptions?: IEpubTextNodeSplitOptions

    Options related to splitting up text nodes in order to increase performance when reflowing an EPUB that has very long text nodes.

    IEpubTextNodeSplitOptions
    Properties