summaryrefslogtreecommitdiff
path: root/lib/epub.js/types/layout.d.ts
blob: 04d373d65c4d93021807bdf7a85c4758eb43798e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
import Contents from "./contents";

interface LayoutSettings {
  layout: string,
  spread: string,
  minSpreadWidth: number,
  evenSpreads: boolean
}

export default class Layout {
  constructor(settings: LayoutSettings);

  settings: LayoutSettings;
  name: string;
  props: {
    name: string,
    spread: string,
    flow: string,
    width: number,
    height: number,
    spreadWidth: number,
    delta: number,
    columnWidth: number,
    gap: number,
    divisor: number
  };

  flow(flow: string): string;

  spread(spread: string, min: number): boolean;

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

  format(contents: Contents): void | Promise<void>;

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

  // Event emitters
  emit(type: any, ...args: any[]): void;

  off(type: any, listener: any): any;

  on(type: any, listener: any): any;

  once(type: any, listener: any, ...args: any[]): any;

  private update(props: object): void;
}