If animations should be used or not by the renderer.
Ignore the calculated aspectRatio to take up as much of the available view space as possible.
Sets the maximum width of the renderer.
If a PERCENTAGE value is used, it will be based on the width of the ReaderView.
If a larger number than 100% of the ReaderView's width is passed, the ReaderView's width will be used.
Defaults to 100%
The name of the Renderer. This can be used to retrieve the Renderer from the ReaderView etc.
Defaults to generated name.
A CSS color to use as default page background.
This option describes how far from the bottom of the renderer's visible area the Reading Area will end.
The Reading Area defines the part of the renderer's visible area that will be used for calculations related to Reading Positions. If a SyncMediaPlayer is attached to the ReaderView and managed ReaderView synchronization is enabled, the Reading Area also has an impact on how the renderer synchronizes its visible content with the SyncMediaPlayer.
After a navigation using ReaderView.goTo(), or after scrolling so that the old Reading Position is outside the visible range, the new Reading Position will match the top of the Reading Area.
When SyncMediaPlayer playback causes the Reading Position to change, the renderer will, if necessary, automatically scroll to keep the Reading Position inside the Reading Area.
Any values lower than 0 will be treated as 0, and any values higher than 30% will be treated as 30%. If a PERCENTAGE value is set, the value will be a percentage of the renderer element's clientHeight.
Defaults to 20%
This option describes how far from the top of the renderer's visible area the Reading Area will start.
The Reading Area defines the part of the renderer's visible area that will be used for calculations related to Reading Positions. If a SyncMediaPlayer is attached to the ReaderView and managed ReaderView synchronization is enabled, the Reading Area also has an impact on how the renderer synchronizes its visible content with the SyncMediaPlayer.
After a navigation using ReaderView.goTo(), or after scrolling so that the old Reading Position is outside the visible range, the new Reading Position will match the top of the Reading Area.
When SyncMediaPlayer playback causes the Reading Position to change, the renderer will, if necessary, automatically scroll to keep the Reading Position inside the Reading Area.
Any values lower than 0 will be treated as 0, and any values higher than 30% will be treated as 30%. If a PERCENTAGE value is set, the value will be a percentage of the renderer element's clientHeight.
Defaults to 10%
The amount of time to spend on scrolling animations.
Sets the maximum scroll distance that will result in an animation. Scroll navigations longer than this distance will instead jump directly to the target location.
If a PERCENTAGE value is used, it will be based on the height of the ReaderView.
Defaults to 200%
Controls where the vertical scrollbar is placed.
Generated using TypeDoc
Common options for vertical scroll renderers.