New to Kendo UI for jQuery? Start a free 30-day trial

Pdf

configuration

Configures the PDF export settings of the Spreadsheet.

pdf

Object

<div id="spreadsheet"></div>
<script>
  $("#spreadsheet").kendoSpreadsheet({
    pdf: {
      area: "selection",
      fileName: "MySpreadsheet.pdf",
      forceProxy: false
    }
  });
</script>

pdf.area

String

The area that will be exported.

The supported values are:

workbook - Exports the full workbook, including all sheets.
sheet - Exports the active sheet.
selection - Exports the selected area on the active sheet.

<div id="spreadsheet"></div>
<script>
    $("#spreadsheet").kendoSpreadsheet({
        sheets: [{
            rows: [{
                cells: [{ value: "A" }, { value: "B" }, { value: "C" }]
            }, {
                cells: [{ value: "1" }, { value: "2" }, { value: "3" }]
            }, {
                cells: [{ value: "4" }, { value: "5" }, { value: "6" }]
            }]
        }],
        pdf: {
            area: "selection"
        }
    });

    var spreadsheet = $("#spreadsheet").data("kendoSpreadsheet");
    spreadsheet.saveAsPDF();
</script>

pdf.author

String

The author of the PDF document.

Default: null

<div id="spreadsheet"></div>
<script>
    $("#spreadsheet").kendoSpreadsheet({
        sheets: [{
            rows: [{
                cells: [{ value: "A" }, { value: "B" }, { value: "C" }]
            }, {
                cells: [{ value: "1" }, { value: "2" }, { value: "3" }]
            }, {
                cells: [{ value: "4" }, { value: "5" }, { value: "6" }]
            }]
        }],
        pdf: {
            author: "John Doe"
        }
    });

    var spreadsheet = $("#spreadsheet").data("kendoSpreadsheet");
    spreadsheet.saveAsPDF();
</script>

pdf.autoPrint

Boolean

Specifies if the Print dialog should be opened immediately after loading the document.

Note: Some PDF Readers/Viewers will not allow opening the Print Preview by default, it might be necessary to configure the corresponding add-on or application.

Default: false

<div id="spreadsheet"></div>
<script>
  $("#spreadsheet").kendoSpreadsheet({
    pdf: {
      autoPrint: true
    }
  });
</script>

pdf.creator

String

The creator of the PDF document.

Default: "Kendo UI PDF Generator"

<div id="spreadsheet"></div>
<script>
    $("#spreadsheet").kendoSpreadsheet({
        sheets: [{
            rows: [{
                cells: [{ value: "A" }, { value: "B" }, { value: "C" }]
            }, {
                cells: [{ value: "1" }, { value: "2" }, { value: "3" }]
            }, {
                cells: [{ value: "4" }, { value: "5" }, { value: "6" }]
            }]
        }],
        pdf: {
            creator: "John Doe"
        }
    });

    var spreadsheet = $("#spreadsheet").data("kendoSpreadsheet");
    spreadsheet.saveAsPDF();
</script>

pdf.date

Date

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

<div id="spreadsheet"></div>
<script>
    $("#spreadsheet").kendoSpreadsheet({
        sheets: [{
            rows: [{
                cells: [{ value: "A" }, { value: "B" }, { value: "C" }]
            }, {
                cells: [{ value: "1" }, { value: "2" }, { value: "3" }]
            }, {
                cells: [{ value: "4" }, { value: "5" }, { value: "6" }]
            }]
        }],
        pdf: {
            date: new Date("2014/10/10")
        }
    });

    var spreadsheet = $("#spreadsheet").data("kendoSpreadsheet");
    spreadsheet.saveAsPDF();
</script>

pdf.fileName

String

Specifies the file name of the exported PDF file.

Default: "Export.pdf"

<div id="spreadsheet"></div>
<script>
    $("#spreadsheet").kendoSpreadsheet({
        sheets: [{
            rows: [{
                cells: [{ value: "A" }, { value: "B" }, { value: "C" }]
            }, {
                cells: [{ value: "1" }, { value: "2" }, { value: "3" }]
            }, {
                cells: [{ value: "4" }, { value: "5" }, { value: "6" }]
            }]
        }],
        pdf: {
            fileName: "Foo.pdf"
        }
    });

    var spreadsheet = $("#spreadsheet").data("kendoSpreadsheet");
    spreadsheet.saveAsPDF();
</script>

pdf.fitWidth

Boolean

Indicates whether to fit the content of the Spreadsheet to the width of the page.

Default: false

<div id="spreadsheet"></div>
<script>
    $("#spreadsheet").kendoSpreadsheet({
        sheets: [{
            rows: [{
                cells: [
                    { value: "A" }, { value: "B" }, { value: "C" },
                    { value: "1" }, { value: "2" }, { value: "3" },
                    { value: "4" }, { value: "5" }, { value: "6" },
                    { value: "7" }, { value: "8" }, { value: "9" }
                ]
            }]
        }],
        pdf: {
            landscape: false,
            fitWidth: true
        }
    });

    var spreadsheet = $("#spreadsheet").data("kendoSpreadsheet");
    spreadsheet.saveAsPDF();
