Options
All
  • Public
  • Public/Protected
  • All
Menu

A Renderer is responsible for the presentation of the ReaderPublication within a ReaderView. For example, the StackRenderer presents the publication as a series of pages stacked on top of each other like a deck of cards.

Each Renderer implementation has its own set of options to controls its behavior and its visual aspects.

Renderers are added to a ReaderView using ReaderView.addRenderer(). See ReaderView.addRenderer for more information.

Hierarchy

  • IRenderer

Implemented by

Index

Methods

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

    Returns string

  • Get this renderer's spread mode.

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

    Returns RendererSpreadMode

  • 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

    Returns void

Generated using TypeDoc