igniteui-webcomponents-grids 4.7.0 → 4.7.2-beta.0

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 (150) hide show
  1. package/bundles/igniteui-webcomponents-grids.umd.js +498 -373
  2. package/bundles/igniteui-webcomponents-grids.umd.min.js +1 -1
  3. package/esm2015/lib/CanvasGridCellBase.js +10 -10
  4. package/esm2015/lib/CanvasSummaryCell.js +2 -2
  5. package/esm2015/lib/ColumnFilterCondition_combined.js +246 -210
  6. package/esm2015/lib/ColumnGroupingView_combined.js +17 -17
  7. package/esm2015/lib/ComparisonOperatorSelectorView_combined.js +3 -3
  8. package/esm2015/lib/EditorCell.js +2 -2
  9. package/esm2015/lib/FilterCell.js +12 -12
  10. package/esm2015/lib/GridCellBase.js +2 -2
  11. package/esm2015/lib/GridColumnFilterOptionsView_combined.js +10 -10
  12. package/esm2015/lib/GridColumnOptionsViewBase_combined.js +4 -4
  13. package/esm2015/lib/GridColumnOptionsView_combined.js +2 -2
  14. package/esm2015/lib/GridColumnSummaryOptionsView_combined.js +5 -5
  15. package/esm2015/lib/GridFilterDialogView_combined.js +16 -16
  16. package/esm2015/lib/GridStyleRepository.js +12 -12
  17. package/esm2015/lib/MultiColumnComboBoxView_combined.js +51 -51
  18. package/esm2015/lib/PropertyEditorView_combined.js +4 -4
  19. package/esm2015/lib/igc-column-exchangers-collection.js +6 -1
  20. package/esm2015/lib/igc-column-property-setters-collection.js +6 -1
  21. package/esm2015/lib/igc-grid-column-collection.js +6 -1
  22. package/esm2015/lib/igc-grid-filter-dialog-view-model-grouping-level-collection.js +6 -1
  23. package/esm2015/lib/igc-grid-filter-dialog-view-model-grouping-level.js +6 -1
  24. package/esm2015/lib/igc-grid-filter-dialog-view-model-row-collection.js +6 -1
  25. package/esm2015/lib/igc-grid-filter-operands-collection.js +6 -1
  26. package/esm2015/lib/igc-grid-selected-cell-ranges-collection.js +6 -1
  27. package/esm2015/lib/igc-grid-selected-cells-collection.js +6 -1
  28. package/esm2015/lib/igc-grid-selected-keys-collection.js +6 -1
  29. package/esm2015/lib/igc-horizontal-property-editor-data-source.js +6 -1
  30. package/esm2015/lib/igc-responsive-phases-collection.js +6 -1
  31. package/esm2015/lib/igc-responsive-states-collection.js +6 -1
  32. package/esm5/lib/CanvasGridCellBase.js +10 -10
  33. package/esm5/lib/CanvasSummaryCell.js +2 -2
  34. package/esm5/lib/ColumnFilterCondition_combined.js +270 -210
  35. package/esm5/lib/ColumnGroupingView_combined.js +17 -17
  36. package/esm5/lib/ComparisonOperatorSelectorView_combined.js +3 -3
  37. package/esm5/lib/EditorCell.js +2 -2
  38. package/esm5/lib/FilterCell.js +12 -12
  39. package/esm5/lib/GridCellBase.js +2 -2
  40. package/esm5/lib/GridColumnFilterOptionsView_combined.js +10 -10
  41. package/esm5/lib/GridColumnOptionsViewBase_combined.js +4 -4
  42. package/esm5/lib/GridColumnOptionsView_combined.js +2 -2
  43. package/esm5/lib/GridColumnSummaryOptionsView_combined.js +5 -5
  44. package/esm5/lib/GridFilterDialogView_combined.js +16 -16
  45. package/esm5/lib/GridStyleRepository.js +12 -12
  46. package/esm5/lib/MultiColumnComboBoxView_combined.js +51 -51
  47. package/esm5/lib/PropertyEditorView_combined.js +4 -4
  48. package/esm5/lib/igc-column-exchangers-collection.js +6 -1
  49. package/esm5/lib/igc-column-property-setters-collection.js +6 -1
  50. package/esm5/lib/igc-grid-column-collection.js +6 -1
  51. package/esm5/lib/igc-grid-filter-dialog-view-model-grouping-level-collection.js +6 -1
  52. package/esm5/lib/igc-grid-filter-dialog-view-model-grouping-level.js +6 -1
  53. package/esm5/lib/igc-grid-filter-dialog-view-model-row-collection.js +6 -1
  54. package/esm5/lib/igc-grid-filter-operands-collection.js +6 -1
  55. package/esm5/lib/igc-grid-selected-cell-ranges-collection.js +6 -1
  56. package/esm5/lib/igc-grid-selected-cells-collection.js +6 -1
  57. package/esm5/lib/igc-grid-selected-keys-collection.js +6 -1
  58. package/esm5/lib/igc-horizontal-property-editor-data-source.js +6 -1
  59. package/esm5/lib/igc-responsive-phases-collection.js +6 -1
  60. package/esm5/lib/igc-responsive-states-collection.js +6 -1
  61. package/fesm2015/igniteui-webcomponents-grids.js +474 -373
  62. package/fesm5/igniteui-webcomponents-grids.js +498 -373
  63. package/grids/3rdpartylicenses.txt +101 -26
  64. package/grids/combined.js +27166 -27890
  65. package/grids/index.d.ts +9 -1
  66. package/grids/lib/igc-action-strip-component.d.ts +4 -15
  67. package/grids/lib/igc-active-node-change-event-args.d.ts +3 -6
  68. package/grids/lib/igc-cancelable-event-args.d.ts +1 -2
  69. package/grids/lib/igc-child-grid-row-component.d.ts +58 -0
  70. package/grids/lib/igc-clipboard-options.d.ts +45 -0
  71. package/grids/lib/igc-column-component.d.ts +15 -1
  72. package/grids/lib/igc-column-exporting-event-args.d.ts +5 -10
  73. package/grids/lib/igc-column-group-component.d.ts +1 -0
  74. package/grids/lib/igc-column-layout-component.d.ts +1 -0
  75. package/grids/lib/igc-column-moving-end-event-args.d.ts +3 -6
  76. package/grids/lib/igc-column-moving-event-args.d.ts +2 -4
  77. package/grids/lib/igc-column-moving-start-event-args.d.ts +1 -2
  78. package/grids/lib/igc-column-resize-event-args.d.ts +3 -6
  79. package/grids/lib/igc-column-selection-event-args.d.ts +5 -10
  80. package/grids/lib/igc-column-state.d.ts +1 -0
  81. package/grids/lib/igc-column-toggled-event-args.d.ts +2 -4
  82. package/grids/lib/igc-column-visibility-changed-event-args.d.ts +2 -4
  83. package/grids/lib/igc-column-visibility-changing-event-args.d.ts +3 -6
  84. package/grids/lib/igc-density-changed-event-args.d.ts +2 -4
  85. package/grids/lib/{igc-exporter-event.d.ts → igc-exporter-event-args.d.ts} +2 -1
  86. package/grids/lib/igc-expression-tree.d.ts +4 -3
  87. package/grids/lib/igc-filtering-event-args.d.ts +2 -4
  88. package/grids/lib/igc-filtering-expressions-tree.d.ts +3 -3
  89. package/grids/lib/igc-for-of-data-changing-event-args.d.ts +1 -2
  90. package/grids/lib/igc-grid-base-directive.d.ts +17 -7
  91. package/grids/lib/igc-grid-cell-event-args.d.ts +2 -4
  92. package/grids/lib/igc-grid-created-event-args.d.ts +26 -0
  93. package/grids/lib/igc-grid-edit-done-event-args.d.ts +4 -8
  94. package/grids/lib/igc-grid-edit-event-args.d.ts +5 -10
  95. package/grids/lib/igc-grid-editing-actions-component.d.ts +1 -0
  96. package/grids/lib/igc-grid-form-group-created-event-args.d.ts +1 -2
  97. package/grids/lib/igc-grid-keydown-event-args.d.ts +4 -8
  98. package/grids/lib/igc-grid-pinning-actions-component.d.ts +1 -0
  99. package/grids/lib/igc-grid-scroll-event-args.d.ts +3 -6
  100. package/grids/lib/igc-grid-state-base-directive.d.ts +2 -16
  101. package/grids/lib/igc-grid-state-collection.d.ts +1 -0
  102. package/grids/lib/igc-grid-state-component.d.ts +11 -3
  103. package/grids/lib/igc-grid-toolbar-actions-component.d.ts +1 -0
  104. package/grids/lib/igc-grid-toolbar-advanced-filtering-component.d.ts +1 -0
  105. package/grids/lib/igc-grid-toolbar-component.d.ts +2 -0
  106. package/grids/lib/igc-grid-toolbar-export-event-args.d.ts +4 -8
  107. package/grids/lib/igc-grid-toolbar-exporter-component.d.ts +3 -2
  108. package/grids/lib/igc-grid-toolbar-hiding-component.d.ts +1 -0
  109. package/grids/lib/igc-grid-toolbar-pinning-component.d.ts +1 -0
  110. package/grids/lib/igc-grid-toolbar-template-context.d.ts +19 -0
  111. package/grids/lib/igc-grid-toolbar-title-component.d.ts +1 -0
  112. package/grids/lib/igc-grid-validation-status-event-args.d.ts +2 -4
  113. package/grids/lib/igc-grouping-done-event-args.d.ts +3 -6
  114. package/grids/lib/igc-grouping-state.d.ts +1 -0
  115. package/grids/lib/igc-hierarchical-grid-base-directive.d.ts +68 -0
  116. package/grids/lib/igc-hierarchical-grid-component.d.ts +218 -0
  117. package/grids/lib/igc-noop-pivot-dimensions-strategy.d.ts +24 -0
  118. package/grids/lib/igc-page-cancellable-event-args.d.ts +2 -4
  119. package/grids/lib/igc-page-event-args.d.ts +2 -4
  120. package/grids/lib/igc-paginator-component.d.ts +3 -0
  121. package/grids/lib/igc-paging-state.d.ts +1 -0
  122. package/grids/lib/igc-pin-column-cancellable-event-args.d.ts +4 -8
  123. package/grids/lib/igc-pin-column-event-args.d.ts +3 -6
  124. package/grids/lib/igc-pin-row-event-args.d.ts +3 -6
  125. package/grids/lib/igc-pinning-config.d.ts +1 -0
  126. package/grids/lib/igc-pivot-configuration-changed-event-args.d.ts +1 -2
  127. package/grids/lib/igc-row-data-event-args.d.ts +2 -4
  128. package/grids/lib/igc-row-drag-end-event-args.d.ts +3 -6
  129. package/grids/lib/igc-row-drag-start-event-args.d.ts +3 -6
  130. package/grids/lib/igc-row-exporting-event-args.d.ts +3 -6
  131. package/grids/lib/igc-row-island-component.d.ts +2635 -0
  132. package/grids/lib/igc-row-selection-event-args.d.ts +5 -10
  133. package/grids/lib/igc-row-toggle-event-args.d.ts +3 -6
  134. package/grids/lib/igc-sorting-event-args.d.ts +1 -2
  135. package/grids/lib/igc-toggle-view-cancelable-event-args.d.ts +1 -2
  136. package/grids/lib/igc-toggle-view-event-args.d.ts +1 -2
  137. package/grids/styles.css +1 -1
  138. package/grids/themes/dark/bootstrap.css +1 -1
  139. package/grids/themes/dark/fluent.css +1 -1
  140. package/grids/themes/dark/indigo.css +1 -1
  141. package/grids/themes/dark/material.css +1 -1
  142. package/grids/themes/light/bootstrap.css +1 -1
  143. package/grids/themes/light/fluent.css +1 -1
  144. package/grids/themes/light/indigo.css +1 -1
  145. package/grids/themes/light/material.css +1 -1
  146. package/lib/ColumnFilterCondition_combined.d.ts +33 -21
  147. package/lib/DateEditorView.d.ts +1 -1
  148. package/lib/GridFilterDialogView_combined.d.ts +1 -1
  149. package/lib/TextEditorView.d.ts +1 -1
  150. package/package.json +4 -4
