Back to all docs
API Reference / ui / Scheduler / pdf
New to Kendo UI for jQuery? Start a free 30-day trial

Pdf

configuration

Configures the Kendo UI Scheduler PDF export settings.

pdf

Object
<div id="scheduler"></div>
<script>
$("#scheduler").kendoScheduler({
    date: new Date("2022/6/13"),
    startTime: new Date("2022/6/13 07:00 AM"),
    height: 600,
    views: ["day", "week"],
    timezone: "Etc/UTC",
    dataSource: [
        {
            id: 1,
            start: new Date("2022/6/13 10:00 AM"),
            end: new Date("2022/6/13 11:00 AM"),
            title: "Team Meeting"
        }
    ],
    pdf: {
        author: "John Doe",
        creator: "Scheduler App",
        date: new Date(),
        fileName: "Scheduler.pdf",
        forceProxy: true,
        keywords: "scheduler export",
        landscape: true,
        margin: {
            bottom: "1cm",
            left: "1cm",
            right: "1cm", 
            top: "1cm"
        },
        paperSize: "A4",
        subject: "Scheduler Export",
        title: "My Schedule"
    },
    toolbar: ["pdf"]
});
</script>

pdf.author

String

The author of the PDF document.

Default: null

<div id="scheduler"></div>
<script>
$("#scheduler").kendoScheduler({
  toolbar: ["pdf"],
  pdf: {
    author: "John Doe"
  },
  date: new Date("2013/6/6"),
  dataSource: [
    {
      id: 1,
      start: new Date("2013/6/6 08:00 AM"),
      end: new Date("2013/6/6 09:00 AM"),
      title: "Interview"
    }
  ]
});
</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="scheduler"></div>
<script>
$("#scheduler").kendoScheduler({
    date: new Date("2022/6/13"),
    startTime: new Date("2022/6/13 07:00 AM"),
    height: 600,
    views: ["day", "week"],
    timezone: "Etc/UTC",
    dataSource: [
        {
            id: 1,
            start: new Date("2022/6/13 10:00 AM"),
            end: new Date("2022/6/13 11:00 AM"),
            title: "Team Meeting"
        }
    ],
    pdf: {
        autoPrint: true
    },
    toolbar: ["pdf"]
});
</script>

pdf.avoidLinks

Boolean|String

A flag indicating whether to produce actual hyperlinks in the exported PDF file.

It's also possible to pass a CSS selector as argument. All matching links will be ignored.

Available in versions 2015.3.1020 and later

Default: false

<div id="scheduler"></div>
<script>
$("#scheduler").kendoScheduler({
    date: new Date("2022/6/13"),
    startTime: new Date("2022/6/13 07:00 AM"),
    height: 600,
    views: ["day", "week"],
    timezone: "Etc/UTC",
    dataSource: [
        {
            id: 1,
            start: new Date("2022/6/13 10:00 AM"),
            end: new Date("2022/6/13 11:00 AM"),
            title: "Team Meeting"
        }
    ],
    pdf: {
        avoidLinks: true
    },
    toolbar: ["pdf"]
});
</script>

pdf.creator

String

The creator of the PDF document.

Default: "Kendo UI PDF Generator"

<div id="scheduler"></div>
<script>
$("#scheduler").kendoScheduler({
  toolbar: ["pdf"],
  pdf: {
    creator: "John Doe"
  },
  date: new Date("2013/6/6"),
  dataSource: [
    {
      id: 1,
      start: new Date("2013/6/6 08:00 AM"),
      end: new Date("2013/6/6 09:00 AM"),
      title: "Interview"
    }
  ]
});
</script>

pdf.date

Date

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

<div id="scheduler"></div>
<script>
$("#scheduler").kendoScheduler({
  toolbar: ["pdf"],
  pdf: {
    date: new Date("2014/10/10")
  },
  date: new Date("2013/6/6"),
  dataSource: [
    {
      id: 1,
      start: new Date("2013/6/6 08:00 AM"),
      end: new Date("2013/6/6 09:00 AM"),
      title: "Interview"
    }
  ]
});
</script>

pdf.fileName

String

Specifies the file name of the exported PDF file.

Default: "Export.pdf"

<div id="scheduler"></div>
<script>
$("#scheduler").kendoScheduler({
  toolbar: ["pdf"],
  pdf: {
    fileName: "Events.pdf"
  },
  date: new Date("2013/6/6"),
  dataSource: [
    {
      id: 1,
      start: new Date("2013/6/6 08:00 AM"),
      end: new Date("2013/6/6 09:00 AM"),
      title: "Interview"
    }
  ]
});
</script>

pdf.forceProxy

Boolean

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

Default: false

<div id="scheduler"></div>
<script>
$("#scheduler").kendoScheduler({
    date: new Date("2022/6/13"),
    startTime: new Date("2022/6/13 07:00 AM"),
    height: 600,
    views: ["day", "week"],
    timezone: "Etc/UTC",
    dataSource: [
        {
            id: 1,
            start: new Date("2022/6/13 10:00 AM"),
            end: new Date("2022/6/13 11:00 AM"),
            title: "Team Meeting"
        }
    ],
    pdf: {
        forceProxy: true,
        proxyURL: "/save"
    },
    toolbar: ["pdf"]
});
</script>

pdf.jpegQuality

Number

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

Default: 0.92

