@progress/kendo-angular-pdf-export 19.1.2-develop.1 → 19.1.2-develop.3

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/directives.d.ts CHANGED
@@ -6,6 +6,20 @@ import { PDFExportMarginComponent } from "./pdf-export-margin.component";
6
6
  import { PDFExportTemplateDirective } from "./pdf-export-template.directive";
7
7
  import { PDFExportComponent } from "./pdf-export.component";
8
8
  /**
9
- * Utility array that contains all `PDFExport` related components and directives
9
+ * Use the `KENDO_PDFEXPORT` utility array to add all `@progress/kendo-angular-pdf-export`-related components and directives to a standalone Angular component.
10
+ *
11
+ * @example
12
+ * ```typescript
13
+ * import { Component } from '@angular/core';
14
+ * import { KENDO_PDFEXPORT } from "@progress/kendo-angular-pdf-export";
15
+ *
16
+ * @Component({
17
+ * standalone: true,
18
+ * imports: [KENDO_PDFEXPORT],
19
+ * selector: 'my-app',
20
+ * template: `<kendo-pdf-export></kendo-pdf-export>`
21
+ * })
22
+ * export class AppComponent {}
23
+ * ```
10
24
  */
11
25
  export declare const KENDO_PDFEXPORT: readonly [typeof PDFExportComponent, typeof PDFExportMarginComponent, typeof PDFExportTemplateDirective];
@@ -6,7 +6,21 @@ import { PDFExportMarginComponent } from "./pdf-export-margin.component";
6
6
  import { PDFExportTemplateDirective } from "./pdf-export-template.directive";
7
7
  import { PDFExportComponent } from "./pdf-export.component";
8
8
  /**
9
- * Utility array that contains all `PDFExport` related components and directives
9
+ * Use the `KENDO_PDFEXPORT` utility array to add all `@progress/kendo-angular-pdf-export`-related components and directives to a standalone Angular component.
10
+ *
11
+ * @example
12
+ * ```typescript
13
+ * import { Component } from '@angular/core';
14
+ * import { KENDO_PDFEXPORT } from "@progress/kendo-angular-pdf-export";
15
+ *
16
+ * @Component({
17
+ * standalone: true,
18
+ * imports: [KENDO_PDFEXPORT],
19
+ * selector: 'my-app',
20
+ * template: `<kendo-pdf-export></kendo-pdf-export>`
21
+ * })
22
+ * export class AppComponent {}
23
+ * ```
10
24
  */
