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

Pdf

configuration

Configures the export settings for the saveAsPDF method.

pdf

Object
<div id="chart"></div>
<script>
$("#chart").kendoChart({
  pdf: {
    fileName: "chart-export.pdf",
    autoPrint: false
  },
  series: [
    { data: [1, 2, 3] }
  ]
});
</script>

The author of the PDF document.

Default: null

<div id="chart"></div>
<script>
  $("#chart").kendoChart({
      pdf: {
          author: "John Doe"
      },
      legend: {
          position: "bottom"
      },
      series: [
          { name: "Series 1", data: [1, 2, 3] },
          { name: "Series 2", data: [3, 4, 5] }
      ]
  });

  var chart = $("#chart").getKendoChart();
  chart.saveAsPDF();
</script>

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="chart"></div>
<script>
$("#chart").kendoChart({
  pdf: {
    autoPrint: true
  },
  series: [
    { data: [1, 2, 3] }
  ]
});
</script>

The creator of the PDF document.

Default: "Kendo UI PDF Generator"

<div id="chart"></div>
<script>
  $("#chart").kendoChart({
      pdf: {
          creator: "John Doe"
      },
      legend: {
          position: "bottom"
      },
      series: [
          { name: "Series 1", data: [1, 2, 3] },
          { name: "Series 2", data: [3, 4, 5] }
      ]
  });

  var chart = $("#chart").getKendoChart();
  chart.saveAsPDF();
</script>

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

<div id="chart"></div>
<script>
  $("#chart").kendoChart({
      pdf: {
          date: new Date("2014/10/10")
      },
      legend: {
          position: "bottom"
      },
      series: [
          { name: "Series 1", data: [1, 2, 3] },
          { name: "Series 2", data: [3, 4, 5] }
      ]
  });

  var chart = $("#chart").getKendoChart();
  chart.saveAsPDF();
</script>

Specifies the file name of the exported PDF file.

Default: "Export.pdf"

<div id="chart"></div>
<script>
  $("#chart").kendoChart({
      pdf: {
          fileName: "Products.pdf"
      },
      legend: {
          position: "bottom"
      },
      series: [
          { name: "Series 1", data: [1, 2, 3] },
          { name: "Series 2", data: [3, 4, 5] }
      ]
  });

  var chart = $("#chart").getKendoChart();
  chart.saveAsPDF();
</script>

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

Default: false

<div id="chart"></div>
<script>
  $("#chart").kendoChart({
      pdf: {
          proxyURL: "https://demos.telerik.com/service/v2/core/export",
          forceProxy: true
      },
      legend: {
          position: "bottom"
      },
      series: [
          { name: "Series 1", data: [1, 2, 3] },
          { name: "Series 2", data: [3, 4, 5] }
      ]
  });

  //var chart = $("#chart").getKendoChart();
  //chart.saveAsPDF(); Calling the method will result in an "403 Access Denied" error because the proxyURL cannot be accessed from the Dojo coderunner;
</script>

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

Default: 0.92

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  pdf: {
    jpegQuality: 0.5
  },
  series: [
    { data: [1, 2, 3] }
  ]
});
</script>

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

Default: false

<div id="chart"></div>
<script>
$("#chart").kendoChart({
  pdf: {
    keepPNG: true
  },
  series: [
    { data: [1, 2, 3] }
  ]
});
</script>

Specifies the keywords of the exported PDF file.

Default: null

<div id="chart"></div>
<script>
  $("#chart").kendoChart({
      pdf: {
          keywords: "monthly report"
      },
      legend: {
          position: "bottom"
      },
      series: [
          { name: "Series 1", data: [1, 2, 3] },
          { name: "Series 2", data: [3, 4, 5] }
      ]
  });

  var chart = $("#chart").getKendoChart();
  chart.saveAsPDF();
</script>

Set to true to reverse the paper dimensions if needed such that width is the larger edge.

Default: false

