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