11
25
  export const KENDO_PDFEXPORT = [
12
26
  PDFExportComponent,
@@ -10,7 +10,7 @@ export const packageMetadata = {
10
10
  productName: 'Kendo UI for Angular',
11
11
  productCode: 'KENDOUIANGULAR',
12
12
  productCodes: ['KENDOUIANGULAR'],
13
- publishDate: 1749804268,
14
- version: '19.1.2-develop.1',
13
+ publishDate: 1750152577,
14
+ version: '19.1.2-develop.3',
15
15
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
16
16
  };
@@ -7,26 +7,40 @@ import * as i0 from "@angular/core";
7
7
  const FIELDS = ['bottom', 'left', 'right', 'top'];
8
8
  /**
9
9
  * Represents the Kendo UI PDFMargin component for Angular.
10
+ *
11
+ * @example
12
+ * ```html
13
+ * <kendo-pdf-export-margin top="2cm" left="1cm" right="1cm" bottom="2cm">
14
+ * </kendo-pdf-export-margin>
15
+ * ```
10
16
  */
11
17
  export class PDFExportMarginComponent {
12
18
  /**
13
- * The bottom margin. The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"` (default).
14
- * Numbers are considered to be points (`"pt"`).
19
+ * Sets the left margin of the PDF page. Accepts a `number` or `string` value.
20
+ *
21
+ * The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"`. Numbers use points (`"pt"`).
22
+ * @default "pt"
15
23
  */
16
24
  left;
17
25
  /**
18
- * The top margin. The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"` (default).
19
- * Numbers are considered to be points (`"pt"`).
26
+ * Sets the top margin of the PDF page. Accepts a `number` or `string` value.
27
+ *
28
+ * The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"`. Numbers use points (`"pt"`).
29
+ * @default "pt"
20
30
  */
21
31
  top;
22
32
  /**
23
- * The right margin. The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"` (default).
24
- * Numbers are considered to be points (`"pt"`).
33
+ * Sets the right margin of the PDF page. Accepts a `number` or `string` value.
34
+ *
35
+ * The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"`. Numbers use points (`"pt"`).
36
+ * @default "pt"
25
37
  */
26
38
  right;
27
39
  /**
28
- * The bottom margin. The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"` (default).
29
- * Numbers are considered to be points (`"pt"`).
40
+ * Sets the bottom margin of the PDF page. Accepts a `number` or `string` value.
41
+ *
42
+ * The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"`. Numbers use points (`"pt"`).
43
+ * @default "pt"
30
44
  */
31
45
  bottom;
32
46
  /**
@@ -4,6 +4,18 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { Directive, Optional, TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
+ /**
8
+ * Represents the directive for defining a custom page template in the PDF Export component ([see example](slug:multipagecontent_pdfexport#page-templates)).
9
+ *
10
+ * @example
11
+ * ```html
12
+ * <kendo-pdf-export paperSize="A4" margin="2cm">
13
+ * <ng-template kendoPDFTemplate let-pageNum="pageNum">
14
+ * <div>Page {{ pageNum }}</div>
15
+ * </ng-template>
16
+ * </kendo-pdf-export>
17
+ * ```
18
+ */
7
19
  export class PDFExportTemplateDirective {
8
20
  templateRef;
9
21
  constructor(templateRef) {
@@ -12,153 +12,133 @@ import { PDFExportMarginComponent } from './pdf-export-margin.component';
12
12
  import { compileTemplate } from './compile-template';
13
13
  import * as i0 from "@angular/core";
14
14
  /**
15
- * Represents the [Kendo UI PDF Export component for Angular]({% slug overview_pdfexport %}).
15
+ * Represents the [Kendo UI PDF Export component for Angular](slug:overview_pdfexport).
16
16
  *
17
17
  * @example
18
- * ```ts-preview
19
- * _@Component({
20
- * selector: 'my-app',
21
- * template: `
22
- * <div class="example-config">
23
- * <button kendoButton (click)="pdf.saveAs('document.pdf')">
24
- * Save As PDF...
25
- * </button>
26
- * </div>
18
+ * ```html
19
+ * <button kendoButton (click)="pdf.saveAs('document.pdf')">
20
+ * Save As PDF...
21
+ * </button>
27
22
  *
28
- * <kendo-pdf-export #pdf paperSize="A4" margin="2cm">
29
- * Content goes here
30
- * </kendo-pdf-export>
31
- * `
32
- * })
33
- * export class AppComponent {
34
- * }
23
+ * <kendo-pdf-export #pdf paperSize="A4" margin="2cm">
24
+ * Content goes here
25
+ * </kendo-pdf-export>
35
26
  * ```
36
27
  */
37
28
  export class PDFExportComponent {
38
29
  element;
39
30
  /**
40
- * Specifies if the Print dialog should be opened immediately after loading the document ([see example](slug:autoprint_pdfexport)).
31
+ * If `true`, opens the Print dialog immediately after the PDF loads ([see example](slug:autoprint_pdfexport)).
41
32
  * Requires `@progress/kendo-drawing` v1.9.0 or later.
42
33
  * @default false
43
34
  */
44
35
  autoPrint;
45
36
  /**
46
- * The author (metadata) of the PDF document.
37
+ * Sets the author metadata for the PDF document.
47
38
  */
48
39
  author;
49
40
  /**
50
- * A flag that indicates whether to produce actual hyperlinks in the exported PDF file ([see example](slug:hyperlinks_pdfexport)).
51
- * It is also possible to set a CSS selector. All matching links will be ignored.
41
+ * Specifies whether actual hyperlinks will be produced in the exported PDF file ([see example](slug:hyperlinks_pdfexport)). You can also set a CSS selector to ignore matching links.
52
42
  */
53
43
  avoidLinks;
54
44
  /**
55
- * An optional CSS selector that specifies the elements which cause the page breaks
56
- * ([see example]({% slug multipagecontent_pdfexport %}#toc-manual-page-breaking)).
45
+ * Sets a CSS selector for elements that cause page breaks
46
+ * ([see example](slug:multipagecontent_pdfexport#toc-manual-page-breaking)).
57
47
  */
58
48
  forcePageBreak;
59
49
  /**
60
- * An optional CSS selector that specifies the elements which should not be split across the pages
61
- * ([see example]({% slug multipagecontent_pdfexport %}#toc-preventing-page-breaking-in-elements)).
50
+ * Sets a CSS selector for elements that should not split across pages
51
+ * ([see example](slug:multipagecontent_pdfexport#toc-preventing-page-breaking-in-elements)).
62
52
  */
63
53
  keepTogether;
64
54
  /**
65
- * The creator of the PDF document.
55
+ * Sets the creator metadata for the PDF document.
66
56
  * @default "Kendo UI PDF Generator"
67
57
  */
68
58
  creator = 'Kendo UI PDF Generator';
69
59
  /**
70
- * The date when the PDF document is created. Defaults to `new Date()`.
60
+ * Sets the creation date for the PDF document. Defaults to `new Date()`.
61
+ * @default new Date()
71
62
  */
72
63
  date;
73
64
  /**
74
- * The forced resolution of the images in the exported PDF document
75
- * ([see example]({% slug embeddedimages_pdfexport %})).
76
- * By default, the images are exported at their full resolution.
65
+ * Sets the image resolution in the exported PDF ([see example](slug:embeddedimages_pdfexport)). By default, images use full resolution.
77
66
  */
78
67
  imageResolution;
79
68
  /**
80
- * Specifies the name of the exported PDF file.
69
+ * Sets the name of the exported PDF file.
81
70
  * @default "export.pdf"
82
71
  */
83
72
  fileName = 'export.pdf';
84
73
  /**
85
- * If set to `true`, the content is forwarded to `proxyURL` even if the
86
- * browser supports local saving of files.
74
+ * If `true`, forwards content to `proxyURL` even if the browser supports local file saving.
87
75
  */
88
76
  forceProxy;
89
77
  /**
90
- * The keywords (metadata) of the PDF document.
78
+ * Sets the keywords metadata for the PDF document.
91
79
  */
92
80
  keywords;
93
81
  /**
94
- * A flag that indicates if the page will be in a landscape orientation.
95
- * By default, the page is in a portrait orientation.
96
- *
82
+ * If `true`, sets the page orientation to landscape. The default page orientation is portrait.
97
83
  * @default false
98
84
  */
99
85
  landscape;
100
86
  /**
101
- * Specifies the margins of the page. Numbers are treated as points (`"pt"`).
102
- *
87
+ * Sets the page margins. Numbers use points (`"pt"`).
103
88
  */
104
89
  margin;
105
90
  /**
106
- * Specifies the paper size of the PDF document ([see example]({% slug multipagecontent_pdfexport %}#toc-automatic-page-breaking)).
107
- * Defaults to `"auto"` which means that the paper size is determined by the content.
91
+ * Sets the paper size for the PDF document. Defaults to `"auto"`, which means the content determines the size of the document.
108
92
  * The size of the content in pixels matches the size of the output in points (1 pixel = 1/72 inch).
109
- * If `paperSize` is set, the content is split across multiple pages. This enables the `repeatHeaders` and
110
- * `scale` options, and allows you to specify a template.
111
93
  *
112
- * The paper size can be a `PaperSize`, an array of two numbers which specify the width and height in points (1 pt = 1/72 in), or an
113
- * array of two strings which specify the width and height in units. The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"`.
114
- * @default 'auto'
94
+ * If set, the content splits across pages, and allows you to use `repeatHeaders`, `scale`, and a template.
95
+ *
96
+ * The value can be a `PaperSize`, an array of two numbers (width and height in points), or an array of two strings (width and height in units: `"mm"`, `"cm"`, `"in"`, or `"pt"`).
97
+ * @default "auto"
115
98
  */
116
99
  paperSize;
117
100
  /**
118
- * Specifies if the `<thead>` elements of the tables will be repeated on each page
119
- * ([see example]({% slug recurrenttableheaders_pdfexport %})).
101
+ * If `true`, repeats the `<thead>` elements of tables on each page. This helps keep table headers visible on every page
102
+ * ([see example](slug:recurrenttableheaders_pdfexport)).
120
103
  */
121
104
  repeatHeaders;
122
105
  /**
123
- * A scale factor ([see example]({% slug scalingofcontent_pdfexport %})).
124
- * The text size on the screen might be too big for printing.
125
- * To scale down the output in PDF, use this option.
106
+ * Sets a scale factor for the PDF output. Use this to make the PDF content smaller or larger
107
+ * ([see example](slug:scalingofcontent_pdfexport)).
126
108
  *
127
109
  * @default 1
128
110
  */
129
111
  scale;
130
112
  /**
131
- * A key/value dictionary of form values which will be sent to the proxy.
132
- * Can be used to submit Anti-Forgery tokens and other metadata.
113
+ * Sets a key/value dictionary of form values sent to the proxy. Use this to send extra data, like Anti-Forgery tokens.
133
114
  */
134
115
  proxyData;
135
116
  /**
136
- * The URL of the server-side proxy which streams the file to the end user. You need to use a proxy if
117
+ * Sets the server-side proxy URL for streaming the file to the user. You need to implement a proxy if
137
118
  * the browser is not capable of saving files locally.
138
- * It is your responsibility to implement the server-side proxy. The proxy returns the decoded file with
139
- * the `"Content-Disposition"` header set to `attachment; filename="<fileName.pdf>"`.
119
+ * The proxy returns the decoded file with the `"Content-Disposition"` header set to `attachment; filename="<fileName.pdf>"`.
140
120
  *
141
- * In the request body, the proxy receives a POST request with the specific parameters.
142
- * [See example](slug:server_proxy#toc-implementations).
121
+ * In the request body, the proxy receives a POST request with the specific parameters
122
+ * ([see example](slug:server_proxy#toc-implementations)).
143
123
  */
144
124
  proxyURL;
145
125
  /**
146
- * A name or keyword which indicates where to display the document that is returned from the proxy.
126
+ * Sets where to display the document returned from the proxy. Use `"_self"` to display in the same window.
147
127
  * To display the document in a new window or iframe,
148
- * the proxy has to have the `"Content-Disposition"` header set to `inline; filename="<fileName.pdf>"`.
128
+ * the proxy must have the `"Content-Disposition"` header set to `inline; filename="<fileName.pdf>"`.
149
129
  * @default "_self"
150
130
  */
151
131
  proxyTarget;
152
132
  /**
153
- * The producer (metadata) of the PDF document.
133
+ * Sets the producer metadata for the PDF document.
154
134
  */
155
135
  producer;
156
136
  /**
157
- * The subject (metadata) of the PDF document.
137
+ * Sets the subject metadata for the PDF document.
158
138
  */
159
139
  subject;
160
140
  /**
161
- * The title (metadata) of the PDF document.
141
+ * Sets the title metadata for the PDF document.
162
142
  */
163
143
  title;
164
144
  /**
@@ -10,7 +10,22 @@ import * as i2 from "./pdf-export-margin.component";
10
10
  import * as i3 from "./pdf-export-template.directive";
11
11
  // IMPORTANT: NgModule export kept for backwards compatibility
12
12
  /**
13
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi']) definition for the PDF Export directive.
13
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) definition for the PDF Export component.
14
+ *
15
+ * @example
16
+ * ```typescript
17
+ * import { NgModule } from '@angular/core';
18
+ * import { BrowserModule } from '@angular/platform-browser';
19
+ * import { PDFExportModule } from '@progress/kendo-angular-pdf-export';
20
+ * import { AppComponent } from './app.component';
21
+ *
22
+ * @NgModule({
23
+ * declarations: [AppComponent],
24
+ * imports: [BrowserModule, PDFExportModule],
25
+ * bootstrap: [AppComponent]
26
+ * })
27
+ * export class AppModule {}
28
+ * ```
14
29
  */
15
30
  export class PDFExportModule {
16
31
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: PDFExportModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
@@ -16,11 +16,23 @@ const packageMetadata = {
16
16
  productName: 'Kendo UI for Angular',
17
17
  productCode: 'KENDOUIANGULAR',
18
18
  productCodes: ['KENDOUIANGULAR'],
19
- publishDate: 1749804268,
20
- version: '19.1.2-develop.1',
19
+ publishDate: 1750152577,
20
+ version: '19.1.2-develop.3',
21
21
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
22
22
  };
23
23
 
24
+ /**
25
+ * Represents the directive for defining a custom page template in the PDF Export component ([see example](slug:multipagecontent_pdfexport#page-templates)).
26
+ *
27
+ * @example
28
+ * ```html
29
+ * <kendo-pdf-export paperSize="A4" margin="2cm">
30
+ * <ng-template kendoPDFTemplate let-pageNum="pageNum">
31
+ * <div>Page {{ pageNum }}</div>
32
+ * </ng-template>
33
+ * </kendo-pdf-export>
34
+ * ```
35
+ */
24
36
  class PDFExportTemplateDirective {
25
37
  templateRef;
26
38
  constructor(templateRef) {
@@ -42,26 +54,40 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
42
54
  const FIELDS = ['bottom', 'left', 'right', 'top'];
43
55
  /**
44
56
  * Represents the Kendo UI PDFMargin component for Angular.
57
+ *
58
+ * @example
59
+ * ```html
60
+ * <kendo-pdf-export-margin top="2cm" left="1cm" right="1cm" bottom="2cm">
61
+ * </kendo-pdf-export-margin>
62
+ * ```
45
63
  */
46
64
  class PDFExportMarginComponent {
47
65
  /**
48
- * The bottom margin. The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"` (default).
49
- * Numbers are considered to be points (`"pt"`).
66
+ * Sets the left margin of the PDF page. Accepts a `number` or `string` value.
67
+ *
68
+ * The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"`. Numbers use points (`"pt"`).
69
+ * @default "pt"
50
70
  */
51
71
  left;
52
72
  /**
53
- * The top margin. The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"` (default).
54
- * Numbers are considered to be points (`"pt"`).
73
+ * Sets the top margin of the PDF page. Accepts a `number` or `string` value.
74
+ *
75
+ * The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"`. Numbers use points (`"pt"`).
76
+ * @default "pt"
55
77
  */
56
78
  top;
57
79
  /**
58
- * The right margin. The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"` (default).
59
- * Numbers are considered to be points (`"pt"`).
80
+ * Sets the right margin of the PDF page. Accepts a `number` or `string` value.
81
+ *
82
+ * The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"`. Numbers use points (`"pt"`).
83
+ * @default "pt"
60
84
  */
61
85
  right;
62
86
  /**
63
- * The bottom margin. The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"` (default).
64
- * Numbers are considered to be points (`"pt"`).
87
+ * Sets the bottom margin of the PDF page. Accepts a `number` or `string` value.
88
+ *
89
+ * The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"`. Numbers use points (`"pt"`).
90
+ * @default "pt"
65
91
  */
66
92
  bottom;
67
93
  /**
@@ -121,153 +147,133 @@ const compileTemplate = (templateRef) => {
121
147
  };
122
148
 
123
149
  /**
124
- * Represents the [Kendo UI PDF Export component for Angular]({% slug overview_pdfexport %}).
150
+ * Represents the [Kendo UI PDF Export component for Angular](slug:overview_pdfexport).
125
151
  *
126
152
  * @example
127
- * ```ts-preview
128
- * _@Component({
129
- * selector: 'my-app',
130
- * template: `
131
- * <div class="example-config">
132
- * <button kendoButton (click)="pdf.saveAs('document.pdf')">
133
- * Save As PDF...
134
- * </button>
135
- * </div>
153
+ * ```html
154
+ * <button kendoButton (click)="pdf.saveAs('document.pdf')">
155
+ * Save As PDF...
156
+ * </button>
136
157
  *
137
- * <kendo-pdf-export #pdf paperSize="A4" margin="2cm">
138
- * Content goes here
139
- * </kendo-pdf-export>
140
- * `
141
- * })
142
- * export class AppComponent {
143
- * }
158
+ * <kendo-pdf-export #pdf paperSize="A4" margin="2cm">
159
+ * Content goes here
160
+ * </kendo-pdf-export>
144
161
  * ```
145
162
  */
146
163
  class PDFExportComponent {
147
164
  element;
148
165
  /**
149
- * Specifies if the Print dialog should be opened immediately after loading the document ([see example](slug:autoprint_pdfexport)).
166
+ * If `true`, opens the Print dialog immediately after the PDF loads ([see example](slug:autoprint_pdfexport)).
150
167
  * Requires `@progress/kendo-drawing` v1.9.0 or later.
151
168
  * @default false
152
169
  */
153
170
  autoPrint;
154
171
  /**
155
- * The author (metadata) of the PDF document.
172
+ * Sets the author metadata for the PDF document.
156
173
  */
157
174
  author;
158
175
  /**
159
- * A flag that indicates whether to produce actual hyperlinks in the exported PDF file ([see example](slug:hyperlinks_pdfexport)).
160
- * It is also possible to set a CSS selector. All matching links will be ignored.
176
+ * Specifies whether actual hyperlinks will be produced in the exported PDF file ([see example](slug:hyperlinks_pdfexport)). You can also set a CSS selector to ignore matching links.
161
177
  */
162
178
  avoidLinks;
163
179
  /**
164
- * An optional CSS selector that specifies the elements which cause the page breaks
165
- * ([see example]({% slug multipagecontent_pdfexport %}#toc-manual-page-breaking)).
180
+ * Sets a CSS selector for elements that cause page breaks
181
+ * ([see example](slug:multipagecontent_pdfexport#toc-manual-page-breaking)).
166
182
  */
167
183
  forcePageBreak;
168
184
  /**
169
- * An optional CSS selector that specifies the elements which should not be split across the pages
170
- * ([see example]({% slug multipagecontent_pdfexport %}#toc-preventing-page-breaking-in-elements)).
185
+ * Sets a CSS selector for elements that should not split across pages
186
+ * ([see example](slug:multipagecontent_pdfexport#toc-preventing-page-breaking-in-elements)).
171
187
  */
172
188
  keepTogether;
173
189
  /**
174
- * The creator of the PDF document.
190
+ * Sets the creator metadata for the PDF document.
175
191
  * @default "Kendo UI PDF Generator"
176
192
  */
177
193
  creator = 'Kendo UI PDF Generator';
178
194
  /**
179
- * The date when the PDF document is created. Defaults to `new Date()`.
195
+ * Sets the creation date for the PDF document. Defaults to `new Date()`.
196
+ * @default new Date()
180
197
  */
181
198
  date;
182
199
  /**
183
- * The forced resolution of the images in the exported PDF document
184
- * ([see example]({% slug embeddedimages_pdfexport %})).
185
- * By default, the images are exported at their full resolution.
200
+ * Sets the image resolution in the exported PDF ([see example](slug:embeddedimages_pdfexport)). By default, images use full resolution.
186
201
  */
187
202
  imageResolution;
188
203
  /**
189
- * Specifies the name of the exported PDF file.
204
+ * Sets the name of the exported PDF file.
190
205
  * @default "export.pdf"
191
206
  */
192
207
  fileName = 'export.pdf';
193
208
  /**
194
- * If set to `true`, the content is forwarded to `proxyURL` even if the
195
- * browser supports local saving of files.
209
+ * If `true`, forwards content to `proxyURL` even if the browser supports local file saving.
196
210
  */
197
211
  forceProxy;
198
212
  /**
199
- * The keywords (metadata) of the PDF document.
213
+ * Sets the keywords metadata for the PDF document.
200
214
  */
201
215
  keywords;
202
216
  /**
203
- * A flag that indicates if the page will be in a landscape orientation.
204
- * By default, the page is in a portrait orientation.
205
- *
217
+ * If `true`, sets the page orientation to landscape. The default page orientation is portrait.
206
218
  * @default false
207
219
  */
208
220
  landscape;
209
221
  /**
210
- * Specifies the margins of the page. Numbers are treated as points (`"pt"`).
211
- *
222
+ * Sets the page margins. Numbers use points (`"pt"`).
212
223
  */
213
224
  margin;
214
225
  /**
215
- * Specifies the paper size of the PDF document ([see example]({% slug multipagecontent_pdfexport %}#toc-automatic-page-breaking)).
216
- * Defaults to `"auto"` which means that the paper size is determined by the content.
226
+ * Sets the paper size for the PDF document. Defaults to `"auto"`, which means the content determines the size of the document.
217
227
  * The size of the content in pixels matches the size of the output in points (1 pixel = 1/72 inch).
218
- * If `paperSize` is set, the content is split across multiple pages. This enables the `repeatHeaders` and
219
- * `scale` options, and allows you to specify a template.
220
228
  *
221
- * The paper size can be a `PaperSize`, an array of two numbers which specify the width and height in points (1 pt = 1/72 in), or an
222
- * array of two strings which specify the width and height in units. The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"`.
223
- * @default 'auto'
229
+ * If set, the content splits across pages, and allows you to use `repeatHeaders`, `scale`, and a template.
230
+ *
231
+ * The value can be a `PaperSize`, an array of two numbers (width and height in points), or an array of two strings (width and height in units: `"mm"`, `"cm"`, `"in"`, or `"pt"`).
232
+ * @default "auto"
224
233
  */
225
234
  paperSize;
226
235
  /**
227
- * Specifies if the `<thead>` elements of the tables will be repeated on each page
228
- * ([see example]({% slug recurrenttableheaders_pdfexport %})).
236
+ * If `true`, repeats the `<thead>` elements of tables on each page. This helps keep table headers visible on every page
237
+ * ([see example](slug:recurrenttableheaders_pdfexport)).
229
238
  */
230
239
  repeatHeaders;
231
240
  /**
232
- * A scale factor ([see example]({% slug scalingofcontent_pdfexport %})).
233
- * The text size on the screen might be too big for printing.
234
- * To scale down the output in PDF, use this option.
241
+ * Sets a scale factor for the PDF output. Use this to make the PDF content smaller or larger
242
+ * ([see example](slug:scalingofcontent_pdfexport)).
235
243
  *
236
244
  * @default 1
237
245
  */
238
246
  scale;
239
247
  /**
240
- * A key/value dictionary of form values which will be sent to the proxy.
241
- * Can be used to submit Anti-Forgery tokens and other metadata.
248
+ * Sets a key/value dictionary of form values sent to the proxy. Use this to send extra data, like Anti-Forgery tokens.
242
249
  */
243
250
  proxyData;
244
251
  /**
245
- * The URL of the server-side proxy which streams the file to the end user. You need to use a proxy if
252
+ * Sets the server-side proxy URL for streaming the file to the user. You need to implement a proxy if
246
253
  * the browser is not capable of saving files locally.
247
- * It is your responsibility to implement the server-side proxy. The proxy returns the decoded file with
248
- * the `"Content-Disposition"` header set to `attachment; filename="<fileName.pdf>"`.
254
+ * The proxy returns the decoded file with the `"Content-Disposition"` header set to `attachment; filename="<fileName.pdf>"`.
249
255
  *
250
- * In the request body, the proxy receives a POST request with the specific parameters.
251
- * [See example](slug:server_proxy#toc-implementations).
256
+ * In the request body, the proxy receives a POST request with the specific parameters
257
+ * ([see example](slug:server_proxy#toc-implementations)).
252
258
  */
253
259
  proxyURL;
254
260
  /**
255
- * A name or keyword which indicates where to display the document that is returned from the proxy.
261
+ * Sets where to display the document returned from the proxy. Use `"_self"` to display in the same window.
256
262
  * To display the document in a new window or iframe,
257
- * the proxy has to have the `"Content-Disposition"` header set to `inline; filename="<fileName.pdf>"`.
263
+ * the proxy must have the `"Content-Disposition"` header set to `inline; filename="<fileName.pdf>"`.
258
264
  * @default "_self"
259
265
  */
260
266
  proxyTarget;
261
267
  /**
262
- * The producer (metadata) of the PDF document.
268
+ * Sets the producer metadata for the PDF document.
263
269
  */
264
270
  producer;
265
271
  /**
266
- * The subject (metadata) of the PDF document.
272
+ * Sets the subject metadata for the PDF document.
267
273
  */
268
274
  subject;
269
275
  /**
270
- * The title (metadata) of the PDF document.
276
+ * Sets the title metadata for the PDF document.
271
277
  */
272
278
  title;
273
279
  /**
@@ -436,7 +442,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
436
442
  }] } });
437
443
 
438
444
  /**
439
- * Utility array that contains all `PDFExport` related components and directives
445
+ * Use the `KENDO_PDFEXPORT` utility array to add all `@progress/kendo-angular-pdf-export`-related components and directives to a standalone Angular component.
446
+ *
447
+ * @example
448
+ * ```typescript
449
+ * import { Component } from '@angular/core';
450
+ * import { KENDO_PDFEXPORT } from "@progress/kendo-angular-pdf-export";
451
+ *
452
+ * @Component({
453
+ * standalone: true,
454
+ * imports: [KENDO_PDFEXPORT],
455
+ * selector: 'my-app',
456
+ * template: `<kendo-pdf-export></kendo-pdf-export>`
457
+ * })
458
+ * export class AppComponent {}
459
+ * ```
440
460
  */
441
461
  const KENDO_PDFEXPORT = [
442
462
  PDFExportComponent,
@@ -446,7 +466,22 @@ const KENDO_PDFEXPORT = [
446
466
 
447
467
  // IMPORTANT: NgModule export kept for backwards compatibility
448
468
  /**
449
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi']) definition for the PDF Export directive.
469
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) definition for the PDF Export component.
470
+ *
471
+ * @example
472
+ * ```typescript
473
+ * import { NgModule } from '@angular/core';
474
+ * import { BrowserModule } from '@angular/platform-browser';
475
+ * import { PDFExportModule } from '@progress/kendo-angular-pdf-export';
476
+ * import { AppComponent } from './app.component';
477
+ *
478
+ * @NgModule({
479
+ * declarations: [AppComponent],
480
+ * imports: [BrowserModule, PDFExportModule],
481
+ * bootstrap: [AppComponent]
482
+ * })
483
+ * export class AppModule {}
484
+ * ```
450
485
  */
451
486
  class PDFExportModule {
452
487
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: PDFExportModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@progress/kendo-angular-pdf-export",
3
- "version": "19.1.2-develop.1",
3
+ "version": "19.1.2-develop.3",
4
4
  "description": "Kendo UI for Angular PDF Export Component",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "author": "Progress",
@@ -17,7 +17,7 @@
17
17
  "package": {
18
18
  "productName": "Kendo UI for Angular",
19
19
  "productCode": "KENDOUIANGULAR",
20
- "publishDate": 1749804268,
20
+ "publishDate": 1750152577,
21
21
  "licensingDocsUrl": "https://www.telerik.com/kendo-angular-ui/my-license/"
22
22
  }
23
23
  },
@@ -28,12 +28,12 @@
28
28
  "@angular/platform-browser": "16 - 20",
29
29
  "@progress/kendo-drawing": "^1.21.0",
30
30
  "@progress/kendo-licensing": "^1.5.0",
31
- "@progress/kendo-angular-common": "19.1.2-develop.1",
31
+ "@progress/kendo-angular-common": "19.1.2-develop.3",
32
32
  "rxjs": "^6.5.3 || ^7.0.0"
33
33
  },
34
34
  "dependencies": {
35
35
  "tslib": "^2.3.1",
36
- "@progress/kendo-angular-schematics": "19.1.2-develop.1",
36
+ "@progress/kendo-angular-schematics": "19.1.2-develop.3",
37
37
  "@progress/kendo-file-saver": "^1.0.1"
38
38
  },
39
39
  "schematics": "./schematics/collection.json",
@@ -6,26 +6,40 @@ import { pdf } from '@progress/kendo-drawing';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
8
  * Represents the Kendo UI PDFMargin component for Angular.
9
+ *
10
+ * @example
11
+ * ```html
12
+ * <kendo-pdf-export-margin top="2cm" left="1cm" right="1cm" bottom="2cm">
13
+ * </kendo-pdf-export-margin>
14
+ * ```
9
15
  */
10
16
  export declare class PDFExportMarginComponent implements pdf.PageMargin {
11
17
  /**
12
- * The bottom margin. The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"` (default).
13
- * Numbers are considered to be points (`"pt"`).
18
+ * Sets the left margin of the PDF page. Accepts a `number` or `string` value.
19
+ *
20
+ * The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"`. Numbers use points (`"pt"`).
21
+ * @default "pt"
14
22
  */
15
23
  left?: number | string;
16
24
  /**
17
- * The top margin. The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"` (default).
18
- * Numbers are considered to be points (`"pt"`).
25
+ * Sets the top margin of the PDF page. Accepts a `number` or `string` value.
26
+ *
27
+ * The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"`. Numbers use points (`"pt"`).
28
+ * @default "pt"
19
29
  */
20
30
  top?: number | string;
21
31
  /**
22
- * The right margin. The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"` (default).
23
- * Numbers are considered to be points (`"pt"`).
32
+ * Sets the right margin of the PDF page. Accepts a `number` or `string` value.
33
+ *
34
+ * The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"`. Numbers use points (`"pt"`).
35
+ * @default "pt"
24
36
  */
25
37
  right?: number | string;
26
38
  /**
27
- * The bottom margin. The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"` (default).
28
- * Numbers are considered to be points (`"pt"`).
39
+ * Sets the bottom margin of the PDF page. Accepts a `number` or `string` value.
40
+ *
41
+ * The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"`. Numbers use points (`"pt"`).
42
+ * @default "pt"
29
43
  */
30
44
  bottom?: number | string;
31
45
  /**
@@ -4,6 +4,18 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
+ /**
8
+ * Represents the directive for defining a custom page template in the PDF Export component ([see example](slug:multipagecontent_pdfexport#page-templates)).
9
+ *
10
+ * @example
11
+ * ```html
12
+ * <kendo-pdf-export paperSize="A4" margin="2cm">
13
+ * <ng-template kendoPDFTemplate let-pageNum="pageNum">
14
+ * <div>Page {{ pageNum }}</div>
15
+ * </ng-template>
16
+ * </kendo-pdf-export>
17
+ * ```
18
+ */
7
19
  export declare class PDFExportTemplateDirective {
8
20
  templateRef: TemplateRef<any>;
9
21
  constructor(templateRef: TemplateRef<any>);
@@ -18,155 +18,135 @@ import * as i0 from "@angular/core";
18
18
  */
19
19
  export type PaperSize = pdf.PaperSize;
20
20
  /**
21
- * Represents the [Kendo UI PDF Export component for Angular]({% slug overview_pdfexport %}).
21
+ * Represents the [Kendo UI PDF Export component for Angular](slug:overview_pdfexport).
22
22
  *
23
23
  * @example
24
- * ```ts-preview
25
- * _@Component({
26
- * selector: 'my-app',
27
- * template: `
28
- * <div class="example-config">
29
- * <button kendoButton (click)="pdf.saveAs('document.pdf')">
30
- * Save As PDF...
31
- * </button>
32
- * </div>
24
+ * ```html
25
+ * <button kendoButton (click)="pdf.saveAs('document.pdf')">
26
+ * Save As PDF...
27
+ * </button>
33
28
  *
34
- * <kendo-pdf-export #pdf paperSize="A4" margin="2cm">
35
- * Content goes here
36
- * </kendo-pdf-export>
37
- * `
38
- * })
39
- * export class AppComponent {
40
- * }
29
+ * <kendo-pdf-export #pdf paperSize="A4" margin="2cm">
30
+ * Content goes here
31
+ * </kendo-pdf-export>
41
32
  * ```
42
33
  */
43
34
  export declare class PDFExportComponent implements pdf.PDFOptions {
44
35
  protected element: ElementRef;
45
36
  /**
46
- * Specifies if the Print dialog should be opened immediately after loading the document ([see example](slug:autoprint_pdfexport)).
37
+ * If `true`, opens the Print dialog immediately after the PDF loads ([see example](slug:autoprint_pdfexport)).
47
38
  * Requires `@progress/kendo-drawing` v1.9.0 or later.
48
39
  * @default false
49
40
  */
50
41
  autoPrint?: boolean;
51
42
  /**
52
- * The author (metadata) of the PDF document.
43
+ * Sets the author metadata for the PDF document.
53
44
  */
54
45
  author: string;
55
46
  /**
56
- * A flag that indicates whether to produce actual hyperlinks in the exported PDF file ([see example](slug:hyperlinks_pdfexport)).
57
- * It is also possible to set a CSS selector. All matching links will be ignored.
47
+ * Specifies whether actual hyperlinks will be produced in the exported PDF file ([see example](slug:hyperlinks_pdfexport)). You can also set a CSS selector to ignore matching links.
58
48
  */
59
49
  avoidLinks: boolean | string;
60
50
  /**
61
- * An optional CSS selector that specifies the elements which cause the page breaks
62
- * ([see example]({% slug multipagecontent_pdfexport %}#toc-manual-page-breaking)).
51
+ * Sets a CSS selector for elements that cause page breaks
52
+ * ([see example](slug:multipagecontent_pdfexport#toc-manual-page-breaking)).
63
53
  */
64
54
  forcePageBreak: string;
65
55
  /**
66
- * An optional CSS selector that specifies the elements which should not be split across the pages
67
- * ([see example]({% slug multipagecontent_pdfexport %}#toc-preventing-page-breaking-in-elements)).
56
+ * Sets a CSS selector for elements that should not split across pages
57
+ * ([see example](slug:multipagecontent_pdfexport#toc-preventing-page-breaking-in-elements)).
68
58
  */
69
59
  keepTogether: string;
70
60
  /**
71
- * The creator of the PDF document.
61
+ * Sets the creator metadata for the PDF document.
72
62
  * @default "Kendo UI PDF Generator"
73
63
  */
74
64
  creator: string;
75
65
  /**
76
- * The date when the PDF document is created. Defaults to `new Date()`.
66
+ * Sets the creation date for the PDF document. Defaults to `new Date()`.
67
+ * @default new Date()
77
68
  */
78
69
  date: Date;
79
70
  /**
80
- * The forced resolution of the images in the exported PDF document
81
- * ([see example]({% slug embeddedimages_pdfexport %})).
82
- * By default, the images are exported at their full resolution.
71
+ * Sets the image resolution in the exported PDF ([see example](slug:embeddedimages_pdfexport)). By default, images use full resolution.
83
72
  */
84
73
  imageResolution: number;
85
74
  /**
86
- * Specifies the name of the exported PDF file.
75
+ * Sets the name of the exported PDF file.
87
76
  * @default "export.pdf"
88
77
  */
89
78
  fileName: string;
90
79
  /**
91
- * If set to `true`, the content is forwarded to `proxyURL` even if the
92
- * browser supports local saving of files.
80
+ * If `true`, forwards content to `proxyURL` even if the browser supports local file saving.
93
81
  */
94
82
  forceProxy: boolean;
95
83
  /**
96
- * The keywords (metadata) of the PDF document.
84
+ * Sets the keywords metadata for the PDF document.
97
85
  */
98
86
  keywords: string;
99
87
  /**
100
- * A flag that indicates if the page will be in a landscape orientation.
101
- * By default, the page is in a portrait orientation.
102
- *
88
+ * If `true`, sets the page orientation to landscape. The default page orientation is portrait.
103
89
  * @default false
104
90
  */
105
91
  landscape: boolean;
106
92
  /**
107
- * Specifies the margins of the page. Numbers are treated as points (`"pt"`).
108
- *
93
+ * Sets the page margins. Numbers use points (`"pt"`).
109
94
  */
110
95
  margin: string | number | pdf.PageMargin;
111
96
  /**
112
- * Specifies the paper size of the PDF document ([see example]({% slug multipagecontent_pdfexport %}#toc-automatic-page-breaking)).
113
- * Defaults to `"auto"` which means that the paper size is determined by the content.
97
+ * Sets the paper size for the PDF document. Defaults to `"auto"`, which means the content determines the size of the document.
114
98
  * The size of the content in pixels matches the size of the output in points (1 pixel = 1/72 inch).
115
- * If `paperSize` is set, the content is split across multiple pages. This enables the `repeatHeaders` and
116
- * `scale` options, and allows you to specify a template.
117
99
  *
118
- * The paper size can be a `PaperSize`, an array of two numbers which specify the width and height in points (1 pt = 1/72 in), or an
119
- * array of two strings which specify the width and height in units. The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"`.
120
- * @default 'auto'
100
+ * If set, the content splits across pages, and allows you to use `repeatHeaders`, `scale`, and a template.
101
+ *
102
+ * The value can be a `PaperSize`, an array of two numbers (width and height in points), or an array of two strings (width and height in units: `"mm"`, `"cm"`, `"in"`, or `"pt"`).
103
+ * @default "auto"
121
104
  */
122
105
  paperSize: PaperSize;
123
106
  /**
124
- * Specifies if the `<thead>` elements of the tables will be repeated on each page
125
- * ([see example]({% slug recurrenttableheaders_pdfexport %})).
107
+ * If `true`, repeats the `<thead>` elements of tables on each page. This helps keep table headers visible on every page
108
+ * ([see example](slug:recurrenttableheaders_pdfexport)).
126
109
  */
127
110
  repeatHeaders: boolean;
128
111
  /**
129
- * A scale factor ([see example]({% slug scalingofcontent_pdfexport %})).
130
- * The text size on the screen might be too big for printing.
131
- * To scale down the output in PDF, use this option.
112
+ * Sets a scale factor for the PDF output. Use this to make the PDF content smaller or larger
113
+ * ([see example](slug:scalingofcontent_pdfexport)).
132
114
  *
133
115
  * @default 1
134
116
  */
135
117
  scale: number;
136
118
  /**
137
- * A key/value dictionary of form values which will be sent to the proxy.
138
- * Can be used to submit Anti-Forgery tokens and other metadata.
119
+ * Sets a key/value dictionary of form values sent to the proxy. Use this to send extra data, like Anti-Forgery tokens.
139
120
  */
140
121
  proxyData?: {
141
122
  [key: string]: string;
142
123
  };
143
124
  /**
144
- * The URL of the server-side proxy which streams the file to the end user. You need to use a proxy if
125
+ * Sets the server-side proxy URL for streaming the file to the user. You need to implement a proxy if
145
126
  * the browser is not capable of saving files locally.
146
- * It is your responsibility to implement the server-side proxy. The proxy returns the decoded file with
147
- * the `"Content-Disposition"` header set to `attachment; filename="<fileName.pdf>"`.
127
+ * The proxy returns the decoded file with the `"Content-Disposition"` header set to `attachment; filename="<fileName.pdf>"`.
148
128
  *
149
- * In the request body, the proxy receives a POST request with the specific parameters.
150
- * [See example](slug:server_proxy#toc-implementations).
129
+ * In the request body, the proxy receives a POST request with the specific parameters
130
+ * ([see example](slug:server_proxy#toc-implementations)).
151
131
  */
152
132
  proxyURL: string;
153
133
  /**
154
- * A name or keyword which indicates where to display the document that is returned from the proxy.
134
+ * Sets where to display the document returned from the proxy. Use `"_self"` to display in the same window.
155
135
  * To display the document in a new window or iframe,
156
- * the proxy has to have the `"Content-Disposition"` header set to `inline; filename="<fileName.pdf>"`.
136
+ * the proxy must have the `"Content-Disposition"` header set to `inline; filename="<fileName.pdf>"`.
157
137
  * @default "_self"
158
138
  */
159
139
  proxyTarget: string;
160
140
  /**
161
- * The producer (metadata) of the PDF document.
141
+ * Sets the producer metadata for the PDF document.
162
142
  */
163
143
  producer: string;
164
144
  /**
165
- * The subject (metadata) of the PDF document.
145
+ * Sets the subject metadata for the PDF document.
166
146
  */
167
147
  subject: string;
168
148
  /**
169
- * The title (metadata) of the PDF document.
149
+ * Sets the title metadata for the PDF document.
170
150
  */
171
151
  title: string;
172
152
  /**
@@ -7,7 +7,22 @@ import * as i1 from "./pdf-export.component";
7
7
  import * as i2 from "./pdf-export-margin.component";
8
8
  import * as i3 from "./pdf-export-template.directive";
9
9
  /**
10
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi']) definition for the PDF Export directive.
10
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) definition for the PDF Export component.
11
+ *
12
+ * @example
13
+ * ```typescript
14
+ * import { NgModule } from '@angular/core';
15
+ * import { BrowserModule } from '@angular/platform-browser';
16
+ * import { PDFExportModule } from '@progress/kendo-angular-pdf-export';
17
+ * import { AppComponent } from './app.component';
18
+ *
19
+ * @NgModule({
20
+ * declarations: [AppComponent],
21
+ * imports: [BrowserModule, PDFExportModule],
22
+ * bootstrap: [AppComponent]
23
+ * })
24
+ * export class AppModule {}
25
+ * ```
11
26
  */
12
27
  export declare class PDFExportModule {
13
28
  static ɵfac: i0.ɵɵFactoryDeclaration<PDFExportModule, never>;