<div id="scheduler"></div>
<script>
$("#scheduler").kendoScheduler({
    date: new Date("2022/6/13"),
    startTime: new Date("2022/6/13 07:00 AM"),
    height: 600,
    views: ["day", "week"],
    timezone: "Etc/UTC",
    dataSource: [
        {
            id: 1,
            start: new Date("2022/6/13 10:00 AM"),
            end: new Date("2022/6/13 11:00 AM"),
            title: "Team Meeting"
        }
    ],
    pdf: {
        jpegQuality: 0.8
    },
    toolbar: ["pdf"]
});
</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="scheduler"></div>
<script>
$("#scheduler").kendoScheduler({
    date: new Date("2022/6/13"),
    startTime: new Date("2022/6/13 07:00 AM"),
    height: 600,
    views: ["day", "week"],
    timezone: "Etc/UTC",
    dataSource: [
        {
            id: 1,
            start: new Date("2022/6/13 10:00 AM"),
            end: new Date("2022/6/13 11:00 AM"),
            title: "Team Meeting"
        }
    ],
    pdf: {
        keepPNG: true
    },
    toolbar: ["pdf"]
});
</script>

pdf.keywords

String

Specifies the keywords of the exported PDF file.

Default: null

<div id="scheduler"></div>
<script>
$("#scheduler").kendoScheduler({
  toolbar: ["pdf"],
  pdf: {
    keywords: "events interviews"
  },
  date: new Date("2013/6/6"),
  dataSource: [
    {
      id: 1,
      start: new Date("2013/6/6 08:00 AM"),
      end: new Date("2013/6/6 09:00 AM"),
      title: "Interview"
    }
  ]
});
</script>

pdf.landscape

Boolean

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

Default: false

<div id="scheduler"></div>
<script>
$("#scheduler").kendoScheduler({
  toolbar: ["pdf"],
  pdf: {
    landscape: true
  },
  date: new Date("2013/6/6"),
  dataSource: [
    {
      id: 1,
      start: new Date("2013/6/6 08:00 AM"),
      end: new Date("2013/6/6 09:00 AM"),
      title: "Interview"
    }
  ]
});
</script>

pdf.margin

Object

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

<div id="scheduler"></div>
<script>
$("#scheduler").kendoScheduler({
  toolbar: ["pdf"],
  pdf: {
    margin: {
        left: 10,
        right: "10pt",
        top: "10mm",
        bottom: "1in"
    }
  },
  date: new Date("2013/6/6"),
  dataSource: [
    {
      id: 1,
      start: new Date("2013/6/6 08:00 AM"),
      end: new Date("2013/6/6 09:00 AM"),
      title: "Interview"
    }
  ]
});
</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="scheduler"></div>
<script>
$("#scheduler").kendoScheduler({
  toolbar: ["pdf"],
  pdf: {
    paperSize: ["20mm", "20mm"]
  },
  date: new Date("2013/6/6"),
  dataSource: [
    {
      id: 1,
      start: new Date("2013/6/6 08:00 AM"),
      end: new Date("2013/6/6 09:00 AM"),
      title: "Interview"
    }
  ]
});
</script>

pdf.proxyTarget

String

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="scheduler"></div>
<script>
$("#scheduler").kendoScheduler({
  toolbar: ["pdf"],
  pdf: {
      forceProxy: true,
      proxyURL: "/save",
      proxyTarget: "_blank"
  },
  date: new Date("2013/6/6"),
  dataSource: [
    {
      id: 1,
      start: new Date("2013/6/6 08:00 AM"),
      end: new Date("2013/6/6 09:00 AM"),
      title: "Interview"
    }
  ]
});
</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 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="scheduler"></div>
<script>
$("#scheduler").kendoScheduler({
  toolbar: ["pdf"],
  pdf: {
    proxyURL: "/save"
  },
  date: new Date("2013/6/6"),
  dataSource: [
    {
      id: 1,
      start: new Date("2013/6/6 08:00 AM"),
      end: new Date("2013/6/6 09:00 AM"),
      title: "Interview"
    }
  ]
});
</script>

pdf.subject

String

Sets the subject of the PDF file.

Default: null

<div id="scheduler"></div>
<script>
$("#scheduler").kendoScheduler({
  toolbar: ["pdf"],
  pdf: {
    subject: "Events"
  },
  date: new Date("2013/6/6"),
  dataSource: [
    {
      id: 1,
      start: new Date("2013/6/6 08:00 AM"),
      end: new Date("2013/6/6 09:00 AM"),
      title: "Interview"
    }
  ]
});
</script>

pdf.title

String

Sets the title of the PDF file.

Default: null

<div id="scheduler"></div>
<script>
$("#scheduler").kendoScheduler({
  toolbar: ["pdf"],
  pdf: {
    title: "Events"
  },
  date: new Date("2013/6/6"),
  dataSource: [
    {
      id: 1,
      start: new Date("2013/6/6 08:00 AM"),
      end: new Date("2013/6/6 09:00 AM"),
      title: "Interview"
    }
  ]
});
</script>

Related Members

  • pdf.margin - Specifies the margins of the page (numbers or strings with units). Supported units are "mm", "cm", "in" and "pt" (default).
In this article
pdfpdf.authorpdf.autoPrintpdf.avoidLinkspdf.creatorpdf.datepdf.fileNamepdf.forceProxypdf.jpegQualitypdf.keepPNGpdf.keywordspdf.landscapepdf.marginpdf.paperSizepdf.proxyTargetpdf.proxyURLpdf.subjectpdf.title
Not finding the help you need?
Contact Support