Method: Playwright::Page#pdf

Defined in:

lib/playwright_api/page.rb

#pdf(displayHeaderFooter: nil, footerTemplate: nil, format: nil, headerTemplate: nil, height: nil, landscape: nil, margin: nil, pageRanges: nil, path: nil, preferCSSPageSize: nil, printBackground: nil, scale: nil, width: nil) ⇒ Object

Returns the PDF buffer.

> NOTE: Generating a pdf is currently only supported in Chromium headless.

‘page.pdf()` generates a pdf of the page with `print` css media. To generate a pdf with `screen` media, call

‘method: Page.emulateMedia`

before calling ‘page.pdf()`:

> NOTE: By default, ‘page.pdf()` generates a pdf with modified colors for printing. Use the [`-webkit-print-color-adjust`](developer.mozilla.org/en-US/docs/Web/CSS/-webkit-print-color-adjust) property to force rendering of exact colors.

“‘js // Generates a PDF with ’screen’ media type. await page.emulateMedia(‘screen’); await page.pdf(‘page.pdf’); “‘

“‘python async # generates a pdf with “screen” media type. await page.emulate_media(media=“screen”) await page.pdf(path=“page.pdf”) “`

“‘python sync # generates a pdf with “screen” media type. page.emulate_media(media=“screen”) page.pdf(path=“page.pdf”) “`

The ‘width`, `height`, and `margin` options accept values labeled with units. Unlabeled values are treated as pixels.

A few examples:

• ‘page.pdf(100)` - prints with width set to 100 pixels

• ‘page.pdf(’100px’)‘ - prints with width set to 100 pixels

• ‘page.pdf(’10cm’)‘ - prints with width set to 10 centimeters.

All possible units are:

• ‘px` - pixel

• ‘in` - inch

• ‘cm` - centimeter

• ‘mm` - millimeter

The ‘format` options are:

• ‘Letter`: 8.5in x 11in

• ‘Legal`: 8.5in x 14in

• ‘Tabloid`: 11in x 17in

• ‘Ledger`: 17in x 11in

• ‘A0`: 33.1in x 46.8in

• ‘A1`: 23.4in x 33.1in

• ‘A2`: 16.54in x 23.4in

• ‘A3`: 11.7in x 16.54in

• ‘A4`: 8.27in x 11.7in

• ‘A5`: 5.83in x 8.27in

• ‘A6`: 4.13in x 5.83in

> NOTE: ‘headerTemplate` and `footerTemplate` markup have the following limitations: > 1. Script tags inside templates are not evaluated. > 2. Page styles are not visible inside templates.

# File 'lib/playwright_api/page.rb', line 1079

def pdf(
      displayHeaderFooter: nil,
      footerTemplate: nil,
      format: nil,
      headerTemplate: nil,
      height: nil,
      landscape: nil,
      margin: nil,
      pageRanges: nil,
      path: nil,
      preferCSSPageSize: nil,
      printBackground: nil,
      scale: nil,
      width: nil)
  wrap_impl(@impl.pdf(displayHeaderFooter: unwrap_impl(displayHeaderFooter), footerTemplate: unwrap_impl(footerTemplate), format: unwrap_impl(format), headerTemplate: unwrap_impl(headerTemplate), height: unwrap_impl(height), landscape: unwrap_impl(landscape), margin: unwrap_impl(margin), pageRanges: unwrap_impl(pageRanges), path: unwrap_impl(path), preferCSSPageSize: unwrap_impl(preferCSSPageSize), printBackground: unwrap_impl(printBackground), scale: unwrap_impl(scale), width: unwrap_impl(width)))
end