Class ContinuousScrollRenderer

A renderer that shows all documents in a single vertical scrolling view.

Implements

IRenderer

Constructors

constructor

new ContinuousScrollRenderer(
options?: IContinuousScrollRendererOptions,
): ContinuousScrollRenderer
Parameters
- Optionaloptions: IContinuousScrollRendererOptions
Returns ContinuousScrollRenderer

Methods

getName

getName(): string
Get the name of the renderer.

Returns string
Implementation of IRenderer.getName

getOptions

getOptions(): IRendererOptions
Get the currently used options for this renderer.

Returns IRendererOptions
Implementation of IRenderer.getOptions

getSpreadMode

getSpreadMode(): RendererSpreadMode
Get this renderer's spread mode.

This will affect how IRenderableDocumentPage objects are delivered to the renderer. See RendererSpreadMode for more information.

Returns RendererSpreadMode
Implementation of IRenderer.getSpreadMode

getSupportedFlowModes

getSupportedFlowModes(): (PAGINATED | SCROLLED_CONTINUOUS | SCROLLED_DOC)[]
Get the supported flow mode for this renderer.

Returns (PAGINATED | SCROLLED_CONTINUOUS | SCROLLED_DOC)[]
Implementation of IRenderer.getSupportedFlowModes

getVisiblePagesArea

getVisiblePagesArea(
    viewDimensions: IDimensions,
    configuredPageAspectRatio: AspectRatioType,
    _publicationPreferredAspectRatio: number,
    _allFxl: boolean,
): number
Parameters
- viewDimensions: IDimensions
- configuredPageAspectRatio: AspectRatioType
- _publicationPreferredAspectRatio: number
- _allFxl: boolean
Returns number

setOptions

setOptions(options: IContinuousScrollRendererOptions): void
Overwrites previously set options using values from the passed object, preserving existing values if they aren't defined in the passed object.

The new options won't be used for already rendered content until ReaderView.refresh() has been called.
Parameters
- options: IContinuousScrollRendererOptions
Returns void
Implementation of IRenderer.setOptions