@syncfusion/ej2-angular-grids 30.1.41 → 30.1.42-ngcc

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.
Files changed (45) hide show
  1. package/@syncfusion/ej2-angular-grids.es5.js +1008 -0
  2. package/@syncfusion/ej2-angular-grids.es5.js.map +1 -0
  3. package/@syncfusion/ej2-angular-grids.js +947 -0
  4. package/@syncfusion/ej2-angular-grids.js.map +1 -0
  5. package/LICENSE +10 -0
  6. package/dist/ej2-angular-grids.umd.js +1634 -0
  7. package/dist/ej2-angular-grids.umd.js.map +1 -0
  8. package/dist/ej2-angular-grids.umd.min.js +11 -0
  9. package/dist/ej2-angular-grids.umd.min.js.map +1 -0
  10. package/ej2-angular-grids.d.ts +6 -0
  11. package/ej2-angular-grids.metadata.json +1 -0
  12. package/package.json +10 -23
  13. package/public_api.d.ts +1 -1
  14. package/schematics/utils/lib-details.js +2 -2
  15. package/schematics/utils/lib-details.ts +2 -2
  16. package/src/grid/aggregate-columns.directive.d.ts +114 -119
  17. package/src/grid/aggregates.directive.d.ts +40 -45
  18. package/src/grid/columns.directive.d.ts +469 -474
  19. package/src/grid/grid-all.module.d.ts +30 -36
  20. package/src/grid/grid.component.d.ts +163 -166
  21. package/src/grid/grid.module.d.ts +5 -15
  22. package/src/grid/stacked-column.directive.d.ts +471 -476
  23. package/src/index.d.ts +11 -11
  24. package/src/pager/pager-all.module.d.ts +5 -11
  25. package/src/pager/pager.component.d.ts +40 -43
  26. package/src/pager/pager.module.d.ts +5 -11
  27. package/CHANGELOG.md +0 -2837
  28. package/esm2020/public_api.mjs +0 -2
  29. package/esm2020/src/grid/aggregate-columns.directive.mjs +0 -84
  30. package/esm2020/src/grid/aggregates.directive.mjs +0 -69
  31. package/esm2020/src/grid/columns.directive.mjs +0 -100
  32. package/esm2020/src/grid/grid-all.module.mjs +0 -98
  33. package/esm2020/src/grid/grid.component.mjs +0 -298
  34. package/esm2020/src/grid/grid.module.mjs +0 -61
  35. package/esm2020/src/grid/stacked-column.directive.mjs +0 -100
  36. package/esm2020/src/index.mjs +0 -12
  37. package/esm2020/src/pager/pager-all.module.mjs +0 -23
  38. package/esm2020/src/pager/pager.component.mjs +0 -66
  39. package/esm2020/src/pager/pager.module.mjs +0 -25
  40. package/esm2020/syncfusion-ej2-angular-grids.mjs +0 -5
  41. package/fesm2015/syncfusion-ej2-angular-grids.mjs +0 -881
  42. package/fesm2015/syncfusion-ej2-angular-grids.mjs.map +0 -1
  43. package/fesm2020/syncfusion-ej2-angular-grids.mjs +0 -881
  44. package/fesm2020/syncfusion-ej2-angular-grids.mjs.map +0 -1
  45. package/syncfusion-ej2-angular-grids.d.ts +0 -5
