API reference / Common / LayoutMode

Type Alias: LayoutMode

type LayoutMode = 
  | "singlePage"
  | "doublePage"
  | "doublePageOddRight"
  | "doublePageOddLeft";

How the arrangement groups pages into spreads — the pages shown side by side as one unit, stacked one spread under the next. A layout setting the host declares on the plane, like the page gap; a plane with no page stack ignores it. Orthogonal to the camera's ScrollMode, which only decides whether the view scrolls through the spreads or shows one at a time.

The variants name pages 1-based, as a reader counts them. In a two-page layout a lone page (a cover, or the last page) keeps its side, facing an empty slot as wide as itself.

Crosses the host boundary by name ("singlePage", "doublePage", …).