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.
Sets if content document scripting should be allowed. Content documents with scripts executes inside a sandbox iframe.
Options controlling clipboard actions.
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().
Extra CSS to inject into all content documents of the publication. This can be used to fix publications with problematic CSS.
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.
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.
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:
Options controlling which publicationStyleOptions set by calling ReaderView.setOptions() that should apply to
fixed-layout documents.
If "pointermove" PointerEngineEvents should include the contentLocation property.
Defaults to false.
Options related with EPUB media overlays
The algorithm to use for estimating the number of pages in content documents. Note: This option is only checked when calling load publication.
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 ColibrioView.setAllowedCalloutActions() instead.
If the default context-menu should be prevented when right-clicking or long pressing: images, video or audio elements
Sets if users should be able to "drag-and-drop" content from the publication.
Options configuring how the reflow engine divide content documents into pages. These options will be further documented in a future version of the framework.
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.
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.
Options related to splitting up text nodes in order to increase performance when reflowing an EPUB that has very long text nodes.
Generated using TypeDoc
Options related to processing and presentation of EPUB publications.