chrome-devtools-kotlin/org.hildan.chrome.devtools.domains.page/PrintToPDFRequest/Builder

Builder

A builder for PrintToPDFRequest, which allows setting the optional parameters of the PageDomain.printToPDF command via a lambda.

Constructors

constructor()

Properties

displayHeaderFooter

var displayHeaderFooter: Boolean?

Display header and footer. Defaults to false.

var footerTemplate: String?

HTML template for the print footer. Should use the same format as the headerTemplate.

generateDocumentOutline

var generateDocumentOutline: Boolean?

Whether or not to embed the document outline into the PDF.

generateTaggedPDF

var generateTaggedPDF: Boolean?

Whether or not to generate tagged (accessible) PDF. Defaults to embedder choice.

var headerTemplate: String?

HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them:

var landscape: Boolean?

Paper orientation. Defaults to false.

var marginBottom: Double?

Bottom margin in inches. Defaults to 1cm (~0.4 inches).

var marginLeft: Double?

Left margin in inches. Defaults to 1cm (~0.4 inches).

var marginRight: Double?

Right margin in inches. Defaults to 1cm (~0.4 inches).

var marginTop: Double?

Top margin in inches. Defaults to 1cm (~0.4 inches).

var pageRanges: String?

Paper ranges to print, one based, e.g., '1-5, 8, 11-13'. Pages are printed in the document order, not in the order specified, and no more than once. Defaults to empty string, which implies the entire document is printed. The page numbers are quietly capped to actual page count of the document, and ranges beyond the end of the document are ignored. If this results in no pages to print, an error is reported. It is an error to specify a range with start greater than end.

var paperHeight: Double?

Paper height in inches. Defaults to 11 inches.

var paperWidth: Double?

Paper width in inches. Defaults to 8.5 inches.

preferCSSPageSize

var preferCSSPageSize: Boolean?

Whether or not to prefer page size as defined by css. Defaults to false, in which case the content will be scaled to fit the paper size.

printBackground

var printBackground: Boolean?

Print background graphics. Defaults to false.

var scale: Double?

Scale of the webpage rendering. Defaults to 1.

var transferMode: TransferMode?

return as stream

Functions

fun build(): PrintToPDFRequest