</script>

pdf.forceProxy

Boolean

If set to true, the content will be forwarded to proxyURL even if the browser supports the saving of files locally.

Default: false

<div id="spreadsheet"></div>
<script>
  $("#spreadsheet").kendoSpreadsheet({
    pdf: {
      forceProxy: true,
      proxyURL: "/save"
    }
  });
</script>

pdf.guidelines

Boolean

Indicates whether to export the cell guidelines.

Default: false

<div id="spreadsheet"></div>
<script>
    $("#spreadsheet").kendoSpreadsheet({
        sheets: [{
            rows: [{
                cells: [{ value: "A" }, { value: "B" }, { value: "C" }]
            }, {
                cells: [{ value: "1" }, { value: "2" }, { value: "3" }]
            }, {
                cells: [{ value: "4" }, { value: "5" }, { value: "6" }]
            }]
        }],
        pdf: {
            guidelines: false
        }
    });

    var spreadsheet = $("#spreadsheet").data("kendoSpreadsheet");
    spreadsheet.saveAsPDF();
</script>

pdf.hCenter

Boolean

Indicates whether to center the content horizontally. For more information, refer to vCenter.

Default: false

<div id="spreadsheet"></div>
<script>
    $("#spreadsheet").kendoSpreadsheet({
        sheets: [{
            rows: [{
                cells: [{ value: "A" }, { value: "B" }, { value: "C" }]
            }, {
                cells: [{ value: "1" }, { value: "2" }, { value: "3" }]
            }, {
                cells: [{ value: "4" }, { value: "5" }, { value: "6" }]
            }]
        }],
        pdf: {
            hCenter: true
        }
    });

    var spreadsheet = $("#spreadsheet").data("kendoSpreadsheet");
    spreadsheet.saveAsPDF();
</script>

pdf.jpegQuality

Number

Specifies the quality of the images within the exported file, from 0 to 1.

Default: 0.92

<div id="spreadsheet"></div>
<script>
  $("#spreadsheet").kendoSpreadsheet({
    pdf: {
      jpegQuality: 0.8
    }
  });
</script>

pdf.keepPNG

Boolean

If set to true all PNG images contained in the exported file will be kept in PNG format.

Default: false

<div id="spreadsheet"></div>
<script>
  $("#spreadsheet").kendoSpreadsheet({
    pdf: {
      keepPNG: true
    }
  });
</script>

pdf.keywords

String

Specifies the keywords of the exported PDF file.

Default: null

<div id="spreadsheet"></div>
<script>
    $("#spreadsheet").kendoSpreadsheet({
        sheets: [{
            rows: [{
                cells: [{ value: "A" }, { value: "B" }, { value: "C" }]
            }, {
                cells: [{ value: "1" }, { value: "2" }, { value: "3" }]
            }, {
                cells: [{ value: "4" }, { value: "5" }, { value: "6" }]
            }]
        }],
        pdf: {
            keywords: "food order"
        }
    });

    var spreadsheet = $("#spreadsheet").data("kendoSpreadsheet");
    spreadsheet.saveAsPDF();
</script>

pdf.landscape

Boolean

If set to true, reverses the paper dimensions if that width is needed as the larger edge.

Default: true

<div id="spreadsheet"></div>
<script>
    $("#spreadsheet").kendoSpreadsheet({
        sheets: [{
            rows: [{
                cells: [{ value: "A" }, { value: "B" }, { value: "C" }]
            }, {
                cells: [{ value: "1" }, { value: "2" }, { value: "3" }]
            }, {
                cells: [{ value: "4" }, { value: "5" }, { value: "6" }]
            }]
        }],
        pdf: {
            landscape: false
        }
    });

    var spreadsheet = $("#spreadsheet").data("kendoSpreadsheet");
    spreadsheet.saveAsPDF();
</script>

pdf.margin

Object

Specifies the margins of the page (numbers or strings with units).

The supported values are:

mm
cm
in
pt (default)

<div id="spreadsheet"></div>
<script>
    $("#spreadsheet").kendoSpreadsheet({
        sheets: [{
            rows: [{
                cells: [{ value: "A" }, { value: "B" }, { value: "C" }]
            }, {
                cells: [{ value: "1" }, { value: "2" }, { value: "3" }]
            }, {
                cells: [{ value: "4" }, { value: "5" }, { value: "6" }]
            }]
        }],
        pdf: {
            margin: {
                left: 10,
                right: "10pt",
                top: "10mm",
                bottom: "1in"
            }
        }
    });

    var spreadsheet = $("#spreadsheet").data("kendoSpreadsheet");
    spreadsheet.saveAsPDF();
