@progress/kendo-react-pdf
Version:
React PDF Processing enables you to export single- and multi-page content in PDF. KendoReact PDF Processing package
114 lines (113 loc) • 3.91 kB
TypeScript
/**
* @license
*-------------------------------------------------------------------------------------------
* Copyright © 2026 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the package root for more information
*-------------------------------------------------------------------------------------------
*/
import { default as PropTypes } from 'prop-types';
import { savePDF } from '../savePDF.js';
import { PDFExportProps } from '../PDFExportProps.js';
import * as React from 'react';
/**
* The props of the GridPDFExport component
* ([more information and examples in the documentation on PDF export](https://www.telerik.com/kendo-react-ui/components/grid/export/pdf-export)).
*/
export interface GridPDFExportProps extends PDFExportProps {
}
/**
* @hidden
*/
export interface GridPDFExportState {
show: boolean;
}
/**
* A React component which facilitates the PDF export of the Grid.
*/
export declare class GridPDFExport extends React.Component<GridPDFExportProps, GridPDFExportState> {
/**
* @hidden
*/
static propTypes: {
author: PropTypes.Requireable<string>;
avoidLinks: PropTypes.Requireable<NonNullable<string | boolean | null | undefined>>;
forcePageBreak: PropTypes.Requireable<string>;
keepTogether: PropTypes.Requireable<string>;
creator: PropTypes.Requireable<string>;
date: PropTypes.Requireable<Date>;
imageResolution: PropTypes.Requireable<number>;
fileName: PropTypes.Requireable<string>;
forceProxy: PropTypes.Requireable<boolean>;
keywords: PropTypes.Requireable<string>;
landscape: PropTypes.Requireable<boolean>;
margin: PropTypes.Requireable<NonNullable<string | number | PropTypes.InferProps<{
left: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
top: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
right: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
bottom: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
}> | null | undefined>>;
pageTemplate: PropTypes.Requireable<any>;
paperSize: PropTypes.Requireable<any>;
repeatHeaders: PropTypes.Requireable<boolean>;
scale: PropTypes.Requireable<number>;
proxyData: PropTypes.Requireable<any>;
proxyURL: PropTypes.Requireable<string>;
proxyTarget: PropTypes.Requireable<string>;
producer: PropTypes.Requireable<string>;
subject: PropTypes.Requireable<string>;
title: PropTypes.Requireable<string>;
};
/**
* @hidden
*/
saveGridPDF: any;
/**
* @hidden
*/
grid: any;
/**
* @hidden
*/
columns: any;
/**
* @hidden
*/
data?: any[];
/**
* @hidden
*/
callback?: any;
/**
* @hidden
*/
gridInnerWrapperRef: React.RefObject<HTMLDivElement | null>;
/**
* @hidden
*/
readonly state: {
show: boolean;
};
private readonly showLicenseWatermark;
private readonly licenseMessage?;
constructor(props: any);
/**
* @hidden
*/
componentDidUpdate(_prevProps: any, prevState: any): void;
/**
* @hidden
*/
render(): React.JSX.Element;
/**
* Saves the content of the Grid as a PDF file.
*
* @param data - The data can be different from the currently displayed data in the Grid. Can be used to export all Grid pages.
* @param callback - The callback that will be executed after the PDF is saved.
*/
save(data?: any[], callback?: () => void): void;
protected getSavePDF(): typeof savePDF;
private getGrid;
private getCustomColumns;
private prepareRawGridForExport;
private getGridNotColumnChildren;
}