igniteui-webcomponents-grids 6.3.0-alpha.0 → 6.3.0-alpha.2

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