@progress/kendo-react-pdf 13.3.0 → 13.4.0-develop.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/KendoDrawingAdapter.d.ts +27 -0
- package/PDFExport.d.ts +62 -0
- package/PDFExportProps.d.ts +186 -0
- package/PDFMargin.d.ts +74 -0
- package/PageTemplateProps.d.ts +20 -0
- package/common/dom-queries.d.ts +51 -0
- package/common/table-query.d.ts +29 -0
- package/common/utils.d.ts +27 -0
- package/dist/cdn/js/kendo-react-pdf.js +1 -1
- package/getPageMargin.d.ts +13 -0
- package/grid/GridPDFExport.d.ts +113 -0
- package/grid/export-element.d.ts +11 -0
- package/grid/grid-query.d.ts +29 -0
- package/grid/grid-query.mjs +1 -1
- package/grid/provideSaveGridPDF.d.ts +17 -0
- package/index.d.mts +11 -577
- package/index.d.ts +11 -577
- package/package-metadata.d.ts +12 -0
- package/package-metadata.js +1 -1
- package/package-metadata.mjs +10 -16
- package/package.json +3 -3
- package/savePDF.d.ts +16 -0
- package/treelist/TreeListPDFExport.d.ts +117 -0
- package/treelist/export-element.d.ts +11 -0
- package/treelist/provideSaveTreeListPDF.d.ts +12 -0
package/index.d.ts
CHANGED
|
@@ -5,580 +5,14 @@
|
|
|
5
5
|
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
6
|
*-------------------------------------------------------------------------------------------
|
|
7
7
|
*/
|
|
8
|
-
import {
|
|
9
|
-
import {
|
|
10
|
-
import {
|
|
11
|
-
import {
|
|
12
|
-
import {
|
|
13
|
-
import {
|
|
14
|
-
import {
|
|
15
|
-
import
|
|
16
|
-
import {
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
* @hidden
|
|
20
|
-
* Returns the margin options by reading the props of he component and the `PDFMargin` child.
|
|
21
|
-
* The props of the `PDFMargin` child are with greater priority.
|
|
22
|
-
*/
|
|
23
|
-
export declare function getPageMargin(props: any): any;
|
|
24
|
-
|
|
25
|
-
/**
|
|
26
|
-
* A React component which facilitates the PDF export of the Grid.
|
|
27
|
-
*/
|
|
28
|
-
export declare class GridPDFExport extends React_2.Component<GridPDFExportProps, GridPDFExportState> {
|
|
29
|
-
/**
|
|
30
|
-
* @hidden
|
|
31
|
-
*/
|
|
32
|
-
static propTypes: {
|
|
33
|
-
author: default_2.Requireable<string>;
|
|
34
|
-
avoidLinks: default_2.Requireable<NonNullable<string | boolean | null | undefined>>;
|
|
35
|
-
forcePageBreak: default_2.Requireable<string>;
|
|
36
|
-
keepTogether: default_2.Requireable<string>;
|
|
37
|
-
creator: default_2.Requireable<string>;
|
|
38
|
-
date: default_2.Requireable<Date>;
|
|
39
|
-
imageResolution: default_2.Requireable<number>;
|
|
40
|
-
fileName: default_2.Requireable<string>;
|
|
41
|
-
forceProxy: default_2.Requireable<boolean>;
|
|
42
|
-
keywords: default_2.Requireable<string>;
|
|
43
|
-
landscape: default_2.Requireable<boolean>;
|
|
44
|
-
margin: default_2.Requireable<NonNullable<string | number | default_2.InferProps<{
|
|
45
|
-
left: default_2.Requireable<NonNullable<string | number | null | undefined>>;
|
|
46
|
-
top: default_2.Requireable<NonNullable<string | number | null | undefined>>;
|
|
47
|
-
right: default_2.Requireable<NonNullable<string | number | null | undefined>>;
|
|
48
|
-
bottom: default_2.Requireable<NonNullable<string | number | null | undefined>>;
|
|
49
|
-
}> | null | undefined>>;
|
|
50
|
-
pageTemplate: default_2.Requireable<any>;
|
|
51
|
-
paperSize: default_2.Requireable<any>;
|
|
52
|
-
repeatHeaders: default_2.Requireable<boolean>;
|
|
53
|
-
scale: default_2.Requireable<number>;
|
|
54
|
-
proxyData: default_2.Requireable<any>;
|
|
55
|
-
proxyURL: default_2.Requireable<string>;
|
|
56
|
-
proxyTarget: default_2.Requireable<string>;
|
|
57
|
-
producer: default_2.Requireable<string>;
|
|
58
|
-
subject: default_2.Requireable<string>;
|
|
59
|
-
title: default_2.Requireable<string>;
|
|
60
|
-
};
|
|
61
|
-
/**
|
|
62
|
-
* @hidden
|
|
63
|
-
*/
|
|
64
|
-
saveGridPDF: any;
|
|
65
|
-
/**
|
|
66
|
-
* @hidden
|
|
67
|
-
*/
|
|
68
|
-
grid: any;
|
|
69
|
-
/**
|
|
70
|
-
* @hidden
|
|
71
|
-
*/
|
|
72
|
-
columns: any;
|
|
73
|
-
/**
|
|
74
|
-
* @hidden
|
|
75
|
-
*/
|
|
76
|
-
data?: any[];
|
|
77
|
-
/**
|
|
78
|
-
* @hidden
|
|
79
|
-
*/
|
|
80
|
-
callback?: any;
|
|
81
|
-
/**
|
|
82
|
-
* @hidden
|
|
83
|
-
*/
|
|
84
|
-
gridInnerWrapperRef: React_2.RefObject<HTMLDivElement | null>;
|
|
85
|
-
/**
|
|
86
|
-
* @hidden
|
|
87
|
-
*/
|
|
88
|
-
readonly state: {
|
|
89
|
-
show: boolean;
|
|
90
|
-
};
|
|
91
|
-
private readonly showLicenseWatermark;
|
|
92
|
-
private readonly licenseMessage?;
|
|
93
|
-
constructor(props: any);
|
|
94
|
-
/**
|
|
95
|
-
* @hidden
|
|
96
|
-
*/
|
|
97
|
-
componentDidUpdate(_prevProps: any, prevState: any): void;
|
|
98
|
-
/**
|
|
99
|
-
* @hidden
|
|
100
|
-
*/
|
|
101
|
-
render(): JSX.Element;
|
|
102
|
-
/**
|
|
103
|
-
* Saves the content of the Grid as a PDF file.
|
|
104
|
-
*
|
|
105
|
-
* @param data - The data can be different from the currently displayed data in the Grid. Can be used to export all Grid pages.
|
|
106
|
-
* @param callback - The callback that will be executed after the PDF is saved.
|
|
107
|
-
*/
|
|
108
|
-
save(data?: any[], callback?: () => void): void;
|
|
109
|
-
protected getSavePDF(): typeof savePDF;
|
|
110
|
-
private getGrid;
|
|
111
|
-
private getCustomColumns;
|
|
112
|
-
private prepareRawGridForExport;
|
|
113
|
-
private getGridNotColumnChildren;
|
|
114
|
-
}
|
|
115
|
-
|
|
116
|
-
/**
|
|
117
|
-
* The props of the GridPDFExport component
|
|
118
|
-
* ([more information and examples in the documentation on PDF export](https://www.telerik.com/kendo-react-ui/components/grid/export/pdf-export)).
|
|
119
|
-
*/
|
|
120
|
-
export declare interface GridPDFExportProps extends PDFExportProps {
|
|
121
|
-
}
|
|
122
|
-
|
|
123
|
-
/**
|
|
124
|
-
* @hidden
|
|
125
|
-
*/
|
|
126
|
-
declare interface GridPDFExportState {
|
|
127
|
-
show: boolean;
|
|
128
|
-
}
|
|
129
|
-
|
|
130
|
-
/**
|
|
131
|
-
* @hidden
|
|
132
|
-
*/
|
|
133
|
-
export declare class KendoDrawingAdapter {
|
|
134
|
-
private drawDOM;
|
|
135
|
-
private exportPDF;
|
|
136
|
-
private saveAs;
|
|
137
|
-
private domElement;
|
|
138
|
-
private options;
|
|
139
|
-
constructor(drawDOM: (element: HTMLElement, options: DrawOptions) => Promise<Group>, exportPDF: (group: Group, options: PDFOptions) => Promise<string>, saveAs: (dataUri: string, fileName: string, options: SaveOptions) => void, domElement: HTMLElement, options?: PDFExportProps);
|
|
140
|
-
savePDF(callback?: () => void): void;
|
|
141
|
-
private getDrawOptions;
|
|
142
|
-
private getPDFOptions;
|
|
143
|
-
private getSaveOptions;
|
|
144
|
-
private convertPageTemplateToHtml;
|
|
145
|
-
}
|
|
146
|
-
|
|
147
|
-
/**
|
|
148
|
-
* Represents the props of a page template component that can be added to the PDFExport component.
|
|
149
|
-
*/
|
|
150
|
-
export declare interface PageTemplateProps {
|
|
151
|
-
/**
|
|
152
|
-
* The number of the current page.
|
|
153
|
-
*/
|
|
154
|
-
pageNum: number;
|
|
155
|
-
/**
|
|
156
|
-
* The total number of pages.
|
|
157
|
-
*/
|
|
158
|
-
totalPages: number;
|
|
159
|
-
}
|
|
160
|
-
|
|
161
|
-
/**
|
|
162
|
-
* Represents the KendoReact PDFExport component.
|
|
163
|
-
*/
|
|
164
|
-
export declare class PDFExport extends React_2.Component<PDFExportProps, {}> {
|
|
165
|
-
/**
|
|
166
|
-
* @hidden
|
|
167
|
-
*/
|
|
168
|
-
static propTypes: {
|
|
169
|
-
author: default_2.Requireable<string>;
|
|
170
|
-
avoidLinks: default_2.Requireable<NonNullable<string | boolean | null | undefined>>;
|
|
171
|
-
forcePageBreak: default_2.Requireable<string>;
|
|
172
|
-
keepTogether: default_2.Requireable<string>;
|
|
173
|
-
creator: default_2.Requireable<string>;
|
|
174
|
-
date: default_2.Requireable<Date>;
|
|
175
|
-
imageResolution: default_2.Requireable<number>;
|
|
176
|
-
fileName: default_2.Requireable<string>;
|
|
177
|
-
forceProxy: default_2.Requireable<boolean>;
|
|
178
|
-
keywords: default_2.Requireable<string>;
|
|
179
|
-
landscape: default_2.Requireable<boolean>;
|
|
180
|
-
margin: default_2.Requireable<NonNullable<string | number | default_2.InferProps<{
|
|
181
|
-
left: default_2.Requireable<NonNullable<string | number | null | undefined>>;
|
|
182
|
-
top: default_2.Requireable<NonNullable<string | number | null | undefined>>;
|
|
183
|
-
right: default_2.Requireable<NonNullable<string | number | null | undefined>>;
|
|
184
|
-
bottom: default_2.Requireable<NonNullable<string | number | null | undefined>>;
|
|
185
|
-
}> | null | undefined>>;
|
|
186
|
-
pageTemplate: default_2.Requireable<any>;
|
|
187
|
-
paperSize: default_2.Requireable<any>;
|
|
188
|
-
repeatHeaders: default_2.Requireable<boolean>;
|
|
189
|
-
scale: default_2.Requireable<number>;
|
|
190
|
-
proxyData: default_2.Requireable<any>;
|
|
191
|
-
proxyURL: default_2.Requireable<string>;
|
|
192
|
-
proxyTarget: default_2.Requireable<string>;
|
|
193
|
-
producer: default_2.Requireable<string>;
|
|
194
|
-
subject: default_2.Requireable<string>;
|
|
195
|
-
title: default_2.Requireable<string>;
|
|
196
|
-
};
|
|
197
|
-
private rootElForPDF;
|
|
198
|
-
private readonly showLicenseWatermark;
|
|
199
|
-
private readonly licenseMessage?;
|
|
200
|
-
constructor(props: PDFExportProps);
|
|
201
|
-
/**
|
|
202
|
-
* @hidden
|
|
203
|
-
*/
|
|
204
|
-
render(): JSX.Element;
|
|
205
|
-
/**
|
|
206
|
-
* Saves the content as a PDF file.
|
|
207
|
-
*
|
|
208
|
-
* @param callback - The callback to be executed after the PDF is saved.
|
|
209
|
-
*/
|
|
210
|
-
save(callback?: () => void): void;
|
|
211
|
-
private getOptions;
|
|
212
|
-
}
|
|
213
|
-
|
|
214
|
-
/**
|
|
215
|
-
* Represents the props of the KendoReact PDFExport component.
|
|
216
|
-
*/
|
|
217
|
-
export declare interface PDFExportProps {
|
|
218
|
-
/**
|
|
219
|
-
* @hidden
|
|
220
|
-
*/
|
|
221
|
-
children?: React.ReactNode;
|
|
222
|
-
/**
|
|
223
|
-
* The author (metadata) of the PDF document.
|
|
224
|
-
*
|
|
225
|
-
* @example
|
|
226
|
-
* ```jsx
|
|
227
|
-
* <PDFExport author="John Doe" />
|
|
228
|
-
* ```
|
|
229
|
-
*/
|
|
230
|
-
author?: string;
|
|
231
|
-
/**
|
|
232
|
-
* Sets whether to produce actual hyperlinks in the exported PDF file.
|
|
233
|
-
* It is also possible to set a CSS selector. All matching links will be ignored.
|
|
234
|
-
*
|
|
235
|
-
* @example
|
|
236
|
-
* ```jsx
|
|
237
|
-
* <PDFExport avoidLinks={true} />
|
|
238
|
-
* <PDFExport avoidLinks=".no-link" />
|
|
239
|
-
* ```
|
|
240
|
-
*/
|
|
241
|
-
avoidLinks?: boolean | string;
|
|
242
|
-
/**
|
|
243
|
-
* Sets a CSS selector that determines the elements which cause the page breaks.
|
|
244
|
-
*
|
|
245
|
-
* @example
|
|
246
|
-
* ```jsx
|
|
247
|
-
* <PDFExport forcePageBreak=".page-break" />
|
|
248
|
-
* ```
|
|
249
|
-
*/
|
|
250
|
-
forcePageBreak?: string;
|
|
251
|
-
/**
|
|
252
|
-
* Sets a CSS selector that determines the elements which should not be split across the pages.
|
|
253
|
-
*
|
|
254
|
-
* @example
|
|
255
|
-
* ```jsx
|
|
256
|
-
* <PDFExport keepTogether=".keep-together" />
|
|
257
|
-
* ```
|
|
258
|
-
*/
|
|
259
|
-
keepTogether?: string;
|
|
260
|
-
/**
|
|
261
|
-
* Sets the creator of the PDF document.
|
|
262
|
-
*
|
|
263
|
-
* @default "KendoReact PDF Generator"
|
|
264
|
-
*/
|
|
265
|
-
creator?: string;
|
|
266
|
-
/**
|
|
267
|
-
* Sets the date when the PDF document is created.
|
|
268
|
-
*
|
|
269
|
-
* @default new Date()
|
|
270
|
-
*/
|
|
271
|
-
date?: Date;
|
|
272
|
-
/**
|
|
273
|
-
* The forced resolution of the images in the exported PDF document. By default, the images are exported at their full resolution.
|
|
274
|
-
*/
|
|
275
|
-
imageResolution?: number;
|
|
276
|
-
/**
|
|
277
|
-
* Sets the name of the exported PDF file.
|
|
278
|
-
*
|
|
279
|
-
* @default "export.pdf"
|
|
280
|
-
*
|
|
281
|
-
* @example
|
|
282
|
-
* ```jsx
|
|
283
|
-
* <PDFExport fileName="custom-file.pdf" />
|
|
284
|
-
* ```
|
|
285
|
-
*/
|
|
286
|
-
fileName?: string;
|
|
287
|
-
/**
|
|
288
|
-
* If set to `true`, the content is forwarded to `proxyURL` even if the browser supports local saving of files.
|
|
289
|
-
*/
|
|
290
|
-
forceProxy?: boolean;
|
|
291
|
-
/**
|
|
292
|
-
* The keywords (metadata) of the PDF document.
|
|
293
|
-
*/
|
|
294
|
-
keywords?: string;
|
|
295
|
-
/**
|
|
296
|
-
* Indicates if the page is in a landscape orientation. By default, the page is in a portrait orientation.
|
|
297
|
-
*
|
|
298
|
-
* @default false
|
|
299
|
-
*/
|
|
300
|
-
landscape?: boolean;
|
|
301
|
-
/**
|
|
302
|
-
* Sets the margins of the page.
|
|
303
|
-
*
|
|
304
|
-
* The supported units are:
|
|
305
|
-
* * `"mm"`
|
|
306
|
-
* * `"cm"`
|
|
307
|
-
* * `"in"`
|
|
308
|
-
* * `"pt"` (default).
|
|
309
|
-
*
|
|
310
|
-
* > Numbers are considered to be points (`"pt"`).
|
|
311
|
-
*/
|
|
312
|
-
margin?: string | number | PageMargin;
|
|
313
|
-
/**
|
|
314
|
-
* A React functional or class component which is used as a template that is inserted into each page of the PDF document. The number of the current page (`pageNum`) and the total number of pages (`totalPages`) are passed to the component as properties.
|
|
315
|
-
*/
|
|
316
|
-
pageTemplate?: any;
|
|
317
|
-
/**
|
|
318
|
-
* Sets the paper size of the PDF document.
|
|
319
|
-
*
|
|
320
|
-
* If set, the content will be split across multiple pages. This enables the `repeatHeaders` and `scale` options, and allows you to specify a template.
|
|
321
|
-
*
|
|
322
|
-
* The supported values are:
|
|
323
|
-
* * A predefined size. The supported paper sizes are: `A0-A10`, `B0-B10`, `C0-C10`, `Executive`, `Folio`, `Legal`, `Letter`, `Tabloid`.
|
|
324
|
-
* * An array of two numbers which specify the width and height in points (1pt = 1/72in).
|
|
325
|
-
* * An array of two strings which specify the width and height in units. The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"`.
|
|
326
|
-
*
|
|
327
|
-
* @default "auto"
|
|
328
|
-
*
|
|
329
|
-
* @example
|
|
330
|
-
* ```jsx
|
|
331
|
-
* <PDFExport paperSize="A4" />
|
|
332
|
-
* ```
|
|
333
|
-
*/
|
|
334
|
-
paperSize?: PaperSize;
|
|
335
|
-
/**
|
|
336
|
-
* Sets if the `<thead>` elements of the tables are repeated on each page.
|
|
337
|
-
*
|
|
338
|
-
* @example
|
|
339
|
-
* ```jsx
|
|
340
|
-
* <PDFExport repeatHeaders={true} />
|
|
341
|
-
* ```
|
|
342
|
-
*/
|
|
343
|
-
repeatHeaders?: boolean;
|
|
344
|
-
/**
|
|
345
|
-
* Sets a scale factor for the PDF content.
|
|
346
|
-
*
|
|
347
|
-
* @default 1
|
|
348
|
-
*
|
|
349
|
-
* @example
|
|
350
|
-
* ```jsx
|
|
351
|
-
* <PDFExport scale={0.8} />
|
|
352
|
-
* ```
|
|
353
|
-
*/
|
|
354
|
-
scale?: number;
|
|
355
|
-
/**
|
|
356
|
-
* Sets a key/value dictionary of form values for the proxy. You can use it to submit Anti-Forgery tokens and other metadata.
|
|
357
|
-
*/
|
|
358
|
-
proxyData?: {
|
|
359
|
-
[key: string]: string;
|
|
360
|
-
};
|
|
361
|
-
/**
|
|
362
|
-
* The URL of the server-side proxy which streams the file to the end user. You need to use a proxy if the browser is not capable of saving files locally—for example, Internet Explorer 9 and Safari. It is your responsibility to implement the server-side proxy.
|
|
363
|
-
*
|
|
364
|
-
* In the request body, the proxy receives a `POST` request with the following parameters:
|
|
365
|
-
* - `"contentType"`—The MIME type of the file.
|
|
366
|
-
* - `"base64"`—The base-64 encoded file content.
|
|
367
|
-
* - `"fileName"`—The file name, as requested by the caller.
|
|
368
|
-
*
|
|
369
|
-
* The proxy returns the decoded file with the `"Content-Disposition"` header set to `attachment;
|
|
370
|
-
* filename="<fileName.pdf>"`.
|
|
371
|
-
*/
|
|
372
|
-
proxyURL?: string;
|
|
373
|
-
/**
|
|
374
|
-
* Sets a name or keyword which indicates where to display the document that is returned from the proxy. To display the document in a new window or iframe, the proxy has to have the `"Content-Disposition"` header set to `inline; filename="<fileName.pdf>"`.
|
|
375
|
-
*
|
|
376
|
-
* @default "_self"
|
|
377
|
-
*/
|
|
378
|
-
proxyTarget?: string;
|
|
379
|
-
/**
|
|
380
|
-
* The producer (metadata) of the PDF document.
|
|
381
|
-
*/
|
|
382
|
-
producer?: string;
|
|
383
|
-
/**
|
|
384
|
-
* The subject (metadata) of the PDF document.
|
|
385
|
-
*/
|
|
386
|
-
subject?: string;
|
|
387
|
-
/**
|
|
388
|
-
* The title (metadata) of the PDF document.
|
|
389
|
-
*/
|
|
390
|
-
title?: string;
|
|
391
|
-
}
|
|
392
|
-
|
|
393
|
-
/**
|
|
394
|
-
* @hidden
|
|
395
|
-
*/
|
|
396
|
-
export declare class PDFMargin extends React_2.Component<PDFMarginProps, {}> {
|
|
397
|
-
static propTypes: {
|
|
398
|
-
left: default_2.Requireable<NonNullable<string | number | null | undefined>>;
|
|
399
|
-
top: default_2.Requireable<NonNullable<string | number | null | undefined>>;
|
|
400
|
-
right: default_2.Requireable<NonNullable<string | number | null | undefined>>;
|
|
401
|
-
bottom: default_2.Requireable<NonNullable<string | number | null | undefined>>;
|
|
402
|
-
};
|
|
403
|
-
render(): null;
|
|
404
|
-
}
|
|
405
|
-
|
|
406
|
-
/**
|
|
407
|
-
* Represents the props of the KendoReact PDFMargin component.
|
|
408
|
-
*/
|
|
409
|
-
export declare interface PDFMarginProps {
|
|
410
|
-
/**
|
|
411
|
-
* The bottom margin.
|
|
412
|
-
*
|
|
413
|
-
* The supported units are:
|
|
414
|
-
* * `"mm"`
|
|
415
|
-
* * `"cm"`
|
|
416
|
-
* * `"in"`
|
|
417
|
-
* * `"pt"` (default).
|
|
418
|
-
*
|
|
419
|
-
* > Numbers are considered to be points (`"pt"`).
|
|
420
|
-
*/
|
|
421
|
-
left?: number | string;
|
|
422
|
-
/**
|
|
423
|
-
* The top margin.
|
|
424
|
-
*
|
|
425
|
-
* The supported units are:
|
|
426
|
-
* * `"mm"`
|
|
427
|
-
* * `"cm"`
|
|
428
|
-
* * `"in"`
|
|
429
|
-
* * `"pt"` (default).
|
|
430
|
-
*
|
|
431
|
-
* > Numbers are considered to be points (`"pt"`).
|
|
432
|
-
*/
|
|
433
|
-
top?: number | string;
|
|
434
|
-
/**
|
|
435
|
-
* The right margin.
|
|
436
|
-
*
|
|
437
|
-
* The supported units are:
|
|
438
|
-
* * `"mm"`
|
|
439
|
-
* * `"cm"`
|
|
440
|
-
* * `"in"`
|
|
441
|
-
* * `"pt"` (default).
|
|
442
|
-
*
|
|
443
|
-
* > Numbers are considered to be points (`"pt"`).
|
|
444
|
-
*/
|
|
445
|
-
right?: number | string;
|
|
446
|
-
/**
|
|
447
|
-
* The bottom margin.
|
|
448
|
-
*
|
|
449
|
-
* The supported units are:
|
|
450
|
-
* * `"mm"`
|
|
451
|
-
* * `"cm"`
|
|
452
|
-
* * `"in"`
|
|
453
|
-
* * `"pt"` (default).
|
|
454
|
-
*
|
|
455
|
-
* > Numbers are considered to be points (`"pt"`).
|
|
456
|
-
*/
|
|
457
|
-
bottom?: number | string;
|
|
458
|
-
}
|
|
459
|
-
|
|
460
|
-
/**
|
|
461
|
-
* Provides a function that saves the content of a DOM element as a PDF file.
|
|
462
|
-
* The function is also used by the `Grid` component when the `pdf` prop is set to `true`.
|
|
463
|
-
*/
|
|
464
|
-
export declare const saveGridPDF: (gridInnerWrapper: any, pdfExportOptions?: PDFExportProps, callback?: () => void) => void;
|
|
465
|
-
|
|
466
|
-
/**
|
|
467
|
-
* Saves the content of a DOM element to a PDF file.
|
|
468
|
-
*
|
|
469
|
-
* @param domElement - The root DOM element to save to a PDF file.
|
|
470
|
-
* @param options - The export options.
|
|
471
|
-
* @param callback - The callback to be executed after the PDF is saved.
|
|
472
|
-
*/
|
|
473
|
-
export declare function savePDF(domElement: HTMLElement, options?: PDFExportProps, callback?: () => void): void;
|
|
474
|
-
|
|
475
|
-
/**
|
|
476
|
-
* A React component which facilitates the PDF export of the TreeList.
|
|
477
|
-
*/
|
|
478
|
-
export declare class TreeListPDFExport extends React_2.Component<TreeListPDFExportProps, TreeListPDFExportState> {
|
|
479
|
-
/**
|
|
480
|
-
* @hidden
|
|
481
|
-
*/
|
|
482
|
-
static propTypes: {
|
|
483
|
-
author: default_2.Requireable<string>;
|
|
484
|
-
avoidLinks: default_2.Requireable<NonNullable<string | boolean | null | undefined>>;
|
|
485
|
-
forcePageBreak: default_2.Requireable<string>;
|
|
486
|
-
keepTogether: default_2.Requireable<string>;
|
|
487
|
-
creator: default_2.Requireable<string>;
|
|
488
|
-
date: default_2.Requireable<Date>;
|
|
489
|
-
imageResolution: default_2.Requireable<number>;
|
|
490
|
-
fileName: default_2.Requireable<string>;
|
|
491
|
-
forceProxy: default_2.Requireable<boolean>;
|
|
492
|
-
keywords: default_2.Requireable<string>;
|
|
493
|
-
landscape: default_2.Requireable<boolean>;
|
|
494
|
-
margin: default_2.Requireable<NonNullable<string | number | default_2.InferProps<{
|
|
495
|
-
left: default_2.Requireable<NonNullable<string | number | null | undefined>>;
|
|
496
|
-
top: default_2.Requireable<NonNullable<string | number | null | undefined>>;
|
|
497
|
-
right: default_2.Requireable<NonNullable<string | number | null | undefined>>;
|
|
498
|
-
bottom: default_2.Requireable<NonNullable<string | number | null | undefined>>;
|
|
499
|
-
}> | null | undefined>>;
|
|
500
|
-
pageTemplate: default_2.Requireable<any>;
|
|
501
|
-
paperSize: default_2.Requireable<any>;
|
|
502
|
-
repeatHeaders: default_2.Requireable<boolean>;
|
|
503
|
-
scale: default_2.Requireable<number>;
|
|
504
|
-
proxyData: default_2.Requireable<any>;
|
|
505
|
-
proxyURL: default_2.Requireable<string>;
|
|
506
|
-
proxyTarget: default_2.Requireable<string>;
|
|
507
|
-
producer: default_2.Requireable<string>;
|
|
508
|
-
subject: default_2.Requireable<string>;
|
|
509
|
-
title: default_2.Requireable<string>;
|
|
510
|
-
allPages: default_2.Requireable<boolean>;
|
|
511
|
-
};
|
|
512
|
-
/**
|
|
513
|
-
* @hidden
|
|
514
|
-
*/
|
|
515
|
-
saveTreeListPDF: any;
|
|
516
|
-
/**
|
|
517
|
-
* @hidden
|
|
518
|
-
*/
|
|
519
|
-
treeList: any;
|
|
520
|
-
/**
|
|
521
|
-
* @hidden
|
|
522
|
-
*/
|
|
523
|
-
columns: any;
|
|
524
|
-
/**
|
|
525
|
-
* @hidden
|
|
526
|
-
*/
|
|
527
|
-
data?: any[];
|
|
528
|
-
/**
|
|
529
|
-
* @hidden
|
|
530
|
-
*/
|
|
531
|
-
callback?: any;
|
|
532
|
-
/**
|
|
533
|
-
* @hidden
|
|
534
|
-
*/
|
|
535
|
-
treeListInnerWrapperRef: React_2.RefObject<HTMLDivElement | null>;
|
|
536
|
-
/**
|
|
537
|
-
* @hidden
|
|
538
|
-
*/
|
|
539
|
-
readonly state: {
|
|
540
|
-
show: boolean;
|
|
541
|
-
};
|
|
542
|
-
private readonly showLicenseWatermark;
|
|
543
|
-
private readonly licenseMessage?;
|
|
544
|
-
constructor(props: any);
|
|
545
|
-
/**
|
|
546
|
-
* @hidden
|
|
547
|
-
*/
|
|
548
|
-
componentDidUpdate(_prevProps: any, prevState: any): void;
|
|
549
|
-
/**
|
|
550
|
-
* @hidden
|
|
551
|
-
*/
|
|
552
|
-
render(): JSX.Element;
|
|
553
|
-
/**
|
|
554
|
-
* Saves the content of the TreeList as a PDF file.
|
|
555
|
-
*
|
|
556
|
-
* @param data - The data that will be exported to the PDF. The data can be different from the currently displayed data in the TreeList.
|
|
557
|
-
* @param columns - The columns that will be exported to the PDF. The columns collection can be different from the currently displayed in the TreeList.
|
|
558
|
-
* @param callback - The callback that will be executed after the PDF is saved.
|
|
559
|
-
*/
|
|
560
|
-
save(data?: any[], columns?: any[], callback?: () => void): void;
|
|
561
|
-
protected getSavePDF(): typeof savePDF;
|
|
562
|
-
private getTreeList;
|
|
563
|
-
private prepareRawTreeListForExport;
|
|
564
|
-
}
|
|
565
|
-
|
|
566
|
-
/**
|
|
567
|
-
* The props of the TreeListPDFExport component
|
|
568
|
-
* ([more information and examples in the documentation on PDF export](https://www.telerik.com/kendo-react-ui/components/treelist/pdf-export)).
|
|
569
|
-
*/
|
|
570
|
-
export declare interface TreeListPDFExportProps extends PDFExportProps {
|
|
571
|
-
/**
|
|
572
|
-
* If set to true it will export all pages of the TreeList data. By default allPages is set to `false`.
|
|
573
|
-
*/
|
|
574
|
-
allPages?: boolean;
|
|
575
|
-
}
|
|
576
|
-
|
|
577
|
-
/**
|
|
578
|
-
* @hidden
|
|
579
|
-
*/
|
|
580
|
-
declare interface TreeListPDFExportState {
|
|
581
|
-
show: boolean;
|
|
582
|
-
}
|
|
583
|
-
|
|
584
|
-
export { }
|
|
8
|
+
import { PDFExport } from './PDFExport.js';
|
|
9
|
+
import { PDFExportProps } from './PDFExportProps.js';
|
|
10
|
+
import { PageTemplateProps } from './PageTemplateProps.js';
|
|
11
|
+
import { PDFMargin, PDFMarginProps } from './PDFMargin.js';
|
|
12
|
+
import { savePDF } from './savePDF.js';
|
|
13
|
+
import { getPageMargin } from './getPageMargin.js';
|
|
14
|
+
import { GridPDFExport, GridPDFExportProps } from './grid/GridPDFExport.js';
|
|
15
|
+
import { saveGridPDF } from './grid/provideSaveGridPDF.js';
|
|
16
|
+
import { TreeListPDFExport, TreeListPDFExportProps } from './treelist/TreeListPDFExport.js';
|
|
17
|
+
import { default as KendoDrawingAdapter } from './KendoDrawingAdapter.js';
|
|
18
|
+
export { saveGridPDF, PDFExport, PDFExportProps, PageTemplateProps, PDFMargin, PDFMarginProps, savePDF, getPageMargin, GridPDFExport, GridPDFExportProps, TreeListPDFExport, TreeListPDFExportProps, KendoDrawingAdapter };
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2026 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
8
|
+
import { PackageMetadata } from '@progress/kendo-licensing';
|
|
9
|
+
/**
|
|
10
|
+
* @hidden
|
|
11
|
+
*/
|
|
12
|
+
export declare const packageMetadata: PackageMetadata;
|
package/package-metadata.js
CHANGED
|
@@ -5,4 +5,4 @@
|
|
|
5
5
|
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
6
|
*-------------------------------------------------------------------------------------------
|
|
7
7
|
*/
|
|
8
|
-
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=Object.freeze({name:"@progress/kendo-react-pdf",productName:"KendoReact",productCode:"KENDOUIREACT",productCodes:["KENDOUIREACT"],publishDate:
|
|
8
|
+
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=Object.freeze({name:"@progress/kendo-react-pdf",productName:"KendoReact",productCode:"KENDOUIREACT",productCodes:["KENDOUIREACT"],publishDate: 1770288117,version:"13.4.0-develop.2",licensingDocsUrl:"https://www.telerik.com/kendo-react-ui/components/my-license/"});exports.packageMetadata=e;
|
package/package-metadata.mjs
CHANGED
|
@@ -1,19 +1,13 @@
|
|
|
1
|
+
// Generated file. DO NOT EDIT.
|
|
1
2
|
/**
|
|
2
|
-
* @
|
|
3
|
-
*-------------------------------------------------------------------------------------------
|
|
4
|
-
* Copyright © 2026 Progress Software Corporation. All rights reserved.
|
|
5
|
-
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
-
*-------------------------------------------------------------------------------------------
|
|
3
|
+
* @hidden
|
|
7
4
|
*/
|
|
8
|
-
const
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
5
|
+
export const packageMetadata = Object.freeze({
|
|
6
|
+
name: '@progress/kendo-react-pdf',
|
|
7
|
+
productName: 'KendoReact',
|
|
8
|
+
productCode: 'KENDOUIREACT',
|
|
9
|
+
productCodes: ['KENDOUIREACT'],
|
|
10
|
+
publishDate: 0,
|
|
11
|
+
version: '13.4.0-develop.2',
|
|
12
|
+
licensingDocsUrl: 'https://www.telerik.com/kendo-react-ui/components/my-license/'
|
|
16
13
|
});
|
|
17
|
-
export {
|
|
18
|
-
e as packageMetadata
|
|
19
|
-
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@progress/kendo-react-pdf",
|
|
3
|
-
"version": "13.
|
|
3
|
+
"version": "13.4.0-develop.2",
|
|
4
4
|
"description": "React PDF Processing enables you to export single- and multi-page content in PDF. KendoReact PDF Processing package",
|
|
5
5
|
"author": "Progress",
|
|
6
6
|
"license": "SEE LICENSE IN LICENSE.md",
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
"@progress/kendo-drawing": "^1.21.2",
|
|
29
29
|
"@progress/kendo-file-saver": "^1.0.1",
|
|
30
30
|
"@progress/kendo-licensing": "^1.7.2",
|
|
31
|
-
"@progress/kendo-react-common": "13.
|
|
31
|
+
"@progress/kendo-react-common": "13.4.0-develop.2",
|
|
32
32
|
"react": "^16.8.2 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc",
|
|
33
33
|
"react-dom": "^16.8.2 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc"
|
|
34
34
|
},
|
|
@@ -54,7 +54,7 @@
|
|
|
54
54
|
"package": {
|
|
55
55
|
"productName": "KendoReact",
|
|
56
56
|
"productCode": "KENDOUIREACT",
|
|
57
|
-
"publishDate":
|
|
57
|
+
"publishDate": 1770288117,
|
|
58
58
|
"licensingDocsUrl": "https://www.telerik.com/kendo-react-ui/components/my-license/"
|
|
59
59
|
}
|
|
60
60
|
},
|
package/savePDF.d.ts
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2026 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
8
|
+
import { PDFExportProps } from './PDFExportProps.js';
|
|
9
|
+
/**
|
|
10
|
+
* Saves the content of a DOM element to a PDF file.
|
|
11
|
+
*
|
|
12
|
+
* @param domElement - The root DOM element to save to a PDF file.
|
|
13
|
+
* @param options - The export options.
|
|
14
|
+
* @param callback - The callback to be executed after the PDF is saved.
|
|
15
|
+
*/
|
|
16
|
+
export declare function savePDF(domElement: HTMLElement, options?: PDFExportProps, callback?: () => void): void;
|