UNPKG

@progress/kendo-grid-vue-wrapper

Version:
117 lines (65 loc) 3.68 kB
--- title: pdfProps API description: "API Index | pdfProps" api_reference: true slug: api_grid_pdfprops_wrapper --- # PdfProps ### pdf-all-pages `Boolean` Exports all Grid pages starting from the first one. ### pdf-author `String` The author of the PDF document. ### pdf-avoid-links `Boolean | String` A flag which indicates whether to produce actual hyperlinks in the exported PDF file. It is also possible to pass a CSS selector as an argument. All matching links will be ignored. ### pdf-creator `String` The creator of the PDF document. ### pdf-date `Date` The date when the PDF document is created. Defaults to `new Date()`. ### pdf-file-name `String` Specifies the file name of the exported PDF file. ### pdf-force-proxy `Boolean` If set to `true`, the content will be forwarded to `proxyURL` even if the browser supports the saving of files locally. ### pdf-keywords `String` The keywords of the exported PDF file. ### pdf-landscape `Boolean` If `pdf-landscape` is set to `true`, the paper dimensions will be reversed. ### pdf-margin-bottom `Number | String` The bottom margin. Numbers are considered as `pt` units. ### pdf-margin-left `Number | String` The left margin. Numbers are considered as `pt` units. ### pdf-margin-right `Number | String` The right margin. Numbers are considered as `pt` units. ### pdf-margin-top `Number | String` The top margin. Numbers are considered as `pt` units. ### pdf-paper-size `String | Array` Specifies the paper size of the PDF document. The default setting is `auto` and determines the paper size by content. The supported values are: * A predefined size&mdash;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` * `pt` ### pdf-template `String` A piece of HTML to be included in each page. Can be used to display headers and footers. See the documentation in drawDOM.Available template variables include: * pageNum * totalPages ### pdf-repeat-headers `Boolean` Set this to true to repeat the grid headers on each page. ### pdf-scale `Number` A scale factor. In many cases, text size on screen will be too big for print, so you can use this option to scale down the output in PDF. See the documentation in drawDOM. ### pdf-proxy-url `String` The URL of the server side proxy which will stream the file to the end user. When the browser is not capable of saving files locally, a proxy will be used. Such browsers are Internet Explorer version 9 (and older) and Safari. You are responsible for implementing the server-side proxy. The proxy receives a `POST` request with the following parameters in the request body: * `contentType`&mdash;The MIME type of the file. * `base64`&mdash;The base-64 encoded file content. * `fileName`&mdash;The file name as requested by the caller. The proxy is expected to return the decoded file with a `Content-Disposition` header set to `attachment; filename="<fileName.pdf>"`. ### pdf-proxy-target `String` A name or keyword which indicates where to display the document that is returned by the proxy. To display the document in a new window or an iframe, the proxy method has to set the `Content-Disposition` header of the response to `inline; filename="<fileName.pdf>"`. ### pdf-subject `String` Sets the subject of the PDF file. ### pdf-title `String` Sets the title of the PDF file. ## Suggested Links * [`Pdf` in Kendo UI Grid for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/grid/configuration/pdf)