Components / Grid / API

PDFComponent

Configures the settings for the export of Grid in PDF (see example).

Selector

kendo-grid-pdf

Inputs

allPages boolean

Exports all Grid pages, starting from the first one.

Fields

author string

The author (metadata) of the PDF document.

A flag that indicates whether to produce actual hyperlinks in the exported PDF file.
It is also possible to set a CSS selector. All matching links will be ignored.

creator string (default: "Kendo UI PDF Generator")

The creator of the PDF document.

date Date

The date when the PDF document is created. Defaults to new Date().

fileName string (default: "Export.pdf")

Specifies the name of the exported PDF file.

forcePageBreak string

An optional CSS selector that specifies the elements which cause the page breaks
(see example).

forceProxy boolean

If set to true, the content is forwarded to proxyURL even if the
browser supports local saving of files.

imageResolution number

The forced resolution of the images in the exported PDF document
(see example).
By default, the images are exported at their full resolution.

keepTogether string

An optional CSS selector that specifies the elements which should not be split across the pages
(see example).

keywords string

The keywords (metadata) of the PDF document.

landscape boolean (default: false)

A flag that indicates if the page will be in a landscape orientation
(see example).
By default, the page is in a portrait orientation.

margin string | number | PageMargin

Specifies the margins of the page.

Numbers are treated as points ("pt").

The supported units are:

  • "mm"
  • "cm"
  • "in"
  • "pt" (default).

paperSize PaperSize

Specifies the paper size of the PDF document (see example).
Defaults to "auto" which means that the paper size is determined by the content.
The size of the content in pixels matches the size of the output in points (1 pixel = 1/72 inch).
If paperSize is set, the content is split across multiple pages. This enables the repeatHeaders and
scale options, and allows you to specify a template.

The supported values are:

  • A predefined size. The supported paper sizes are: A0-A10, B0-B10, C0-C10, Executive, Folio, Legal, Letter, Tabloid.
  • An array of two numbers which specify the width and height in points (1pt = 1/72in).
  • An array of two strings which specify the width and height in units. The supported units are "mm", "cm", "in", and "pt".

producer string

The producer (metadata) of the PDF document.

proxyData? {[key: string]: string}

A key/value dictionary of form values which will be sent to the proxy.
Can be used to submit Anti-Forgery tokens and other metadata.

proxyTarget string (default: "_self")

A name or keyword which indicates where to display the document that is returned from the proxy.
To display the document in a new window or iframe,
the proxy has to have the "Content-Disposition" header set to inline; filename="<fileName.pdf>".

proxyURL string

The URL of the server-side proxy which streams the file to the end user. You need to use a proxy if
the browser is not capable of saving files locally—for example, Internet Explorer 9 and Safari.
It is your responsibility to implement the server-side proxy. The proxy returns the decoded file with
the "Content-Disposition" header set to attachment; filename="<fileName.pdf>".

In the request body, the proxy receives a POST request with the following parameters:

  • "contentType"—The MIME type of the file.
  • "base64"—The base-64 encoded file content.
  • "fileName"—The file name, as requested by the caller.

repeatHeaders boolean

Specifies if the <thead> elements of the tables will be repeated on each page
(see example).

scale number (default: 1)

A scale factor (see example).
The text size on the screen might be too big for printing.
To scale down the output in PDF, use this option.

subject string

The subject (metadata) of the PDF document.

title string

The title (metadata) of the PDF document.

Methods

export

Exports the content as a Group for further processing.

Returns

Promise<Group> - The root group of the exported scene.

saveAs

Saves the content as a PDF file with the specified name.

Parameters

fileName? string

The name of the exported file.