<div id="chart" style="width: 600px; height: 400px;"></div>
<script>
  $("#chart").kendoChart({
      pdf: {
          paperSize: "A4",
          landscape: true
      },
      legend: {
          position: "bottom"
      },
      series: [
          { name: "Series 1", data: [1, 2, 3] },
          { name: "Series 2", data: [3, 4, 5] }
      ]
  });

  var chart = $("#chart").getKendoChart();
  chart.saveAsPDF();
</script>

Specifies the margins of the page (numbers or strings with units). Supported units are "mm", "cm", "in" and "pt" (default).

<div id="chart" style="width: 600px; height: 400px;"></div>
<script>
  $("#chart").kendoChart({
      pdf: {
          margin: {
              left: 10,
              right: "10pt",
              top: "10mm",
              bottom: "1in"
          }
      },
      legend: {
          position: "bottom"
      },
      series: [
          { name: "Series 1", data: [1, 2, 3] },
          { name: "Series 2", data: [3, 4, 5] }
      ]
  });

  var chart = $("#chart").getKendoChart();
  chart.saveAsPDF();
</script>

pdf.paperSize

String|Array

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

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

Supported values:

  • A predefined size: "A4", "A3" etc
  • An array of two numbers specifying the width and height in points (1pt = 1/72in)
  • An array of two strings specifying the width and height in units. Supported units are "mm", "cm", "in" and "pt".

Default: "auto"

<div id="chart"></div>
<script>
  $("#chart").kendoChart({
      pdf: {
          paperSize: ["20cm", "20cm"]
      },
      legend: {
          position: "bottom"
      },
      series: [
          { name: "Series 1", data: [1, 2, 3] },
          { name: "Series 2", data: [3, 4, 5] }
      ]
  });

  var chart = $("#chart").getKendoChart();
  chart.saveAsPDF();
</script>

A name or keyword indicating where to display the document returned from the proxy.

If you want to display the document in a new window or iframe, the proxy should set the "Content-Disposition" header to inline; filename="<fileName.pdf>".

Default: "_self"

<div id="chart"></div>
<script>
  $("#chart").kendoChart({
      pdf: {
          forceProxy: true,
          proxyURL: "/save",
          proxyTarget: "_blank"
      },
      legend: {
          position: "bottom"
      },
      series: [
          { name: "Series 1", data: [1, 2, 3] },
          { name: "Series 2", data: [3, 4, 5] }
      ]
  });

  var chart = $("#chart").getKendoChart();
  chart.saveAsPDF();
</script>

The URL of the server side proxy which will stream the file to the end user.

A proxy will be used when the browser isn't capable of saving files locally. Such browsers are IE version 9 and lower and Safari.

The developer is responsible for implementing the server-side proxy.

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.

The proxy should return the decoded file with set "Content-Disposition" header.

Default: null

<div id="chart"></div>
<script>
  $("#chart").kendoChart({
      pdf: {
          proxyURL: "/save"
      },
      legend: {
          position: "bottom"
      },
      series: [
          { name: "Series 1", data: [1, 2, 3] },
          { name: "Series 2", data: [3, 4, 5] }
      ]
  });

  var chart = $("#chart").getKendoChart();
  chart.saveAsPDF();
</script>

Sets the subject of the PDF file.

Default: null

<div id="chart"></div>
<script>
  $("#chart").kendoChart({
      pdf: {
          subject: "Products"
      },
      legend: {
          position: "bottom"
      },
      series: [
          { name: "Series 1", data: [1, 2, 3] },
          { name: "Series 2", data: [3, 4, 5] }
      ]
  });

  var chart = $("#chart").getKendoChart();
  chart.saveAsPDF();
</script>

pdf.title

String

Sets the title of the PDF file.

Default: null

<div id="chart"></div>
<script>
  $("#chart").kendoChart({
      pdf: {
          title: "Products"
      },
      legend: {
          position: "bottom"
      },
      series: [
          { name: "Series 1", data: [1, 2, 3] },
          { name: "Series 2", data: [3, 4, 5] }
      ]
  });

  var chart = $("#chart").getKendoChart();
  chart.saveAsPDF();
</script>