Options
All
  • Public
  • Public/Protected
  • All
Menu

Describes if and how a renderer displays spreads.

This impacts which IRenderableDocumentPageStream implementation that is used to deliver IRenderableDocumentPage objects to a renderer.

Index

Enumeration members

Enumeration members

MIXED

MIXED = "MIXED"

The renderer can mix between center pages and left-right spreads. It can show either one or two IRenderableDocumentPage at a time. IRenderableDocumentPage are delivered with any PageSpreadSlot value.

SINGLE_PAGE

SINGLE_PAGE = "SINGLE_PAGE"

The renderer can only show one page at a time. Spreads are optionally supported using PAN or ZOOM gestures.

Two adjacent IRenderableDocumentPage objects with PageSpreadSlot.LEFT/PageSpreadSlot.RIGHT are intended to be rendered side by side. Otherwise PageSpreadSlot.AUTO will be used for all pages

TWO_PAGES

TWO_PAGES = "TWO_PAGES"

The renderer emulates a book and will always render content using two page spreads. It always has a "left" and "right" slot. The ReadingSystem will inject "empty" pages where necessary to align pages with "left" "right" as intended by the publication author. Empty pages will not be injected before the "first" page and not after the "last" page. In other words, the renderer may need to render the first page in the "right" slot and leave the "left" slot empty.

This mode does not support PageSpreadSlot.CENTER, these will be delivered with PageSpreadSlot.LEFT / RIGHT values

Generated using TypeDoc