Class Layout

constructor

• new Layout(settings: LayoutSettings): Layout

  Parameters

  • settings: LayoutSettings

  Returns Layout

_evenSpreads

_flow

_minSpreadWidth

_spread

columnWidth

delta

divisor

emit

gap

height

name

off

on

pageWidth

props

settings

spreadWidth

width

calculate

• calculate(_width: number, _height: number, _gap?: number): void

  Calculate the dimensions of the pagination

  Parameters

  • _width: number

    width of the rendering

  • _height: number

    height of the rendering

  • Optional_gap: number

    width of the gap between columns

  Returns void

count

• count(
      totalLength: number,
      pageLength?: number,
  ): { pages: number; spreads: number }

  Count number of pages

  Parameters

  • totalLength: number
  • OptionalpageLength: number

  Returns { pages: number; spreads: number }

flow

• flow(flow?: string): string

  Switch the flow between paginated and scrolled

  Parameters

  • Optionalflow: string

    paginated | scrolled

  Returns string

  simplified flow

format

• format(contents: Contents, section?: Section, axis?: string): void

  Apply Css to a Document

  Parameters

  • contents: Contents
  • Optionalsection: Section
  • Optionalaxis: string

  Returns void

spread

• spread(spread?: string, min?: number): boolean

  Switch between using spreads or not, and set the width at which they switch to single.

  Parameters

  • Optionalspread: string

    "none" | "always" | "auto"

  • Optionalmin: number

    integer in pixels

  Returns boolean

  spread true | false