@progress/kendo-angular-grid 12.0.0-develop.10 → 12.0.0-develop.12
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/column-menu/column-menu.service.d.ts +9 -21
- package/columns/column-base.d.ts +14 -369
- package/columns/sort-settings.d.ts +20 -4
- package/common/fetch-data-callback.d.ts +1 -1
- package/common/preventable-event.d.ts +1 -1
- package/common/single-popup.service.d.ts +1 -1
- package/common/size-options.d.ts +1 -2
- package/data/grid-item.interface.d.ts +6 -3
- package/esm2020/column-menu/column-menu.service.mjs +9 -21
- package/esm2020/columns/column-base.mjs +6 -40
- package/esm2020/common/preventable-event.mjs +1 -1
- package/esm2020/common/single-popup.service.mjs +1 -1
- package/esm2020/excel/excel.module.mjs +5 -15
- package/esm2020/grid.component.mjs +1 -1
- package/esm2020/grid.module.mjs +6 -16
- package/esm2020/layout/sizing-options.service.mjs +3 -0
- package/esm2020/package-metadata.mjs +2 -2
- package/esm2020/pdf/pdf.module.mjs +7 -16
- package/esm2020/rendering/toolbar/toolbar-position.mjs +17 -0
- package/excel/excel.module.d.ts +5 -15
- package/fesm2015/progress-kendo-angular-grid.mjs +41 -113
- package/fesm2020/progress-kendo-angular-grid.mjs +41 -113
- package/filtering/filterable.d.ts +10 -0
- package/grid.component.d.ts +1 -1
- package/grid.module.d.ts +6 -16
- package/layout/sizing-options.service.d.ts +3 -0
- package/navigation/navigable-settings.d.ts +15 -1
- package/package.json +15 -15
- package/pager/pager-settings.d.ts +8 -12
- package/pdf/pdf.module.d.ts +7 -16
- package/rendering/common/row-class.d.ts +4 -4
- package/rendering/toolbar/toolbar-position.d.ts +18 -1
- package/schematics/ngAdd/index.js +2 -2
- package/scrolling/scrollmode.d.ts +4 -4
- package/selection/types.d.ts +24 -2
|
@@ -10,27 +10,15 @@ import * as i0 from "@angular/core";
|
|
|
10
10
|
* [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
|
|
11
11
|
*
|
|
12
12
|
* @example
|
|
13
|
-
* ```
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
* <kendo-grid-columnmenu-sort [service]="service">
|
|
23
|
-
* </kendo-grid-columnmenu-sort>
|
|
24
|
-
* </ng-template>
|
|
25
|
-
* <kendo-grid-column field="Field1"></kendo-grid-column>
|
|
26
|
-
* <kendo-grid-column field="Field2"></kendo-grid-column>
|
|
27
|
-
* </kendo-grid>
|
|
28
|
-
* `
|
|
29
|
-
* })
|
|
30
|
-
*
|
|
31
|
-
* class AppComponent {
|
|
32
|
-
* public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
|
|
33
|
-
* }
|
|
13
|
+
* ```html
|
|
14
|
+
* <kendo-grid [data]="data" [columnMenu]="true">
|
|
15
|
+
* <ng-template kendoGridColumnMenuTemplate let-service="service">
|
|
16
|
+
* <span class="k-icon k-i-x" (click)="service.close()" </span>
|
|
17
|
+
* <kendo-grid-columnmenu-sort [service]="service">
|
|
18
|
+
* </kendo-grid-columnmenu-sort>
|
|
19
|
+
* </ng-template>
|
|
20
|
+
* <kendo-grid-column field="Field1"></kendo-grid-column>
|
|
21
|
+
* </kendo-grid>
|
|
34
22
|
*
|
|
35
23
|
* ```
|
|
36
24
|
*/
|
package/columns/column-base.d.ts
CHANGED
|
@@ -30,9 +30,9 @@ export declare class ColumnBase {
|
|
|
30
30
|
*/
|
|
31
31
|
matchesMedia: boolean;
|
|
32
32
|
/**
|
|
33
|
-
* The column index after reordering.
|
|
33
|
+
* The column index after reordering. The `orderIndex` is a read-only property. Setting this field does not affect column order.
|
|
34
34
|
*
|
|
35
|
-
*
|
|
35
|
+
* @default 0
|
|
36
36
|
*/
|
|
37
37
|
orderIndex: number;
|
|
38
38
|
/**
|
|
@@ -90,44 +90,6 @@ export declare class ColumnBase {
|
|
|
90
90
|
*
|
|
91
91
|
* @default false
|
|
92
92
|
*
|
|
93
|
-
* @example
|
|
94
|
-
* ```ts
|
|
95
|
-
* _@Component({
|
|
96
|
-
* selector: 'my-app',
|
|
97
|
-
* template: `
|
|
98
|
-
* <kendo-grid [data]="gridData" [scrollable]="scrollable" style="height: 200px">
|
|
99
|
-
* <kendo-grid-column field="ProductID" title="Product ID" [width]="120" [locked]="true">
|
|
100
|
-
* </kendo-grid-column>
|
|
101
|
-
* <kendo-grid-column field="ProductName" title="Product Name" [width]="200">
|
|
102
|
-
* </kendo-grid-column>
|
|
103
|
-
* <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
|
|
104
|
-
* </kendo-grid-column>
|
|
105
|
-
* </kendo-grid>
|
|
106
|
-
* `
|
|
107
|
-
* })
|
|
108
|
-
*
|
|
109
|
-
* class AppComponent {
|
|
110
|
-
* public gridData: any[];
|
|
111
|
-
*
|
|
112
|
-
* constructor() {
|
|
113
|
-
* this.gridData = products;
|
|
114
|
-
* }
|
|
115
|
-
* }
|
|
116
|
-
*
|
|
117
|
-
* const products = [{
|
|
118
|
-
* "ProductID": 1,
|
|
119
|
-
* "ProductName": "Chai",
|
|
120
|
-
* "UnitPrice": 18.0000,
|
|
121
|
-
* "Discontinued": true
|
|
122
|
-
* }, {
|
|
123
|
-
* "ProductID": 2,
|
|
124
|
-
* "ProductName": "Chang",
|
|
125
|
-
* "UnitPrice": 19.0000,
|
|
126
|
-
* "Discontinued": false
|
|
127
|
-
* }
|
|
128
|
-
* ];
|
|
129
|
-
*
|
|
130
|
-
* ```
|
|
131
93
|
*/
|
|
132
94
|
set locked(value: boolean);
|
|
133
95
|
get locked(): boolean;
|
|
@@ -148,85 +110,35 @@ export declare class ColumnBase {
|
|
|
148
110
|
* Sets the condition that needs to be satisfied for a column to remain visible ([see example]({% slug styling_responsive_grid %}#toc-columns)).
|
|
149
111
|
* If you set the `hidden` property, the behavior of `media` is overridden.
|
|
150
112
|
*
|
|
151
|
-
* @example
|
|
152
|
-
* ```html
|
|
153
|
-
* <kendo-grid>
|
|
154
|
-
* <kendo-grid-column field="UnitPrice" media="(min-width: 320px)">
|
|
155
|
-
* </kendo-grid-column>
|
|
156
|
-
* </kendo-grid>
|
|
157
|
-
* ```
|
|
158
|
-
*
|
|
159
113
|
* Accepts the device identifiers that are [available in Bootstrap 4](https://v4-alpha.getbootstrap.com/layout/grid/#grid-options)
|
|
160
114
|
* ([see example]({% slug styling_responsive_grid %}#toc-bootstrap-4-compatibility)):
|
|
161
|
-
* * `"xs"`—Equivalent to `"(max-width: 576px)"`.
|
|
162
|
-
* * `"sm"`—Equivalent to `"(min-width: 576px)"`.
|
|
163
|
-
* * `"md"`—Equivalent to `"(min-width: 768px)"`.
|
|
164
|
-
* * `"lg"`—Equivalent to `"(min-width: 992px)"`.
|
|
165
|
-
* * `"xl"`—Equivalent to `"(min-width: 1200px)"`.
|
|
166
|
-
*
|
|
167
|
-
* @example
|
|
168
|
-
* ```html
|
|
169
|
-
* <kendo-grid>
|
|
170
|
-
* <kendo-grid-column field="UnitPrice" media="md">
|
|
171
|
-
* </kendo-grid-column>
|
|
172
|
-
* </kendo-grid>
|
|
173
|
-
* ```
|
|
174
115
|
*/
|
|
175
116
|
media: string;
|
|
176
117
|
/**
|
|
177
118
|
* Specifies if the column can be locked or unlocked from the column menu or by reordering the columns.
|
|
119
|
+
* @default true
|
|
178
120
|
*/
|
|
179
121
|
lockable: boolean;
|
|
180
122
|
/**
|
|
181
123
|
* Specifies if the column can be stuck or unstuck from the column menu.
|
|
124
|
+
* @default true
|
|
182
125
|
*/
|
|
183
126
|
stickable: boolean;
|
|
184
127
|
/**
|
|
185
128
|
* Specifies if the column menu will be shown for the column.
|
|
129
|
+
* @default true
|
|
186
130
|
*/
|
|
187
131
|
columnMenu: boolean;
|
|
188
132
|
/**
|
|
189
133
|
* Specifies if the column will be included in the column-chooser list.
|
|
134
|
+
* @default true
|
|
190
135
|
*/
|
|
191
136
|
includeInChooser: boolean;
|
|
192
137
|
/**
|
|
193
138
|
* Sets the custom styles for the table cells (excluding the footer and header ones) of the column. Under the hood,
|
|
194
139
|
* to apply the property, the `style` option uses the
|
|
195
|
-
* [NgStyle](link:site.data.urls.angular['ngstyleapi']) directive.
|
|
140
|
+
* [NgStyle](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-cells).
|
|
196
141
|
*
|
|
197
|
-
* @example
|
|
198
|
-
* ```ts
|
|
199
|
-
* _@Component({
|
|
200
|
-
* selector: 'my-app',
|
|
201
|
-
* template: `
|
|
202
|
-
* <kendo-grid [data]="gridData" style="height: 200px">
|
|
203
|
-
* <kendo-grid-column field="ProductName" title="Product Name" [width]="200" [style]="{'text-align': 'right'}">
|
|
204
|
-
* </kendo-grid-column>
|
|
205
|
-
* <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
|
|
206
|
-
* </kendo-grid-column>
|
|
207
|
-
* </kendo-grid>
|
|
208
|
-
* `
|
|
209
|
-
* })
|
|
210
|
-
*
|
|
211
|
-
* class AppComponent {
|
|
212
|
-
* public gridData: any[];
|
|
213
|
-
*
|
|
214
|
-
* constructor() {
|
|
215
|
-
* this.gridData = [{
|
|
216
|
-
* "ProductID": 1,
|
|
217
|
-
* "ProductName": "Chai",
|
|
218
|
-
* "UnitPrice": 18.0000,
|
|
219
|
-
* "Discontinued": true
|
|
220
|
-
* }, {
|
|
221
|
-
* "ProductID": 2,
|
|
222
|
-
* "ProductName": "Chang",
|
|
223
|
-
* "UnitPrice": 19.0000,
|
|
224
|
-
* "Discontinued": false
|
|
225
|
-
* }];
|
|
226
|
-
* }
|
|
227
|
-
* }
|
|
228
|
-
*
|
|
229
|
-
* ```
|
|
230
142
|
*/
|
|
231
143
|
style: {
|
|
232
144
|
[key: string]: string;
|
|
@@ -234,41 +146,8 @@ export declare class ColumnBase {
|
|
|
234
146
|
/**
|
|
235
147
|
* Sets the custom styles for the header cell of the column. Under the hood, to apply the property,
|
|
236
148
|
* the `headerStyle` option uses the
|
|
237
|
-
* [NgStyle](link:site.data.urls.angular['ngstyleapi']) directive.
|
|
238
|
-
*
|
|
239
|
-
* @example
|
|
240
|
-
* ```ts
|
|
241
|
-
* _@Component({
|
|
242
|
-
* selector: 'my-app',
|
|
243
|
-
* template: `
|
|
244
|
-
* <kendo-grid [data]="gridData" style="height: 200px">
|
|
245
|
-
* <kendo-grid-column field="ProductName" title="Product Name" [width]="200" [headerStyle]="{'text-align': 'right'}">
|
|
246
|
-
* </kendo-grid-column>
|
|
247
|
-
* <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
|
|
248
|
-
* </kendo-grid-column>
|
|
249
|
-
* </kendo-grid>
|
|
250
|
-
* `
|
|
251
|
-
* })
|
|
252
|
-
*
|
|
253
|
-
* class AppComponent {
|
|
254
|
-
* public gridData: any[];
|
|
149
|
+
* [NgStyle](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-header).
|
|
255
150
|
*
|
|
256
|
-
* constructor() {
|
|
257
|
-
* this.gridData = [{
|
|
258
|
-
* "ProductID": 1,
|
|
259
|
-
* "ProductName": "Chai",
|
|
260
|
-
* "UnitPrice": 18.0000,
|
|
261
|
-
* "Discontinued": true
|
|
262
|
-
* }, {
|
|
263
|
-
* "ProductID": 2,
|
|
264
|
-
* "ProductName": "Chang",
|
|
265
|
-
* "UnitPrice": 19.0000,
|
|
266
|
-
* "Discontinued": false
|
|
267
|
-
* }];
|
|
268
|
-
* }
|
|
269
|
-
* }
|
|
270
|
-
*
|
|
271
|
-
* ```
|
|
272
151
|
*/
|
|
273
152
|
headerStyle: {
|
|
274
153
|
[key: string]: string;
|
|
@@ -276,41 +155,8 @@ export declare class ColumnBase {
|
|
|
276
155
|
/**
|
|
277
156
|
* Sets the custom styles for the filter row cell. Under the hood, to apply the property,
|
|
278
157
|
* the `filterStyle` option uses the
|
|
279
|
-
* [NgStyle](link:site.data.urls.angular['ngstyleapi']) directive.
|
|
280
|
-
*
|
|
281
|
-
* @example
|
|
282
|
-
* ```ts
|
|
283
|
-
* _@Component({
|
|
284
|
-
* selector: 'my-app',
|
|
285
|
-
* template: `
|
|
286
|
-
* <kendo-grid [data]="gridData" style="height: 180px" [filterable]="true">
|
|
287
|
-
* <kendo-grid-column field="ProductName" title="Product Name" [width]="200" [filterStyle]="{'padding': '25px'}">
|
|
288
|
-
* </kendo-grid-column>
|
|
289
|
-
* <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="200">
|
|
290
|
-
* </kendo-grid-column>
|
|
291
|
-
* </kendo-grid>
|
|
292
|
-
* `
|
|
293
|
-
* })
|
|
294
|
-
*
|
|
295
|
-
* export class AppComponent {
|
|
296
|
-
* public gridData: any[];
|
|
297
|
-
*
|
|
298
|
-
* constructor() {
|
|
299
|
-
* this.gridData = [{
|
|
300
|
-
* "ProductID": 1,
|
|
301
|
-
* "ProductName": "Chai",
|
|
302
|
-
* "UnitPrice": 18.0000,
|
|
303
|
-
* "Discontinued": true
|
|
304
|
-
* }, {
|
|
305
|
-
* "ProductID": 2,
|
|
306
|
-
* "ProductName": "Chang",
|
|
307
|
-
* "UnitPrice": 19.0000,
|
|
308
|
-
* "Discontinued": false
|
|
309
|
-
* }];
|
|
310
|
-
* }
|
|
311
|
-
* }
|
|
158
|
+
* [NgStyle](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-filter-row-cells).
|
|
312
159
|
*
|
|
313
|
-
* ```
|
|
314
160
|
*/
|
|
315
161
|
filterStyle: {
|
|
316
162
|
[key: string]: string;
|
|
@@ -318,95 +164,18 @@ export declare class ColumnBase {
|
|
|
318
164
|
/**
|
|
319
165
|
* Sets the custom styles for the footer cell of the column. Under the hood, to apply the property,
|
|
320
166
|
* the `footerStyle` option uses the
|
|
321
|
-
* [NgStyle](link:site.data.urls.angular['ngstyleapi']) directive.
|
|
167
|
+
* [NgStyle](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-footer).
|
|
322
168
|
*
|
|
323
|
-
* @example
|
|
324
|
-
* ```ts
|
|
325
|
-
* _@Component({
|
|
326
|
-
* selector: 'my-app',
|
|
327
|
-
* template: `
|
|
328
|
-
* <kendo-grid [data]="gridData" style="height: 200px">
|
|
329
|
-
* <kendo-grid-column field="ProductName" title="Product Name" [width]="200" [footerStyle]="{'text-align': 'right'}">
|
|
330
|
-
* <ng-template kendoGridFooterTemplate>
|
|
331
|
-
* footer text
|
|
332
|
-
* </ng-template>
|
|
333
|
-
* </kendo-grid-column>
|
|
334
|
-
* <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
|
|
335
|
-
* </kendo-grid-column>
|
|
336
|
-
* </kendo-grid>
|
|
337
|
-
* `
|
|
338
|
-
* })
|
|
339
|
-
*
|
|
340
|
-
* class AppComponent {
|
|
341
|
-
* public gridData: any[];
|
|
342
|
-
*
|
|
343
|
-
* constructor() {
|
|
344
|
-
* this.gridData = [{
|
|
345
|
-
* "ProductID": 1,
|
|
346
|
-
* "ProductName": "Chai",
|
|
347
|
-
* "UnitPrice": 18.0000,
|
|
348
|
-
* "Discontinued": true
|
|
349
|
-
* }, {
|
|
350
|
-
* "ProductID": 2,
|
|
351
|
-
* "ProductName": "Chang",
|
|
352
|
-
* "UnitPrice": 19.0000,
|
|
353
|
-
* "Discontinued": false
|
|
354
|
-
* }];
|
|
355
|
-
* }
|
|
356
|
-
* }
|
|
357
|
-
*
|
|
358
|
-
* ```
|
|
359
169
|
*/
|
|
360
170
|
footerStyle: {
|
|
361
171
|
[key: string]: string;
|
|
362
172
|
};
|
|
363
173
|
/**
|
|
364
174
|
* Sets the custom CSS classes to the column cells. Under the hood, to apply the property, the `class` option uses the
|
|
365
|
-
* [NgClass](link:site.data.urls.angular['ngclassapi']) directive.
|
|
175
|
+
* [NgClass](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-cells).
|
|
366
176
|
* To customize header and footer column cells, use the [headerClass]({% slug api_grid_columncomponent %}#toc-headerclass)
|
|
367
177
|
* and [footerClass]({% slug api_grid_columncomponent %}#toc-footerclass) inputs.
|
|
368
178
|
*
|
|
369
|
-
* @example
|
|
370
|
-
* ```ts
|
|
371
|
-
* import { Component, ViewEncapsulation } from '@angular/core';
|
|
372
|
-
*
|
|
373
|
-
* _@Component({
|
|
374
|
-
* selector: 'my-app',
|
|
375
|
-
* encapsulation: ViewEncapsulation.None,
|
|
376
|
-
* styles: [`
|
|
377
|
-
* tr .myClass {
|
|
378
|
-
* text-align: right
|
|
379
|
-
* }
|
|
380
|
-
* `],
|
|
381
|
-
* template: `
|
|
382
|
-
* <kendo-grid [data]="gridData" style="height: 200px">
|
|
383
|
-
* <kendo-grid-column field="ProductName" title="Product Name" [width]="200" [class]="{'myClass': true}">
|
|
384
|
-
* </kendo-grid-column>
|
|
385
|
-
* <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
|
|
386
|
-
* </kendo-grid-column>
|
|
387
|
-
* </kendo-grid>
|
|
388
|
-
* `
|
|
389
|
-
* })
|
|
390
|
-
*
|
|
391
|
-
* class AppComponent {
|
|
392
|
-
* public gridData: any[];
|
|
393
|
-
*
|
|
394
|
-
* constructor() {
|
|
395
|
-
* this.gridData = [{
|
|
396
|
-
* "ProductID": 1,
|
|
397
|
-
* "ProductName": "Chai",
|
|
398
|
-
* "UnitPrice": 18.0000,
|
|
399
|
-
* "Discontinued": true
|
|
400
|
-
* }, {
|
|
401
|
-
* "ProductID": 2,
|
|
402
|
-
* "ProductName": "Chang",
|
|
403
|
-
* "UnitPrice": 19.0000,
|
|
404
|
-
* "Discontinued": false
|
|
405
|
-
* }];
|
|
406
|
-
* }
|
|
407
|
-
* }
|
|
408
|
-
*
|
|
409
|
-
* ```
|
|
410
179
|
*/
|
|
411
180
|
cssClass: string | string[] | Set<string> | {
|
|
412
181
|
[key: string]: any;
|
|
@@ -414,49 +183,8 @@ export declare class ColumnBase {
|
|
|
414
183
|
/**
|
|
415
184
|
* Sets the custom CSS classes to the column header cell. Under the hood, to apply the property,
|
|
416
185
|
* the `headerClass` option uses the
|
|
417
|
-
* [NgClass](link:site.data.urls.angular['ngclassapi']) directive.
|
|
418
|
-
*
|
|
419
|
-
* @example
|
|
420
|
-
* ```ts
|
|
421
|
-
* import { Component, ViewEncapsulation } from '@angular/core';
|
|
422
|
-
*
|
|
423
|
-
* _@Component({
|
|
424
|
-
* selector: 'my-app',
|
|
425
|
-
* encapsulation: ViewEncapsulation.None,
|
|
426
|
-
* styles: [`
|
|
427
|
-
* tr .myClass {
|
|
428
|
-
* text-align: right
|
|
429
|
-
* }
|
|
430
|
-
* `],
|
|
431
|
-
* template: `
|
|
432
|
-
* <kendo-grid [data]="gridData" style="height: 200px">
|
|
433
|
-
* <kendo-grid-column field="ProductName" title="Product Name" [width]="200" [headerClass]="{'myClass': true}">
|
|
434
|
-
* </kendo-grid-column>
|
|
435
|
-
* <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
|
|
436
|
-
* </kendo-grid-column>
|
|
437
|
-
* </kendo-grid>
|
|
438
|
-
* `
|
|
439
|
-
* })
|
|
440
|
-
*
|
|
441
|
-
* class AppComponent {
|
|
442
|
-
* public gridData: any[];
|
|
186
|
+
* [NgClass](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-header).
|
|
443
187
|
*
|
|
444
|
-
* constructor() {
|
|
445
|
-
* this.gridData = [{
|
|
446
|
-
* "ProductID": 1,
|
|
447
|
-
* "ProductName": "Chai",
|
|
448
|
-
* "UnitPrice": 18.0000,
|
|
449
|
-
* "Discontinued": true
|
|
450
|
-
* }, {
|
|
451
|
-
* "ProductID": 2,
|
|
452
|
-
* "ProductName": "Chang",
|
|
453
|
-
* "UnitPrice": 19.0000,
|
|
454
|
-
* "Discontinued": false
|
|
455
|
-
* }];
|
|
456
|
-
* }
|
|
457
|
-
* }
|
|
458
|
-
*
|
|
459
|
-
* ```
|
|
460
188
|
*/
|
|
461
189
|
headerClass: string | string[] | Set<string> | {
|
|
462
190
|
[key: string]: any;
|
|
@@ -464,47 +192,8 @@ export declare class ColumnBase {
|
|
|
464
192
|
/**
|
|
465
193
|
* Sets the custom CSS classes to the filter row cell. Under the hood, to apply the property,
|
|
466
194
|
* the `filterClass` option uses the
|
|
467
|
-
* [NgClass](link:site.data.urls.angular['ngclassapi']) directive.
|
|
468
|
-
*
|
|
469
|
-
* @example
|
|
470
|
-
* ```ts
|
|
471
|
-
* import { Component, ViewEncapsulation } from '@angular/core';
|
|
472
|
-
*
|
|
473
|
-
* _@Component({
|
|
474
|
-
* selector: 'my-app',
|
|
475
|
-
* encapsulation: ViewEncapsulation.None,
|
|
476
|
-
* styles: [`
|
|
477
|
-
* .k-grid-header .myClass { background-color: #ffff00; }
|
|
478
|
-
* `],
|
|
479
|
-
* template: `
|
|
480
|
-
* <kendo-grid [data]="gridData" style="height: 155px" [filterable]="true">
|
|
481
|
-
* <kendo-grid-column field="ProductName" title="Product Name" [width]="200" [filterClass]="{'myClass': true}">
|
|
482
|
-
* </kendo-grid-column>
|
|
483
|
-
* <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="200">
|
|
484
|
-
* </kendo-grid-column>
|
|
485
|
-
* </kendo-grid>
|
|
486
|
-
* `
|
|
487
|
-
* })
|
|
488
|
-
*
|
|
489
|
-
* export class AppComponent {
|
|
490
|
-
* public gridData: any[];
|
|
491
|
-
*
|
|
492
|
-
* constructor() {
|
|
493
|
-
* this.gridData = [{
|
|
494
|
-
* "ProductID": 1,
|
|
495
|
-
* "ProductName": "Chai",
|
|
496
|
-
* "UnitPrice": 18.0000,
|
|
497
|
-
* "Discontinued": true
|
|
498
|
-
* }, {
|
|
499
|
-
* "ProductID": 2,
|
|
500
|
-
* "ProductName": "Chang",
|
|
501
|
-
* "UnitPrice": 19.0000,
|
|
502
|
-
* "Discontinued": false
|
|
503
|
-
* }];
|
|
504
|
-
* }
|
|
505
|
-
* }
|
|
195
|
+
* [NgClass](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-filter-row-cells).
|
|
506
196
|
*
|
|
507
|
-
* ```
|
|
508
197
|
*/
|
|
509
198
|
filterClass: string | string[] | Set<string> | {
|
|
510
199
|
[key: string]: any;
|
|
@@ -512,52 +201,8 @@ export declare class ColumnBase {
|
|
|
512
201
|
/**
|
|
513
202
|
* Sets the custom CSS classes to the column footer cell. Under the hood, to apply the property,
|
|
514
203
|
* the `footerClass` option uses the
|
|
515
|
-
* [NgClass](link:site.data.urls.angular['ngclassapi']) directive.
|
|
516
|
-
*
|
|
517
|
-
* @example
|
|
518
|
-
* ```ts
|
|
519
|
-
* import { Component, ViewEncapsulation } from '@angular/core';
|
|
520
|
-
*
|
|
521
|
-
* _@Component({
|
|
522
|
-
* selector: 'my-app',
|
|
523
|
-
* encapsulation: ViewEncapsulation.None,
|
|
524
|
-
* styles: [`
|
|
525
|
-
* tr .myClass {
|
|
526
|
-
* text-align: right
|
|
527
|
-
* }
|
|
528
|
-
* `],
|
|
529
|
-
* template: `
|
|
530
|
-
* <kendo-grid [data]="gridData" style="height: 200px">
|
|
531
|
-
* <kendo-grid-column field="ProductName" title="Product Name" [width]="200" [footerClass]="{'myClass': true}">
|
|
532
|
-
* <ng-template kendoGridFooterTemplate>
|
|
533
|
-
* footer text
|
|
534
|
-
* </ng-template>
|
|
535
|
-
* </kendo-grid-column>
|
|
536
|
-
* <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
|
|
537
|
-
* </kendo-grid-column>
|
|
538
|
-
* </kendo-grid>
|
|
539
|
-
* `
|
|
540
|
-
* })
|
|
541
|
-
*
|
|
542
|
-
* class AppComponent {
|
|
543
|
-
* public gridData: any[];
|
|
544
|
-
*
|
|
545
|
-
* constructor() {
|
|
546
|
-
* this.gridData = [{
|
|
547
|
-
* "ProductID": 1,
|
|
548
|
-
* "ProductName": "Chai",
|
|
549
|
-
* "UnitPrice": 18.0000,
|
|
550
|
-
* "Discontinued": true
|
|
551
|
-
* }, {
|
|
552
|
-
* "ProductID": 2,
|
|
553
|
-
* "ProductName": "Chang",
|
|
554
|
-
* "UnitPrice": 19.0000,
|
|
555
|
-
* "Discontinued": false
|
|
556
|
-
* }];
|
|
557
|
-
* }
|
|
558
|
-
* }
|
|
204
|
+
* [NgClass](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-footer).
|
|
559
205
|
*
|
|
560
|
-
* ```
|
|
561
206
|
*/
|
|
562
207
|
footerClass: string | string[] | Set<string> | {
|
|
563
208
|
[key: string]: any;
|
|
@@ -29,7 +29,15 @@ export interface SingleSortSettings extends ColumnSortSettings {
|
|
|
29
29
|
mode?: 'single';
|
|
30
30
|
}
|
|
31
31
|
/**
|
|
32
|
-
* Specifies a modifier key.
|
|
32
|
+
* Specifies a modifier key when multiple sort. [See example](slug:multi_sort_grid#toc-sort-key-modifier).
|
|
33
|
+
*
|
|
34
|
+
* @example
|
|
35
|
+
* ```html
|
|
36
|
+
* <kendo-grid [sortable]="{ mode: 'multiple', multiSortKey: 'shift' }">
|
|
37
|
+
* <kendo-grid-column field="ProductID"></kendo-grid-column>
|
|
38
|
+
* ...
|
|
39
|
+
* </kendo-grid>
|
|
40
|
+
* ```
|
|
33
41
|
*/
|
|
34
42
|
export declare type ModifierKey = 'none' | 'ctrl' | 'shift' | 'alt';
|
|
35
43
|
/**
|
|
@@ -60,9 +68,17 @@ export interface MultipleSortSettings extends ColumnSortSettings {
|
|
|
60
68
|
multiSortKey?: ModifierKey;
|
|
61
69
|
}
|
|
62
70
|
/**
|
|
63
|
-
* Defines the settings for sorting the Grid.
|
|
64
|
-
*
|
|
65
|
-
*
|
|
71
|
+
* Defines the settings for sorting the Grid. [See example](slug:multi_sort_grid).
|
|
72
|
+
*
|
|
73
|
+
* The available options are:
|
|
74
|
+
* * `boolean`
|
|
75
|
+
* * [SingleSortSettings]({% slug api_grid_singlesortsettings %})
|
|
76
|
+
* * [MultipleSortSettings]({% slug api_grid_multiplesortsettings %})
|
|
77
|
+
*
|
|
78
|
+
* @example
|
|
79
|
+
* ```html
|
|
80
|
+
* <kendo-grid [sorting]="true"></kendo-grid>
|
|
81
|
+
* ```
|
|
66
82
|
*/
|
|
67
83
|
export declare type SortSettings = boolean | SingleSortSettings | MultipleSortSettings;
|
|
68
84
|
/**
|
|
@@ -7,6 +7,6 @@ import { Observable } from "rxjs";
|
|
|
7
7
|
import { GridComponent } from "../grid.component";
|
|
8
8
|
/**
|
|
9
9
|
* The function that is used to get the exported data options. By default, uses the current data and group of the Grid.
|
|
10
|
-
* To export data that is different from the current Grid data, provide a custom function.
|
|
10
|
+
* To export data that is different from the current Grid data, provide a custom function. [See example](slug:excelexport_grid#toc-exporting-specific-data)
|
|
11
11
|
*/
|
|
12
12
|
export declare type FetchDataCallback = (component: GridComponent) => ExcelExportData | Promise<ExcelExportData> | Observable<ExcelExportData>;
|
|
@@ -14,7 +14,7 @@ export declare abstract class PreventableEvent {
|
|
|
14
14
|
*/
|
|
15
15
|
preventDefault(): void;
|
|
16
16
|
/**
|
|
17
|
-
* Returns
|
|
17
|
+
* Returns a respective boolean if the event was prevented
|
|
18
18
|
* by any of its subscribers.
|
|
19
19
|
*
|
|
20
20
|
* @returns `true` if the default action was prevented.
|
|
@@ -21,7 +21,7 @@ export declare class PopupCloseEvent extends PreventableEvent {
|
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
23
|
* The service that is used for the popups of the filter and column menus
|
|
24
|
-
* ([see example]({% slug filter_menu %}#toc-
|
|
24
|
+
* ([see example]({% slug filter_menu %}#toc-filter-menu-with-popup)).
|
|
25
25
|
*/
|
|
26
26
|
export declare class SinglePopupService implements OnDestroy {
|
|
27
27
|
private popupService;
|
package/common/size-options.d.ts
CHANGED
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
* Licensed under commercial license. See LICENSE.md in the project root for more information
|
|
4
4
|
*-------------------------------------------------------------------------------------------*/
|
|
5
5
|
/**
|
|
6
|
-
* Represents the possible size options of the Grid.
|
|
7
|
-
* @default `medium`
|
|
6
|
+
* Represents the possible size options of the Grid. [See example](slug:sizing_grid).
|
|
8
7
|
*/
|
|
9
8
|
export declare type GridSize = 'small' | 'medium' | 'none';
|
|
@@ -6,8 +6,11 @@ import { DataItem } from './data-item.interface';
|
|
|
6
6
|
import { GroupItem } from './group-item.interface';
|
|
7
7
|
import { GroupFooterItem } from './group-footer-item.interface';
|
|
8
8
|
/**
|
|
9
|
-
* Represents
|
|
10
|
-
*
|
|
11
|
-
*
|
|
9
|
+
* Represents the item by which the Grid tracks changes. [See example](slug:track_changes_grid).
|
|
10
|
+
*
|
|
11
|
+
* The possible values are:
|
|
12
|
+
* * [`DataItem`]({% slug api_grid_dataitem %}).
|
|
13
|
+
* * [`GroupItem`]({% slug api_grid_groupitem %}).
|
|
14
|
+
* * [`GroupFooterItem`]({% slug api_grid_groupfooteritem %}).
|
|
12
15
|
*/
|
|
13
16
|
export declare type GridItem = DataItem | GroupItem | GroupFooterItem;
|
|
@@ -11,27 +11,15 @@ import * as i1 from "./../filtering/menu/menu-tabbing.service";
|
|
|
11
11
|
* [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
|
|
12
12
|
*
|
|
13
13
|
* @example
|
|
14
|
-
* ```
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
* <kendo-grid-columnmenu-sort [service]="service">
|
|
24
|
-
* </kendo-grid-columnmenu-sort>
|
|
25
|
-
* </ng-template>
|
|
26
|
-
* <kendo-grid-column field="Field1"></kendo-grid-column>
|
|
27
|
-
* <kendo-grid-column field="Field2"></kendo-grid-column>
|
|
28
|
-
* </kendo-grid>
|
|
29
|
-
* `
|
|
30
|
-
* })
|
|
31
|
-
*
|
|
32
|
-
* class AppComponent {
|
|
33
|
-
* public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
|
|
34
|
-
* }
|
|
14
|
+
* ```html
|
|
15
|
+
* <kendo-grid [data]="data" [columnMenu]="true">
|
|
16
|
+
* <ng-template kendoGridColumnMenuTemplate let-service="service">
|
|
17
|
+
* <span class="k-icon k-i-x" (click)="service.close()" </span>
|
|
18
|
+
* <kendo-grid-columnmenu-sort [service]="service">
|
|
19
|
+
* </kendo-grid-columnmenu-sort>
|
|
20
|
+
* </ng-template>
|
|
21
|
+
* <kendo-grid-column field="Field1"></kendo-grid-column>
|
|
22
|
+
* </kendo-grid>
|
|
35
23
|
*
|
|
36
24
|
* ```
|
|
37
25
|
*/
|