Options
All
  • Public
  • Public/Protected
  • All
Menu

Presents the publication as a book. Two pages are displayed at a time as a spread. You can configure the spread slot (left or right) for the first page using ReaderViewOptions.defaultStartPageSpreadSlot. The page animation resembles a flip book with 3D perspective.

Hierarchy

  • FlipBookRenderer

Implements

Index

Constructors

constructor

Methods

createRuntime

destroyRuntime

getName

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

    Returns string

getOptions

getSpreadMode

  • Get this renderer's spread mode.

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

    Returns RendererSpreadMode

getSupportedFlowModes

getVisiblePagesArea

  • getVisiblePagesArea(viewDimensions: IDimensions, preferredPageAspectRatio: number, allDocumentsFixedLayout: boolean): number
  • Get the total area (as css width * css height) this renderer can utilize for displaying pages with the given page aspect ratio, but without any chrome used by the renderer.

    Parameters

    • viewDimensions: IDimensions
    • preferredPageAspectRatio: number
    • allDocumentsFixedLayout: boolean

    Returns number

setOptions

  • 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