UNPKG

@progress/kendo-react-pdf

Version:

React PDF Processing enables you to export single- and multi-page content in PDF. KendoReact PDF Processing package

118 lines (117 loc) 4.28 kB
/** * @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 TreeListPDFExport component * ([more information and examples in the documentation on PDF export](https://www.telerik.com/kendo-react-ui/components/treelist/pdf-export)). */ export interface TreeListPDFExportProps extends PDFExportProps { /** * If set to true it will export all pages of the TreeList data. By default allPages is set to `false`. */ allPages?: boolean; } /** * @hidden */ export interface TreeListPDFExportState { show: boolean; } /** * A React component which facilitates the PDF export of the TreeList. */ export declare class TreeListPDFExport extends React.Component<TreeListPDFExportProps, TreeListPDFExportState> { /** * @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>; allPages: PropTypes.Requireable<boolean>; }; /** * @hidden */ saveTreeListPDF: any; /** * @hidden */ treeList: any; /** * @hidden */ columns: any; /** * @hidden */ data?: any[]; /** * @hidden */ callback?: any; /** * @hidden */ treeListInnerWrapperRef: 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 TreeList as a PDF file. * * @param data - The data that will be exported to the PDF. The data can be different from the currently displayed data in the TreeList. * @param columns - The columns that will be exported to the PDF. The columns collection can be different from the currently displayed in the TreeList. * @param callback - The callback that will be executed after the PDF is saved. */ save(data?: any[], columns?: any[], callback?: () => void): void; protected getSavePDF(): typeof savePDF; private getTreeList; private prepareRawTreeListForExport; }