\Kendo\Dataviz\UI\DiagramPdf

A PHP class representing the pdf setting of Diagram.

Methods

author

The author of the PDF document that will be visible in the PDF file metadata.

Returns

\Kendo\Dataviz\UI\DiagramPdf

Parameters

$value string

Example

<?php
$pdf = new \Kendo\Dataviz\UI\DiagramPdf();
$pdf->author('value');
?>

creator

The creator of the PDF document.

Returns

\Kendo\Dataviz\UI\DiagramPdf

Parameters

$value string

Example

<?php
$pdf = new \Kendo\Dataviz\UI\DiagramPdf();
$pdf->creator('value');
?>

date

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

Returns

\Kendo\Dataviz\UI\DiagramPdf

Parameters

$value date

Example

<?php
$pdf = new \Kendo\Dataviz\UI\DiagramPdf();
$pdf->date(new date());
?>

fileName

Specifies the file name of the exported PDF file.

Returns

\Kendo\Dataviz\UI\DiagramPdf

Parameters

$value string

Example

<?php
$pdf = new \Kendo\Dataviz\UI\DiagramPdf();
$pdf->fileName('value');
?>

forceProxy

If set to true, the exported content is forwarded to the endpoint specified using the proxyURL setting, even if the browser supports saving of files in the user's local file system.

Returns

\Kendo\Dataviz\UI\DiagramPdf

Parameters

$value boolean

Example

<?php
$pdf = new \Kendo\Dataviz\UI\DiagramPdf();
$pdf->forceProxy(true);
?>

keywords

Specifies the keywords that will appear in the metadata of the exported PDF file.

Returns

\Kendo\Dataviz\UI\DiagramPdf

Parameters

$value string

Example

<?php
$pdf = new \Kendo\Dataviz\UI\DiagramPdf();
$pdf->keywords('value');
?>

landscape

If set to true, changes the document orientation to landscape. This property takes effect when pdf.paperSize is set.

Returns

\Kendo\Dataviz\UI\DiagramPdf

Parameters

$value boolean

Example

<?php
$pdf = new \Kendo\Dataviz\UI\DiagramPdf();
$pdf->landscape(true);
?>

margin

Sets the paper margins. The value has to be an object containing top, left, right, and bottom numbers which specify the paper margins. If numbers are passed, they are assumed to be in points (pt). By using strings, you can specify the units. The supported units are mm, cm, in, and pt (default).

Returns

\Kendo\Dataviz\UI\DiagramPdf

Parameters

$value \Kendo\Dataviz\UI\DiagramPdfMargin|array

Example - using \Kendo\Dataviz\UI\DiagramPdfMargin

<?php
$pdf = new \Kendo\Dataviz\UI\DiagramPdf();
$margin = new \Kendo\Dataviz\UI\DiagramPdfMargin();
$bottom = 1;
$margin->bottom($bottom);
$pdf->margin($margin);
?>

Example - using array

<?php
$pdf = new \Kendo\Dataviz\UI\DiagramPdf();
$bottom = 1;
$pdf->margin(array('bottom' => $bottom));
?>

paperSize

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: A0-A10, B0-B10, C0-C10, Executive, Folio, Legal, Letter, Tabloid.; An array of two numbers specifying the width and height in points (1pt = 1/72in) or An array of two strings specifying the width and height in units. The supported units are mm, cm, in, and pt..

Returns

\Kendo\Dataviz\UI\DiagramPdf

Parameters

$value string|array

Example - using string

<?php
$pdf = new \Kendo\Dataviz\UI\DiagramPdf();
$pdf->paperSize('value');
?>

Example - using array

<?php
$pdf = new \Kendo\Dataviz\UI\DiagramPdf();
$pdf->paperSize(array());
?>

proxyTarget

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 an iframe, the proxy method has to set the Content-Disposition header of the response to inline; filename="".

Returns

\Kendo\Dataviz\UI\DiagramPdf

Parameters

$value string

Example

<?php
$pdf = new \Kendo\Dataviz\UI\DiagramPdf();
$pdf->proxyTarget('value');
?>

proxyURL

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 - The MIME type of the file; base64 - The base-64 encoded file content or fileName - The file name, as requested by the caller.. The proxy is expected to return the decoded file with a set Content-Disposition header.You can see sample server proxy implementations here: Server Proxy Implementations.

Returns

\Kendo\Dataviz\UI\DiagramPdf

Parameters

$value string

Example

<?php
$pdf = new \Kendo\Dataviz\UI\DiagramPdf();
$pdf->proxyURL('value');
?>

subject

Sets the subject of document, which will be shown in the PDF file metadata.

Returns

\Kendo\Dataviz\UI\DiagramPdf

Parameters

$value string

Example

<?php
$pdf = new \Kendo\Dataviz\UI\DiagramPdf();
$pdf->subject('value');
?>

title

Sets the title of the document, which will be shown in the PDF file metadata.

Returns

\Kendo\Dataviz\UI\DiagramPdf

Parameters

$value string

Example

<?php
$pdf = new \Kendo\Dataviz\UI\DiagramPdf();
$pdf->title('value');
?>