</script>

pdf.paperSize

String|Array

Specifies the paper size of the PDF document. The default auto setting means that the paper size is determined by the content.

The size of the content in pixels will match the size of the output in points (1 pixel = 1/72 inch).

The supported values are:

A predefined size - A4, A3, and so on.
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 values are mm, cm, in, and pt.

Default: "auto"

<div id="spreadsheet"></div>
<script>
    $("#spreadsheet").kendoSpreadsheet({
        sheets: [{
            rows: [{
                cells: [{ value: "A" }, { value: "B" }, { value: "C" }]
            }, {
                cells: [{ value: "1" }, { value: "2" }, { value: "3" }]
            }, {
                cells: [{ value: "4" }, { value: "5" }, { value: "6" }]
            }]
        }],
        pdf: {
            paperSize: ["100mm", "50mm"]
        }
    });

    var spreadsheet = $("#spreadsheet").data("kendoSpreadsheet");
    spreadsheet.saveAsPDF();
</script>

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, set the proxy Content-Disposition header to inline; filename="<fileName.pdf>".

Default: "_self"

<div id="spreadsheet"></div>
<script>
    $("#spreadsheet").kendoSpreadsheet({
        sheets: [{
            rows: [{
                cells: [{ value: "A" }, { value: "B" }, { value: "C" }]
            }, {
                cells: [{ value: "1" }, { value: "2" }, { value: "3" }]
            }, {
                cells: [{ value: "4" }, { value: "5" }, { value: "6" }]
            }]
        }],
        pdf: {
            forceProxy: true,
            proxyURL: "/save",
            proxyTarget: "_blank"
        }
    });

    var spreadsheet = $("#spreadsheet").data("kendoSpreadsheet");
    spreadsheet.saveAsPDF();
</script>

pdf.proxyURL

String

The URL of the server side proxy which will stream the file to the end user. A proxy will be used when the browser is not capable of saving files locally, for example, Internet Explorer 9 and Safari. The developer is responsible for implementing the server-side proxy. The proxy will return the decoded file with the Content-Disposition header set to attachment; filename="<fileName.pdf>".

The proxy will receive a POST request with the following parameters in the request body:

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

Default: null

<div id="spreadsheet"></div>
<script>
    $("#spreadsheet").kendoSpreadsheet({
        sheets: [{
            rows: [{
                cells: [{ value: "A" }, { value: "B" }, { value: "C" }]
            }, {
                cells: [{ value: "1" }, { value: "2" }, { value: "3" }]
            }, {
                cells: [{ value: "4" }, { value: "5" }, { value: "6" }]
            }]
        }],
        pdf: {
            proxyURL: "/save"
        }
    });

    var spreadsheet = $("#spreadsheet").data("kendoSpreadsheet");
    spreadsheet.saveAsPDF();
</script>

pdf.subject

String

Sets the subject of the PDF file.

Default: null

<div id="spreadsheet"></div>
<script>
    $("#spreadsheet").kendoSpreadsheet({
        sheets: [{
            rows: [{
                cells: [{ value: "A" }, { value: "B" }, { value: "C" }]
            }, {
                cells: [{ value: "1" }, { value: "2" }, { value: "3" }]
            }, {
                cells: [{ value: "4" }, { value: "5" }, { value: "6" }]
            }]
        }],
        pdf: {
            subject: "Products"
        }
    });

    var spreadsheet = $("#spreadsheet").data("kendoSpreadsheet");
    spreadsheet.saveAsPDF();
</script>

pdf.title

String

Sets the title of the PDF file.

Default: null

<div id="spreadsheet"></div>
<script>
    $("#spreadsheet").kendoSpreadsheet({
        sheets: [{
            rows: [{
                cells: [{ value: "A" }, { value: "B" }, { value: "C" }]
            }, {
                cells: [{ value: "1" }, { value: "2" }, { value: "3" }]
            }, {
                cells: [{ value: "4" }, { value: "5" }, { value: "6" }]
            }]
        }],
        pdf: {
            title: "Products"
        }
    });

    var spreadsheet = $("#spreadsheet").data("kendoSpreadsheet");
    spreadsheet.saveAsPDF();
</script>

pdf.vCenter

Boolean

Indicates whether to center the content vertically. For more information, refer to hCenter.

Default: false

<div id="spreadsheet"></div>
<script>
    $("#spreadsheet").kendoSpreadsheet({
        sheets: [{
            rows: [{
                cells: [{ value: "A" }, { value: "B" }, { value: "C" }]
            }, {
                cells: [{ value: "1" }, { value: "2" }, { value: "3" }]
            }, {
                cells: [{ value: "4" }, { value: "5" }, { value: "6" }]
            }]
        }],
        pdf: {
            vCenter: true
        }
    });

    var spreadsheet = $("#spreadsheet").data("kendoSpreadsheet");
    spreadsheet.saveAsPDF();
</script>

Related Members