CreatePDFFromHtmlOptionsBuilder

CreatePDFFromHtmlOptionsBuilder

Builds a CreatePDFFromHtmlOptions instance.

Constructor

new CreatePDFFromHtmlOptionsBuilder()

Constructs a CreatePDFFromHtmlOptionsBuilder instance.

Methods

includesHeaderFooter(includeHeaderFooternon-null) → {CreatePDFFromHtmlOptionsBuilder}

Sets the includeHeaderFooter parameter. If true, default header and footer will be included in resulting PDF. The default header consists of the date and the document.title. The default footer consists of the file name and page number.

Parameters:
Name Type Description
includeHeaderFooter Boolean

True if default header and footer should be included in the resulting PDF. Default value is true.

Returns:

This Builder instance to add any additional parameters.

Type
CreatePDFFromHtmlOptionsBuilder

withPageLayout(pageLayoutnon-null) → {CreatePDFFromHtmlOptionsBuilder}

Sets the pageLayout parameter.

Parameters:
Name Type Description
pageLayout PageLayout

Intended page layout of the resulting PDF file.

Returns:

This builder instance to add any additional parameters.

Type
CreatePDFFromHtmlOptionsBuilder

build() → {CreatePDFFromHtmlOptions}

Returns a new CreatePDFFromHtmlOptions instance built from the current state of this builder.

Returns:

A CreatePDFFromHtmlOptions instance.

Type
CreatePDFFromHtmlOptions