Type alias GeneratePDFOptions

Type declaration

• body: {
      html: string;
  }

  The HTML to render as a pdf

  • html: string

• Optional footer?: {
      html: string;
  }

  The HTML to render at the bottom of every page

  • html: string

• Optional header?: {
      html: string;
  }

  The HTML to render at the top of every page

  • html: string

• Optional page?: {
      margins?: {
          bottom?: string;
          left?: string;
          right?: string;
          top?: string;
      };
      orientation?: "Portrait" | "Landscape";
      size?: FormSubmissionPDFPageSize | "Legal" | "Tabloid" | "Ledger" | "A0" | "A1" | "A2" | "A3" | "A5" | "A6";
  }

  • Optional margins?: {
        bottom?: string;
        left?: string;
        right?: string;
        top?: string;
    }

    • Optional bottom?: string

      How much space between the right of each page and the content. Supported dimension units are: 'mm', 'cm', 'in', 'px'

    • Optional left?: string

      How much space between the left of each page and the content. Supported dimension units are: 'mm', 'cm', 'in', 'px'

    • Optional right?: string

      How much space between the right of each page and the content. Supported dimension units are: 'mm', 'cm', 'in', 'px'

    • Optional top?: string

      How much space between the top of each page and the content. Supported dimension units are: 'mm', 'cm', 'in', 'px'

  • Optional orientation?: "Portrait" | "Landscape"

    'Portrait' or 'Landscape'. Default is 'Portrait'

  • Optional size?: FormSubmissionPDFPageSize | "Legal" | "Tabloid" | "Ledger" | "A0" | "A1" | "A2" | "A3" | "A5" | "A6"

    'Letter', 'Legal', 'Tabloid', 'Ledger', 'A0', 'A1', 'A2', 'A3', 'A4', 'A5' or 'A6'. Default is 'A4'