@@ -0,0 +1,2635 @@
1
+
2
+ import { IgcGridCreatedEventArgs } from './igc-grid-created-event-args';
3
+ import { IgcForOfState } from './igc-for-of-state';
4
+ import { IgcFilteringExpressionsTree } from './igc-filtering-expressions-tree';
5
+ import { IgcGridScrollEventArgs } from './igc-grid-scroll-event-args';
6
+ import { IgcGridCellEventArgs } from './igc-grid-cell-event-args';
7
+ import { IgcGridFormGroupCreatedEventArgs } from './igc-grid-form-group-created-event-args';
8
+ import { IgcGridValidationStatusEventArgs } from './igc-grid-validation-status-event-args';
9
+ import { IgcRowSelectionEventArgs } from './igc-row-selection-event-args';
10
+ import { IgcColumnSelectionEventArgs } from './igc-column-selection-event-args';
11
+ import { IgcPinColumnCancellableEventArgs } from './igc-pin-column-cancellable-event-args';
12
+ import { IgcPinColumnEventArgs } from './igc-pin-column-event-args';
13
+ import { IgcGridEditEventArgs } from './igc-grid-edit-event-args';
14
+ import { IgcGridEditDoneEventArgs } from './igc-grid-edit-done-event-args';
15
+ import { IgcColumnComponent } from './igc-column-component';
16
+ import { IgcColumnsAutoGeneratedEventArgs } from './igc-columns-auto-generated-event-args';
17
+ import { IgcSortingEventArgs } from './igc-sorting-event-args';
18
+ import { IgcSortingExpression } from './igc-sorting-expression';
19
+ import { IgcFilteringEventArgs } from './igc-filtering-event-args';
20
+ import { IgcRowDataEventArgs } from './igc-row-data-event-args';
21
+ import { IgcColumnResizeEventArgs } from './igc-column-resize-event-args';
22
+ import { IgcColumnVisibilityChangingEventArgs } from './igc-column-visibility-changing-event-args';
23
+ import { IgcColumnVisibilityChangedEventArgs } from './igc-column-visibility-changed-event-args';
24
+ import { IgcColumnMovingStartEventArgs } from './igc-column-moving-start-event-args';
25
+ import { IgcColumnMovingEventArgs } from './igc-column-moving-event-args';
26
+ import { IgcColumnMovingEndEventArgs } from './igc-column-moving-end-event-args';
27
+ import { IgcGridKeydownEventArgs } from './igc-grid-keydown-event-args';
28
+ import { IgcRowDragStartEventArgs } from './igc-row-drag-start-event-args';
29
+ import { IgcRowDragEndEventArgs } from './igc-row-drag-end-event-args';
30
+ import { IgcGridClipboardEvent } from './igc-grid-clipboard-event';
31
+ import { IgcRowToggleEventArgs } from './igc-row-toggle-event-args';
32
+ import { IgcPinRowEventArgs } from './igc-pin-row-event-args';
33
+ import { IgcActiveNodeChangeEventArgs } from './igc-active-node-change-event-args';
34
+ import { IgcGridToolbarExportEventArgs } from './igc-grid-toolbar-export-event-args';
35
+ import { IgcGridSelectionRange } from './igc-grid-selection-range';
36
+ import { IgcForOfDataChangingEventArgs } from './igc-for-of-data-changing-event-args';
37
+ import { IgcGridToolbarTemplateContext } from './igc-grid-toolbar-template-context';
38
+ import { IgcRenderFunction } from './common';
39
+ import { IgcDataCloneStrategy } from './igc-data-clone-strategy';
40
+ import { IgcClipboardOptions } from './igc-clipboard-options';
41
+ import { IgcActionStripComponent } from './igc-action-strip-component';
42
+ import { IgcGridRowDragGhostContext } from './igc-grid-row-drag-ghost-context';
43
+ import { IgcGridRowEditTextTemplateContext } from './igc-grid-row-edit-text-template-context';
44
+ import { IgcGridEmptyTemplateContext } from './igc-grid-empty-template-context';
45
+ import { IgcGridRowEditActionsTemplateContext } from './igc-grid-row-edit-actions-template-context';
46
+ import { IgcGridRowTemplateContext } from './igc-grid-row-template-context';
47
+ import { IgcGridTemplateContext } from './igc-grid-template-context';
48
+ import { IgcGridHeaderTemplateContext } from './igc-grid-header-template-context';
49
+ import { IgcGridToolbarComponent } from './igc-grid-toolbar-component';
50
+ import { IgcPaginatorComponent } from './igc-paginator-component';
51
+ import { IgcGridResourceStrings } from './igc-grid-resource-strings';
52
+ import { FilteringLogic } from './filtering-logic';
53
+ import { GridPagingMode } from './grid-paging-mode';
54
+ import { GridValidationTrigger } from './grid-validation-trigger';
55
+ import { IgcPinningConfig } from './igc-pinning-config';
56
+ import { FilterMode } from './filter-mode';
57
+ import { GridSummaryPosition } from './grid-summary-position';
58
+ import { GridSummaryCalculationMode } from './grid-summary-calculation-mode';
59
+ import { IgcFilteringStrategy } from './igc-filtering-strategy';
60
+ import { IgcGridSortingStrategy } from './igc-grid-sorting-strategy';
61
+ import { IgcSortingOptions } from './igc-sorting-options';
62
+ import { IgcRowDirective } from './igc-row-directive';
63
+ import { IgcHeadSelectorTemplateContext } from './igc-head-selector-template-context';
64
+ import { IgcRowSelectorTemplateContext } from './igc-row-selector-template-context';
65
+ import { GridSelectionMode } from './grid-selection-mode';
66
+ import { IgcGridRowComponent } from './igc-grid-row-component';
67
+ import { DropPosition } from './drop-position';
68
+ import { IgcFilteringOperation } from './igc-filtering-operation';
69
+ import { IgcRowType } from './igc-row-type';
70
+ import { IgcCellPosition } from './igc-cell-position';
71
+ import { IgcOverlaySettings } from './igc-overlay-settings';
72
+ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from './common';
73
+
74
+
75
+
76
+
77
+ /* blazorCopyInheritedMembers */
78
+ /* blazorElement */
79
+ /* wcElementTag: igc-row-island */
80
+ /* blazorIndirectRender */
81
+ /* jsonAPIManageCollectionInMarkup */
82
+ /* jsonAPIManageItemInMarkup */
83
+ /* mustUseNGParentAnchor */
84
+ /* contentParent: RowIsland */
85
+ /* contentParent: HierarchicalGrid */
86
+ /**
87
+ * Row island
88
+ *
89
+ * @igxModule IgxHierarchicalGridModule
90
+ * @igxParent IgxHierarchicalGridComponent, IgxRowIslandComponent
91
+ *
92
+ */
93
+
94
+ export declare class IgcRowIslandComponent extends EventEmitterMixin<IgcRowIslandComponentEventMap, Constructor<LitElement>>(LitElement)
95
+
96
+ {
97
+
98
+
99
+ public set childDataKey(value: string);
100
+ public get childDataKey(): string;
101
+
102
+
103
+
104
+ /* contentChildren */
105
+ /* blazorInclude */
106
+ /* blazorTreatAsCollection */
107
+ /* blazorCollectionName: RowIslandCollection */
108
+ /**
109
+ * @hidden
110
+ */
111
+ public set childLayoutList(value: IgcRowIslandComponent[]);
112
+ public get childLayoutList(): IgcRowIslandComponent[];
113
+
114
+
115
+
116
+ /**
117
+ * Gets the toolbar template for each child grid created from this row island.
118
+ */
119
+ public set toolbarTemplate(value: IgcRenderFunction<IgcGridToolbarTemplateContext>);
120
+ public get toolbarTemplate(): IgcRenderFunction<IgcGridToolbarTemplateContext>;
121
+
122
+
123
+
124
+ /**
125
+ * Gets the paginator template for each child grid created from this row island.
126
+ */
127
+ public set paginatorTemplate(value: IgcRenderFunction<any>);
128
+ public get paginatorTemplate(): IgcRenderFunction<any>;
129
+
130
+
131
+ public set data(value: any[]);
132
+ public get data(): any[];
133
+
134
+
135
+
136
+ /**
137
+ * Sets if all immediate children of the grids for this `IgxRowIslandComponent` should be expanded/collapsed.
138
+ * ```html
139
+ * <igx-hierarchical-grid [data]="Data" [autoGenerate]="true">
140
+ * <igx-row-island [key]="'childData'" [expandChildren]="true" #rowIsland>
141
+ * <!-- ... -->
142
+ * </igx-row-island>
143
+ * </igx-hierarchical-grid>
144
+ * ```
145
+ *
146
+ * @memberof IgxRowIslandComponent
147
+ */
148
+ public set expandChildren(value: boolean);
149
+ public get expandChildren(): boolean;
150
+
151
+
152
+ /**
153
+ * Gets/Sets the key indicating whether a row has children. If row has no children it does not render an expand indicator.
154
+ *
155
+ * @example
156
+ * ```html
157
+ * <igx-hierarchical-grid #grid [data]="localData" [hasChildrenKey]="'hasEmployees'">
158
+ * </igx-hierarchical-grid>
159
+ * ```
160
+ */
161
+ public set hasChildrenKey(value: string);
162
+ public get hasChildrenKey(): string;
163
+
164
+
165
+
166
+ /**
167
+ * Gets/Sets whether the expand/collapse all button in the header should be rendered.
168
+ *
169
+ * @remark
170
+ * The default value is false.
171
+ * @example
172
+ * ```html
173
+ * <igx-hierarchical-grid #grid [data]="localData" [showExpandAll]="true">
174
+ * </igx-hierarchical-grid>
175
+ * ```
176
+ */
177
+ public set showExpandAll(value: boolean);
178
+ public get showExpandAll(): boolean;
179
+
180
+
181
+
182
+ public set batchEditing(value: boolean);
183
+ public get batchEditing(): boolean;
184
+
185
+
186
+
187
+ /**
188
+ * Gets/Sets the display time for the row adding snackbar notification.
189
+ *
190
+ * @remarks
191
+ * By default it is 6000ms.
192
+ */
193
+ public set snackbarDisplayTime(value: number);
194
+ public get snackbarDisplayTime(): number;
195
+
196
+
197
+
198
+ /**
199
+ * Gets/Sets whether to auto-generate the columns.
200
+ *
201
+ * @remarks
202
+ * The default value is false. When set to true, it will override all columns declared through code or in markup.
203
+ * @example
204
+ * ```html
205
+ * <igx-grid [data]="Data" [autoGenerate]="true"></igx-grid>
206
+ * ```
207
+ */
208
+ public set autoGenerate(value: boolean);
209
+ public get autoGenerate(): boolean;
210
+
211
+
212
+
213
+ /**
214
+ * Gets/Sets a list of property keys to be excluded from the generated column collection
215
+ * @remarks
216
+ * The collection is only used during initialization and changing it will not cause any changes in the generated columns at runtime
217
+ * unless the grid is destroyed and recreated. To modify the columns visible in the UI at runtime, please use their
218
+ * [hidden](https://www.infragistics.com/products/ignite-ui-angular/docs/typescript/latest/classes/IgxColumnComponent.html#hidden) property.
219
+ * @example
220
+ * ```html
221
+ * <igx-grid data=[Data] [autoGenerate]="true" [autoGenerateExclude]="['ProductName', 'Count']"></igx-grid>
222
+ * ```
223
+ * ```typescript
224
+ * const Data = [{ 'Id': '1', 'ProductName': 'name1', 'Description': 'description1', 'Count': 5 }]
225
+ * ```
226
+ */
227
+ public set autoGenerateExclude(value: string[]);
228
+ public get autoGenerateExclude(): string[];
229
+
230
+
231
+
232
+ /**
233
+ * Controls whether columns moving is enabled in the grid.
234
+ *
235
+ */
236
+ public set moving(value: boolean);
237
+ public get moving(): boolean;
238
+
239
+
240
+
241
+ /**
242
+ * Gets/Sets a custom template when empty.
243
+ *
244
+ * @example
245
+ * ```html
246
+ * <igx-grid [id]="'igx-grid-1'" [data]="Data" [emptyGridTemplate]="myTemplate" [autoGenerate]="true"></igx-grid>
247
+ * ```
248
+ */
249
+ public set emptyGridTemplate(value: IgcRenderFunction<void>);
250
+ public get emptyGridTemplate(): IgcRenderFunction<void>;
251
+
252
+
253
+
254
+ /**
255
+ * Gets/Sets a custom template for adding row UI when grid is empty.
256
+ *
257
+ * @example
258
+ * ```html
259
+ * <igx-grid [id]="'igx-grid-1'" [data]="Data" [addRowEmptyTemplate]="myTemplate" [autoGenerate]="true"></igx-grid>
260
+ * ```
261
+ */
262
+ public set addRowEmptyTemplate(value: IgcRenderFunction<void>);
263
+ public get addRowEmptyTemplate(): IgcRenderFunction<void>;
264
+
265
+
266
+
267
+ /**
268
+ * Gets/Sets a custom template when loading.
269
+ *
270
+ * @example
271
+ * ```html
272
+ * <igx-grid [id]="'igx-grid-1'" [data]="Data" [loadingGridTemplate]="myTemplate" [autoGenerate]="true"></igx-grid>
273
+ * ```
274
+ */
275
+ public set loadingGridTemplate(value: IgcRenderFunction<void>);
276
+ public get loadingGridTemplate(): IgcRenderFunction<void>;
277
+
278
+
279
+
280
+ /**
281
+ * Get/Set IgxSummaryRow height
282
+ */
283
+ public set summaryRowHeight(value: number);
284
+ public get summaryRowHeight(): number;
285
+
286
+
287
+
288
+ /**
289
+ * Gets/Sets the data clone strategy of the grid when in edit mode.
290
+ *
291
+ * @example
292
+ * ```html
293
+ * <igx-grid #grid [data]="localData" [dataCloneStrategy]="customCloneStrategy"></igx-grid>
294
+ * ```
295
+ */
296
+ public set dataCloneStrategy(value: IgcDataCloneStrategy);
297
+ public get dataCloneStrategy(): IgcDataCloneStrategy;
298
+
299
+
300
+
301
+ /**
302
+ * Controls the copy behavior of the grid.
303
+ */
304
+ public set clipboardOptions(value: IgcClipboardOptions);
305
+ public get clipboardOptions(): IgcClipboardOptions;
306
+
307
+
308
+
309
+ /* treatAsRef */
310
+ /**
311
+ * Sets a conditional class selector to the grid's row element.
312
+ * Accepts an object literal, containing key-value pairs,
313
+ * where the key is the name of the CSS class and the value is
314
+ * either a callback function that returns a boolean, or boolean, like so:
315
+ * ```typescript
316
+ * callback = (row: RowType) => { return row.selected > 6; }
317
+ * rowClasses = { 'className' : this.callback };
318
+ * ```
319
+ * ```html
320
+ * <igx-grid #grid [data]="Data" [rowClasses] = "rowClasses" [autoGenerate]="true"></igx-grid>
321
+ * ```
322
+ *
323
+ * @memberof IgxColumnComponent
324
+ */
325
+ public set rowClasses(value: any);
326
+ public get rowClasses(): any;
327
+
328
+
329
+
330
+ /* treatAsRef */
331
+ /**
332
+ * Sets conditional style properties on the grid row element.
333
+ * It accepts an object literal where the keys are
334
+ * the style properties and the value is an expression to be evaluated.
335
+ * ```typescript
336
+ * styles = {
337
+ * background: 'yellow',
338
+ * color: (row: RowType) => row.selected : 'red': 'white'
339
+ * }
340
+ * ```
341
+ * ```html
342
+ * <igx-grid #grid [data]="Data" [rowStyles]="styles" [autoGenerate]="true"></igx-grid>
343
+ * ```
344
+ *
345
+ * @memberof IgxColumnComponent
346
+ */
347
+ public set rowStyles(value: any);
348
+ public get rowStyles(): any;
349
+
350
+
351
+
352
+ /* alternateType: string */
353
+ /**
354
+ * Gets/Sets the primary key.
355
+ *
356
+ * @example
357
+ * ```html
358
+ * <igx-grid #grid [data]="localData" [primaryKey]="'ProductID'" [autoGenerate]="true"></igx-grid>
359
+ * ```
360
+ */
361
+ public set primaryKey(value: string);
362
+ public get primaryKey(): string;
363
+
364
+
365
+
366
+ /* contentChildren */
367
+ /* blazorInclude */
368
+ /* blazorTreatAsCollection */
369
+ /* blazorCollectionName: ColumnCollection */
370
+ /* ngQueryListName: columnList */
371
+ /**
372
+ * @hidden @internal
373
+ */
374
+ public set columnList(value: IgcColumnComponent[]);
375
+ public get columnList(): IgcColumnComponent[];
376
+
377
+
378
+
379
+ /* contentChildren */
380
+ /* blazorInclude */
381
+ /* blazorTreatAsCollection */
382
+ /* blazorCollectionName: ActionStripCollection */
383
+ /* ngQueryListName: actionStripComponents */
384
+ /** @hidden @internal */
385
+ public set actionStripComponents(value: IgcActionStripComponent[]);
386
+ public get actionStripComponents(): IgcActionStripComponent[];
387
+
388
+
389
+
390
+
391
+ /**
392
+ * Gets the custom template, if any, used for row drag ghost.
393
+ */
394
+ public set dragGhostCustomTemplate(value: IgcRenderFunction<IgcGridRowDragGhostContext>);
395
+ public get dragGhostCustomTemplate(): IgcRenderFunction<IgcGridRowDragGhostContext>;
396
+
397
+
398
+
399
+ /**
400
+ * Gets the row edit text template.
401
+ */
402
+ public set rowEditTextTemplate(value: IgcRenderFunction<IgcGridRowEditTextTemplateContext>);
403
+ public get rowEditTextTemplate(): IgcRenderFunction<IgcGridRowEditTextTemplateContext>;
404
+
405
+
406
+
407
+ /**
408
+ * Gets the row add text template.
409
+ */
410
+ public set rowAddTextTemplate(value: IgcRenderFunction<IgcGridEmptyTemplateContext>);
411
+ public get rowAddTextTemplate(): IgcRenderFunction<IgcGridEmptyTemplateContext>;
412
+
413
+
414
+
415
+ /**
416
+ * Gets the row edit actions template.
417
+ */
418
+ public set rowEditActionsTemplate(value: IgcRenderFunction<IgcGridRowEditActionsTemplateContext>);
419
+ public get rowEditActionsTemplate(): IgcRenderFunction<IgcGridRowEditActionsTemplateContext>;
420
+
421
+
422
+
423
+ /**
424
+ * Gets the row expand indicator template.
425
+ */
426
+ public set rowExpandedIndicatorTemplate(value: IgcRenderFunction<IgcGridRowTemplateContext>);
427
+ public get rowExpandedIndicatorTemplate(): IgcRenderFunction<IgcGridRowTemplateContext>;
428
+
429
+
430
+
431
+ /**
432
+ * Gets the row collapse indicator template.
433
+ */
434
+ public set rowCollapsedIndicatorTemplate(value: IgcRenderFunction<IgcGridRowTemplateContext>);
435
+ public get rowCollapsedIndicatorTemplate(): IgcRenderFunction<IgcGridRowTemplateContext>;
436
+
437
+
438
+
439
+ /**
440
+ * Gets the header expand indicator template.
441
+ */
442
+ public set headerExpandedIndicatorTemplate(value: IgcRenderFunction<IgcGridTemplateContext>);
443
+ public get headerExpandedIndicatorTemplate(): IgcRenderFunction<IgcGridTemplateContext>;
444
+
445
+
446
+
447
+ /**
448
+ * Gets the row collapse indicator template.
449
+ */
450
+ public set headerCollapsedIndicatorTemplate(value: IgcRenderFunction<IgcGridTemplateContext>);
451
+ public get headerCollapsedIndicatorTemplate(): IgcRenderFunction<IgcGridTemplateContext>;
452
+
453
+
454
+
455
+ /**
456
+ * Gets the excel style header icon.
457
+ */
458
+ public set excelStyleHeaderIconTemplate(value: IgcRenderFunction<IgcGridHeaderTemplateContext>);
459
+ public get excelStyleHeaderIconTemplate(): IgcRenderFunction<IgcGridHeaderTemplateContext>;
460
+
461
+
462
+
463
+ /**
464
+ * The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in asc order.
465
+ */
466
+ public set sortAscendingHeaderIconTemplate(value: IgcRenderFunction<IgcGridHeaderTemplateContext>);
467
+ public get sortAscendingHeaderIconTemplate(): IgcRenderFunction<IgcGridHeaderTemplateContext>;
468
+
469
+
470
+
471
+ /**
472
+ * The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in desc order.
473
+ */
474
+ public set sortDescendingHeaderIconTemplate(value: IgcRenderFunction<IgcGridHeaderTemplateContext>);
475
+ public get sortDescendingHeaderIconTemplate(): IgcRenderFunction<IgcGridHeaderTemplateContext>;
476
+
477
+
478
+
479
+ /**
480
+ * Gets custom template, if any, that should be used when rendering a header sorting indicator when columns are not sorted.
481
+ */
482
+ public set sortHeaderIconTemplate(value: IgcRenderFunction<IgcGridHeaderTemplateContext>);
483
+ public get sortHeaderIconTemplate(): IgcRenderFunction<IgcGridHeaderTemplateContext>;
484
+
485
+
486
+
487
+ /* contentChildren */
488
+ /* blazorInclude */
489
+ /* blazorTreatAsCollection */
490
+ /* blazorCollectionName: GridToolbarCollection */
491
+ /* ngQueryListName: toolbar */
492
+ /** @hidden @internal */
493
+ public set toolbar(value: IgcGridToolbarComponent[]);
494
+ public get toolbar(): IgcGridToolbarComponent[];
495
+
496
+
497
+
498
+ /* contentChildren */
499
+ /* blazorInclude */
500
+ /* blazorTreatAsCollection */
501
+ /* blazorCollectionName: PaginatorCollection */
502
+ /* ngQueryListName: paginationComponents */
503
+ /** @hidden @internal */
504
+ public set paginationComponents(value: IgcPaginatorComponent[]);
505
+ public get paginationComponents(): IgcPaginatorComponent[];
506
+
507
+
508
+
509
+ /**
510
+ * Gets/Sets the resource strings.
511
+ *
512
+ * @remarks
513
+ * By default it uses EN resources.
514
+ */
515
+ public set resourceStrings(value: IgcGridResourceStrings);
516
+ public get resourceStrings(): IgcGridResourceStrings;
517
+
518
+
519
+
520
+ /**
521
+ * Gets/Sets the filtering logic of the `IgxGridComponent`.
522
+ *
523
+ * @remarks
524
+ * The default is AND.
525
+ * @example
526
+ * ```html
527
+ * <igx-grid [data]="Data" [autoGenerate]="true" [filteringLogic]="filtering"></igx-grid>
528
+ * ```
529
+ */
530
+ public set filteringLogic(value: FilteringLogic);
531
+ public get filteringLogic(): FilteringLogic;
532
+
533
+
534
+
535
+ /* mustSetInCodePlatforms: WebComponents;Blazor */
536
+ /**
537
+ * Gets/Sets the filtering state.
538
+ *
539
+ * @example
540
+ * ```html
541
+ * <igx-grid #grid [data]="Data" [autoGenerate]="true" [(filteringExpressionsTree)]="model.filteringExpressions"></igx-grid>
542
+ * ```
543
+ * @remarks
544
+ * Supports two-way binding.
545
+ */
546
+ public set filteringExpressionsTree(value: IgcFilteringExpressionsTree);
547
+ public get filteringExpressionsTree(): IgcFilteringExpressionsTree;
548
+
549
+
550
+
551
+ /**
552
+ * Gets/Sets the advanced filtering state.
553
+ *
554
+ * @example
555
+ * ```typescript
556
+ * let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;
557
+ * this.grid.advancedFilteringExpressionsTree = logic;
558
+ * ```
559
+ */
560
+ public set advancedFilteringExpressionsTree(value: IgcFilteringExpressionsTree);
561
+ public get advancedFilteringExpressionsTree(): IgcFilteringExpressionsTree;
562
+
563
+
564
+
565
+ /**
566
+ * Gets/Sets the locale.
567
+ *
568
+ * @remarks
569
+ * If not set, returns browser's language.
570
+ */
571
+ public set locale(value: string);
572
+ public get locale(): string;
573
+
574
+
575
+
576
+ public set pagingMode(value: GridPagingMode);
577
+ public get pagingMode(): GridPagingMode;
578
+
579
+
580
+
581
+ /**
582
+ * Gets/Sets if the row selectors are hidden.
583
+ *
584
+ * @remarks
585
+ * By default row selectors are shown
586
+ */
587
+ public set hideRowSelectors(value: boolean);
588
+ public get hideRowSelectors(): boolean;
589
+
590
+
591
+
592
+ /**
593
+ * Gets/Sets whether rows can be moved.
594
+ *
595
+ * @example
596
+ * ```html
597
+ * <igx-grid #grid [rowDraggable]="true"></igx-grid>
598
+ * ```
599
+ */
600
+ public set rowDraggable(value: boolean);
601
+ public get rowDraggable(): boolean;
602
+
603
+
604
+
605
+ /**
606
+ * Gets/Sets the trigger for validators used when editing the grid.
607
+ *
608
+ * @example
609
+ * ```html
610
+ * <igx-grid #grid validationTrigger='blur'></igx-grid>
611
+ * ```
612
+ */
613
+ public set validationTrigger(value: GridValidationTrigger);
614
+ public get validationTrigger(): GridValidationTrigger;
615
+
616
+
617
+
618
+ /**
619
+ * Gets/Sets whether the rows are editable.
620
+ *
621
+ * @remarks
622
+ * By default it is set to false.
623
+ * @example
624
+ * ```html
625
+ * <igx-grid #grid [rowEditable]="true" [primaryKey]="'ProductID'" ></igx-grid>
626
+ * ```
627
+ */
628
+ public set rowEditable(value: boolean);
629
+ public get rowEditable(): boolean;
630
+
631
+
632
+
633
+ /* csSuppress */
634
+ /**
635
+ * Gets/Sets the height.
636
+ *
637
+ * @example
638
+ * ```html
639
+ * <igx-grid #grid [data]="Data" [height]="'305px'" [autoGenerate]="true"></igx-grid>
640
+ * ```
641
+ */
642
+ public set height(value: string);
643
+ public get height(): string;
644
+
645
+
646
+
647
+ /* csSuppress */
648
+ /**
649
+ * Gets/Sets the width of the grid.
650
+ *
651
+ * @example
652
+ * ```typescript
653
+ * let gridWidth = this.grid.width;
654
+ * ```
655
+ */
656
+ public set width(value: string);
657
+ public get width(): string;
658
+
659
+
660
+
661
+ /**
662
+ * Gets/Sets the row height.
663
+ *
664
+ * @example
665
+ * ```html
666
+ * <igx-grid #grid [data]="localData" [rowHeight]="100" [autoGenerate]="true"></igx-grid>
667
+ * ```
668
+ */
669
+ public set rowHeight(value: number);
670
+ public get rowHeight(): number;
671
+
672
+
673
+
674
+ /**
675
+ * Gets/Sets the default width of the columns.
676
+ *
677
+ * @example
678
+ * ```html
679
+ * <igx-grid #grid [data]="localData" [columnWidth]="100" [autoGenerate]="true"></igx-grid>
680
+ * ```
681
+ */
682
+ public set columnWidth(value: string);
683
+ public get columnWidth(): string;
684
+
685
+
686
+
687
+ /**
688
+ * Get/Sets the message displayed when there are no records.
689
+ *
690
+ * @example
691
+ * ```html
692
+ * <igx-grid #grid [data]="Data" [emptyGridMessage]="'The grid is empty'" [autoGenerate]="true"></igx-grid>
693
+ * ```
694
+ */
695
+ public set emptyGridMessage(value: string);
696
+ public get emptyGridMessage(): string;
697
+
698
+
699
+
700
+ /**
701
+ * Gets/Sets whether the grid is going to show a loading indicator.
702
+ *
703
+ * @example
704
+ * ```html
705
+ * <igx-grid #grid [data]="Data" [isLoading]="true" [autoGenerate]="true"></igx-grid>
706
+ * ```
707
+ */
708
+ public set isLoading(value: boolean);
709
+ public get isLoading(): boolean;
710
+
711
+
712
+
713
+ /**
714
+ * Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid
715
+ *
716
+ * @remarks
717
+ * This will allow to bind the grid to remote data and having auto-generated columns at the same time.
718
+ * Note that after generating the columns, this property would be disabled to avoid re-creating
719
+ * columns each time a new data is assigned.
720
+ * @example
721
+ * ```typescript
722
+ * this.grid.shouldGenerate = true;
723
+ * ```
724
+ */
725
+ public set shouldGenerate(value: boolean);
726
+ public get shouldGenerate(): boolean;
727
+
728
+
729
+
730
+ /**
731
+ * Gets/Sets the message displayed when there are no records and the grid is filtered.
732
+ *
733
+ * @example
734
+ * ```html
735
+ * <igx-grid #grid [data]="Data" [emptyGridMessage]="'The grid is empty'" [autoGenerate]="true"></igx-grid>
736
+ * ```
737
+ */
738
+ public set emptyFilteredGridMessage(value: string);
739
+ public get emptyFilteredGridMessage(): string;
740
+
741
+
742
+
743
+ /* mustSetInCodePlatforms: WebComponents;Blazor;React */
744
+ /**
745
+ * Gets/Sets the initial pinning configuration.
746
+ *
747
+ * @remarks
748
+ * Allows to apply pinning the columns to the start or the end.
749
+ * Note that pinning to both sides at a time is not allowed.
750
+ * @example
751
+ * ```html
752
+ * <igx-grid [pinning]="pinningConfig"></igx-grid>
753
+ * ```
754
+ */
755
+ public set pinning(value: IgcPinningConfig);
756
+ public get pinning(): IgcPinningConfig;
757
+
758
+
759
+
760
+ /**
761
+ * Gets/Sets if the filtering is enabled.
762
+ *
763
+ * @example
764
+ * ```html
765
+ * <igx-grid #grid [data]="localData" [allowFiltering]="true" [height]="'305px'" [autoGenerate]="true"></igx-grid>
766
+ * ```
767
+ */
768
+ public set allowFiltering(value: boolean);
769
+ public get allowFiltering(): boolean;
770
+
771
+
772
+
773
+ /**
774
+ * Gets/Sets a value indicating whether the advanced filtering is enabled.
775
+ *
776
+ * @example
777
+ * ```html
778
+ * <igx-grid #grid [data]="localData" [allowAdvancedFiltering]="true" [autoGenerate]="true"></igx-grid>
779
+ * ```
780
+ */
781
+ public set allowAdvancedFiltering(value: boolean);
782
+ public get allowAdvancedFiltering(): boolean;
783
+
784
+
785
+
786
+ /**
787
+ * Gets/Sets the filter mode.
788
+ *
789
+ * @example
790
+ * ```html
791
+ * <igx-grid #grid [data]="localData" [filterMode]="'quickFilter'" [height]="'305px'" [autoGenerate]="true"></igx-grid>
792
+ * ```
793
+ * @remarks
794
+ * By default it's set to FilterMode.quickFilter.
795
+ */
796
+ public set filterMode(value: FilterMode);
797
+ public get filterMode(): FilterMode;
798
+
799
+
800
+
801
+ /**
802
+ * Gets/Sets the summary position.
803
+ *
804
+ * @example
805
+ * ```html
806
+ * <igx-grid #grid [data]="localData" summaryPosition="top" [autoGenerate]="true"></igx-grid>
807
+ * ```
808
+ * @remarks
809
+ * By default it is bottom.
810
+ */
811
+ public set summaryPosition(value: GridSummaryPosition);
812
+ public get summaryPosition(): GridSummaryPosition;
813
+
814
+
815
+
816
+ /**
817
+ * Gets/Sets the summary calculation mode.
818
+ *
819
+ * @example
820
+ * ```html
821
+ * <igx-grid #grid [data]="localData" summaryCalculationMode="rootLevelOnly" [autoGenerate]="true"></igx-grid>
822
+ * ```
823
+ * @remarks
824
+ * By default it is rootAndChildLevels which means the summaries are calculated for the root level and each child level.
825
+ */
826
+ public set summaryCalculationMode(value: GridSummaryCalculationMode);
827
+ public get summaryCalculationMode(): GridSummaryCalculationMode;
828
+
829
+
830
+
831
+ /**
832
+ * Controls whether the summary row is visible when groupBy/parent row is collapsed.
833
+ *
834
+ * @example
835
+ * ```html
836
+ * <igx-grid #grid [data]="localData" [showSummaryOnCollapse]="true" [autoGenerate]="true"></igx-grid>
837
+ * ```
838
+ * @remarks
839
+ * By default showSummaryOnCollapse is set to 'false' which means that the summary row is not visible
840
+ * when the groupBy/parent row is collapsed.
841
+ */
842
+ public set showSummaryOnCollapse(value: boolean);
843
+ public get showSummaryOnCollapse(): boolean;
844
+
845
+
846
+
847
+ /**
848
+ * Gets/Sets the filtering strategy of the grid.
849
+ *
850
+ * @example
851
+ * ```html
852
+ * <igx-grid #grid [data]="localData" [filterStrategy]="filterStrategy"></igx-grid>
853
+ * ```
854
+ */
855
+ public set filterStrategy(value: IgcFilteringStrategy);
856
+ public get filterStrategy(): IgcFilteringStrategy;
857
+
858
+
859
+
860
+ /**
861
+ * Gets/Sets the sorting strategy of the grid.
862
+ *
863
+ * @example
864
+ * ```html
865
+ * <igx-grid #grid [data]="localData" [sortStrategy]="sortStrategy"></igx-grid>
866
+ * ```
867
+ */
868
+ public set sortStrategy(value: IgcGridSortingStrategy);
869
+ public get sortStrategy(): IgcGridSortingStrategy;
870
+
871
+
872
+
873
+ /**
874
+ * Gets/Sets the sorting options - single or multiple sorting.
875
+ * Accepts an `ISortingOptions` object with any of the `mode` properties.
876
+ *
877
+ * @example
878
+ * ```typescript
879
+ * const _sortingOptions: ISortingOptions = {
880
+ * mode: 'single'
881
+ * }
882
+ * ```html
883
+ * <igx-grid [sortingOptions]="sortingOptions"><igx-grid>
884
+ * ```
885
+ */
886
+ public set sortingOptions(value: IgcSortingOptions);
887
+ public get sortingOptions(): IgcSortingOptions;
888
+
889
+
890
+
891
+ /* blazorByValueArray */
892
+ /* blazorAlwaysWriteback */
893
+ /* @tsTwoWayProperty (true, "RowSelectionChanging", "Detail.NewSelection", false) */
894
+ /**
895
+ * Gets/Sets the current selection state.
896
+ *
897
+ * @remarks
898
+ * Represents the selected rows' IDs (primary key or rowData)
899
+ * @example
900
+ * ```html
901
+ * <igx-grid [data]="localData" primaryKey="ID" rowSelection="multiple" [selectedRows]="[0, 1, 2]"><igx-grid>
902
+ * ```
903
+ */
904
+ /* @tsTwoWayProperty (true, "RowSelectionChanging", "Detail.NewSelection", false) */
905
+ /* @blazorSynthesizeTwoWayBind */
906
+ public set selectedRows(value: any[]);
907
+ public get selectedRows(): any[];
908
+
909
+
910
+
911
+ /* csSuppress */
912
+ /**
913
+ * A list of `IgxGridRowComponent`.
914
+ *
915
+ * @example
916
+ * ```typescript
917
+ * const rowList = this.grid.rowList;
918
+ * ```
919
+ */
920
+ public get rowList(): IgcRowDirective[];
921
+
922
+
923
+
924
+ /* csSuppress */
925
+ /**
926
+ * A list of currently rendered `IgxGridRowComponent`'s.
927
+ *
928
+ * @example
929
+ * ```typescript
930
+ * const dataList = this.grid.dataRowList;
931
+ * ```
932
+ */
933
+ public get dataRowList(): IgcRowDirective[];
934
+
935
+
936
+
937
+ /**
938
+ * Gets the header row selector template.
939
+ */
940
+ public set headSelectorTemplate(value: IgcRenderFunction<IgcHeadSelectorTemplateContext>);
941
+ public get headSelectorTemplate(): IgcRenderFunction<IgcHeadSelectorTemplateContext>;
942
+
943
+
944
+
945
+ /**
946
+ * Gets the row selector template.
947
+ */
948
+ public set rowSelectorTemplate(value: IgcRenderFunction<IgcRowSelectorTemplateContext>);
949
+ public get rowSelectorTemplate(): IgcRenderFunction<IgcRowSelectorTemplateContext>;
950
+
951
+
952
+
953
+ /**
954
+ * The custom template, if any, that should be used when rendering the row drag indicator icon
955
+ */
956
+ public set dragIndicatorIconTemplate(value: IgcRenderFunction<IgcGridEmptyTemplateContext>);
957
+ public get dragIndicatorIconTemplate(): IgcRenderFunction<IgcGridEmptyTemplateContext>;
958
+
959
+
960
+
961
+ /* mustSetInCodePlatforms: WebComponents;Blazor */
962
+ /**
963
+ * Gets/Sets the sorting state.
964
+ *
965
+ * @remarks
966
+ * Supports two-way data binding.
967
+ * @example
968
+ * ```html
969
+ * <igx-grid #grid [data]="Data" [autoGenerate]="true" [(sortingExpressions)]="model.sortingExpressions"></igx-grid>
970
+ * ```
971
+ */
972
+ public set sortingExpressions(value: IgcSortingExpression[]);
973
+ public get sortingExpressions(): IgcSortingExpression[];
974
+
975
+
976
+
977
+ /**
978
+ * Gets the number of hidden columns.
979
+ *
980
+ * @example
981
+ * ```typescript
982
+ * const hiddenCol = this.grid.hiddenColumnsCount;
983
+ * ``
984
+ */
985
+ public get hiddenColumnsCount(): number;
986
+
987
+
988
+
989
+ /**
990
+ * Gets the number of pinned columns.
991
+ */
992
+ public get pinnedColumnsCount(): number;
993
+
994
+
995
+
996
+ /**
997
+ * Gets/Sets cell selection mode.
998
+ *
999
+ * @remarks
1000
+ * By default the cell selection mode is multiple
1001
+ * @param selectionMode: GridSelectionMode
1002
+ */
1003
+ public set cellSelection(value: GridSelectionMode);
1004
+ public get cellSelection(): GridSelectionMode;
1005
+
1006
+
1007
+
1008
+ /**
1009
+ * Gets/Sets row selection mode
1010
+ *
1011
+ * @remarks
1012
+ * By default the row selection mode is 'none'
1013
+ * Note that in IgxGrid and IgxHierarchicalGrid 'multipleCascade' behaves like 'multiple'
1014
+ */
1015
+ public set rowSelection(value: GridSelectionMode);
1016
+ public get rowSelection(): GridSelectionMode;
1017
+
1018
+
1019
+
1020
+ /**
1021
+ * Gets/Sets column selection mode
1022
+ *
1023
+ * @remarks
1024
+ * By default the row selection mode is none
1025
+ * @param selectionMode: GridSelectionMode
1026
+ */
1027
+ public set columnSelection(value: GridSelectionMode);
1028
+ public get columnSelection(): GridSelectionMode;
1029
+
1030
+
1031
+
1032
+ /**
1033
+ * Returns an array of objects containing the filtered data.
1034
+ *
1035
+ * @example
1036
+ * ```typescript
1037
+ * let filteredData = this.grid.filteredData;
1038
+ * ```
1039
+ */
1040
+ public get filteredData(): any;
1041
+
1042
+
1043
+
1044
+ /**
1045
+ * Returns an array containing the filtered sorted data.
1046
+ *
1047
+ * @example
1048
+ * ```typescript
1049
+ * const filteredSortedData = this.grid1.filteredSortedData;
1050
+ * ```
1051
+ */
1052
+ public get filteredSortedData(): any[];
1053
+
1054
+
1055
+
1056
+ /**
1057
+ * Returns the state of the grid virtualization.
1058
+ *
1059
+ * @remarks
1060
+ * Includes the start index and how many records are rendered.
1061
+ * @example
1062
+ * ```typescript
1063
+ * const gridVirtState = this.grid1.virtualizationState;
1064
+ * ```
1065
+ */
1066
+ public get virtualizationState(): IgcForOfState;
1067
+
1068
+
1069
+
1070
+
1071
+ /**
1072
+ * Gets the default row height.
1073
+ *
1074
+ * @example
1075
+ * ```typescript
1076
+ * const rowHeigh = this.grid.defaultRowHeight;
1077
+ * ```
1078
+ */
1079
+ public get defaultRowHeight(): number;
1080
+
1081
+
1082
+
1083
+ /**
1084
+ * Returns the `IgxGridHeaderGroupComponent`'s minimum allowed width.
1085
+ *
1086
+ * @remarks
1087
+ * Used internally for restricting header group component width.
1088
+ * The values below depend on the header cell default right/left padding values.
1089
+ */
1090
+ public get defaultHeaderGroupMinWidth(): number;
1091
+
1092
+
1093
+
1094
+ /**
1095
+ * Gets an array of `IgxColumnComponent`s.
1096
+ *
1097
+ * @example
1098
+ * ```typescript
1099
+ * const columns = this.grid.columns.
1100
+ * ```
1101
+ */
1102
+ public set columns(value: IgcColumnComponent[]);
1103
+ public get columns(): IgcColumnComponent[];
1104
+
1105
+
1106
+
1107
+ /**
1108
+ * Gets an array of the pinned `IgxColumnComponent`s.
1109
+ *
1110
+ * @example
1111
+ * ```typescript
1112
+ * const pinnedColumns = this.grid.pinnedColumns.
1113
+ * ```
1114
+ */
1115
+ public get pinnedColumns(): IgcColumnComponent[];
1116
+
1117
+
1118
+
1119
+ /* csSuppress */
1120
+ /**
1121
+ * Gets an array of the pinned `IgxRowComponent`s.
1122
+ *
1123
+ * @example
1124
+ * ```typescript
1125
+ * const pinnedRow = this.grid.pinnedRows;
1126
+ * ```
1127
+ */
1128
+ public get pinnedRows(): IgcGridRowComponent[];
1129
+
1130
+
1131
+
1132
+ /**
1133
+ * Gets an array of unpinned `IgxColumnComponent`s.
1134
+ *
1135
+ * @example
1136
+ * ```typescript
1137
+ * const unpinnedColumns = this.grid.unpinnedColumns.
1138
+ * ```
1139
+ */
1140
+ public get unpinnedColumns(): IgcColumnComponent[];
1141
+
1142
+
1143
+
1144
+ /**
1145
+ * Returns an array of visible `IgxColumnComponent`s.
1146
+ *
1147
+ * @example
1148
+ * ```typescript
1149
+ * const visibleColumns = this.grid.visibleColumns.
1150
+ * ```
1151
+ */
1152
+ public get visibleColumns(): IgcColumnComponent[];
1153
+
1154
+
1155
+
1156
+ /**
1157
+ * Returns the total number of records.
1158
+ *
1159
+ * @remarks
1160
+ * Only functions when paging is enabled.
1161
+ * @example
1162
+ * ```typescript
1163
+ * const totalRecords = this.grid.totalRecords;
1164
+ * ```
1165
+ */
1166
+ public set totalRecords(value: number);
1167
+ public get totalRecords(): number;
1168
+
1169
+
1170
+
1171
+ /**
1172
+ * Returns the currently transformed paged/filtered/sorted/grouped/pinned/unpinned row data, displayed in the grid.
1173
+ *
1174
+ * @example
1175
+ * ```typescript
1176
+ * const dataView = this.grid.dataView;
1177
+ * ```
1178
+ */
1179
+ public get dataView(): any[];
1180
+
1181
+
1182
+
1183
+ /**
1184
+ * Gets/Sets whether clicking over a row should select/deselect it
1185
+ *
1186
+ * @remarks
1187
+ * By default it is set to true
1188
+ * @param enabled: boolean
1189
+ */
1190
+ public set selectRowOnClick(value: boolean);
1191
+ public get selectRowOnClick(): boolean;
1192
+
1193
+
1194
+
1195
+ /**
1196
+ * Returns whether the record is pinned or not.
1197
+ *
1198
+ * @param rowIndex Index of the record in the `filteredSortedData` collection.
1199
+ */
1200
+ public isRecordPinnedByIndex(rowIndex: number): void;
1201
+
1202
+
1203
+
1204
+ /**
1205
+ * Toggles the specified column's visibility.
1206
+ *
1207
+ * @example
1208
+ * ```typescript
1209
+ * this.grid1.toggleColumnVisibility({
1210
+ * column: this.grid1.columns[0],
1211
+ * newValue: true
1212
+ * });
1213
+ * ```
1214
+ */
1215
+ public toggleColumnVisibility(args: IgcColumnVisibilityChangedEventArgs): void;
1216
+
1217
+
1218
+
1219
+ /**
1220
+ * Expands all rows.
1221
+ *
1222
+ * @example
1223
+ * ```typescript
1224
+ * this.grid.expandAll();
1225
+ * ```
1226
+ */
1227
+ public expandAll(): void;
1228
+
1229
+
1230
+
1231
+ /**
1232
+ * Collapses all rows.
1233
+ *
1234
+ * @example
1235
+ * ```typescript
1236
+ * this.grid.collapseAll();
1237
+ * ```
1238
+ */
1239
+ public collapseAll(): void;
1240
+
1241
+
1242
+
1243
+ /**
1244
+ * Expands the row by its id.
1245
+ *
1246
+ * @remarks
1247
+ * ID is either the primaryKey value or the data record instance.
1248
+ * @example
1249
+ * ```typescript
1250
+ * this.grid.expandRow(rowID);
1251
+ * ```
1252
+ * @param rowID The row id - primaryKey value or the data record instance.
1253
+ */
1254
+ public expandRow(rowID: any): void;
1255
+
1256
+
1257
+
1258
+ /**
1259
+ * Collapses the row by its id.
1260
+ *
1261
+ * @remarks
1262
+ * ID is either the primaryKey value or the data record instance.
1263
+ * @example
1264
+ * ```typescript
1265
+ * this.grid.collapseRow(rowID);
1266
+ * ```
1267
+ * @param rowID The row id - primaryKey value or the data record instance.
1268
+ */
1269
+ public collapseRow(rowID: any): void;
1270
+
1271
+
1272
+
1273
+
1274
+ /**
1275
+ * Toggles the row by its id.
1276
+ *
1277
+ * @remarks
1278
+ * ID is either the primaryKey value or the data record instance.
1279
+ * @example
1280
+ * ```typescript
1281
+ * this.grid.toggleRow(rowID);
1282
+ * ```
1283
+ * @param rowID The row id - primaryKey value or the data record instance.
1284
+ */
1285
+ public toggleRow(rowID: any): void;
1286
+
1287
+
1288
+
1289
+ /**
1290
+ * Gets the `width` to be set on `IgxGridHeaderGroupComponent`.
1291
+ */
1292
+ public getHeaderGroupWidth(column: IgcColumnComponent): string;
1293
+
1294
+
1295
+
1296
+ /**
1297
+ * Returns the `IgxColumnComponent` by field name.
1298
+ *
1299
+ * @example
1300
+ * ```typescript
1301
+ * const myCol = this.grid1.getColumnByName("ID");
1302
+ * ```
1303
+ * @param name
1304
+ */
1305
+ public getColumnByName(name: string): IgcColumnComponent;
1306
+
1307
+
1308
+
1309
+ public getColumnByVisibleIndex(index: number): IgcColumnComponent;
1310
+
1311
+
1312
+
1313
+ /**
1314
+ * Recalculates all widths of columns that have size set to `auto`.
1315
+ *
1316
+ * @example
1317
+ * ```typescript
1318
+ * this.grid1.recalculateAutoSizes();
1319
+ * ```
1320
+ */
1321
+ public recalculateAutoSizes(): void;
1322
+
1323
+
1324
+
1325
+ /**
1326
+ * Places a column before or after the specified target column.
1327
+ *
1328
+ * @example
1329
+ * ```typescript
1330
+ * grid.moveColumn(column, target);
1331
+ * ```
1332
+ */
1333
+ public moveColumn(column: IgcColumnComponent, target: IgcColumnComponent, pos?: DropPosition): void;
1334
+
1335
+
1336
+
1337
+ /**
1338
+ * Triggers change detection for the `IgxGridComponent`.
1339
+ * Calling markForCheck also triggers the grid pipes explicitly, resulting in all updates being processed.
1340
+ * May degrade performance if used when not needed, or if misused:
1341
+ * ```typescript
1342
+ * // DON'Ts:
1343
+ * // don't call markForCheck from inside a loop
1344
+ * // don't call markForCheck when a primitive has changed
1345
+ * grid.data.forEach(rec => {
1346
+ * rec = newValue;
1347
+ * grid.markForCheck();
1348
+ * });
1349
+ *
1350
+ * // DOs
1351
+ * // call markForCheck after updating a nested property
1352
+ * grid.data.forEach(rec => {
1353
+ * rec.nestedProp1.nestedProp2 = newValue;
1354
+ * });
1355
+ * grid.markForCheck();
1356
+ * ```
1357
+ *
1358
+ * @example
1359
+ * ```typescript
1360
+ * grid.markForCheck();
1361
+ * ```
1362
+ */
1363
+ public markForCheck(): void;
1364
+
1365
+
1366
+
1367
+ /* csSuppress */
1368
+ /**
1369
+ * Creates a new `IgxGridRowComponent` and adds the data record to the end of the data source.
1370
+ *
1371
+ * @example
1372
+ * ```typescript
1373
+ * this.grid1.addRow(record);
1374
+ * ```
1375
+ * @param data
1376
+ */
1377
+ public addRow(data: any): void;
1378
+
1379
+
1380
+
1381
+ /* blazorCSSuppress */
1382
+ /**
1383
+ * Removes the `IgxGridRowComponent` and the corresponding data record by primary key.
1384
+ *
1385
+ * @remarks
1386
+ * Requires that the `primaryKey` property is set.
1387
+ * The method accept rowSelector as a parameter, which is the rowID.
1388
+ * @example
1389
+ * ```typescript
1390
+ * this.grid1.deleteRow(0);
1391
+ * ```
1392
+ * @param rowSelector
1393
+ */
1394
+ public deleteRow(rowSelector: any): any;
1395
+
1396
+
1397
+
1398
+ /* blazorCSSuppress */
1399
+ /**
1400
+ * Updates the `IgxGridRowComponent` and the corresponding data record by primary key.
1401
+ *
1402
+ * @remarks
1403
+ * Requires that the `primaryKey` property is set.
1404
+ * @example
1405
+ * ```typescript
1406
+ * this.gridWithPK.updateCell('Updated', 1, 'ProductName');
1407
+ * ```
1408
+ * @param value the new value which is to be set.
1409
+ * @param rowSelector corresponds to rowID.
1410
+ * @param column corresponds to column field.
1411
+ */
1412
+ public updateCell(value: any, rowSelector: any, column: string): void;
1413
+
1414
+
1415
+
1416
+ /* blazorCSSuppress */
1417
+ /**
1418
+ * Updates the `IgxGridRowComponent`
1419
+ *
1420
+ * @remarks
1421
+ * The row is specified by
1422
+ * rowSelector parameter and the data source record with the passed value.
1423
+ * This method will apply requested update only if primary key is specified in the grid.
1424
+ * @example
1425
+ * ```typescript
1426
+ * grid.updateRow({
1427
+ * ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')
1428
+ * }, 1);
1429
+ * ```
1430
+ * @param value–
1431
+ * @param rowSelector correspond to rowID
1432
+ */
1433
+ // TODO: prevent event invocation
1434
+ public updateRow(value: any, rowSelector: any): void;
1435
+
1436
+
1437
+
1438
+ /**
1439
+ * Returns the data that is contained in the row component.
1440
+ *
1441
+ * @remarks
1442
+ * If the primary key is not specified the row selector match the row data.
1443
+ * @example
1444
+ * ```typescript
1445
+ * const data = grid.getRowData(94741);
1446
+ * ```
1447
+ * @param rowSelector correspond to rowID
1448
+ */
1449
+ public getRowData(rowSelector: any): any;
1450
+
1451
+
1452
+
1453
+ /**
1454
+ * Sort a single `IgxColumnComponent`.
1455
+ *
1456
+ * @remarks
1457
+ * Sort the `IgxGridComponent`'s `IgxColumnComponent` based on the provided array of sorting expressions.
1458
+ * @example
1459
+ * ```typescript
1460
+ * this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });
1461
+ * ```
1462
+ */
1463
+ public sort(expression: IgcSortingExpression[]): void;
1464
+
1465
+
1466
+
1467
+ /**
1468
+ * Filters a single `IgxColumnComponent`.
1469
+ *
1470
+ * @example
1471
+ * ```typescript
1472
+ * public filter(term) {
1473
+ * this.grid.filter("ProductName", term, IgxStringFilteringOperand.instance().condition("contains"));
1474
+ * }
1475
+ * ```
1476
+ * @param name
1477
+ * @param value
1478
+ * @param conditionOrExpressionTree
1479
+ * @param ignoreCase
1480
+ */
1481
+ public filter(name: string, value: any, conditionOrExpressionTree?: IgcFilteringExpressionsTree | IgcFilteringOperation, ignoreCase?: boolean): void;
1482
+
1483
+
1484
+
1485
+ /**
1486
+ * Filters all the `IgxColumnComponent` in the `IgxGridComponent` with the same condition.
1487
+ *
1488
+ * @example
1489
+ * ```typescript
1490
+ * grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));
1491
+ * ```
1492
+ * @param value
1493
+ * @param condition
1494
+ * @param ignoreCase
1495
+ */
1496
+ public filterGlobal(value: any, condition: any, ignoreCase?: any): void;
1497
+
1498
+
1499
+
1500
+ /**
1501
+ * Enables summaries for the specified column and applies your customSummary.
1502
+ *
1503
+ * @remarks
1504
+ * If you do not provide the customSummary, then the default summary for the column data type will be applied.
1505
+ * @example
1506
+ * ```typescript
1507
+ * grid.enableSummaries([{ fieldName: 'ProductName' }, { fieldName: 'ID' }]);
1508
+ * ```
1509
+ * Enable summaries for the listed columns.
1510
+ * @example
1511
+ * ```typescript
1512
+ * grid.enableSummaries('ProductName');
1513
+ * ```
1514
+ * @param rest
1515
+ */
1516
+ public enableSummaries(rest: any[]): void;
1517
+
1518
+
1519
+
1520
+ /**
1521
+ * Disable summaries for the specified column.
1522
+ *
1523
+ * @example
1524
+ * ```typescript
1525
+ * grid.disableSummaries('ProductName');
1526
+ * ```
1527
+ * @remarks
1528
+ * Disable summaries for the listed columns.
1529
+ * @example
1530
+ * ```typescript
1531
+ * grid.disableSummaries([{ fieldName: 'ProductName' }]);
1532
+ * ```
1533
+ */
1534
+ public disableSummaries(rest: any[]): void;
1535
+
1536
+
1537
+
1538
+ /**
1539
+ * If name is provided, clears the filtering state of the corresponding `IgxColumnComponent`.
1540
+ *
1541
+ * @remarks
1542
+ * Otherwise clears the filtering state of all `IgxColumnComponent`s.
1543
+ * @example
1544
+ * ```typescript
1545
+ * this.grid.clearFilter();
1546
+ * ```
1547
+ * @param name
1548
+ */
1549
+ public clearFilter(name?: string): void;
1550
+
1551
+
1552
+
1553
+ /**
1554
+ * If name is provided, clears the sorting state of the corresponding `IgxColumnComponent`.
1555
+ *
1556
+ * @remarks
1557
+ * otherwise clears the sorting state of all `IgxColumnComponent`.
1558
+ * @example
1559
+ * ```typescript
1560
+ * this.grid.clearSort();
1561
+ * ```
1562
+ * @param name
1563
+ */
1564
+ public clearSort(name?: string): void;
1565
+
1566
+
1567
+
1568
+ // TODO: We have return values here. Move them to event args ??
1569
+
1570
+ /**
1571
+ * Pins a column by field name.
1572
+ *
1573
+ * @remarks
1574
+ * Returns whether the operation is successful.
1575
+ * @example
1576
+ * ```typescript
1577
+ * this.grid.pinColumn("ID");
1578
+ * ```
1579
+ * @param columnName
1580
+ * @param index
1581
+ */
1582
+ public pinColumn(columnName: string, index?: any): boolean;
1583
+
1584
+
1585
+
1586
+ /**
1587
+ * Unpins a column by field name. Returns whether the operation is successful.
1588
+ *
1589
+ * @example
1590
+ * ```typescript
1591
+ * this.grid.pinColumn("ID");
1592
+ * ```
1593
+ * @param columnName
1594
+ * @param index
1595
+ */
1596
+ public unpinColumn(columnName: string, index?: any): boolean;
1597
+
1598
+
1599
+
1600
+ /* csSuppress */
1601
+ /**
1602
+ * Pin the row by its id.
1603
+ *
1604
+ * @remarks
1605
+ * ID is either the primaryKey value or the data record instance.
1606
+ * @example
1607
+ * ```typescript
1608
+ * this.grid.pinRow(rowID);
1609
+ * ```
1610
+ * @param rowID The row id - primaryKey value or the data record instance.
1611
+ * @param index The index at which to insert the row in the pinned collection.
1612
+ */
1613
+ public pinRow(rowID: any, index?: number, row?: IgcRowType): boolean;
1614
+
1615
+
1616
+
1617
+ /* csSuppress */
1618
+ /**
1619
+ * Unpin the row by its id.
1620
+ *
1621
+ * @remarks
1622
+ * ID is either the primaryKey value or the data record instance.
1623
+ * @example
1624
+ * ```typescript
1625
+ * this.grid.unpinRow(rowID);
1626
+ * ```
1627
+ * @param rowID The row id - primaryKey value or the data record instance.
1628
+ */
1629
+ public unpinRow(rowID: any, row?: IgcRowType): boolean;
1630
+
1631
+
1632
+
1633
+ /**
1634
+ * Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible.
1635
+ *
1636
+ * @remarks
1637
+ * Returns how many times the grid contains the string.
1638
+ * @example
1639
+ * ```typescript
1640
+ * this.grid.findNext("financial");
1641
+ * ```
1642
+ * @param text the string to search.
1643
+ * @param caseSensitive optionally, if the search should be case sensitive (defaults to false).
1644
+ * @param exactMatch optionally, if the text should match the entire value (defaults to false).
1645
+ */
1646
+ public findNext(text: string, caseSensitive?: boolean, exactMatch?: boolean): number;
1647
+
1648
+
1649
+
1650
+ /**
1651
+ * Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible.
1652
+ *
1653
+ * @remarks
1654
+ * Returns how many times the grid contains the string.
1655
+ * @example
1656
+ * ```typescript
1657
+ * this.grid.findPrev("financial");
1658
+ * ```
1659
+ * @param text the string to search.
1660
+ * @param caseSensitive optionally, if the search should be case sensitive (defaults to false).
1661
+ * @param exactMatch optionally, if the text should match the entire value (defaults to false).
1662
+ */
1663
+ public findPrev(text: string, caseSensitive?: boolean, exactMatch?: boolean): number;
1664
+
1665
+
1666
+
1667
+ /**
1668
+ * Reapplies the existing search.
1669
+ *
1670
+ * @remarks
1671
+ * Returns how many times the grid contains the last search.
1672
+ * @example
1673
+ * ```typescript
1674
+ * this.grid.refreshSearch();
1675
+ * ```
1676
+ * @param updateActiveInfo
1677
+ */
1678
+ public refreshSearch(updateActiveInfo?: boolean, endEdit?: boolean): number;
1679
+
1680
+
1681
+
1682
+ /**
1683
+ * Removes all the highlights in the cell.
1684
+ *
1685
+ * @example
1686
+ * ```typescript
1687
+ * this.grid.clearSearch();
1688
+ * ```
1689
+ */
1690
+ public clearSearch(): void;
1691
+
1692
+
1693
+
1694
+ /**
1695
+ * Gets calculated width of the pinned area.
1696
+ *
1697
+ * @example
1698
+ * ```typescript
1699
+ * const pinnedWidth = this.grid.getPinnedWidth();
1700
+ * ```
1701
+ * @param takeHidden If we should take into account the hidden columns in the pinned area.
1702
+ */
1703
+ public getPinnedWidth(takeHidden?: boolean): void;
1704
+
1705
+
1706
+
1707
+ /**
1708
+ * Select specified rows by ID.
1709
+ *
1710
+ * @example
1711
+ * ```typescript
1712
+ * this.grid.selectRows([1,2,5], true);
1713
+ * ```
1714
+ * @param rowIDs
1715
+ * @param clearCurrentSelection if true clears the current selection
1716
+ */
1717
+ public selectRows(rowIDs: any[], clearCurrentSelection?: boolean): void;
1718
+
1719
+
1720
+
1721
+ /**
1722
+ * Deselect specified rows by ID.
1723
+ *
1724
+ * @example
1725
+ * ```typescript
1726
+ * this.grid.deselectRows([1,2,5]);
1727
+ * ```
1728
+ * @param rowIDs
1729
+ */
1730
+ public deselectRows(rowIDs: any[]): void;
1731
+
1732
+
1733
+
1734
+ /**
1735
+ * Selects all rows
1736
+ *
1737
+ * @remarks
1738
+ * By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.
1739
+ * If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows.
1740
+ * @example
1741
+ * ```typescript
1742
+ * this.grid.selectAllRows();
1743
+ * this.grid.selectAllRows(false);
1744
+ * ```
1745
+ * @param onlyFilterData
1746
+ */
1747
+ public selectAllRows(onlyFilterData?: boolean): void;
1748
+
1749
+
1750
+
1751
+ /**
1752
+ * Deselects all rows
1753
+ *
1754
+ * @remarks
1755
+ * By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.
1756
+ * If you set the parameter onlyFilterData to false that will deselect all rows in the grid exept deleted rows.
1757
+ * @example
1758
+ * ```typescript
1759
+ * this.grid.deselectAllRows();
1760
+ * ```
1761
+ * @param onlyFilterData
1762
+ */
1763
+ public deselectAllRows(onlyFilterData?: boolean): void;
1764
+
1765
+
1766
+
1767
+ /**
1768
+ * Deselect selected cells.
1769
+ * @example
1770
+ * ```typescript
1771
+ * this.grid.clearCellSelection();
1772
+ * ```
1773
+ */
1774
+ public clearCellSelection(): void;
1775
+
1776
+
1777
+
1778
+ /**
1779
+ * Select range(s) of cells between certain rows and columns of the grid.
1780
+ */
1781
+ public selectRange(arg: IgcGridSelectionRange[]): void;
1782
+
1783
+
1784
+
1785
+ /**
1786
+ * Get the currently selected ranges in the grid.
1787
+ */
1788
+ public getSelectedRanges(): IgcGridSelectionRange[];
1789
+
1790
+
1791
+
1792
+ /**
1793
+ *
1794
+ * Returns an array of the current cell selection in the form of `[{ column.field: cell.value }, ...]`.
1795
+ *
1796
+ * @remarks
1797
+ * If `formatters` is enabled, the cell value will be formatted by its respective column formatter (if any).
1798
+ * If `headers` is enabled, it will use the column header (if any) instead of the column field.
1799
+ */
1800
+ public getSelectedData(formatters?: boolean, headers?: boolean): void;
1801
+
1802
+
1803
+
1804
+ /**
1805
+ * Get current selected columns.
1806
+ *
1807
+ * @example
1808
+ * Returns an array with selected columns
1809
+ * ```typescript
1810
+ * const selectedColumns = this.grid.selectedColumns();
1811
+ * ```
1812
+ */
1813
+ public selectedColumns(): IgcColumnComponent[];
1814
+
1815
+
1816
+
1817
+
1818
+ /**
1819
+ * Select specified columns.
1820
+ *
1821
+ * @example
1822
+ * ```typescript
1823
+ * this.grid.selectColumns(['ID','Name'], true);
1824
+ * ```
1825
+ * @param columns
1826
+ * @param clearCurrentSelection if true clears the current selection
1827
+ */
1828
+ public selectColumns(columns: string[] | IgcColumnComponent[], clearCurrentSelection?: boolean): void;
1829
+
1830
+
1831
+
1832
+ /**
1833
+ * Deselect specified columns by field.
1834
+ *
1835
+ * @example
1836
+ * ```typescript
1837
+ * this.grid.deselectColumns(['ID','Name']);
1838
+ * ```
1839
+ * @param columns
1840
+ */
1841
+ public deselectColumns(columns: string[] | IgcColumnComponent[]): void;
1842
+
1843
+
1844
+
1845
+ /**
1846
+ * Deselects all columns
1847
+ *
1848
+ * @example
1849
+ * ```typescript
1850
+ * this.grid.deselectAllColumns();
1851
+ * ```
1852
+ */
1853
+ public deselectAllColumns(): void;
1854
+
1855
+
1856
+
1857
+ /**
1858
+ * Selects all columns
1859
+ *
1860
+ * @example
1861
+ * ```typescript
1862
+ * this.grid.deselectAllColumns();
1863
+ * ```
1864
+ */
1865
+ public selectAllColumns(): void;
1866
+
1867
+
1868
+
1869
+ /**
1870
+ *
1871
+ * Returns an array of the current columns selection in the form of `[{ column.field: cell.value }, ...]`.
1872
+ *
1873
+ * @remarks
1874
+ * If `formatters` is enabled, the cell value will be formatted by its respective column formatter (if any).
1875
+ * If `headers` is enabled, it will use the column header (if any) instead of the column field.
1876
+ */
1877
+ public getSelectedColumnsData(formatters?: boolean, headers?: boolean): void;
1878
+
1879
+
1880
+
1881
+ /* blazorCsSuppress */
1882
+ /**
1883
+ * Navigates to a position in the grid based on provided `rowindex` and `visibleColumnIndex`.
1884
+ *
1885
+ * @remarks
1886
+ * Also can execute a custom logic over the target element,
1887
+ * through a callback function that accepts { targetType: GridKeydownTargetType, target: Object }
1888
+ * @example
1889
+ * ```typescript
1890
+ * this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });
1891
+ * ```
1892
+ */
1893
+ public navigateTo(rowIndex: number, visibleColIndex?: number, cb?: any): void;
1894
+
1895
+
1896
+
1897
+ /* blazorCsSuppress */
1898
+ /**
1899
+ * Returns `ICellPosition` which defines the next cell,
1900
+ * according to the current position, that match specific criteria.
1901
+ *
1902
+ * @remarks
1903
+ * You can pass callback function as a third parameter of `getPreviousCell` method.
1904
+ * The callback function accepts IgxColumnComponent as a param
1905
+ * @example
1906
+ * ```typescript
1907
+ * const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);
1908
+ * ```
1909
+ */
1910
+ public getNextCell(currRowIndex: number, curVisibleColIndex: number, callback?: any): IgcCellPosition;
1911
+
1912
+
1913
+
1914
+ /* blazorCsSuppress */
1915
+ /**
1916
+ * Returns `ICellPosition` which defines the previous cell,
1917
+ * according to the current position, that match specific criteria.
1918
+ *
1919
+ * @remarks
1920
+ * You can pass callback function as a third parameter of `getPreviousCell` method.
1921
+ * The callback function accepts IgxColumnComponent as a param
1922
+ * @example
1923
+ * ```typescript
1924
+ * const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);
1925
+ * ```
1926
+ */
1927
+ public getPreviousCell(currRowIndex: number, curVisibleColIndex: number, callback?: any): IgcCellPosition;
1928
+
1929
+
1930
+
1931
+ /**
1932
+ * Opens the advanced filtering dialog.
1933
+ */
1934
+ public openAdvancedFilteringDialog(overlaySettings?: IgcOverlaySettings): void;
1935
+
1936
+
1937
+
1938
+ /**
1939
+ * Closes the advanced filtering dialog.
1940
+ *
1941
+ * @param applyChanges indicates whether the changes should be applied
1942
+ */
1943
+ public closeAdvancedFilteringDialog(applyChanges: boolean): void;
1944
+
1945
+
1946
+
1947
+ /**
1948
+ * Finishes the row transactions on the current row.
1949
+ *
1950
+ * @remarks
1951
+ * If `commit === true`, passes them from the pending state to the data (or transaction service)
1952
+ * @example
1953
+ * ```html
1954
+ * <button igxButton (click)="grid.endEdit(true)">Commit Row</button>
1955
+ * ```
1956
+ * @param commit
1957
+ */
1958
+ // TODO: Facade for crud service refactoring. To be removed
1959
+ // TODO: do not remove this, as it is used in rowEditTemplate, but mark is as internal and hidden
1960
+ /* blazorCSSuppress */
1961
+ public endEdit(commit?: boolean, evt?: any): void;
1962
+
1963
+
1964
+
1965
+ /**
1966
+ * Enters add mode by spawning the UI under the specified row by rowID.
1967
+ *
1968
+ * @remarks
1969
+ * If null is passed as rowID, the row adding UI is spawned as the first record in the data view
1970
+ * @remarks
1971
+ * Spawning the UI to add a child for a record only works if you provide a rowID
1972
+ * @example
1973
+ * ```typescript
1974
+ * this.grid.beginAddRowById('ALFKI');
1975
+ * this.grid.beginAddRowById('ALFKI', true);
1976
+ * this.grid.beginAddRowById(null);
1977
+ * ```
1978
+ * @param rowID - The rowID to spawn the add row UI for, or null to spawn it as the first record in the data view
1979
+ * @param asChild - Whether the record should be added as a child. Only applicable to igxTreeGrid.
1980
+ */
1981
+ public beginAddRowById(rowID: any, asChild?: boolean): void;
1982
+
1983
+
1984
+
1985
+ /* csSuppress */
1986
+ /**
1987
+ * Enters add mode by spawning the UI at the specified index.
1988
+ *
1989
+ * @remarks
1990
+ * Accepted values for index are integers from 0 to this.grid.dataView.length
1991
+ * @example
1992
+ * ```typescript
1993
+ * this.grid.beginAddRowByIndex(0);
1994
+ * ```
1995
+ * @param index - The index to spawn the UI at. Accepts integers from 0 to this.grid.dataView.length
1996
+ */
1997
+ public beginAddRowByIndex(index: number): void;
1998
+
1999
+ }
2000
+
2001
+ export declare interface IgcRowIslandComponentEventMap {
2002
+
2003
+ /**
2004
+ * Event emmited when a grid is being created based on this row island.
2005
+ * ```html
2006
+ * <igx-hierarchical-grid [data]="Data" [autoGenerate]="true">
2007
+ * <igx-row-island [key]="'childData'" (gridCreated)="gridCreated($event)" #rowIsland>
2008
+ * <!-- ... -->
2009
+ * </igx-row-island>
2010
+ * </igx-hierarchical-grid>
2011
+ * ```
2012
+ *
2013
+ * @memberof IgxRowIslandComponent
2014
+ */
2015
+ gridCreated: CustomEvent<IgcGridCreatedEventArgs>;
2016
+
2017
+ /**
2018
+ * Emitted after a grid is being initialized for this row island.
2019
+ * The emitting is done in `ngAfterViewInit`.
2020
+ * ```html
2021
+ * <igx-hierarchical-grid [data]="Data" [autoGenerate]="true">
2022
+ * <igx-row-island [key]="'childData'" (gridInitialized)="gridInitialized($event)" #rowIsland>
2023
+ * <!-- ... -->
2024
+ * </igx-row-island>
2025
+ * </igx-hierarchical-grid>
2026
+ * ```
2027
+ *
2028
+ * @memberof IgxRowIslandComponent
2029
+ */
2030
+ gridInitialized: CustomEvent<IgcGridCreatedEventArgs>;
2031
+
2032
+ /**
2033
+ * Emitted when a new chunk of data is loaded from virtualization.
2034
+ *
2035
+ * @example
2036
+ * ```typescript
2037
+ * <igx-hierarchical-grid [id]="'igx-grid-1'" [data]="Data" [autoGenerate]="true" (dataPreLoad)="handleEvent()">
2038
+ * </igx-hierarchical-grid>
2039
+ * ```
2040
+ */
2041
+ dataPreLoad: CustomEvent<IgcForOfState>;
2042
+
2043
+ /**
2044
+ * Emitted after filtering is performed.
2045
+ *
2046
+ * @remarks
2047
+ * Returns the filtering expressions tree of the column for which filtering was performed.
2048
+ * @example
2049
+ * ```html
2050
+ * <igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true"
2051
+ * (filteringExpressionsTreeChange)="filteringExprTreeChange($event)"></igx-grid>
2052
+ * ```
2053
+ */
2054
+ filteringExpressionsTreeChange: CustomEvent<IgcFilteringExpressionsTree>;
2055
+
2056
+ /**
2057
+ * Emitted after advanced filtering is performed.
2058
+ *
2059
+ * @remarks
2060
+ * Returns the advanced filtering expressions tree.
2061
+ * @example
2062
+ * ```html
2063
+ * <igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true"
2064
+ * (advancedFilteringExpressionsTreeChange)="advancedFilteringExprTreeChange($event)"></igx-grid>
2065
+ * ```
2066
+ */
2067
+ advancedFilteringExpressionsTreeChange: CustomEvent<IgcFilteringExpressionsTree>;
2068
+
2069
+ /**
2070
+ * Emitted when grid is scrolled horizontally/vertically.
2071
+ *
2072
+ * @example
2073
+ * ```html
2074
+ * <igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true"
2075
+ * (gridScroll)="onScroll($event)"></igx-grid>
2076
+ * ```
2077
+ */
2078
+ gridScroll: CustomEvent<IgcGridScrollEventArgs>;
2079
+
2080
+ /**
2081
+ * Emitted when a cell is clicked.
2082
+ *
2083
+ * @remarks
2084
+ * Returns the `IgxGridCell`.
2085
+ * @example
2086
+ * ```html
2087
+ * <igx-grid #grid (cellClick)="cellClick($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
2088
+ * ```
2089
+ */
2090
+ cellClick: CustomEvent<IgcGridCellEventArgs>;
2091
+
2092
+ /**
2093
+ * Emitted when formGroup is created on edit of row/cell.
2094
+ *
2095
+ * @example
2096
+ * ```html
2097
+ * <igx-grid #grid (formGroupCreated)="formGroupCreated($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
2098
+ * ```
2099
+ */
2100
+ formGroupCreated: CustomEvent<IgcGridFormGroupCreatedEventArgs>;
2101
+
2102
+ /**
2103
+ * Emitted when grid's validation status changes.
2104
+ *
2105
+ * @example
2106
+ * ```html
2107
+ * <igx-grid #grid (validationStatusChange)="validationStatusChange($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
2108
+ * ```
2109
+ */
2110
+ validationStatusChange: CustomEvent<IgcGridValidationStatusEventArgs>;
2111
+
2112
+ /**
2113
+ * Emitted when a cell is selected.
2114
+ *
2115
+ * @remarks
2116
+ * Returns the `IgxGridCell`.
2117
+ * @example
2118
+ * ```html
2119
+ * <igx-grid #grid (selected)="onCellSelect($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
2120
+ * ```
2121
+ */
2122
+ selected: CustomEvent<IgcGridCellEventArgs>;
2123
+
2124
+ /**
2125
+ * Emitted when `IgxGridRowComponent` is selected.
2126
+ *
2127
+ * @example
2128
+ * ```html
2129
+ * <igx-grid #grid (rowSelectionChanging)="rowSelectionChanging($event)" [data]="localData" [autoGenerate]="true"></igx-grid>
2130
+ * ```
2131
+ */
2132
+ rowSelectionChanging: CustomEvent<IgcRowSelectionEventArgs>;
2133
+
2134
+ /**
2135
+ * Emitted when `IgxColumnComponent` is selected.
2136
+ *
2137
+ * @example
2138
+ * ```html
2139
+ * <igx-grid #grid (columnSelectionChanging)="columnSelectionChanging($event)" [data]="localData" [autoGenerate]="true"></igx-grid>
2140
+ * ```
2141
+ */
2142
+ columnSelectionChanging: CustomEvent<IgcColumnSelectionEventArgs>;
2143
+
2144
+ /**
2145
+ * Emitted before `IgxColumnComponent` is pinned.
2146
+ *
2147
+ * @remarks
2148
+ * The index at which to insert the column may be changed through the `insertAtIndex` property.
2149
+ * @example
2150
+ * ```typescript
2151
+ * public columnPinning(event) {
2152
+ * if (event.column.field === "Name") {
2153
+ * event.insertAtIndex = 0;
2154
+ * }
2155
+ * }
2156
+ * ```
2157
+ */
2158
+ columnPin: CustomEvent<IgcPinColumnCancellableEventArgs>;
2159
+
2160
+ /**
2161
+ * Emitted after `IgxColumnComponent` is pinned.
2162
+ *
2163
+ * @remarks
2164
+ * The index that the column is inserted at may be changed through the `insertAtIndex` property.
2165
+ * @example
2166
+ * ```typescript
2167
+ * public columnPinning(event) {
2168
+ * if (event.column.field === "Name") {
2169
+ * event.insertAtIndex = 0;
2170
+ * }
2171
+ * }
2172
+ * ```
2173
+ */
2174
+ columnPinned: CustomEvent<IgcPinColumnEventArgs>;
2175
+
2176
+ /**
2177
+ * Emitted when cell enters edit mode.
2178
+ *
2179
+ * @remarks
2180
+ * This event is cancelable.
2181
+ * @example
2182
+ * ```html
2183
+ * <igx-grid #grid3 (cellEditEnter)="editStart($event)" [data]="data" [primaryKey]="'ProductID'">
2184
+ * </igx-grid>
2185
+ * ```
2186
+ */
2187
+ cellEditEnter: CustomEvent<IgcGridEditEventArgs>;
2188
+
2189
+ /**
2190
+ * Emitted when cell exits edit mode.
2191
+ *
2192
+ * @example
2193
+ * ```html
2194
+ * <igx-grid #grid3 (cellEditExit)="editExit($event)" [data]="data" [primaryKey]="'ProductID'">
2195
+ * </igx-grid>
2196
+ * ```
2197
+ */
2198
+ cellEditExit: CustomEvent<IgcGridEditDoneEventArgs>;
2199
+
2200
+ /**
2201
+ * Emitted when cell has been edited.
2202
+ *
2203
+ * @remarks
2204
+ * Event is fired after editing is completed, when the cell is exiting edit mode.
2205
+ * This event is cancelable.
2206
+ * @example
2207
+ * ```html
2208
+ * <igx-grid #grid3 (cellEdit)="editDone($event)" [data]="data" [primaryKey]="'ProductID'">
2209
+ * </igx-grid>
2210
+ * ```
2211
+ */
2212
+ cellEdit: CustomEvent<IgcGridEditEventArgs>;
2213
+
2214
+ /* blazorCSSuppress */
2215
+ /**
2216
+ * Emitted after cell has been edited and editing has been committed.
2217
+ *
2218
+ * @example
2219
+ * ```html
2220
+ * <igx-grid #grid3 (cellEditDone)="editDone($event)" [data]="data" [primaryKey]="'ProductID'">
2221
+ * </igx-grid>
2222
+ * ```
2223
+ */
2224
+ cellEditDone: CustomEvent<IgcGridEditDoneEventArgs>;
2225
+
2226
+ /**
2227
+ * Emitted when a row enters edit mode.
2228
+ *
2229
+ * @remarks
2230
+ * Emitted when [rowEditable]="true".
2231
+ * This event is cancelable.
2232
+ * @example
2233
+ * ```html
2234
+ * <igx-grid #grid3 (rowEditEnter)="editStart($event)" [primaryKey]="'ProductID'" [rowEditable]="true">
2235
+ * </igx-grid>
2236
+ * ```
2237
+ */
2238
+ rowEditEnter: CustomEvent<IgcGridEditEventArgs>;
2239
+
2240
+ /**
2241
+ * Emitted when exiting edit mode for a row.
2242
+ *
2243
+ * @remarks
2244
+ * Emitted when [rowEditable]="true" & `endEdit(true)` is called.
2245
+ * Emitted when changing rows during edit mode, selecting an un-editable cell in the edited row,
2246
+ * performing paging operation, column resizing, pinning, moving or hitting `Done`
2247
+ * button inside of the rowEditingOverlay, or hitting the `Enter` key while editing a cell.
2248
+ * This event is cancelable.
2249
+ * @example
2250
+ * ```html
2251
+ * <igx-grid #grid3 (rowEdit)="editDone($event)" [data]="data" [primaryKey]="'ProductID'" [rowEditable]="true">
2252
+ * </igx-grid>
2253
+ * ```
2254
+ */
2255
+ rowEdit: CustomEvent<IgcGridEditEventArgs>;
2256
+
2257
+ /**
2258
+ * Emitted after exiting edit mode for a row and editing has been committed.
2259
+ *
2260
+ * @remarks
2261
+ * Emitted when [rowEditable]="true" & `endEdit(true)` is called.
2262
+ * Emitted when changing rows during edit mode, selecting an un-editable cell in the edited row,
2263
+ * performing paging operation, column resizing, pinning, moving or hitting `Done`
2264
+ * button inside of the rowEditingOverlay, or hitting the `Enter` key while editing a cell.
2265
+ * @example
2266
+ * ```html
2267
+ * <igx-grid #grid3 (rowEditDone)="editDone($event)" [data]="data" [primaryKey]="'ProductID'" [rowEditable]="true">
2268
+ * </igx-grid>
2269
+ * ```
2270
+ */
2271
+ rowEditDone: CustomEvent<IgcGridEditDoneEventArgs>;
2272
+
2273
+ /**
2274
+ * Emitted when row editing is canceled.
2275
+ *
2276
+ * @remarks
2277
+ * Emits when [rowEditable]="true" & `endEdit(false)` is called.
2278
+ * Emitted when changing hitting `Esc` key during cell editing and when click on the `Cancel` button
2279
+ * in the row editing overlay.
2280
+ * @example
2281
+ * ```html
2282
+ * <igx-grid #grid3 (rowEditExit)="editExit($event)" [data]="data" [primaryKey]="'ProductID'" [rowEditable]="true">
2283
+ * </igx-grid>
2284
+ * ```
2285
+ */
2286
+ rowEditExit: CustomEvent<IgcGridEditDoneEventArgs>;
2287
+
2288
+ /**
2289
+ * Emitted when a column is initialized.
2290
+ *
2291
+ * @remarks
2292
+ * Returns the column object.
2293
+ * @example
2294
+ * ```html
2295
+ * <igx-grid #grid [data]="localData" (columnInit)="initColumns($event)" [autoGenerate]="true"></igx-grid>
2296
+ * ```
2297
+ */
2298
+ columnInit: CustomEvent<IgcColumnComponent>;
2299
+
2300
+ /* blazorInclude */
2301
+ /**
2302
+ * @internal
2303
+ */
2304
+ columnsAutogenerated: CustomEvent<IgcColumnsAutoGeneratedEventArgs>;
2305
+
2306
+ /**
2307
+ * Emitted before sorting expressions are applied.
2308
+ *
2309
+ * @remarks
2310
+ * Returns an `ISortingEventArgs` object. `sortingExpressions` key holds the sorting expressions.
2311
+ * @example
2312
+ * ```html
2313
+ * <igx-grid #grid [data]="localData" [autoGenerate]="true" (sorting)="sorting($event)"></igx-grid>
2314
+ * ```
2315
+ */
2316
+ sorting: CustomEvent<IgcSortingEventArgs>;
2317
+
2318
+ /**
2319
+ * Emitted after sorting is completed.
2320
+ *
2321
+ * @remarks
2322
+ * Returns the sorting expression.
2323
+ * @example
2324
+ * ```html
2325
+ * <igx-grid #grid [data]="localData" [autoGenerate]="true" (sortingDone)="sortingDone($event)"></igx-grid>
2326
+ * ```
2327
+ */
2328
+ sortingDone: CustomEvent<IgcSortingExpression[]>;
2329
+
2330
+ /**
2331
+ * Emitted before filtering expressions are applied.
2332
+ *
2333
+ * @remarks
2334
+ * Returns an `IFilteringEventArgs` object. `filteringExpressions` key holds the filtering expressions for the column.
2335
+ * @example
2336
+ * ```html
2337
+ * <igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true" (filtering)="filtering($event)"></igx-grid>
2338
+ * ```
2339
+ */
2340
+ filtering: CustomEvent<IgcFilteringEventArgs>;
2341
+
2342
+ /**
2343
+ * Emitted after filtering is performed through the UI.
2344
+ *
2345
+ * @remarks
2346
+ * Returns the filtering expressions tree of the column for which filtering was performed.
2347
+ * @example
2348
+ * ```html
2349
+ * <igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true" (filteringDone)="filteringDone($event)"></igx-grid>
2350
+ * ```
2351
+ */
2352
+ filteringDone: CustomEvent<IgcFilteringExpressionsTree>;
2353
+
2354
+ /* blazorCSSuppress */
2355
+ /**
2356
+ * Emitted when a row is added.
2357
+ *
2358
+ * @remarks
2359
+ * Returns the data for the new `IgxGridRowComponent` object.
2360
+ * @example
2361
+ * ```html
2362
+ * <igx-grid #grid [data]="localData" (rowAdded)="rowAdded($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>
2363
+ * ```
2364
+ */
2365
+ rowAdded: CustomEvent<IgcRowDataEventArgs>;
2366
+
2367
+ /* blazorCSSuppress */
2368
+ /**
2369
+ * Emitted when a row is deleted.
2370
+ *
2371
+ * @remarks
2372
+ * Returns an `IRowDataEventArgs` object.
2373
+ * @example
2374
+ * ```html
2375
+ * <igx-grid #grid [data]="localData" (rowDeleted)="rowDeleted($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>
2376
+ * ```
2377
+ */
2378
+ rowDeleted: CustomEvent<IgcRowDataEventArgs>;
2379
+
2380
+ /**
2381
+ * Emmited when deleting a row.
2382
+ *
2383
+ * @remarks
2384
+ * This event is cancelable.
2385
+ * Returns an `IGridEditEventArgs` object.
2386
+ * @example
2387
+ * ```html
2388
+ * <igx-grid #grid [data]="localData" (rowDelete)="rowDelete($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>
2389
+ * ```
2390
+ */
2391
+ rowDelete: CustomEvent<IgcGridEditEventArgs>;
2392
+
2393
+ /**
2394
+ * Emmited just before the newly added row is commited.
2395
+ *
2396
+ * @remarks
2397
+ * This event is cancelable.
2398
+ * Returns an `IGridEditEventArgs` object.
2399
+ * @example
2400
+ * ```html
2401
+ * <igx-grid #grid [data]="localData" (rowAdd)="rowAdd($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>
2402
+ * ```
2403
+ */
2404
+ rowAdd: CustomEvent<IgcGridEditEventArgs>;
2405
+
2406
+ /**
2407
+ * Emitted after column is resized.
2408
+ *
2409
+ * @remarks
2410
+ * Returns the `IgxColumnComponent` object's old and new width.
2411
+ * @example
2412
+ * ```html
2413
+ * <igx-grid #grid [data]="localData" (columnResized)="resizing($event)" [autoGenerate]="true"></igx-grid>
2414
+ * ```
2415
+ */
2416
+ columnResized: CustomEvent<IgcColumnResizeEventArgs>;
2417
+
2418
+ /**
2419
+ * Emitted when a cell is right clicked.
2420
+ *
2421
+ * @remarks
2422
+ * Returns the `IgxGridCell` object.
2423
+ * ```html
2424
+ * <igx-grid #grid [data]="localData" (contextMenu)="contextMenu($event)" [autoGenerate]="true"></igx-grid>
2425
+ * ```
2426
+ */
2427
+ contextMenu: CustomEvent<IgcGridCellEventArgs>;
2428
+
2429
+ /**
2430
+ * Emitted when a cell is double clicked.
2431
+ *
2432
+ * @remarks
2433
+ * Returns the `IgxGridCell` object.
2434
+ * @example
2435
+ * ```html
2436
+ * <igx-grid #grid [data]="localData" (doubleClick)="dblClick($event)" [autoGenerate]="true"></igx-grid>
2437
+ * ```
2438
+ */
2439
+ doubleClick: CustomEvent<IgcGridCellEventArgs>;
2440
+
2441
+ /**
2442
+ * Emitted before column visibility is changed.
2443
+ *
2444
+ * @remarks
2445
+ * Args: { column: any, newValue: boolean }
2446
+ * @example
2447
+ * ```html
2448
+ * <igx-grid (columnVisibilityChanging)="visibilityChanging($event)"></igx-grid>
2449
+ * ```
2450
+ */
2451
+ columnVisibilityChanging: CustomEvent<IgcColumnVisibilityChangingEventArgs>;
2452
+
2453
+ /**
2454
+ * Emitted after column visibility is changed.
2455
+ *
2456
+ * @remarks
2457
+ * Args: { column: IgxColumnComponent, newValue: boolean }
2458
+ * @example
2459
+ * ```html
2460
+ * <igx-grid (columnVisibilityChanged)="visibilityChanged($event)"></igx-grid>
2461
+ * ```
2462
+ */
2463
+ columnVisibilityChanged: CustomEvent<IgcColumnVisibilityChangedEventArgs>;
2464
+
2465
+ /**
2466
+ * Emitted when column moving starts.
2467
+ *
2468
+ * @remarks
2469
+ * Returns the moved `IgxColumnComponent` object.
2470
+ * @example
2471
+ * ```html
2472
+ * <igx-grid (columnMovingStart)="movingStart($event)"></igx-grid>
2473
+ * ```
2474
+ */
2475
+ columnMovingStart: CustomEvent<IgcColumnMovingStartEventArgs>;
2476
+
2477
+ /**
2478
+ * Emitted during the column moving operation.
2479
+ *
2480
+ * @remarks
2481
+ * Returns the source and target `IgxColumnComponent` objects. This event is cancelable.
2482
+ * @example
2483
+ * ```html
2484
+ * <igx-grid (columnMoving)="moving($event)"></igx-grid>
2485
+ * ```
2486
+ */
2487
+ columnMoving: CustomEvent<IgcColumnMovingEventArgs>;
2488
+
2489
+ /**
2490
+ * Emitted when column moving ends.
2491
+ *
2492
+ * @remarks
2493
+ * Returns the source and target `IgxColumnComponent` objects.
2494
+ * @example
2495
+ * ```html
2496
+ * <igx-grid (columnMovingEnd)="movingEnds($event)"></igx-grid>
2497
+ * ```
2498
+ */
2499
+ columnMovingEnd: CustomEvent<IgcColumnMovingEndEventArgs>;
2500
+
2501
+ /**
2502
+ * Emitted when keydown is triggered over element inside grid's body.
2503
+ *
2504
+ * @remarks
2505
+ * This event is fired only if the key combination is supported in the grid.
2506
+ * Return the target type, target object and the original event. This event is cancelable.
2507
+ * @example
2508
+ * ```html
2509
+ * <igx-grid (gridKeydown)="customKeydown($event)"></igx-grid>
2510
+ * ```
2511
+ */
2512
+ gridKeydown: CustomEvent<IgcGridKeydownEventArgs>;
2513
+
2514
+ /**
2515
+ * Emitted when start dragging a row.
2516
+ *
2517
+ * @remarks
2518
+ * Return the dragged row.
2519
+ */
2520
+ rowDragStart: CustomEvent<IgcRowDragStartEventArgs>;
2521
+
2522
+ /**
2523
+ * Emitted when dropping a row.
2524
+ *
2525
+ * @remarks
2526
+ * Return the dropped row.
2527
+ */
2528
+ rowDragEnd: CustomEvent<IgcRowDragEndEventArgs>;
2529
+
2530
+ /**
2531
+ * Emitted when a copy operation is executed.
2532
+ *
2533
+ * @remarks
2534
+ * Fired only if copy behavior is enabled through the [`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions}.
2535
+ */
2536
+ gridCopy: CustomEvent<IgcGridClipboardEvent>;
2537
+
2538
+ /**
2539
+ * Emitted when the expanded state of a row gets changed.
2540
+ *
2541
+ * @example
2542
+ * ```html
2543
+ * <igx-grid [data]="employeeData" (rowToggle)="rowToggle($event)" [autoGenerate]="true"></igx-grid>
2544
+ * ```
2545
+ */
2546
+ rowToggle: CustomEvent<IgcRowToggleEventArgs>;
2547
+
2548
+ /**
2549
+ * Emitted when the pinned state of a row is changed.
2550
+ *
2551
+ * @example
2552
+ * ```html
2553
+ * <igx-grid [data]="employeeData" (rowPinning)="rowPin($event)" [autoGenerate]="true"></igx-grid>
2554
+ * ```
2555
+ */
2556
+ rowPinning: CustomEvent<IgcPinRowEventArgs>;
2557
+
2558
+ /**
2559
+ * Emitted when the pinned state of a row is changed.
2560
+ *
2561
+ * @example
2562
+ * ```html
2563
+ * <igx-grid [data]="employeeData" (rowPinned)="rowPin($event)" [autoGenerate]="true"></igx-grid>
2564
+ * ```
2565
+ */
2566
+ rowPinned: CustomEvent<IgcPinRowEventArgs>;
2567
+
2568
+ /**
2569
+ * Emmited when the active node is changed.
2570
+ *
2571
+ * @example
2572
+ * ```
2573
+ * <igx-grid [data]="data" [autoGenerate]="true" (activeNodeChange)="activeNodeChange($event)"></igx-grid>
2574
+ * ```
2575
+ */
2576
+ activeNodeChange: CustomEvent<IgcActiveNodeChangeEventArgs>;
2577
+
2578
+ /**
2579
+ * Emitted before sorting is performed.
2580
+ *
2581
+ * @remarks
2582
+ * Returns the sorting expressions.
2583
+ * @example
2584
+ * ```html
2585
+ * <igx-grid #grid [data]="localData" [autoGenerate]="true" (sortingExpressionsChange)="sortingExprChange($event)"></igx-grid>
2586
+ * ```
2587
+ */
2588
+ sortingExpressionsChange: CustomEvent<IgcSortingExpression[]>;
2589
+
2590
+ /**
2591
+ * Emitted when an export process is initiated by the user.
2592
+ *
2593
+ * @example
2594
+ * ```typescript
2595
+ * toolbarExporting(event: IGridToolbarExportEventArgs){
2596
+ * const toolbarExporting = event;
2597
+ * }
2598
+ * ```
2599
+ */
2600
+ toolbarExporting: CustomEvent<IgcGridToolbarExportEventArgs>;
2601
+
2602
+ /* End of toolbar related definitions */
2603
+ /**
2604
+ * Emitted when making a range selection.
2605
+ *
2606
+ * @remarks
2607
+ * Range selection can be made either through drag selection or through keyboard selection.
2608
+ */
2609
+ rangeSelected: CustomEvent<IgcGridSelectionRange>;
2610
+
2611
+ /** Emitted after the ngAfterViewInit hook. At this point the grid exists in the DOM */
2612
+ rendered: CustomEvent;
2613
+
2614
+ /**
2615
+ * Emitted before the grid's data view is changed because of a data operation, rebinding, etc.
2616
+ *
2617
+ * @example
2618
+ * ```typescript
2619
+ * <igx-grid #grid [data]="localData" [autoGenerate]="true" (dataChanging)='handleDataChangingEvent()'></igx-grid>
2620
+ * ```
2621
+ */
2622
+ dataChanging: CustomEvent<IgcForOfDataChangingEventArgs>;
2623
+
2624
+ /**
2625
+ * Emitted after the grid's data view is changed because of a data operation, rebinding, etc.
2626
+ *
2627
+ * @example
2628
+ * ```typescript
2629
+ * <igx-grid #grid [data]="localData" [autoGenerate]="true" (dataChanged)='handleDataChangedEvent()'></igx-grid>
2630
+ * ```
2631
+ */
2632
+ dataChanged: CustomEvent;
2633
+
2634
+ }
2635
+