Page.PdfOptions (Playwright - Main Library 1.26.0 API)

java.lang.Object
- com.microsoft.playwright.Page.PdfOptions

Enclosing interface:: Page

public static class Page.PdfOptions
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`Boolean`	`displayHeaderFooter` Display header and footer.
`String`	`footerTemplate` HTML template for the print footer.
`String`	`format` Paper format.
`String`	`headerTemplate` HTML template for the print header.
`String`	`height` Paper height, accepts values labeled with units.
`Boolean`	`landscape` Paper orientation.
`Margin`	`margin` Paper margins, defaults to none.
`String`	`pageRanges` Paper ranges to print, e.g., '1-5, 8, 11-13'.
`Path`	`path` The file path to save the PDF to.
`Boolean`	`preferCSSPageSize` Give any CSS `@page` size declared in the page priority over what is declared in `width` and `height` or `format` options.
`Boolean`	`printBackground` Print background graphics.
`Double`	`scale` Scale of the webpage rendering.
`String`	`width` Paper width, accepts values labeled with units.

Constructor Summary

Constructors
Constructor and Description

PdfOptions()

Constructors
Constructor and Description
`PdfOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Page.PdfOptions`	`setDisplayHeaderFooter(boolean displayHeaderFooter)` Display header and footer.
`Page.PdfOptions`	`setFooterTemplate(String footerTemplate)` HTML template for the print footer.
`Page.PdfOptions`	`setFormat(String format)` Paper format.
`Page.PdfOptions`	`setHeaderTemplate(String headerTemplate)` HTML template for the print header.
`Page.PdfOptions`	`setHeight(String height)` Paper height, accepts values labeled with units.
`Page.PdfOptions`	`setLandscape(boolean landscape)` Paper orientation.
`Page.PdfOptions`	`setMargin(Margin margin)` Paper margins, defaults to none.
`Page.PdfOptions`	`setPageRanges(String pageRanges)` Paper ranges to print, e.g., '1-5, 8, 11-13'.
`Page.PdfOptions`	`setPath(Path path)` The file path to save the PDF to.
`Page.PdfOptions`	`setPreferCSSPageSize(boolean preferCSSPageSize)` Give any CSS `@page` size declared in the page priority over what is declared in `width` and `height` or `format` options.
`Page.PdfOptions`	`setPrintBackground(boolean printBackground)` Print background graphics.
`Page.PdfOptions`	`setScale(double scale)` Scale of the webpage rendering.
`Page.PdfOptions`	`setWidth(String width)` Paper width, accepts values labeled with units.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - displayHeaderFooter
```
public Boolean displayHeaderFooter
```
    Display header and footer. Defaults to false.
  - footerTemplate
```
public String footerTemplate
```
    HTML template for the print footer. Should use the same format as the headerTemplate.
  - format
```
public String format
```
    Paper format. If set, takes priority over width or height options. Defaults to 'Letter'.
  - headerTemplate
```
public String headerTemplate
```
    HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them:
    - "date" formatted print date
    - "title" document title
    - "url" document location
    - "pageNumber" current page number
    - "totalPages" total pages in the document
  - height
```
public String height
```
    Paper height, accepts values labeled with units.
  - landscape
```
public Boolean landscape
```
    Paper orientation. Defaults to false.
  - margin
```
public Margin margin
```
    Paper margins, defaults to none.
  - pageRanges
```
public String pageRanges
```
    Paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means print all pages.
  - path
```
public Path path
```
    The file path to save the PDF to. If path is a relative path, then it is resolved relative to the current working directory. If no path is provided, the PDF won't be saved to the disk.
  - preferCSSPageSize
```
public Boolean preferCSSPageSize
```
    Give any CSS @page size declared in the page priority over what is declared in width and height or format options. Defaults to false, which will scale the content to fit the paper size.
  - printBackground
```
public Boolean printBackground
```
    Print background graphics. Defaults to false.
  - scale
```
public Double scale
```
    Scale of the webpage rendering. Defaults to 1. Scale amount must be between 0.1 and 2.
  - width
```
public String width
```
    Paper width, accepts values labeled with units.
- Constructor Detail
  - PdfOptions
```
public PdfOptions()
```
- Method Detail
  - setDisplayHeaderFooter
```
public Page.PdfOptions setDisplayHeaderFooter(boolean displayHeaderFooter)
```
    Display header and footer. Defaults to false.
  - setFooterTemplate
```
public Page.PdfOptions setFooterTemplate(String footerTemplate)
```
    HTML template for the print footer. Should use the same format as the headerTemplate.
  - setFormat
```
public Page.PdfOptions setFormat(String format)
```
    Paper format. If set, takes priority over width or height options. Defaults to 'Letter'.
  - setHeaderTemplate
```
public Page.PdfOptions setHeaderTemplate(String headerTemplate)
```
    HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them:
    - "date" formatted print date
    - "title" document title
    - "url" document location
    - "pageNumber" current page number
    - "totalPages" total pages in the document
  - setHeight
```
public Page.PdfOptions setHeight(String height)
```
    Paper height, accepts values labeled with units.
  - setLandscape
```
public Page.PdfOptions setLandscape(boolean landscape)
```
    Paper orientation. Defaults to false.
  - setMargin
```
public Page.PdfOptions setMargin(Margin margin)
```
    Paper margins, defaults to none.
  - setPageRanges
```
public Page.PdfOptions setPageRanges(String pageRanges)
```
    Paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means print all pages.
  - setPath
```
public Page.PdfOptions setPath(Path path)
```
    The file path to save the PDF to. If path is a relative path, then it is resolved relative to the current working directory. If no path is provided, the PDF won't be saved to the disk.
  - setPreferCSSPageSize
```
public Page.PdfOptions setPreferCSSPageSize(boolean preferCSSPageSize)
```
    Give any CSS @page size declared in the page priority over what is declared in width and height or format options. Defaults to false, which will scale the content to fit the paper size.
  - setPrintBackground
```
public Page.PdfOptions setPrintBackground(boolean printBackground)
```
    Print background graphics. Defaults to false.
  - setScale
```
public Page.PdfOptions setScale(double scale)
```
    Scale of the webpage rendering. Defaults to 1. Scale amount must be between 0.1 and 2.
  - setWidth
```
public Page.PdfOptions setWidth(String width)
```
    Paper width, accepts values labeled with units.

Class Page.PdfOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

displayHeaderFooter

footerTemplate

format

headerTemplate

height

landscape

margin

pageRanges

path

preferCSSPageSize

printBackground

scale

width

Constructor Detail

PdfOptions

Method Detail

setDisplayHeaderFooter

setFooterTemplate

setFormat

setHeaderTemplate

setHeight

setLandscape

setMargin

setPageRanges

setPath

setPreferCSSPageSize

setPrintBackground

setScale

setWidth