@@ -1,474 +1,469 @@
1
- import { ViewContainerRef } from '@angular/core';
2
- import { ComplexBase, ArrayBase } from '@syncfusion/ej2-angular-base';
3
- import * as i0 from "@angular/core";
4
- /**
5
- * `e-column` directive represent a column of the Angular Grid.
6
- * It must be contained in a Grid component(`ejs-grid`).
7
- * ```html
8
- * <ejs-grid [dataSource]='data' allowPaging='true' allowSorting='true'>
9
- * <e-columns>
10
- * <e-column field='ID' width='100'></e-column>
11
- * <e-column field='name' headerText='Name' width='100'></e-column>
12
- * </e-columns>
13
- * </ejs-grid>
14
- * ```
15
- */
16
- export declare class ColumnDirective extends ComplexBase<ColumnDirective> {
17
- private viewContainerRef;
18
- directivePropList: any;
19
- childColumns: any;
20
- tags: string[];
21
- /**
22
- * Defines the data type of the column.
23
- * @default null
24
- */
25
- type: any;
26
- /**
27
- * If `allowEditing` set to false, then it disables editing of a particular column.
28
- * By default all columns are editable.
29
- * @default true
30
- */
31
- allowEditing: any;
32
- /**
33
- * If `allowFiltering` set to false, then it disables filtering option and filter bar element of a particular column.
34
- * By default all columns are filterable.
35
- * @default true
36
- */
37
- allowFiltering: any;
38
- /**
39
- * If `allowGrouping` set to false, then it disables grouping of a particular column.
40
- * By default all columns are groupable.
41
- * @default true
42
- */
43
- allowGrouping: any;
44
- /**
45
- * If `allowReordering` set to false, then it disables reorder of a particular column.
46
- * By default all columns can be reorder.
47
- * @default true
48
- */
49
- allowReordering: any;
50
- /**
51
- * If `allowResizing` set to false, it disables resize option of a particular column.
52
- * @default true
53
- */
54
- allowResizing: any;
55
- /**
56
- * If `allowSearching` set to false, then it disables Searching of a particular column.
57
- * By default all columns allow Searching.
58
- * @default true
59
- */
60
- allowSearching: any;
61
- /**
62
- * If `allowSorting` set to false, then it disables sorting option of a particular column.
63
- * By default all columns are sortable.
64
- * @default true
65
- */
66
- allowSorting: any;
67
- /**
68
- * If `autoFit` set to true, then the particular column content width will be
69
- * adjusted based on its content in the initial rendering itself.
70
- * Setting this property as true is equivalent to calling `autoFitColumns` method in the `dataBound` event.
71
- * @default false
72
- */
73
- autoFit: any;
74
- /**
75
- * Defines the cell content's overflow mode. The available modes are
76
- * * `Clip` - Truncates the cell content when it overflows its area.
77
- * * `Ellipsis` - Displays ellipsis when the cell content overflows its area.
78
- * * `EllipsisWithTooltip` - Displays ellipsis when the cell content overflows its area
79
- * also it will display tooltip while hover on ellipsis applied cell.
80
- * @default Ellipsis
81
- */
82
- clipMode: any;
83
- /**
84
- * Used to render multiple header rows(stacked headers) on the Grid header.
85
- * @default null
86
- */
87
- columns: any;
88
- /**
89
- * `commands` provides an option to display command buttons in every cell.
90
- * The available built-in command buttons are
91
- * * Edit - Edit the record.
92
- * * Delete - Delete the record.
93
- * * Save - Save the record.
94
- * * Cancel - Cancel the edit state.
95
- *
96
- * The following code example implements the custom command column.
97
- *```html
98
- *<style type="text/css" class="cssStyles">
99
- *.details-icon:before
100
- *{
101
- * content:"\e74d";
102
- *}
103
- *</style>
104
- *<div id="Grid"></div>
105
- *```
106
- *```typescript
107
- *var gridObj = new Grid({
108
- *datasource: window.gridData,
109
- *columns : [
110
- * { field: 'CustomerID', headerText: 'Customer ID' },
111
- * { field: 'CustomerName', headerText: 'Customer Name' },
112
- * {commands: [{buttonOption:{content: 'Details', click: onClick, cssClass: details-icon}}], headerText: 'Customer Details'}
113
- *]
114
- *gridObj.appendTo("#Grid");
115
- *```
116
- *
117
- * @default null
118
- */
119
- commands: any;
120
- /**
121
- * The CSS styles and attributes of the content cells of a particular column can be customized.
122
- *
123
- * ```html
124
- *<div id="Grid"></div>
125
- *```
126
- *```typescript
127
- *let gridObj: Grid = new Grid({
128
- *dataSource: filterData,
129
- *columns: [
130
- * { field: 'OrderID', headerText: 'Order ID' },
131
- * {
132
- * field: 'EmployeeID', headerText: 'Employee ID', customAttributes: {
133
- * class: 'employeeid',
134
- * type: 'employee-id-cell'
135
- * }
136
- * }]
137
- *});
138
- *gridObj.appendTo('#Grid');
139
- *```
140
- *
141
- * @default null
142
- */
143
- customAttributes: any;
144
- /**
145
- * Defines the column data source which will act as foreign data source.
146
- * @default null
147
- */
148
- dataSource: any;
149
- /**
150
- * Defines default values for the component when adding a new record to the Grid.
151
- * @default null
152
- * @asptype object
153
- */
154
- defaultValue: any;
155
- /**
156
- * If `disableHtmlEncode` is set to true, it encodes the HTML of the header and content cells.
157
- * @default true
158
- */
159
- disableHtmlEncode: any;
160
- /**
161
- * If `displayAsCheckBox` is set to true, it displays the column value as a check box instead of Boolean value.
162
- * @default false
163
- */
164
- displayAsCheckBox: any;
165
- /**
166
- * Defines the `IEditCell`(../../grid/edit/#cell-edit-template) object to customize default edit cell.
167
- * @default {}
168
- */
169
- edit: any;
170
- /**
171
- * Defines the type of component for editing.
172
- * @default 'stringedit'
173
- */
174
- editType: any;
175
- /**
176
- * If `enableGroupByFormat` set to true, then it groups the particular column by formatted values.
177
- * By default no columns are group by format.
178
- * @default true
179
- */
180
- enableGroupByFormat: any;
181
- /**
182
- * Defines the field name of column which is mapped with mapping name of DataSource.
183
- * The bounded columns can be sort, filter and group etc.,
184
- * If the `field` name contains “dot”, then it is considered as complex binding.
185
- * The `field` name must be a valid JavaScript identifier,
186
- * the first character must be an alphabet and should not contain spaces and special characters.
187
- * @default ''
188
- */
189
- field: any;
190
- /**
191
- * Defines the filter options to customize filtering for the particular column.
192
- * @default {}
193
- */
194
- filter: any;
195
- /**
196
- * The `filterBarTemplate` is used to add a custom component instead of default input component for filter bar.
197
- * It have create and read functions.
198
- * * create: It is used for creating custom components.
199
- * * read: It is used to perform custom filter action.
200
- *
201
- * ```html
202
- *<div id="Grid"></div>
203
- *```
204
- *```typescript
205
- *let gridObj: Grid = new Grid({
206
- *dataSource: filterData,
207
- *columns: [
208
- * { field: 'OrderID', headerText: 'Order ID' },
209
- * {
210
- * field: 'EmployeeID', filterBarTemplate: {
211
- * create: (args: { element: Element, column: Column }) => {
212
- * let input: HTMLInputElement = document.createElement('input');
213
- * input.id = 'EmployeeID';
214
- * input.type = 'text';
215
- * return input;
216
- * },
217
- * write: (args: { element: Element, column: Column }) => {
218
- * args.element.addEventListener('input', args.column.filterBarTemplate.read as EventListener);
219
- * },
220
- * read: (args: { element: HTMLInputElement, columnIndex: number, column: Column }) => {
221
- * gridObj.filterByColumn(args.element.id, 'equal', args.element.value);
222
- * }
223
- * }
224
- * }],
225
- * allowFiltering: true
226
- *});
227
- *gridObj.appendTo('#Grid');
228
- *```
229
- *
230
- * @default null
231
- */
232
- filterBarTemplate: any;
233
- /**
234
- * Defines the mapping column name of the foreign data source.
235
- * If it is not defined then the `columns.field` will be considered as mapping column name
236
- * @default null
237
- */
238
- foreignKeyField: any;
239
- /**
240
- * Defines the display column name from the foreign data source which will be obtained from comparing local and foreign data
241
- * @default null
242
- */
243
- foreignKeyValue: any;
244
- /**
245
- * It is used to change display value with the given format and does not affect the original data.
246
- * Gets the format from the user which can be standard or custom
247
- * [`number`](../../common/internationalization/#manipulating-numbers)
248
- * and [`date`](../../common/internationalization/#manipulating-datetime) formats.
249
- * @default null
250
- * @asptype string
251
- */
252
- format: any;
253
- /**
254
- * Defines the method which is used to achieve custom formatting from an external function.
255
- * This function triggers before rendering of each cell.
256
- *
257
- * ```html
258
- *<div id="Grid"></div>
259
- *```
260
- *```typescript
261
- *class ExtendedFormatter implements ICellFormatter {
262
- *public getValue(column: Column, data: Object): Object {
263
- * return '<span style="color:' + (data['Verified'] ? 'green' : 'red') + '"><i>' + data['Verified'] + '</i><span>';
264
- *}
265
- *}
266
- *let gridObj: Grid = new Grid({
267
- * dataSource: filterData,
268
- * columns: [
269
- * { field: 'ShipName', headerText: 'Ship Name' },
270
- * { field: 'Verified', headerText: 'Verified Status', formatter: ExtendedFormatter }]
271
- *});
272
- *gridObj.appendTo('#Grid');
273
- *```
274
- *
275
- * @default null
276
- */
277
- formatter: any;
278
- /**
279
- * defines which side the column need to freeze
280
- * The available built-in freeze directions are
281
- * * Left - Freeze the column at left side.
282
- * * Right - Freeze the column at right side.
283
- * * Fixed - Freeze the column at Center.
284
- * * None - Does not freeze the column.
285
- * @default None
286
- */
287
- freeze: any;
288
- /**
289
- * Defines the header text of column which is used to display in column header.
290
- * If `headerText` is not defined, then field name value will be assigned to header text.
291
- * @default null
292
- */
293
- headerText: any;
294
- /**
295
- * Define the alignment of column header which is used to align the text of column header.
296
- * @aspdefaultvalueignore
297
- * @default null
298
- */
299
- headerTextAlign: any;
300
- /**
301
- * Defines the method used to apply custom header cell values from external function and display this on each cell rendered.
302
- *
303
- * ```html
304
- *<div id="Grid"></div>
305
- *```
306
- *```typescript
307
- *let gridObj: Grid = new Grid({
308
- *dataSource: [{ EmployeeID: 1, EmployeeName: ['John', 'M'] }, { EmployeeID: 2, EmployeeName: ['Peter', 'A'] }],
309
- *columns: [
310
- * { field: 'EmployeeID', headerText: 'Employee ID' },
311
- * { field: 'EmployeeName', headerText: 'Employee First Name',
312
- * headerValueAccessor: (field: string,column: Column) => {
313
- * return "newheadername";
314
- * },
315
- * }]
316
- *});
317
- *```
318
- *
319
- * @default null
320
- */
321
- headerValueAccessor: any;
322
- /**
323
- * column visibility can change based on its [`Media Queries`](http://cssmediaqueries.com/what-are-css-media-queries.html).
324
- * `hideAtMedia` accepts only valid Media Queries.
325
- * @default ''
326
- */
327
- hideAtMedia: any;
328
- /**
329
- * Gets the unique identifier value of the column. It is used to get the object.
330
- * @default null
331
- */
332
- index: any;
333
- /**
334
- * You can use this property to freeze selected columns in grid.
335
- * @default false
336
- */
337
- isFrozen: any;
338
- /**
339
- * If `isIdentity` is set to true, then this column is considered as identity column.
340
- * @default false
341
- */
342
- isIdentity: any;
343
- /**
344
- * If `isPrimaryKey` is set to true, considers this column as the primary key constraint.
345
- * @default false
346
- */
347
- isPrimaryKey: any;
348
- /**
349
- * Defines the mapping column name of the foreign data source.
350
- * If it is not defined then the `columns.field` will be considered as mapping column name
351
- * @default false
352
- */
353
- lockColumn: any;
354
- /**
355
- * Defines the maximum width of the column in pixel or percentage, which will restrict resizing beyond this pixel or percentage.
356
- * @default ''
357
- */
358
- maxWidth: any;
359
- /**
360
- * Defines the minimum width of the column in pixels or percentage.
361
- * @default ''
362
- */
363
- minWidth: any;
364
- /**
365
- * If `showColumnMenu` set to false, then it disable the column menu of a particular column.
366
- * By default column menu will show for all columns
367
- * @default true
368
- */
369
- showColumnMenu: any;
370
- /**
371
- * If `showInColumnChooser` set to false, then hides the particular column in column chooser.
372
- * By default all columns are displayed in column Chooser.
373
- * @default true
374
- */
375
- showInColumnChooser: any;
376
- /**
377
- * It defines the custom sort comparer function.
378
- */
379
- sortComparer: any;
380
- /**
381
- * Determines the behavior of the `aria-label` attribute for cells in template columns.
382
- * If enableAriaLabel is set to false, the aria-label attribute is not applied to template column cells, which affects screen reader accessibility.
383
- * @default {}
384
- */
385
- templateOptions: any;
386
- /**
387
- * Defines the alignment of the column in both header and content cells.
388
- * @default Left
389
- */
390
- textAlign: any;
391
- /**
392
- * Gets the unique identifier value of the column. It is used to get the object.
393
- * @default ''
394
- */
395
- uid: any;
396
- /**
397
- * `editType`(../../grid/edit/#cell-edit-type-and-its-params) Defines rules to validate data before creating and updating.
398
- * @default null
399
- */
400
- validationRules: any;
401
- /**
402
- * Defines the method used to apply custom cell values from external function and display this on each cell rendered.
403
- *
404
- * ```html
405
- *<div id="Grid"></div>
406
- *```
407
- *```typescript
408
- *let gridObj: Grid = new Grid({
409
- *dataSource: [{ EmployeeID: 1, EmployeeName: ['John', 'M'] }, { EmployeeID: 2, EmployeeName: ['Peter', 'A'] }],
410
- *columns: [
411
- * { field: 'EmployeeID', headerText: 'Employee ID' },
412
- * { field: 'EmployeeName', headerText: 'Employee First Name',
413
- * valueAccessor: (field: string, data: Object, column: Column) => {
414
- * return data['EmployeeName'][0];
415
- * },
416
- * }]
417
- *});
418
- *```
419
- *
420
- * @default null
421
- */
422
- valueAccessor: any;
423
- /**
424
- * If `visible` is set to false, hides the particular column. By default, all columns are displayed.
425
- * @default true
426
- */
427
- visible: any;
428
- /**
429
- * Defines the width of the column in pixels or percentage.
430
- * @default ''
431
- */
432
- width: any;
433
- /**
434
- * Defines the column template that renders customized element in each cell of the column.
435
- * It accepts either [template string](../../common/template-engine/) or HTML element ID.
436
- * @default null
437
- * @asptype string
438
- */
439
- template: any;
440
- /**
441
- * Defines the column template as string or HTML element ID which is used to add customized element in the column header.
442
- * @default null
443
- * @asptype string
444
- */
445
- headerTemplate: any;
446
- commandsTemplate: any;
447
- filter_itemTemplate: any;
448
- /**
449
- * Defines the cell edit template that used as editor for a particular column.
450
- * It accepts either template string or HTML element ID.
451
- * @default null
452
- * @asptype string
453
- */
454
- editTemplate: any;
455
- /**
456
- * Defines the filter template/UI that used as filter for a particular column.
457
- * It accepts either template string or HTML element ID.
458
- * @default null
459
- * @asptype string
460
- */
461
- filterTemplate: any;
462
- constructor(viewContainerRef: ViewContainerRef);
463
- static ɵfac: i0.ɵɵFactoryDeclaration<ColumnDirective, never>;
464
- static ɵdir: i0.ɵɵDirectiveDeclaration<ColumnDirective, "ejs-grid>e-columns>e-column", never, { "allowEditing": "allowEditing"; "allowFiltering": "allowFiltering"; "allowGrouping": "allowGrouping"; "allowReordering": "allowReordering"; "allowResizing": "allowResizing"; "allowSearching": "allowSearching"; "allowSorting": "allowSorting"; "autoFit": "autoFit"; "clipMode": "clipMode"; "columns": "columns"; "commands": "commands"; "customAttributes": "customAttributes"; "dataSource": "dataSource"; "defaultValue": "defaultValue"; "disableHtmlEncode": "disableHtmlEncode"; "displayAsCheckBox": "displayAsCheckBox"; "edit": "edit"; "editTemplate": "editTemplate"; "editType": "editType"; "enableGroupByFormat": "enableGroupByFormat"; "field": "field"; "filter": "filter"; "filterBarTemplate": "filterBarTemplate"; "filterTemplate": "filterTemplate"; "foreignKeyField": "foreignKeyField"; "foreignKeyValue": "foreignKeyValue"; "format": "format"; "formatter": "formatter"; "freeze": "freeze"; "headerTemplate": "headerTemplate"; "headerText": "headerText"; "headerTextAlign": "headerTextAlign"; "headerValueAccessor": "headerValueAccessor"; "hideAtMedia": "hideAtMedia"; "index": "index"; "isFrozen": "isFrozen"; "isIdentity": "isIdentity"; "isPrimaryKey": "isPrimaryKey"; "lockColumn": "lockColumn"; "maxWidth": "maxWidth"; "minWidth": "minWidth"; "showColumnMenu": "showColumnMenu"; "showInColumnChooser": "showInColumnChooser"; "sortComparer": "sortComparer"; "template": "template"; "templateOptions": "templateOptions"; "textAlign": "textAlign"; "type": "type"; "uid": "uid"; "validationRules": "validationRules"; "valueAccessor": "valueAccessor"; "visible": "visible"; "width": "width"; }, {}, ["template", "headerTemplate", "commandsTemplate", "filter_itemTemplate", "editTemplate", "filterTemplate", "childColumns"]>;
465
- }
466
- /**
467
- * Column Array Directive
468
- * @private
469
- */
470
- export declare class ColumnsDirective extends ArrayBase<ColumnsDirective> {
471
- constructor();
472
- static ɵfac: i0.ɵɵFactoryDeclaration<ColumnsDirective, never>;
473
- static ɵdir: i0.ɵɵDirectiveDeclaration<ColumnsDirective, "ejs-grid>e-columns", never, {}, {}, ["children"]>;
474
- }
1
+ import { ViewContainerRef } from '@angular/core';
2
+ import { ComplexBase, ArrayBase } from '@syncfusion/ej2-angular-base';
3
+ /**
4
+ * `e-column` directive represent a column of the Angular Grid.
5
+ * It must be contained in a Grid component(`ejs-grid`).
6
+ * ```html
7
+ * <ejs-grid [dataSource]='data' allowPaging='true' allowSorting='true'>
8
+ * <e-columns>
9
+ * <e-column field='ID' width='100'></e-column>
10
+ * <e-column field='name' headerText='Name' width='100'></e-column>
11
+ * </e-columns>
12
+ * </ejs-grid>
13
+ * ```
14
+ */
15
+ export declare class ColumnDirective extends ComplexBase<ColumnDirective> {
16
+ private viewContainerRef;
17
+ directivePropList: any;
18
+ childColumns: any;
19
+ tags: string[];
20
+ /**
21
+ * Defines the data type of the column.
22
+ * @default null
23
+ */
24
+ type: any;
25
+ /**
26
+ * If `allowEditing` set to false, then it disables editing of a particular column.
27
+ * By default all columns are editable.
28
+ * @default true
29
+ */
30
+ allowEditing: any;
31
+ /**
32
+ * If `allowFiltering` set to false, then it disables filtering option and filter bar element of a particular column.
33
+ * By default all columns are filterable.
34
+ * @default true
35
+ */
36
+ allowFiltering: any;
37
+ /**
38
+ * If `allowGrouping` set to false, then it disables grouping of a particular column.
39
+ * By default all columns are groupable.
40
+ * @default true
41
+ */
42
+ allowGrouping: any;
43
+ /**
44
+ * If `allowReordering` set to false, then it disables reorder of a particular column.
45
+ * By default all columns can be reorder.
46
+ * @default true
47
+ */
48
+ allowReordering: any;
49
+ /**
50
+ * If `allowResizing` set to false, it disables resize option of a particular column.
51
+ * @default true
52
+ */
53
+ allowResizing: any;
54
+ /**
55
+ * If `allowSearching` set to false, then it disables Searching of a particular column.
56
+ * By default all columns allow Searching.
57
+ * @default true
58
+ */
59
+ allowSearching: any;
60
+ /**
61
+ * If `allowSorting` set to false, then it disables sorting option of a particular column.
62
+ * By default all columns are sortable.
63
+ * @default true
64
+ */
65
+ allowSorting: any;
66
+ /**
67
+ * If `autoFit` set to true, then the particular column content width will be
68
+ * adjusted based on its content in the initial rendering itself.
69
+ * Setting this property as true is equivalent to calling `autoFitColumns` method in the `dataBound` event.
70
+ * @default false
71
+ */
72
+ autoFit: any;
73
+ /**
74
+ * Defines the cell content's overflow mode. The available modes are
75
+ * * `Clip` - Truncates the cell content when it overflows its area.
76
+ * * `Ellipsis` - Displays ellipsis when the cell content overflows its area.
77
+ * * `EllipsisWithTooltip` - Displays ellipsis when the cell content overflows its area
78
+ * also it will display tooltip while hover on ellipsis applied cell.
79
+ * @default Ellipsis
80
+ */
81
+ clipMode: any;
82
+ /**
83
+ * Used to render multiple header rows(stacked headers) on the Grid header.
84
+ * @default null
85
+ */
86
+ columns: any;
87
+ /**
88
+ * `commands` provides an option to display command buttons in every cell.
89
+ * The available built-in command buttons are
90
+ * * Edit - Edit the record.
91
+ * * Delete - Delete the record.
92
+ * * Save - Save the record.
93
+ * * Cancel - Cancel the edit state.
94
+ *
95
+ * The following code example implements the custom command column.
96
+ *```html
97
+ *<style type="text/css" class="cssStyles">
98
+ *.details-icon:before
99
+ *{
100
+ * content:"\e74d";
101
+ *}
102
+ *</style>
103
+ *<div id="Grid"></div>
104
+ *```
105
+ *```typescript
106
+ *var gridObj = new Grid({
107
+ *datasource: window.gridData,
108
+ *columns : [
109
+ * { field: 'CustomerID', headerText: 'Customer ID' },
110
+ * { field: 'CustomerName', headerText: 'Customer Name' },
111
+ * {commands: [{buttonOption:{content: 'Details', click: onClick, cssClass: details-icon}}], headerText: 'Customer Details'}
112
+ *]
113
+ *gridObj.appendTo("#Grid");
114
+ *```
115
+ *
116
+ * @default null
117
+ */
118
+ commands: any;
119
+ /**
120
+ * The CSS styles and attributes of the content cells of a particular column can be customized.
121
+ *
122
+ * ```html
123
+ *<div id="Grid"></div>
124
+ *```
125
+ *```typescript
126
+ *let gridObj: Grid = new Grid({
127
+ *dataSource: filterData,
128
+ *columns: [
129
+ * { field: 'OrderID', headerText: 'Order ID' },
130
+ * {
131
+ * field: 'EmployeeID', headerText: 'Employee ID', customAttributes: {
132
+ * class: 'employeeid',
133
+ * type: 'employee-id-cell'
134
+ * }
135
+ * }]
136
+ *});
137
+ *gridObj.appendTo('#Grid');
138
+ *```
139
+ *
140
+ * @default null
141
+ */
142
+ customAttributes: any;
143
+ /**
144
+ * Defines the column data source which will act as foreign data source.
145
+ * @default null
146
+ */
147
+ dataSource: any;
148
+ /**
149
+ * Defines default values for the component when adding a new record to the Grid.
150
+ * @default null
151
+ * @asptype object
152
+ */
153
+ defaultValue: any;
154
+ /**
155
+ * If `disableHtmlEncode` is set to true, it encodes the HTML of the header and content cells.
156
+ * @default true
157
+ */
158
+ disableHtmlEncode: any;
159
+ /**
160
+ * If `displayAsCheckBox` is set to true, it displays the column value as a check box instead of Boolean value.
161
+ * @default false
162
+ */
163
+ displayAsCheckBox: any;
164
+ /**
165
+ * Defines the `IEditCell`(../../grid/edit/#cell-edit-template) object to customize default edit cell.
166
+ * @default {}
167
+ */
168
+ edit: any;
169
+ /**
170
+ * Defines the type of component for editing.
171
+ * @default 'stringedit'
172
+ */
173
+ editType: any;
174
+ /**
175
+ * If `enableGroupByFormat` set to true, then it groups the particular column by formatted values.
176
+ * By default no columns are group by format.
177
+ * @default true
178
+ */
179
+ enableGroupByFormat: any;
180
+ /**
181
+ * Defines the field name of column which is mapped with mapping name of DataSource.
182
+ * The bounded columns can be sort, filter and group etc.,
183
+ * If the `field` name contains “dot”, then it is considered as complex binding.
184
+ * The `field` name must be a valid JavaScript identifier,
185
+ * the first character must be an alphabet and should not contain spaces and special characters.
186
+ * @default ''
187
+ */
188
+ field: any;
189
+ /**
190
+ * Defines the filter options to customize filtering for the particular column.
191
+ * @default {}
192
+ */
193
+ filter: any;
194
+ /**
195
+ * The `filterBarTemplate` is used to add a custom component instead of default input component for filter bar.
196
+ * It have create and read functions.
197
+ * * create: It is used for creating custom components.
198
+ * * read: It is used to perform custom filter action.
199
+ *
200
+ * ```html
201
+ *<div id="Grid"></div>
202
+ *```
203
+ *```typescript
204
+ *let gridObj: Grid = new Grid({
205
+ *dataSource: filterData,
206
+ *columns: [
207
+ * { field: 'OrderID', headerText: 'Order ID' },
208
+ * {
209
+ * field: 'EmployeeID', filterBarTemplate: {
210
+ * create: (args: { element: Element, column: Column }) => {
211
+ * let input: HTMLInputElement = document.createElement('input');
212
+ * input.id = 'EmployeeID';
213
+ * input.type = 'text';
214
+ * return input;
215
+ * },
216
+ * write: (args: { element: Element, column: Column }) => {
217
+ * args.element.addEventListener('input', args.column.filterBarTemplate.read as EventListener);
218
+ * },
219
+ * read: (args: { element: HTMLInputElement, columnIndex: number, column: Column }) => {
220
+ * gridObj.filterByColumn(args.element.id, 'equal', args.element.value);
221
+ * }
222
+ * }
223
+ * }],
224
+ * allowFiltering: true
225
+ *});
226
+ *gridObj.appendTo('#Grid');
227
+ *```
228
+ *
229
+ * @default null
230
+ */
231
+ filterBarTemplate: any;
232
+ /**
233
+ * Defines the mapping column name of the foreign data source.
234
+ * If it is not defined then the `columns.field` will be considered as mapping column name
235
+ * @default null
236
+ */
237
+ foreignKeyField: any;
238
+ /**
239
+ * Defines the display column name from the foreign data source which will be obtained from comparing local and foreign data
240
+ * @default null
241
+ */
242
+ foreignKeyValue: any;
243
+ /**
244
+ * It is used to change display value with the given format and does not affect the original data.
245
+ * Gets the format from the user which can be standard or custom
246
+ * [`number`](../../common/internationalization/#manipulating-numbers)
247
+ * and [`date`](../../common/internationalization/#manipulating-datetime) formats.
248
+ * @default null
249
+ * @asptype string
250
+ */
251
+ format: any;
252
+ /**
253
+ * Defines the method which is used to achieve custom formatting from an external function.
254
+ * This function triggers before rendering of each cell.
255
+ *
256
+ * ```html
257
+ *<div id="Grid"></div>
258
+ *```
259
+ *```typescript
260
+ *class ExtendedFormatter implements ICellFormatter {
261
+ *public getValue(column: Column, data: Object): Object {
262
+ * return '<span style="color:' + (data['Verified'] ? 'green' : 'red') + '"><i>' + data['Verified'] + '</i><span>';
263
+ *}
264
+ *}
265
+ *let gridObj: Grid = new Grid({
266
+ * dataSource: filterData,
267
+ * columns: [
268
+ * { field: 'ShipName', headerText: 'Ship Name' },
269
+ * { field: 'Verified', headerText: 'Verified Status', formatter: ExtendedFormatter }]
270
+ *});
271
+ *gridObj.appendTo('#Grid');
272
+ *```
273
+ *
274
+ * @default null
275
+ */
276
+ formatter: any;
277
+ /**
278
+ * defines which side the column need to freeze
279
+ * The available built-in freeze directions are
280
+ * * Left - Freeze the column at left side.
281
+ * * Right - Freeze the column at right side.
282
+ * * Fixed - Freeze the column at Center.
283
+ * * None - Does not freeze the column.
284
+ * @default None
285
+ */
286
+ freeze: any;
287
+ /**
288
+ * Defines the header text of column which is used to display in column header.
289
+ * If `headerText` is not defined, then field name value will be assigned to header text.
290
+ * @default null
291
+ */
292
+ headerText: any;
293
+ /**
294
+ * Define the alignment of column header which is used to align the text of column header.
295
+ * @aspdefaultvalueignore
296
+ * @default null
297
+ */
298
+ headerTextAlign: any;
299
+ /**
300
+ * Defines the method used to apply custom header cell values from external function and display this on each cell rendered.
301
+ *
302
+ * ```html
303
+ *<div id="Grid"></div>
304
+ *```
305
+ *```typescript
306
+ *let gridObj: Grid = new Grid({
307
+ *dataSource: [{ EmployeeID: 1, EmployeeName: ['John', 'M'] }, { EmployeeID: 2, EmployeeName: ['Peter', 'A'] }],
308
+ *columns: [
309
+ * { field: 'EmployeeID', headerText: 'Employee ID' },
310
+ * { field: 'EmployeeName', headerText: 'Employee First Name',
311
+ * headerValueAccessor: (field: string,column: Column) => {
312
+ * return "newheadername";
313
+ * },
314
+ * }]
315
+ *});
316
+ *```
317
+ *
318
+ * @default null
319
+ */
320
+ headerValueAccessor: any;
321
+ /**
322
+ * column visibility can change based on its [`Media Queries`](http://cssmediaqueries.com/what-are-css-media-queries.html).
323
+ * `hideAtMedia` accepts only valid Media Queries.
324
+ * @default ''
325
+ */
326
+ hideAtMedia: any;
327
+ /**
328
+ * Gets the unique identifier value of the column. It is used to get the object.
329
+ * @default null
330
+ */
331
+ index: any;
332
+ /**
333
+ * You can use this property to freeze selected columns in grid.
334
+ * @default false
335
+ */
336
+ isFrozen: any;
337
+ /**
338
+ * If `isIdentity` is set to true, then this column is considered as identity column.
339
+ * @default false
340
+ */
341
+ isIdentity: any;
342
+ /**
343
+ * If `isPrimaryKey` is set to true, considers this column as the primary key constraint.
344
+ * @default false
345
+ */
346
+ isPrimaryKey: any;
347
+ /**
348
+ * Defines the mapping column name of the foreign data source.
349
+ * If it is not defined then the `columns.field` will be considered as mapping column name
350
+ * @default false
351
+ */
352
+ lockColumn: any;
353
+ /**
354
+ * Defines the maximum width of the column in pixel or percentage, which will restrict resizing beyond this pixel or percentage.
355
+ * @default ''
356
+ */
357
+ maxWidth: any;
358
+ /**
359
+ * Defines the minimum width of the column in pixels or percentage.
360
+ * @default ''
361
+ */
362
+ minWidth: any;
363
+ /**
364
+ * If `showColumnMenu` set to false, then it disable the column menu of a particular column.
365
+ * By default column menu will show for all columns
366
+ * @default true
367
+ */
368
+ showColumnMenu: any;
369
+ /**
370
+ * If `showInColumnChooser` set to false, then hides the particular column in column chooser.
371
+ * By default all columns are displayed in column Chooser.
372
+ * @default true
373
+ */
374
+ showInColumnChooser: any;
375
+ /**
376
+ * It defines the custom sort comparer function.
377
+ */
378
+ sortComparer: any;
379
+ /**
380
+ * Determines the behavior of the `aria-label` attribute for cells in template columns.
381
+ * If enableAriaLabel is set to false, the aria-label attribute is not applied to template column cells, which affects screen reader accessibility.
382
+ * @default {}
383
+ */
384
+ templateOptions: any;
385
+ /**
386
+ * Defines the alignment of the column in both header and content cells.
387
+ * @default Left
388
+ */
389
+ textAlign: any;
390
+ /**
391
+ * Gets the unique identifier value of the column. It is used to get the object.
392
+ * @default ''
393
+ */
394
+ uid: any;
395
+ /**
396
+ * `editType`(../../grid/edit/#cell-edit-type-and-its-params) Defines rules to validate data before creating and updating.
397
+ * @default null
398
+ */
399
+ validationRules: any;
400
+ /**
401
+ * Defines the method used to apply custom cell values from external function and display this on each cell rendered.
402
+ *
403
+ * ```html
404
+ *<div id="Grid"></div>
405
+ *```
406
+ *```typescript
407
+ *let gridObj: Grid = new Grid({
408
+ *dataSource: [{ EmployeeID: 1, EmployeeName: ['John', 'M'] }, { EmployeeID: 2, EmployeeName: ['Peter', 'A'] }],
409
+ *columns: [
410
+ * { field: 'EmployeeID', headerText: 'Employee ID' },
411
+ * { field: 'EmployeeName', headerText: 'Employee First Name',
412
+ * valueAccessor: (field: string, data: Object, column: Column) => {
413
+ * return data['EmployeeName'][0];
414
+ * },
415
+ * }]
416
+ *});
417
+ *```
418
+ *
419
+ * @default null
420
+ */
421
+ valueAccessor: any;
422
+ /**
423
+ * If `visible` is set to false, hides the particular column. By default, all columns are displayed.
424
+ * @default true
425
+ */
426
+ visible: any;
427
+ /**
428
+ * Defines the width of the column in pixels or percentage.
429
+ * @default ''
430
+ */
431
+ width: any;
432
+ /**
433
+ * Defines the column template that renders customized element in each cell of the column.
434
+ * It accepts either [template string](../../common/template-engine/) or HTML element ID.
435
+ * @default null
436
+ * @asptype string
437
+ */
438
+ template: any;
439
+ /**
440
+ * Defines the column template as string or HTML element ID which is used to add customized element in the column header.
441
+ * @default null
442
+ * @asptype string
443
+ */
444
+ headerTemplate: any;
445
+ commandsTemplate: any;
446
+ filter_itemTemplate: any;
447
+ /**
448
+ * Defines the cell edit template that used as editor for a particular column.
449
+ * It accepts either template string or HTML element ID.
450
+ * @default null
451
+ * @asptype string
452
+ */
453
+ editTemplate: any;
454
+ /**
455
+ * Defines the filter template/UI that used as filter for a particular column.
456
+ * It accepts either template string or HTML element ID.
457
+ * @default null
458
+ * @asptype string
459
+ */
460
+ filterTemplate: any;
461
+ constructor(viewContainerRef: ViewContainerRef);
462
+ }
463
+ /**
464
+ * Column Array Directive
465
+ * @private
466
+ */
467
+ export declare class ColumnsDirective extends ArrayBase<ColumnsDirective> {
468
+ constructor();
469
+ }