If true, engine events will be emitted for DOM events targeting the ReaderView element or any descendant. If false, engine events will be emitted for all DOM events within the global window scope.
The default page aspect ratio as (width / height) to use when it cannot be detected from the publication.
Defaults to 10 / 15
The default page progression direction to use if not defined by the publication.
The default PageSpreadSlot to use for the first content document in publications if the publication does not define it. This option has no effect if the publication defines a SpreadSlot for the first content document, or when the activeRenderer cannot display spreads.
Possible values:
If set to false, "pointermove" events are only emitted between "pointerdown" and "pointerup" events. If set to true, all "pointermove" events will be emitted, for example when moving the mouse without pressing any button.
Force a page aspect ratio (width / height).
Force a specific page progression direction to be used.
Options related to gestures (such as pan-zoom) in the ReaderView.
The unique name of this ReaderView. You can fetch a ReaderView by name from the ReadingSystemEngine object.
Options related with the PageProgressionTimeline.
Allows to set various styling options when rendering the publication such as fonts and color palettes.
The delay in milliseconds until a call to refresh() will actually cause a refresh. Multiple calls to refresh() within this delay will be merged into a single refresh call.
Note: When performing a forced refresh using refresh(true), this value is ignored. The refresh will occur on next tick.
A renderer transition happens when the activeRenderer changes, or a refresh() call requires the activeRenderer to re-layout its content. Normally the renderer transition will start when visible content has finished rendering.
This option controls the duration of the fade-in animation.
Default is null which will use values specific to the platform type: 'mobile', 'tablet' or 'desktop'. Setting this value to 0 disables the animation.
A renderer transition happens when the activeRenderer changes, or a refresh() call requires the activeRenderer to re-layout its content. Normally the renderer transition will start when visible content has finished rendering.
This option controls the maximum time to wait for visible content to render before starting the renderer transition anyway. Setting this to 0 will cause the renderer transition to start immediately and will cause loaders to show until pages have rendered.
To change the loader animation you can use ReaderView.setContentOnLoading().
Options related to the transform manager.
Generated using TypeDoc
Options for changing the behavior and appearance of a ReaderView.