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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (225) hide show
  1. package/custom-elements.json +20 -23291
  2. package/grids/3rdpartylicenses.txt +887 -27
  3. package/grids/combined.js +68006 -47615
  4. package/grids/lib/igc-grid-state-component.d.ts +10 -7
  5. package/grids/lib/igc-grid-state-info.d.ts +6 -15
  6. package/grids/lib/index.d.ts +0 -208
  7. package/grids/themes/dark/bootstrap.css +1 -1
  8. package/grids/themes/dark/fluent.css +1 -1
  9. package/grids/themes/dark/indigo.css +1 -1
  10. package/grids/themes/dark/material.css +1 -1
  11. package/grids/themes/light/bootstrap.css +1 -1
  12. package/grids/themes/light/fluent.css +1 -1
  13. package/grids/themes/light/indigo.css +1 -1
  14. package/grids/themes/light/material.css +1 -1
  15. package/package.json +1 -1
  16. package/vscode.html-custom-data.json +1 -1
  17. package/web-types.json +1 -1
  18. package/grids/lib/column-pinning-position.d.ts +0 -20
  19. package/grids/lib/drop-position.d.ts +0 -19
  20. package/grids/lib/filter-mode.d.ts +0 -3
  21. package/grids/lib/filtering-expressions-tree-type.d.ts +0 -15
  22. package/grids/lib/filtering-logic.d.ts +0 -15
  23. package/grids/lib/grid-cell-merge-mode.d.ts +0 -3
  24. package/grids/lib/grid-column-data-type.d.ts +0 -3
  25. package/grids/lib/grid-keydown-target-type.d.ts +0 -3
  26. package/grids/lib/grid-paging-mode.d.ts +0 -3
  27. package/grids/lib/grid-selection-mode.d.ts +0 -3
  28. package/grids/lib/grid-summary-calculation-mode.d.ts +0 -3
  29. package/grids/lib/grid-summary-position.d.ts +0 -3
  30. package/grids/lib/grid-toolbar-exporter-type.d.ts +0 -3
  31. package/grids/lib/grid-validation-trigger.d.ts +0 -3
  32. package/grids/lib/horizontal-alignment.d.ts +0 -16
  33. package/grids/lib/igc-action-strip-component.d.ts +0 -119
  34. package/grids/lib/igc-action-strip-resource-strings.d.ts +0 -15
  35. package/grids/lib/igc-action-strip-token.d.ts +0 -16
  36. package/grids/lib/igc-active-node-change-event-args.d.ts +0 -38
  37. package/grids/lib/igc-base-date-time-filtering-operand.d.ts +0 -19
  38. package/grids/lib/igc-base-event-args.d.ts +0 -19
  39. package/grids/lib/igc-base-exporter.d.ts +0 -72
  40. package/grids/lib/igc-base-filtering-strategy.d.ts +0 -36
  41. package/grids/lib/igc-base-search-info.d.ts +0 -34
  42. package/grids/lib/igc-base-toolbar-column-actions-directive.d.ts +0 -21
  43. package/grids/lib/igc-base-toolbar-directive.d.ts +0 -86
  44. package/grids/lib/igc-boolean-filtering-operand.d.ts +0 -20
  45. package/grids/lib/igc-by-level-tree-grid-merge-strategy.d.ts +0 -18
  46. package/grids/lib/igc-cancelable-browser-event-args.d.ts +0 -14
  47. package/grids/lib/igc-cancelable-event-args.d.ts +0 -19
  48. package/grids/lib/igc-cell-position.d.ts +0 -30
  49. package/grids/lib/igc-cell-template-context.d.ts +0 -27
  50. package/grids/lib/igc-cell-type.d.ts +0 -117
  51. package/grids/lib/igc-clipboard-options.d.ts +0 -45
  52. package/grids/lib/igc-column-component.d.ts +0 -1105
  53. package/grids/lib/igc-column-editor-options.d.ts +0 -15
  54. package/grids/lib/igc-column-exporting-event-args.d.ts +0 -64
  55. package/grids/lib/igc-column-group-component.d.ts +0 -186
  56. package/grids/lib/igc-column-layout-component.d.ts +0 -55
  57. package/grids/lib/igc-column-moving-end-event-args.d.ts +0 -37
  58. package/grids/lib/igc-column-moving-event-args.d.ts +0 -30
  59. package/grids/lib/igc-column-moving-start-event-args.d.ts +0 -23
  60. package/grids/lib/igc-column-pipe-args.d.ts +0 -17
  61. package/grids/lib/igc-column-resize-event-args.d.ts +0 -29
  62. package/grids/lib/igc-column-selection-event-args.d.ts +0 -51
  63. package/grids/lib/igc-column-state.d.ts +0 -140
  64. package/grids/lib/igc-column-template-context.d.ts +0 -23
  65. package/grids/lib/igc-column-toggled-event-args.d.ts +0 -27
  66. package/grids/lib/igc-column-visibility-changed-event-args.d.ts +0 -26
  67. package/grids/lib/igc-column-visibility-changing-event-args.d.ts +0 -35
  68. package/grids/lib/igc-columns-auto-generated-event-args.d.ts +0 -22
  69. package/grids/lib/igc-data-clone-strategy.d.ts +0 -22
  70. package/grids/lib/igc-date-filtering-operand.d.ts +0 -20
  71. package/grids/lib/igc-date-summary-operand.d.ts +0 -75
  72. package/grids/lib/igc-date-time-filtering-operand.d.ts +0 -15
  73. package/grids/lib/igc-default-merge-strategy.d.ts +0 -28
  74. package/grids/lib/igc-default-tree-grid-merge-strategy.d.ts +0 -19
  75. package/grids/lib/igc-dimensions-change.d.ts +0 -29
  76. package/grids/lib/igc-exporter-event-args.d.ts +0 -35
  77. package/grids/lib/igc-exporter-options-base.d.ts +0 -153
  78. package/grids/lib/igc-exporter-options.d.ts +0 -14
  79. package/grids/lib/igc-expression-tree.d.ts +0 -34
  80. package/grids/lib/igc-field-editor-options.d.ts +0 -21
  81. package/grids/lib/igc-field-pipe-args.d.ts +0 -48
  82. package/grids/lib/igc-filter-item.d.ts +0 -25
  83. package/grids/lib/igc-filtering-event-args.d.ts +0 -37
  84. package/grids/lib/igc-filtering-expression.d.ts +0 -39
  85. package/grids/lib/igc-filtering-expressions-tree.d.ts +0 -47
  86. package/grids/lib/igc-filtering-operand.d.ts +0 -53
  87. package/grids/lib/igc-filtering-operation.d.ts +0 -44
  88. package/grids/lib/igc-filtering-strategy.d.ts +0 -26
  89. package/grids/lib/igc-for-of-data-change-event-args.d.ts +0 -14
  90. package/grids/lib/igc-for-of-data-changing-event-args.d.ts +0 -24
  91. package/grids/lib/igc-for-of-state.d.ts +0 -21
  92. package/grids/lib/igc-grid-actions-base-directive.d.ts +0 -32
  93. package/grids/lib/igc-grid-base-directive.d.ts +0 -2664
  94. package/grids/lib/igc-grid-cell-event-args.d.ts +0 -28
  95. package/grids/lib/igc-grid-clipboard-event.d.ts +0 -28
  96. package/grids/lib/igc-grid-component.d.ts +0 -570
  97. package/grids/lib/igc-grid-context-menu-event-args.d.ts +0 -32
  98. package/grids/lib/igc-grid-created-event-args.d.ts +0 -29
  99. package/grids/lib/igc-grid-edit-done-event-args.d.ts +0 -86
  100. package/grids/lib/igc-grid-edit-event-args.d.ts +0 -96
  101. package/grids/lib/igc-grid-editing-actions-component.d.ts +0 -77
  102. package/grids/lib/igc-grid-empty-template-context.d.ts +0 -13
  103. package/grids/lib/igc-grid-form-group-created-event-args.d.ts +0 -22
  104. package/grids/lib/igc-grid-grouping-strategy.d.ts +0 -33
  105. package/grids/lib/igc-grid-header-template-context.d.ts +0 -19
  106. package/grids/lib/igc-grid-keydown-event-args.d.ts +0 -40
  107. package/grids/lib/igc-grid-master-detail-context.d.ts +0 -22
  108. package/grids/lib/igc-grid-merge-strategy.d.ts +0 -32
  109. package/grids/lib/igc-grid-paginator-template-context.d.ts +0 -19
  110. package/grids/lib/igc-grid-pinning-actions-component.d.ts +0 -56
  111. package/grids/lib/igc-grid-resource-strings.d.ts +0 -549
  112. package/grids/lib/igc-grid-row-component.d.ts +0 -24
  113. package/grids/lib/igc-grid-row-drag-ghost-context.d.ts +0 -27
  114. package/grids/lib/igc-grid-row-edit-actions-template-context.d.ts +0 -20
  115. package/grids/lib/igc-grid-row-edit-text-template-context.d.ts +0 -18
  116. package/grids/lib/igc-grid-row-event-args.d.ts +0 -27
  117. package/grids/lib/igc-grid-row-template-context.d.ts +0 -19
  118. package/grids/lib/igc-grid-scroll-event-args.d.ts +0 -30
  119. package/grids/lib/igc-grid-selection-range.d.ts +0 -48
  120. package/grids/lib/igc-grid-sorting-strategy.d.ts +0 -30
  121. package/grids/lib/igc-grid-state-base-directive.d.ts +0 -31
  122. package/grids/lib/igc-grid-state-collection.d.ts +0 -28
  123. package/grids/lib/igc-grid-state-options.d.ts +0 -59
  124. package/grids/lib/igc-grid-template-context.d.ts +0 -19
  125. package/grids/lib/igc-grid-toolbar-actions-component.d.ts +0 -36
  126. package/grids/lib/igc-grid-toolbar-advanced-filtering-component.d.ts +0 -43
  127. package/grids/lib/igc-grid-toolbar-component.d.ts +0 -63
  128. package/grids/lib/igc-grid-toolbar-export-event-args.d.ts +0 -52
  129. package/grids/lib/igc-grid-toolbar-exporter-component.d.ts +0 -87
  130. package/grids/lib/igc-grid-toolbar-hiding-component.d.ts +0 -38
  131. package/grids/lib/igc-grid-toolbar-pinning-component.d.ts +0 -37
  132. package/grids/lib/igc-grid-toolbar-template-context.d.ts +0 -19
  133. package/grids/lib/igc-grid-toolbar-title-component.d.ts +0 -34
  134. package/grids/lib/igc-grid-validation-state.d.ts +0 -28
  135. package/grids/lib/igc-grid-validation-status-event-args.d.ts +0 -26
  136. package/grids/lib/igc-group-by-expand-state.d.ts +0 -21
  137. package/grids/lib/igc-group-by-key.d.ts +0 -22
  138. package/grids/lib/igc-group-by-record.d.ts +0 -47
  139. package/grids/lib/igc-group-by-result.d.ts +0 -23
  140. package/grids/lib/igc-group-by-row-selector-template-context.d.ts +0 -18
  141. package/grids/lib/igc-group-by-row-selector-template-details.d.ts +0 -27
  142. package/grids/lib/igc-group-by-row-template-context.d.ts +0 -19
  143. package/grids/lib/igc-grouped-records.d.ts +0 -16
  144. package/grids/lib/igc-grouping-done-event-args.d.ts +0 -25
  145. package/grids/lib/igc-grouping-expression.d.ts +0 -21
  146. package/grids/lib/igc-grouping-state.d.ts +0 -30
  147. package/grids/lib/igc-head-selector-template-context.d.ts +0 -18
  148. package/grids/lib/igc-head-selector-template-details.d.ts +0 -28
  149. package/grids/lib/igc-header-type.d.ts +0 -50
  150. package/grids/lib/igc-hierarchical-grid-base-directive.d.ts +0 -69
  151. package/grids/lib/igc-hierarchical-grid-component.d.ts +0 -230
  152. package/grids/lib/igc-noop-filtering-strategy.d.ts +0 -24
  153. package/grids/lib/igc-noop-pivot-dimensions-strategy.d.ts +0 -24
  154. package/grids/lib/igc-noop-sorting-strategy.d.ts +0 -27
  155. package/grids/lib/igc-number-filtering-operand.d.ts +0 -20
  156. package/grids/lib/igc-number-summary-operand.d.ts +0 -104
  157. package/grids/lib/igc-overlay-outlet-directive.d.ts +0 -20
  158. package/grids/lib/igc-overlay-settings.d.ts +0 -41
  159. package/grids/lib/igc-page-cancellable-event-args.d.ts +0 -20
  160. package/grids/lib/igc-page-event-args.d.ts +0 -20
  161. package/grids/lib/igc-paginator-component.d.ts +0 -231
  162. package/grids/lib/igc-paginator-resource-strings.d.ts +0 -30
  163. package/grids/lib/igc-paging-state.d.ts +0 -24
  164. package/grids/lib/igc-pin-column-cancellable-event-args.d.ts +0 -44
  165. package/grids/lib/igc-pin-column-event-args.d.ts +0 -37
  166. package/grids/lib/igc-pin-row-event-args.d.ts +0 -52
  167. package/grids/lib/igc-pinning-config.d.ts +0 -27
  168. package/grids/lib/igc-pivot-aggregator.d.ts +0 -47
  169. package/grids/lib/igc-pivot-configuration-changed-event-args.d.ts +0 -21
  170. package/grids/lib/igc-pivot-configuration.d.ts +0 -53
  171. package/grids/lib/igc-pivot-data-selector-component.d.ts +0 -182
  172. package/grids/lib/igc-pivot-date-dimension-options.d.ts +0 -34
  173. package/grids/lib/igc-pivot-date-dimension.d.ts +0 -91
  174. package/grids/lib/igc-pivot-dimension-strategy.d.ts +0 -26
  175. package/grids/lib/igc-pivot-dimension.d.ts +0 -80
  176. package/grids/lib/igc-pivot-grid-column.d.ts +0 -32
  177. package/grids/lib/igc-pivot-grid-component.d.ts +0 -472
  178. package/grids/lib/igc-pivot-grid-record.d.ts +0 -36
  179. package/grids/lib/igc-pivot-grid-value-template-context.d.ts +0 -19
  180. package/grids/lib/igc-pivot-keys.d.ts +0 -48
  181. package/grids/lib/igc-pivot-ui-settings.d.ts +0 -28
  182. package/grids/lib/igc-pivot-value.d.ts +0 -62
  183. package/grids/lib/igc-position-settings.d.ts +0 -41
  184. package/grids/lib/igc-position-strategy.d.ts +0 -36
  185. package/grids/lib/igc-row-data-cancelable-event-args.d.ts +0 -61
  186. package/grids/lib/igc-row-data-event-args.d.ts +0 -38
  187. package/grids/lib/igc-row-directive.d.ts +0 -191
  188. package/grids/lib/igc-row-drag-end-event-args.d.ts +0 -28
  189. package/grids/lib/igc-row-drag-start-event-args.d.ts +0 -38
  190. package/grids/lib/igc-row-exporting-event-args.d.ts +0 -39
  191. package/grids/lib/igc-row-island-component.d.ts +0 -2661
  192. package/grids/lib/igc-row-selection-event-args.d.ts +0 -56
  193. package/grids/lib/igc-row-selector-template-context.d.ts +0 -19
  194. package/grids/lib/igc-row-selector-template-details.d.ts +0 -39
  195. package/grids/lib/igc-row-toggle-event-args.d.ts +0 -40
  196. package/grids/lib/igc-row-type.d.ts +0 -177
  197. package/grids/lib/igc-scroll-strategy.d.ts +0 -37
  198. package/grids/lib/igc-search-info.d.ts +0 -23
  199. package/grids/lib/igc-size.d.ts +0 -25
  200. package/grids/lib/igc-sorting-event-args.d.ts +0 -49
  201. package/grids/lib/igc-sorting-expression.d.ts +0 -34
  202. package/grids/lib/igc-sorting-options.d.ts +0 -19
  203. package/grids/lib/igc-sorting-strategy.d.ts +0 -14
  204. package/grids/lib/igc-string-filtering-operand.d.ts +0 -29
  205. package/grids/lib/igc-summary-expression.d.ts +0 -24
  206. package/grids/lib/igc-summary-operand.d.ts +0 -61
  207. package/grids/lib/igc-summary-result.d.ts +0 -44
  208. package/grids/lib/igc-summary-template-context.d.ts +0 -19
  209. package/grids/lib/igc-time-filtering-operand.d.ts +0 -15
  210. package/grids/lib/igc-time-summary-operand.d.ts +0 -49
  211. package/grids/lib/igc-toggle-view-cancelable-event-args.d.ts +0 -17
  212. package/grids/lib/igc-toggle-view-event-args.d.ts +0 -18
  213. package/grids/lib/igc-tree-grid-component.d.ts +0 -397
  214. package/grids/lib/igc-tree-grid-record.d.ts +0 -38
  215. package/grids/lib/igc-validation-errors.d.ts +0 -11
  216. package/grids/lib/igc-values-change.d.ts +0 -23
  217. package/grids/lib/pivot-aggregation-type.d.ts +0 -3
  218. package/grids/lib/pivot-dimension-type.d.ts +0 -17
  219. package/grids/lib/pivot-row-layout-type.d.ts +0 -3
  220. package/grids/lib/pivot-summary-position.d.ts +0 -3
  221. package/grids/lib/row-pinning-position.d.ts +0 -20
  222. package/grids/lib/sorting-direction.d.ts +0 -16
  223. package/grids/lib/sorting-options-mode.d.ts +0 -3
  224. package/grids/lib/validation-status.d.ts +0 -3
  225. package/grids/lib/vertical-alignment.d.ts +0 -16
@@ -1,2661 +0,0 @@
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 { IgcGridToolbarTemplateContext } from './igc-grid-toolbar-template-context';
41
- import { IgcRenderFunction } from './common';
42
- import { IgcGridPaginatorTemplateContext } from './igc-grid-paginator-template-context';
43
- import { IgcActionStripToken } from './igc-action-strip-token';
44
- import { IgcGridTemplateContext } from './igc-grid-template-context';
45
- import { IgcDataCloneStrategy } from './igc-data-clone-strategy';
46
- import { IgcClipboardOptions } from './igc-clipboard-options';
47
- import { IgcGridRowDragGhostContext } from './igc-grid-row-drag-ghost-context';
48
- import { IgcGridRowEditTextTemplateContext } from './igc-grid-row-edit-text-template-context';
49
- import { IgcGridEmptyTemplateContext } from './igc-grid-empty-template-context';
50
- import { IgcGridRowEditActionsTemplateContext } from './igc-grid-row-edit-actions-template-context';
51
- import { IgcGridRowTemplateContext } from './igc-grid-row-template-context';
52
- import { IgcGridHeaderTemplateContext } from './igc-grid-header-template-context';
53
- import { IgcGridToolbarComponent } from './igc-grid-toolbar-component';
54
- import { IgcPaginatorComponent } from './igc-paginator-component';
55
- import { IgcGridResourceStrings } from './igc-grid-resource-strings';
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
- /* contentChildren */
123
- /* blazorInclude */
124
- /* blazorTreatAsCollection */
125
- /* blazorCollectionName: RowIslandCollection */
126
- /**
127
- * @hidden @internal
128
- */
129
- public set childLayoutList(value: IgcRowIslandComponent[]);
130
- public get childLayoutList(): IgcRowIslandComponent[];
131
-
132
-
133
-
134
- /* csSuppress */
135
- /**
136
- * Sets/Gets the toolbar template for each child grid created from this row island.
137
- */
138
- public set toolbarTemplate(value: IgcRenderFunction<IgcGridToolbarTemplateContext>);
139
- public get toolbarTemplate(): IgcRenderFunction<IgcGridToolbarTemplateContext>;
140
-
141
-
142
-
143
-
144
- /* csSuppress */
145
- /**
146
- * Sets/Gets the paginator template for each child grid created from this row island.
147
- */
148
- public set paginatorTemplate(value: IgcRenderFunction<IgcGridPaginatorTemplateContext>);
149
- public get paginatorTemplate(): IgcRenderFunction<IgcGridPaginatorTemplateContext>;
150
-
151
-
152
-
153
- // TODO(api-analyzer): Shouldn't need all tags to copy from base or hidden/internal due to include tag
154
- /* contentChildren */
155
- /* blazorInclude */
156
- /* blazorTreatAsCollection */
157
- /* blazorCollectionName: ActionStripCollection */
158
- /* blazorCollectionItemName: ActionStrip */
159
- /* ngQueryListName: actionStripComponents */
160
- /** @hidden @internal */
161
- public set actionStripComponents(value: IgcActionStripToken[]);
162
- public get actionStripComponents(): IgcActionStripToken[];
163
-
164
-
165
-
166
- /**
167
- * Sets if all immediate children of the grids for this `IgxRowIslandComponent` should be expanded/collapsed.
168
- * ```html
169
- * <igx-hierarchical-grid [data]="Data" [autoGenerate]="true">
170
- * <igx-row-island [key]="'childData'" [expandChildren]="true" #rowIsland>
171
- * <!-- ... -->
172
- * </igx-row-island>
173
- * </igx-hierarchical-grid>
174
- * ```
175
- *
176
- * @memberof IgxRowIslandComponent
177
- */
178
- public set expandChildren(value: boolean);
179
- public get expandChildren(): boolean;
180
-
181
-
182
- /**
183
- * Gets/Sets the key indicating whether a row has children. If row has no children it does not render an expand indicator.
184
- *
185
- * @example
186
- * ```html
187
- * <igx-hierarchical-grid #grid [data]="localData" [hasChildrenKey]="'hasEmployees'">
188
- * </igx-hierarchical-grid>
189
- * ```
190
- */
191
- public set hasChildrenKey(value: string);
192
- public get hasChildrenKey(): string;
193
-
194
-
195
-
196
- /**
197
- * Gets/Sets whether the expand/collapse all button in the header should be rendered.
198
- *
199
- * @remarks
200
- * The default value is false.
201
- * @example
202
- * ```html
203
- * <igx-hierarchical-grid #grid [data]="localData" [showExpandAll]="true">
204
- * </igx-hierarchical-grid>
205
- * ```
206
- */
207
- public set showExpandAll(value: boolean);
208
- public get showExpandAll(): boolean;
209
-
210
-
211
-
212
- public set batchEditing(value: boolean);
213
- public get batchEditing(): boolean;
214
-
215
-
216
-
217
- /**
218
- * Gets/Sets the display time for the row adding snackbar notification.
219
- *
220
- * @remarks
221
- * By default it is 6000ms.
222
- */
223
- public set snackbarDisplayTime(value: number);
224
- public get snackbarDisplayTime(): number;
225
-
226
-
227
-
228
- /**
229
- * Gets/Sets whether to auto-generate the columns.
230
- *
231
- * @remarks
232
- * The default value is false. When set to true, it will override all columns declared through code or in markup.
233
- * @example
234
- * ```html
235
- * <igx-grid [data]="Data" [autoGenerate]="true"></igx-grid>
236
- * ```
237
- */
238
- public set autoGenerate(value: boolean);
239
- public get autoGenerate(): boolean;
240
-
241
-
242
-
243
- /**
244
- * Gets/Sets a list of property keys to be excluded from the generated column collection
245
- * @remarks
246
- * The collection is only used during initialization and changing it will not cause any changes in the generated columns at runtime
247
- * unless the grid is destroyed and recreated. To modify the columns visible in the UI at runtime, please use their
248
- * [hidden](https://www.infragistics.com/products/ignite-ui-angular/docs/typescript/latest/classes/IgxColumnComponent.html#hidden) property.
249
- * @example
250
- * ```html
251
- * <igx-grid data=[Data] [autoGenerate]="true" [autoGenerateExclude]="['ProductName', 'Count']"></igx-grid>
252
- * ```
253
- * ```typescript
254
- * const Data = [{ 'Id': '1', 'ProductName': 'name1', 'Description': 'description1', 'Count': 5 }]
255
- * ```
256
- */
257
- public set autoGenerateExclude(value: string[]);
258
- public get autoGenerateExclude(): string[];
259
-
260
-
261
-
262
- /**
263
- * Controls whether columns moving is enabled in the grid.
264
- *
265
- */
266
- public set moving(value: boolean);
267
- public get moving(): boolean;
268
-
269
-
270
-
271
- /**
272
- * Gets/Sets a custom template when empty.
273
- *
274
- * @example
275
- * ```html
276
- * <ng-template igxGridEmpty>
277
- * <!-- content to show when the grid is empty -->
278
- * </ng-template>
279
- * ```
280
- * Or
281
- * ```html
282
- * <igx-grid [id]="'igx-grid-1'" [data]="Data" [emptyGridTemplate]="myTemplate" [autoGenerate]="true"></igx-grid>
283
- * ```
284
- */
285
- public set emptyGridTemplate(value: IgcRenderFunction<IgcGridTemplateContext>);
286
- public get emptyGridTemplate(): IgcRenderFunction<IgcGridTemplateContext>;
287
-
288
-
289
-
290
- /**
291
- * Gets/Sets a custom template for adding row UI when grid is empty.
292
- *
293
- * @example
294
- * ```html
295
- * <igx-grid [id]="'igx-grid-1'" [data]="Data" [addRowEmptyTemplate]="myTemplate" [autoGenerate]="true"></igx-grid>
296
- * ```
297
- */
298
- public set addRowEmptyTemplate(value: IgcRenderFunction<void>);
299
- public get addRowEmptyTemplate(): IgcRenderFunction<void>;
300
-
301
-
302
-
303
- /**
304
- * Gets/Sets a custom template when loading.
305
- *
306
- * @example
307
- * ```html
308
- * <ng-template igxGridLoading>
309
- * <!-- content to show when the grid is loading -->
310
- * </ng-template>
311
- * ```
312
- * Or
313
- * ```html
314
- * <igx-grid [id]="'igx-grid-1'" [data]="Data" [loadingGridTemplate]="myTemplate" [autoGenerate]="true"></igx-grid>
315
- * ```
316
- */
317
- public set loadingGridTemplate(value: IgcRenderFunction<IgcGridTemplateContext>);
318
- public get loadingGridTemplate(): IgcRenderFunction<IgcGridTemplateContext>;
319
-
320
-
321
-
322
- /**
323
- * Get/Set IgxSummaryRow height
324
- */
325
- public set summaryRowHeight(value: number);
326
- public get summaryRowHeight(): number;
327
-
328
-
329
-
330
- /**
331
- * Gets/Sets the data clone strategy of the grid when in edit mode.
332
- *
333
- * @example
334
- * ```html
335
- * <igx-grid #grid [data]="localData" [dataCloneStrategy]="customCloneStrategy"></igx-grid>
336
- * ```
337
- */
338
- public set dataCloneStrategy(value: IgcDataCloneStrategy);
339
- public get dataCloneStrategy(): IgcDataCloneStrategy;
340
-
341
-
342
-
343
- /**
344
- * Controls the copy behavior of the grid.
345
- */
346
- public set clipboardOptions(value: IgcClipboardOptions);
347
- public get clipboardOptions(): IgcClipboardOptions;
348
-
349
-
350
-
351
- /* treatAsRef */
352
- /**
353
- * Sets a conditional class selector to the grid's row element.
354
- * Accepts an object literal, containing key-value pairs,
355
- * where the key is the name of the CSS class and the value is
356
- * either a callback function that returns a boolean, or boolean, like so:
357
- * ```typescript
358
- * callback = (row: RowType) => { return row.selected > 6; }
359
- * rowClasses = { 'className' : this.callback };
360
- * ```
361
- * ```html
362
- * <igx-grid #grid [data]="Data" [rowClasses] = "rowClasses" [autoGenerate]="true"></igx-grid>
363
- * ```
364
- *
365
- * @memberof IgxColumnComponent
366
- */
367
- public set rowClasses(value: any);
368
- public get rowClasses(): any;
369
-
370
-
371
-
372
- /* treatAsRef */
373
- /**
374
- * Sets conditional style properties on the grid row element.
375
- * It accepts an object literal where the keys are
376
- * the style properties and the value is an expression to be evaluated.
377
- * ```typescript
378
- * styles = {
379
- * background: 'yellow',
380
- * color: (row: RowType) => row.selected : 'red': 'white'
381
- * }
382
- * ```
383
- * ```html
384
- * <igx-grid #grid [data]="Data" [rowStyles]="styles" [autoGenerate]="true"></igx-grid>
385
- * ```
386
- *
387
- * @memberof IgxColumnComponent
388
- */
389
- public set rowStyles(value: any);
390
- public get rowStyles(): any;
391
-
392
-
393
-
394
- /**
395
- * Gets/Sets the primary key.
396
- *
397
- * @example
398
- * ```html
399
- * <igx-grid #grid [data]="localData" [primaryKey]="'ProductID'" [autoGenerate]="true"></igx-grid>
400
- * ```
401
- */
402
- public set primaryKey(value: string);
403
- public get primaryKey(): string;
404
-
405
-
406
-
407
- /* reactContentChildren */
408
- /* blazorInclude */
409
- /* blazorTreatAsCollection */
410
- /* blazorCollectionName: ColumnCollection */
411
- /* ngQueryListName: columnList */
412
- /**
413
- * @hidden @internal
414
- */
415
- public set columnList(value: IgcColumnComponent[]);
416
- public get columnList(): IgcColumnComponent[];
417
-
418
-
419
-
420
-
421
- /**
422
- * Gets the custom template, if any, used for row drag ghost.
423
- */
424
- public set dragGhostCustomTemplate(value: IgcRenderFunction<IgcGridRowDragGhostContext>);
425
- public get dragGhostCustomTemplate(): IgcRenderFunction<IgcGridRowDragGhostContext>;
426
-
427
-
428
-
429
- /**
430
- * Gets the row edit text template.
431
- */
432
- public set rowEditTextTemplate(value: IgcRenderFunction<IgcGridRowEditTextTemplateContext>);
433
- public get rowEditTextTemplate(): IgcRenderFunction<IgcGridRowEditTextTemplateContext>;
434
-
435
-
436
-
437
- /**
438
- * Gets the row add text template.
439
- */
440
- public set rowAddTextTemplate(value: IgcRenderFunction<IgcGridEmptyTemplateContext>);
441
- public get rowAddTextTemplate(): IgcRenderFunction<IgcGridEmptyTemplateContext>;
442
-
443
-
444
-
445
- /**
446
- * Gets the row edit actions template.
447
- */
448
- public set rowEditActionsTemplate(value: IgcRenderFunction<IgcGridRowEditActionsTemplateContext>);
449
- public get rowEditActionsTemplate(): IgcRenderFunction<IgcGridRowEditActionsTemplateContext>;
450
-
451
-
452
-
453
- /**
454
- * Gets the row expand indicator template.
455
- */
456
- public set rowExpandedIndicatorTemplate(value: IgcRenderFunction<IgcGridRowTemplateContext>);
457
- public get rowExpandedIndicatorTemplate(): IgcRenderFunction<IgcGridRowTemplateContext>;
458
-
459
-
460
-
461
- /**
462
- * Gets the row collapse indicator template.
463
- */
464
- public set rowCollapsedIndicatorTemplate(value: IgcRenderFunction<IgcGridRowTemplateContext>);
465
- public get rowCollapsedIndicatorTemplate(): IgcRenderFunction<IgcGridRowTemplateContext>;
466
-
467
-
468
-
469
- /**
470
- * Gets the header expand indicator template.
471
- */
472
- public set headerExpandedIndicatorTemplate(value: IgcRenderFunction<IgcGridTemplateContext>);
473
- public get headerExpandedIndicatorTemplate(): IgcRenderFunction<IgcGridTemplateContext>;
474
-
475
-
476
-
477
- /**
478
- * Gets the row collapse indicator template.
479
- */
480
- public set headerCollapsedIndicatorTemplate(value: IgcRenderFunction<IgcGridTemplateContext>);
481
- public get headerCollapsedIndicatorTemplate(): IgcRenderFunction<IgcGridTemplateContext>;
482
-
483
-
484
-
485
- /**
486
- * Gets the excel style header icon.
487
- */
488
- public set excelStyleHeaderIconTemplate(value: IgcRenderFunction<IgcGridHeaderTemplateContext>);
489
- public get excelStyleHeaderIconTemplate(): IgcRenderFunction<IgcGridHeaderTemplateContext>;
490
-
491
-
492
-
493
- /**
494
- * The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in asc order.
495
- */
496
- public set sortAscendingHeaderIconTemplate(value: IgcRenderFunction<IgcGridHeaderTemplateContext>);
497
- public get sortAscendingHeaderIconTemplate(): IgcRenderFunction<IgcGridHeaderTemplateContext>;
498
-
499
-
500
-
501
- /**
502
- * The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in desc order.
503
- */
504
- public set sortDescendingHeaderIconTemplate(value: IgcRenderFunction<IgcGridHeaderTemplateContext>);
505
- public get sortDescendingHeaderIconTemplate(): IgcRenderFunction<IgcGridHeaderTemplateContext>;
506
-
507
-
508
-
509
- /**
510
- * Gets custom template, if any, that should be used when rendering a header sorting indicator when columns are not sorted.
511
- */
512
- public set sortHeaderIconTemplate(value: IgcRenderFunction<IgcGridHeaderTemplateContext>);
513
- public get sortHeaderIconTemplate(): IgcRenderFunction<IgcGridHeaderTemplateContext>;
514
-
515
-
516
-
517
- /* contentChildren */
518
- /* blazorInclude */
519
- /* blazorTreatAsCollection */
520
- /* blazorCollectionName: GridToolbarCollection */
521
- /* ngQueryListName: toolbar */
522
- /** @hidden @internal */
523
- public set toolbar(value: IgcGridToolbarComponent[]);
524
- public get toolbar(): IgcGridToolbarComponent[];
525
-
526
-
527
-
528
- /* contentChildren */
529
- /* blazorInclude */
530
- /* blazorTreatAsCollection */
531
- /* blazorCollectionName: PaginatorCollection */
532
- /* ngQueryListName: paginationComponents */
533
- /** @hidden @internal */
534
- public set paginationComponents(value: IgcPaginatorComponent[]);
535
- public get paginationComponents(): IgcPaginatorComponent[];
536
-
537
-
538
-
539
- /**
540
- * Gets/Sets the resource strings.
541
- *
542
- * @remarks
543
- * By default it uses EN resources.
544
- */
545
- public set resourceStrings(value: IgcGridResourceStrings);
546
- public get resourceStrings(): IgcGridResourceStrings;
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
-
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
- /**
1110
- * Gets an array of the pinned to the left `IgxColumnComponent`s.
1111
- *
1112
- * @example
1113
- * ```typescript
1114
- * const pinnedColumns = this.grid.pinnedStartColumns.
1115
- * ```
1116
- */
1117
- public get pinnedStartColumns(): IgcColumnComponent[];
1118
-
1119
-
1120
-
1121
- /**
1122
- * Gets an array of the pinned to the right `IgxColumnComponent`s.
1123
- *
1124
- * @example
1125
- * ```typescript
1126
- * const pinnedColumns = this.grid.pinnedEndColumns.
1127
- * ```
1128
- */
1129
- public get pinnedEndColumns(): IgcColumnComponent[];
1130
-
1131
-
1132
-
1133
- /* csSuppress */
1134
- /**
1135
- * Gets an array of the pinned `IgxRowComponent`s.
1136
- *
1137
- * @example
1138
- * ```typescript
1139
- * const pinnedRow = this.grid.pinnedRows;
1140
- * ```
1141
- */
1142
- public get pinnedRows(): IgcGridRowComponent[];
1143
-
1144
-
1145
-
1146
- /**
1147
- * Returns the total number of records.
1148
- *
1149
- * @remarks
1150
- * Only functions when paging is enabled.
1151
- * @example
1152
- * ```typescript
1153
- * const totalRecords = this.grid.totalRecords;
1154
- * ```
1155
- */
1156
- public set totalRecords(value: number);
1157
- public get totalRecords(): number;
1158
-
1159
-
1160
-
1161
- /**
1162
- * Gets/Sets whether clicking over a row should select/deselect it
1163
- *
1164
- * @remarks
1165
- * By default it is set to true
1166
- * @param enabled: boolean
1167
- */
1168
- public set selectRowOnClick(value: boolean);
1169
- public get selectRowOnClick(): boolean;
1170
-
1171
-
1172
-
1173
- /**
1174
- * Returns whether the record is pinned or not.
1175
- *
1176
- * @param rowIndex Index of the record in the `filteredSortedData` collection.
1177
- */
1178
- public isRecordPinnedByIndex(rowIndex: number): void;
1179
-
1180
-
1181
-
1182
- /**
1183
- * Toggles the specified column's visibility.
1184
- *
1185
- * @example
1186
- * ```typescript
1187
- * this.grid1.toggleColumnVisibility({
1188
- * column: this.grid1.columns[0],
1189
- * newValue: true
1190
- * });
1191
- * ```
1192
- */
1193
- public toggleColumnVisibility(args: IgcColumnVisibilityChangedEventArgs): void;
1194
-
1195
-
1196
-
1197
- /**
1198
- * Expands all rows.
1199
- *
1200
- * @example
1201
- * ```typescript
1202
- * this.grid.expandAll();
1203
- * ```
1204
- */
1205
- public expandAll(): void;
1206
-
1207
-
1208
-
1209
- /**
1210
- * Collapses all rows.
1211
- *
1212
- * @example
1213
- * ```typescript
1214
- * this.grid.collapseAll();
1215
- * ```
1216
- */
1217
- public collapseAll(): void;
1218
-
1219
-
1220
-
1221
- /**
1222
- * Expands the row by its id.
1223
- *
1224
- * @remarks
1225
- * ID is either the primaryKey value or the data record instance.
1226
- * @example
1227
- * ```typescript
1228
- * this.grid.expandRow(rowID);
1229
- * ```
1230
- * @param rowID The row id - primaryKey value or the data record instance.
1231
- */
1232
- public expandRow(rowID: any): void;
1233
-
1234
-
1235
-
1236
- /**
1237
- * Collapses the row by its id.
1238
- *
1239
- * @remarks
1240
- * ID is either the primaryKey value or the data record instance.
1241
- * @example
1242
- * ```typescript
1243
- * this.grid.collapseRow(rowID);
1244
- * ```
1245
- * @param rowID The row id - primaryKey value or the data record instance.
1246
- */
1247
- public collapseRow(rowID: any): void;
1248
-
1249
-
1250
-
1251
-
1252
- /**
1253
- * Toggles the row by its id.
1254
- *
1255
- * @remarks
1256
- * ID is either the primaryKey value or the data record instance.
1257
- * @example
1258
- * ```typescript
1259
- * this.grid.toggleRow(rowID);
1260
- * ```
1261
- * @param rowID The row id - primaryKey value or the data record instance.
1262
- */
1263
- public toggleRow(rowID: any): void;
1264
-
1265
-
1266
-
1267
- /**
1268
- * Gets the `width` to be set on `IgxGridHeaderGroupComponent`.
1269
- */
1270
- public getHeaderGroupWidth(column: IgcColumnComponent): string;
1271
-
1272
-
1273
-
1274
- /**
1275
- * Returns the `IgxColumnComponent` by field name.
1276
- *
1277
- * @example
1278
- * ```typescript
1279
- * const myCol = this.grid1.getColumnByName("ID");
1280
- * ```
1281
- * @param name
1282
- */
1283
- public getColumnByName(name: string): IgcColumnComponent;
1284
-
1285
-
1286
-
1287
- public getColumnByVisibleIndex(index: number): IgcColumnComponent;
1288
-
1289
-
1290
-
1291
- /**
1292
- * Recalculates all widths of columns that have size set to `auto`.
1293
- *
1294
- * @example
1295
- * ```typescript
1296
- * this.grid1.recalculateAutoSizes();
1297
- * ```
1298
- */
1299
- public recalculateAutoSizes(): void;
1300
-
1301
-
1302
-
1303
- /**
1304
- * Places a column before or after the specified target column.
1305
- *
1306
- * @example
1307
- * ```typescript
1308
- * grid.moveColumn(column, target);
1309
- * ```
1310
- */
1311
- public moveColumn(column: IgcColumnComponent, target: IgcColumnComponent, pos?: DropPosition): void;
1312
-
1313
-
1314
-
1315
- /**
1316
- * Triggers change detection for the `IgxGridComponent`.
1317
- * Calling markForCheck also triggers the grid pipes explicitly, resulting in all updates being processed.
1318
- * May degrade performance if used when not needed, or if misused:
1319
- * ```typescript
1320
- * // DON'Ts:
1321
- * // don't call markForCheck from inside a loop
1322
- * // don't call markForCheck when a primitive has changed
1323
- * grid.data.forEach(rec => {
1324
- * rec = newValue;
1325
- * grid.markForCheck();
1326
- * });
1327
- *
1328
- * // DOs
1329
- * // call markForCheck after updating a nested property
1330
- * grid.data.forEach(rec => {
1331
- * rec.nestedProp1.nestedProp2 = newValue;
1332
- * });
1333
- * grid.markForCheck();
1334
- * ```
1335
- *
1336
- * @example
1337
- * ```typescript
1338
- * grid.markForCheck();
1339
- * ```
1340
- */
1341
- public markForCheck(): void;
1342
-
1343
-
1344
-
1345
- /* csSuppress */
1346
- /**
1347
- * Creates a new `IgxGridRowComponent` and adds the data record to the end of the data source.
1348
- *
1349
- * @example
1350
- * ```typescript
1351
- * this.grid1.addRow(record);
1352
- * ```
1353
- * @param data
1354
- */
1355
- public addRow(data: any): void;
1356
-
1357
-
1358
-
1359
- /* blazorCSSuppress */
1360
- /**
1361
- * Removes the `IgxGridRowComponent` and the corresponding data record by primary key.
1362
- *
1363
- * @remarks
1364
- * Requires that the `primaryKey` property is set.
1365
- * The method accept rowSelector as a parameter, which is the rowID.
1366
- * @example
1367
- * ```typescript
1368
- * this.grid1.deleteRow(0);
1369
- * ```
1370
- * @param rowSelector
1371
- */
1372
- public deleteRow(rowSelector: any): any;
1373
-
1374
-
1375
-
1376
- /* blazorCSSuppress */
1377
- /**
1378
- * Updates the `IgxGridRowComponent` and the corresponding data record by primary key.
1379
- *
1380
- * @remarks
1381
- * Requires that the `primaryKey` property is set.
1382
- * @example
1383
- * ```typescript
1384
- * this.gridWithPK.updateCell('Updated', 1, 'ProductName');
1385
- * ```
1386
- * @param value the new value which is to be set.
1387
- * @param rowSelector corresponds to rowID.
1388
- * @param column corresponds to column field.
1389
- */
1390
- public updateCell(value: any, rowSelector: any, column: string): void;
1391
-
1392
-
1393
-
1394
- /* blazorCSSuppress */
1395
- /**
1396
- * Updates the `IgxGridRowComponent`
1397
- *
1398
- * @remarks
1399
- * The row is specified by
1400
- * rowSelector parameter and the data source record with the passed value.
1401
- * This method will apply requested update only if primary key is specified in the grid.
1402
- * @example
1403
- * ```typescript
1404
- * grid.updateRow({
1405
- * ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')
1406
- * }, 1);
1407
- * ```
1408
- * @param value–
1409
- * @param rowSelector correspond to rowID
1410
- */
1411
- // TODO: prevent event invocation
1412
- public updateRow(value: any, rowSelector: any): void;
1413
-
1414
-
1415
-
1416
- /**
1417
- * Returns the data that is contained in the row component.
1418
- *
1419
- * @remarks
1420
- * If the primary key is not specified the row selector match the row data.
1421
- * @example
1422
- * ```typescript
1423
- * const data = grid.getRowData(94741);
1424
- * ```
1425
- * @param rowSelector correspond to rowID
1426
- */
1427
- public getRowData(rowSelector: any): any;
1428
-
1429
-
1430
-
1431
- /**
1432
- * Sort a single `IgxColumnComponent`.
1433
- *
1434
- * @remarks
1435
- * Sort the `IgxGridComponent`'s `IgxColumnComponent` based on the provided array of sorting expressions.
1436
- * @example
1437
- * ```typescript
1438
- * this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });
1439
- * ```
1440
- */
1441
- public sort(expression: IgcSortingExpression[]): void;
1442
-
1443
-
1444
-
1445
- /**
1446
- * Filters a single `IgxColumnComponent`.
1447
- *
1448
- * @example
1449
- * ```typescript
1450
- * public filter(term) {
1451
- * this.grid.filter("ProductName", term, IgxStringFilteringOperand.instance().condition("contains"));
1452
- * }
1453
- * ```
1454
- * @param name
1455
- * @param value
1456
- * @param conditionOrExpressionTree
1457
- * @param ignoreCase
1458
- */
1459
- public filter(name: string, value: any, conditionOrExpressionTree?: IgcFilteringExpressionsTree | IgcFilteringOperation, ignoreCase?: boolean): void;
1460
-
1461
-
1462
-
1463
- /**
1464
- * Filters all the `IgxColumnComponent` in the `IgxGridComponent` with the same condition.
1465
- *
1466
- * @example
1467
- * ```typescript
1468
- * grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));
1469
- * ```
1470
- * @param value
1471
- * @param condition
1472
- * @param ignoreCase
1473
- * @deprecated
1474
- */
1475
- public filterGlobal(value: any, condition: any, ignoreCase?: any): void;
1476
-
1477
-
1478
-
1479
- /**
1480
- * Enables summaries for the specified column and applies your customSummary.
1481
- *
1482
- * @remarks
1483
- * If you do not provide the customSummary, then the default summary for the column data type will be applied.
1484
- * @example
1485
- * ```typescript
1486
- * grid.enableSummaries([{ fieldName: 'ProductName' }, { fieldName: 'ID' }]);
1487
- * ```
1488
- * Enable summaries for the listed columns.
1489
- * @example
1490
- * ```typescript
1491
- * grid.enableSummaries('ProductName');
1492
- * ```
1493
- * @param rest
1494
- */
1495
- public enableSummaries(rest: any[]): void;
1496
-
1497
-
1498
-
1499
- /**
1500
- * Disable summaries for the specified column.
1501
- *
1502
- * @example
1503
- * ```typescript
1504
- * grid.disableSummaries('ProductName');
1505
- * ```
1506
- * @remarks
1507
- * Disable summaries for the listed columns.
1508
- * @example
1509
- * ```typescript
1510
- * grid.disableSummaries([{ fieldName: 'ProductName' }]);
1511
- * ```
1512
- */
1513
- public disableSummaries(rest: any[]): void;
1514
-
1515
-
1516
-
1517
- /**
1518
- * If name is provided, clears the filtering state of the corresponding `IgxColumnComponent`.
1519
- *
1520
- * @remarks
1521
- * Otherwise clears the filtering state of all `IgxColumnComponent`s.
1522
- * @example
1523
- * ```typescript
1524
- * this.grid.clearFilter();
1525
- * ```
1526
- * @param name
1527
- */
1528
- public clearFilter(name?: string): void;
1529
-
1530
-
1531
-
1532
- /**
1533
- * If name is provided, clears the sorting state of the corresponding `IgxColumnComponent`.
1534
- *
1535
- * @remarks
1536
- * otherwise clears the sorting state of all `IgxColumnComponent`.
1537
- * @example
1538
- * ```typescript
1539
- * this.grid.clearSort();
1540
- * ```
1541
- * @param name
1542
- */
1543
- public clearSort(name?: string): void;
1544
-
1545
-
1546
-
1547
- // TODO: We have return values here. Move them to event args ??
1548
-
1549
- /**
1550
- * Pins a column by field name.
1551
- *
1552
- * @remarks
1553
- * Returns whether the operation is successful.
1554
- * @example
1555
- * ```typescript
1556
- * this.grid.pinColumn("ID");
1557
- * ```
1558
- * @param columnName
1559
- * @param index
1560
- * @param pinningPosition
1561
- */
1562
- public pinColumn(columnName: string, index?: number, pinningPosition?: ColumnPinningPosition): boolean;
1563
-
1564
-
1565
-
1566
- /**
1567
- * Unpins a column by field name. Returns whether the operation is successful.
1568
- *
1569
- * @example
1570
- * ```typescript
1571
- * this.grid.pinColumn("ID");
1572
- * ```
1573
- * @param columnName
1574
- * @param index
1575
- */
1576
- public unpinColumn(columnName: string, index?: number): boolean;
1577
-
1578
-
1579
-
1580
- /* csSuppress */
1581
- /**
1582
- * Pin the row by its id.
1583
- *
1584
- * @remarks
1585
- * ID is either the primaryKey value or the data record instance.
1586
- * @example
1587
- * ```typescript
1588
- * this.grid.pinRow(rowID);
1589
- * ```
1590
- * @param rowID The row id - primaryKey value or the data record instance.
1591
- * @param index The index at which to insert the row in the pinned collection.
1592
- */
1593
- public pinRow(rowID: any, index?: number, row?: IgcRowType): boolean;
1594
-
1595
-
1596
-
1597
- /* csSuppress */
1598
- /**
1599
- * Unpin the row by its id.
1600
- *
1601
- * @remarks
1602
- * ID is either the primaryKey value or the data record instance.
1603
- * @example
1604
- * ```typescript
1605
- * this.grid.unpinRow(rowID);
1606
- * ```
1607
- * @param rowID The row id - primaryKey value or the data record instance.
1608
- */
1609
- public unpinRow(rowID: any, row?: IgcRowType): boolean;
1610
-
1611
-
1612
-
1613
- /**
1614
- * Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible.
1615
- *
1616
- * @remarks
1617
- * Returns how many times the grid contains the string.
1618
- * @example
1619
- * ```typescript
1620
- * this.grid.findNext("financial");
1621
- * ```
1622
- * @param text the string to search.
1623
- * @param caseSensitive optionally, if the search should be case sensitive (defaults to false).
1624
- * @param exactMatch optionally, if the text should match the entire value (defaults to false).
1625
- */
1626
- public findNext(text: string, caseSensitive?: boolean, exactMatch?: boolean): number;
1627
-
1628
-
1629
-
1630
- /**
1631
- * Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible.
1632
- *
1633
- * @remarks
1634
- * Returns how many times the grid contains the string.
1635
- * @example
1636
- * ```typescript
1637
- * this.grid.findPrev("financial");
1638
- * ```
1639
- * @param text the string to search.
1640
- * @param caseSensitive optionally, if the search should be case sensitive (defaults to false).
1641
- * @param exactMatch optionally, if the text should match the entire value (defaults to false).
1642
- */
1643
- public findPrev(text: string, caseSensitive?: boolean, exactMatch?: boolean): number;
1644
-
1645
-
1646
-
1647
- /**
1648
- * Reapplies the existing search.
1649
- *
1650
- * @remarks
1651
- * Returns how many times the grid contains the last search.
1652
- * @example
1653
- * ```typescript
1654
- * this.grid.refreshSearch();
1655
- * ```
1656
- * @param updateActiveInfo
1657
- */
1658
- public refreshSearch(updateActiveInfo?: boolean, endEdit?: boolean): number;
1659
-
1660
-
1661
-
1662
- /**
1663
- * Removes all the highlights in the cell.
1664
- *
1665
- * @example
1666
- * ```typescript
1667
- * this.grid.clearSearch();
1668
- * ```
1669
- */
1670
- public clearSearch(): void;
1671
-
1672
-
1673
-
1674
- /**
1675
- * Gets calculated width of the pinned areas.
1676
- *
1677
- * @example
1678
- * ```typescript
1679
- * const pinnedWidth = this.grid.getPinnedStartWidth();
1680
- * ```
1681
- * @param takeHidden If we should take into account the hidden columns in the pinned area.
1682
- */
1683
- public getPinnedStartWidth(takeHidden?: boolean): void;
1684
-
1685
-
1686
-
1687
- /**
1688
- * Gets calculated width of the pinned areas.
1689
- *
1690
- * @example
1691
- * ```typescript
1692
- * const pinnedWidth = this.grid.getPinnedEndWidth();
1693
- * ```
1694
- * @param takeHidden If we should take into account the hidden columns in the pinned area.
1695
- */
1696
- public getPinnedEndWidth(takeHidden?: boolean): void;
1697
-
1698
-
1699
-
1700
- /**
1701
- * Select specified rows by ID.
1702
- *
1703
- * @example
1704
- * ```typescript
1705
- * this.grid.selectRows([1,2,5], true);
1706
- * ```
1707
- * @param rowIDs
1708
- * @param clearCurrentSelection if true clears the current selection
1709
- */
1710
- public selectRows(rowIDs: any[], clearCurrentSelection?: boolean): void;
1711
-
1712
-
1713
-
1714
- /**
1715
- * Deselect specified rows by ID.
1716
- *
1717
- * @example
1718
- * ```typescript
1719
- * this.grid.deselectRows([1,2,5]);
1720
- * ```
1721
- * @param rowIDs
1722
- */
1723
- public deselectRows(rowIDs: any[]): void;
1724
-
1725
-
1726
-
1727
- /**
1728
- * Selects all rows
1729
- *
1730
- * @remarks
1731
- * By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.
1732
- * If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows.
1733
- * @example
1734
- * ```typescript
1735
- * this.grid.selectAllRows();
1736
- * this.grid.selectAllRows(false);
1737
- * ```
1738
- * @param onlyFilterData
1739
- */
1740
- public selectAllRows(onlyFilterData?: boolean): void;
1741
-
1742
-
1743
-
1744
- /**
1745
- * Deselects all rows
1746
- *
1747
- * @remarks
1748
- * By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.
1749
- * If you set the parameter onlyFilterData to false that will deselect all rows in the grid exept deleted rows.
1750
- * @example
1751
- * ```typescript
1752
- * this.grid.deselectAllRows();
1753
- * ```
1754
- * @param onlyFilterData
1755
- */
1756
- public deselectAllRows(onlyFilterData?: boolean): void;
1757
-
1758
-
1759
-
1760
- /**
1761
- * Deselect selected cells.
1762
- * @example
1763
- * ```typescript
1764
- * this.grid.clearCellSelection();
1765
- * ```
1766
- */
1767
- public clearCellSelection(): void;
1768
-
1769
-
1770
-
1771
- /**
1772
- * Select range(s) of cells between certain rows and columns of the grid.
1773
- */
1774
- public selectRange(arg: IgcGridSelectionRange[]): void;
1775
-
1776
-
1777
-
1778
- /**
1779
- * Get the currently selected ranges in the grid.
1780
- */
1781
- public getSelectedRanges(): IgcGridSelectionRange[];
1782
-
1783
-
1784
-
1785
- /**
1786
- *
1787
- * Returns an array of the current cell selection in the form of `[{ column.field: cell.value }, ...]`.
1788
- *
1789
- * @remarks
1790
- * If `formatters` is enabled, the cell value will be formatted by its respective column formatter (if any).
1791
- * If `headers` is enabled, it will use the column header (if any) instead of the column field.
1792
- */
1793
- public getSelectedData(formatters?: boolean, headers?: boolean): void;
1794
-
1795
-
1796
-
1797
- /**
1798
- * Get current selected columns.
1799
- *
1800
- * @example
1801
- * Returns an array with selected columns
1802
- * ```typescript
1803
- * const selectedColumns = this.grid.selectedColumns();
1804
- * ```
1805
- */
1806
- public selectedColumns(): IgcColumnComponent[];
1807
-
1808
-
1809
-
1810
- /**
1811
- * Select specified columns.
1812
- *
1813
- * @example
1814
- * ```typescript
1815
- * this.grid.selectColumns(['ID','Name'], true);
1816
- * ```
1817
- * @param columns
1818
- * @param clearCurrentSelection if true clears the current selection
1819
- */
1820
- public selectColumns(columns: string[] | IgcColumnComponent[], clearCurrentSelection?: boolean): void;
1821
-
1822
-
1823
-
1824
- /**
1825
- * Deselect specified columns by field.
1826
- *
1827
- * @example
1828
- * ```typescript
1829
- * this.grid.deselectColumns(['ID','Name']);
1830
- * ```
1831
- * @param columns
1832
- */
1833
- public deselectColumns(columns: string[] | IgcColumnComponent[]): void;
1834
-
1835
-
1836
-
1837
- /**
1838
- * Deselects all columns
1839
- *
1840
- * @example
1841
- * ```typescript
1842
- * this.grid.deselectAllColumns();
1843
- * ```
1844
- */
1845
- public deselectAllColumns(): void;
1846
-
1847
-
1848
-
1849
- /**
1850
- * Selects all columns
1851
- *
1852
- * @example
1853
- * ```typescript
1854
- * this.grid.deselectAllColumns();
1855
- * ```
1856
- */
1857
- public selectAllColumns(): void;
1858
-
1859
-
1860
-
1861
- /**
1862
- *
1863
- * Returns an array of the current columns selection in the form of `[{ column.field: cell.value }, ...]`.
1864
- *
1865
- * @remarks
1866
- * If `formatters` is enabled, the cell value will be formatted by its respective column formatter (if any).
1867
- * If `headers` is enabled, it will use the column header (if any) instead of the column field.
1868
- */
1869
- public getSelectedColumnsData(formatters?: boolean, headers?: boolean): void;
1870
-
1871
-
1872
-
1873
- /* blazorCsSuppress */
1874
- /**
1875
- * Navigates to a position in the grid based on provided `rowindex` and `visibleColumnIndex`.
1876
- *
1877
- * @remarks
1878
- * Also can execute a custom logic over the target element,
1879
- * through a callback function that accepts { targetType: GridKeydownTargetType, target: Object }
1880
- * @example
1881
- * ```typescript
1882
- * this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });
1883
- * ```
1884
- */
1885
- public navigateTo(rowIndex: number, visibleColIndex?: number, cb?: any): void;
1886
-
1887
-
1888
-
1889
- /* blazorCsSuppress */
1890
- /**
1891
- * Returns `ICellPosition` which defines the next cell,
1892
- * according to the current position, that match specific criteria.
1893
- *
1894
- * @remarks
1895
- * You can pass callback function as a third parameter of `getPreviousCell` method.
1896
- * The callback function accepts IgxColumnComponent as a param
1897
- * @example
1898
- * ```typescript
1899
- * const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);
1900
- * ```
1901
- */
1902
- public getNextCell(currRowIndex: number, curVisibleColIndex: number, callback?: any): IgcCellPosition;
1903
-
1904
-
1905
-
1906
- /* blazorCsSuppress */
1907
- /**
1908
- * Returns `ICellPosition` which defines the previous cell,
1909
- * according to the current position, that match specific criteria.
1910
- *
1911
- * @remarks
1912
- * You can pass callback function as a third parameter of `getPreviousCell` method.
1913
- * The callback function accepts IgxColumnComponent as a param
1914
- * @example
1915
- * ```typescript
1916
- * const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);
1917
- * ```
1918
- */
1919
- public getPreviousCell(currRowIndex: number, curVisibleColIndex: number, callback?: any): IgcCellPosition;
1920
-
1921
-
1922
-
1923
- /**
1924
- * Opens the advanced filtering dialog.
1925
- */
1926
- public openAdvancedFilteringDialog(overlaySettings?: IgcOverlaySettings): void;
1927
-
1928
-
1929
-
1930
- /**
1931
- * Closes the advanced filtering dialog.
1932
- *
1933
- * @param applyChanges indicates whether the changes should be applied
1934
- */
1935
- public closeAdvancedFilteringDialog(applyChanges: boolean): void;
1936
-
1937
-
1938
-
1939
- /**
1940
- * Finishes the row transactions on the current row and returns whether the grid editing was canceled.
1941
- *
1942
- * @remarks
1943
- * If `commit === true`, passes them from the pending state to the data (or transaction service)
1944
- * @example
1945
- * ```html
1946
- * <button type="button" igxButton (click)="grid.endEdit(true)">Commit Row</button>
1947
- * ```
1948
- * @param commit
1949
- */
1950
- // TODO: Facade for crud service refactoring. To be removed
1951
- // TODO: do not remove this, as it is used in rowEditTemplate, but mark is as internal and hidden
1952
- /* blazorCSSuppress */
1953
- public endEdit(commit?: boolean, evt?: any): boolean;
1954
-
1955
-
1956
-
1957
- /**
1958
- * Enters add mode by spawning the UI under the specified row by rowID.
1959
- *
1960
- * @remarks
1961
- * If null is passed as rowID, the row adding UI is spawned as the first record in the data view
1962
- * @remarks
1963
- * Spawning the UI to add a child for a record only works if you provide a rowID
1964
- * @example
1965
- * ```typescript
1966
- * this.grid.beginAddRowById('ALFKI');
1967
- * this.grid.beginAddRowById('ALFKI', true);
1968
- * this.grid.beginAddRowById(null);
1969
- * ```
1970
- * @param rowID - The rowID to spawn the add row UI for, or null to spawn it as the first record in the data view
1971
- * @param asChild - Whether the record should be added as a child. Only applicable to igxTreeGrid.
1972
- */
1973
- public beginAddRowById(rowID: any, asChild?: boolean): void;
1974
-
1975
-
1976
-
1977
- /* csSuppress */
1978
- /**
1979
- * Enters add mode by spawning the UI at the specified index.
1980
- *
1981
- * @remarks
1982
- * Accepted values for index are integers from 0 to this.grid.dataView.length
1983
- * @example
1984
- * ```typescript
1985
- * this.grid.beginAddRowByIndex(0);
1986
- * ```
1987
- * @param index - The index to spawn the UI at. Accepts integers from 0 to this.grid.dataView.length
1988
- */
1989
- public beginAddRowByIndex(index: number): void;
1990
-
1991
- }
1992
-
1993
- export declare interface IgcRowIslandComponentEventMap {
1994
-
1995
- /**
1996
- * Event emitted when a grid is being created based on this row island.
1997
- * ```html
1998
- * <igx-hierarchical-grid [data]="Data" [autoGenerate]="true">
1999
- * <igx-row-island [key]="'childData'" (gridCreated)="gridCreated($event)" #rowIsland>
2000
- * <!-- ... -->
2001
- * </igx-row-island>
2002
- * </igx-hierarchical-grid>
2003
- * ```
2004
- *
2005
- * @memberof IgxRowIslandComponent
2006
- */
2007
- gridCreated: CustomEvent<IgcGridCreatedEventArgs>;
2008
-
2009
- /**
2010
- * Emitted after a grid is being initialized for this row island.
2011
- * The emitting is done in `ngAfterViewInit`.
2012
- * ```html
2013
- * <igx-hierarchical-grid [data]="Data" [autoGenerate]="true">
2014
- * <igx-row-island [key]="'childData'" (gridInitialized)="gridInitialized($event)" #rowIsland>
2015
- * <!-- ... -->
2016
- * </igx-row-island>
2017
- * </igx-hierarchical-grid>
2018
- * ```
2019
- *
2020
- * @memberof IgxRowIslandComponent
2021
- */
2022
- gridInitialized: CustomEvent<IgcGridCreatedEventArgs>;
2023
-
2024
- /**
2025
- * Emitted when a new chunk of data is loaded from virtualization.
2026
- *
2027
- * @example
2028
- * ```typescript
2029
- * <igx-hierarchical-grid [id]="'igx-grid-1'" [data]="Data" [autoGenerate]="true" (dataPreLoad)="handleEvent()">
2030
- * </igx-hierarchical-grid>
2031
- * ```
2032
- */
2033
- dataPreLoad: CustomEvent<IgcForOfState>;
2034
-
2035
- /**
2036
- * Emitted after filtering is performed.
2037
- *
2038
- * @remarks
2039
- * Returns the filtering expressions tree of the column for which filtering was performed.
2040
- * @example
2041
- * ```html
2042
- * <igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true"
2043
- * (filteringExpressionsTreeChange)="filteringExprTreeChange($event)"></igx-grid>
2044
- * ```
2045
- */
2046
- filteringExpressionsTreeChange: CustomEvent<IgcFilteringExpressionsTree>;
2047
-
2048
- /**
2049
- * Emitted after advanced filtering is performed.
2050
- *
2051
- * @remarks
2052
- * Returns the advanced filtering expressions tree.
2053
- * @example
2054
- * ```html
2055
- * <igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true"
2056
- * (advancedFilteringExpressionsTreeChange)="advancedFilteringExprTreeChange($event)"></igx-grid>
2057
- * ```
2058
- */
2059
- advancedFilteringExpressionsTreeChange: CustomEvent<IgcFilteringExpressionsTree>;
2060
-
2061
- /**
2062
- * Emitted when grid is scrolled horizontally/vertically.
2063
- *
2064
- * @example
2065
- * ```html
2066
- * <igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true"
2067
- * (gridScroll)="onScroll($event)"></igx-grid>
2068
- * ```
2069
- */
2070
- gridScroll: CustomEvent<IgcGridScrollEventArgs>;
2071
-
2072
- /**
2073
- * Emitted when a cell is clicked.
2074
- *
2075
- * @remarks
2076
- * Returns the `IgxGridCell`.
2077
- * @example
2078
- * ```html
2079
- * <igx-grid #grid (cellClick)="cellClick($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
2080
- * ```
2081
- */
2082
- cellClick: CustomEvent<IgcGridCellEventArgs>;
2083
-
2084
- /**
2085
- * Emitted when a row is clicked.
2086
- *
2087
- * @remarks
2088
- * Returns the `IgxGridRow`.
2089
- * @example
2090
- * ```html
2091
- * <igx-grid #grid (rowClick)="rowClick($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
2092
- * ```
2093
- */
2094
- rowClick: CustomEvent<IgcGridRowEventArgs>;
2095
-
2096
- /**
2097
- * Emitted when formGroup is created on edit of row/cell.
2098
- *
2099
- * @example
2100
- * ```html
2101
- * <igx-grid #grid (formGroupCreated)="formGroupCreated($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
2102
- * ```
2103
- */
2104
- formGroupCreated: CustomEvent<IgcGridFormGroupCreatedEventArgs>;
2105
-
2106
- /**
2107
- * Emitted when grid's validation status changes.
2108
- *
2109
- * @example
2110
- * ```html
2111
- * <igx-grid #grid (validationStatusChange)="validationStatusChange($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
2112
- * ```
2113
- */
2114
- validationStatusChange: CustomEvent<IgcGridValidationStatusEventArgs>;
2115
-
2116
- /**
2117
- * Emitted when a cell is selected.
2118
- *
2119
- * @remarks
2120
- * Returns the `IgxGridCell`.
2121
- * @example
2122
- * ```html
2123
- * <igx-grid #grid (selected)="onCellSelect($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
2124
- * ```
2125
- */
2126
- selected: CustomEvent<IgcGridCellEventArgs>;
2127
-
2128
- /**
2129
- * Emitted when `IgxGridRowComponent` is selected.
2130
- *
2131
- * @example
2132
- * ```html
2133
- * <igx-grid #grid (rowSelectionChanging)="rowSelectionChanging($event)" [data]="localData" [autoGenerate]="true"></igx-grid>
2134
- * ```
2135
- */
2136
- rowSelectionChanging: CustomEvent<IgcRowSelectionEventArgs>;
2137
-
2138
- /**
2139
- * Emitted when `IgxColumnComponent` is selected.
2140
- *
2141
- * @example
2142
- * ```html
2143
- * <igx-grid #grid (columnSelectionChanging)="columnSelectionChanging($event)" [data]="localData" [autoGenerate]="true"></igx-grid>
2144
- * ```
2145
- */
2146
- columnSelectionChanging: CustomEvent<IgcColumnSelectionEventArgs>;
2147
-
2148
- /**
2149
- * Emitted before `IgxColumnComponent` is pinned.
2150
- *
2151
- * @remarks
2152
- * The index at which to insert the column may be changed through the `insertAtIndex` property.
2153
- * @example
2154
- * ```typescript
2155
- * public columnPinning(event) {
2156
- * if (event.column.field === "Name") {
2157
- * event.insertAtIndex = 0;
2158
- * }
2159
- * }
2160
- * ```
2161
- */
2162
- columnPin: CustomEvent<IgcPinColumnCancellableEventArgs>;
2163
-
2164
- /**
2165
- * Emitted after `IgxColumnComponent` is pinned.
2166
- *
2167
- * @remarks
2168
- * The index that the column is inserted at may be changed through the `insertAtIndex` property.
2169
- * @example
2170
- * ```typescript
2171
- * public columnPinning(event) {
2172
- * if (event.column.field === "Name") {
2173
- * event.insertAtIndex = 0;
2174
- * }
2175
- * }
2176
- * ```
2177
- */
2178
- columnPinned: CustomEvent<IgcPinColumnEventArgs>;
2179
-
2180
- /**
2181
- * Emitted when cell enters edit mode.
2182
- *
2183
- * @remarks
2184
- * This event is cancelable.
2185
- * @example
2186
- * ```html
2187
- * <igx-grid #grid3 (cellEditEnter)="editStart($event)" [data]="data" [primaryKey]="'ProductID'">
2188
- * </igx-grid>
2189
- * ```
2190
- */
2191
- cellEditEnter: CustomEvent<IgcGridEditEventArgs>;
2192
-
2193
- /**
2194
- * Emitted when cell exits edit mode.
2195
- *
2196
- * @example
2197
- * ```html
2198
- * <igx-grid #grid3 (cellEditExit)="editExit($event)" [data]="data" [primaryKey]="'ProductID'">
2199
- * </igx-grid>
2200
- * ```
2201
- */
2202
- cellEditExit: CustomEvent<IgcGridEditDoneEventArgs>;
2203
-
2204
- /**
2205
- * Emitted when cell has been edited.
2206
- *
2207
- * @remarks
2208
- * Event is fired after editing is completed, when the cell is exiting edit mode.
2209
- * This event is cancelable.
2210
- * @example
2211
- * ```html
2212
- * <igx-grid #grid3 (cellEdit)="editDone($event)" [data]="data" [primaryKey]="'ProductID'">
2213
- * </igx-grid>
2214
- * ```
2215
- */
2216
- cellEdit: CustomEvent<IgcGridEditEventArgs>;
2217
-
2218
- /* blazorCSSuppress */
2219
- /**
2220
- * Emitted after cell has been edited and editing has been committed.
2221
- *
2222
- * @example
2223
- * ```html
2224
- * <igx-grid #grid3 (cellEditDone)="editDone($event)" [data]="data" [primaryKey]="'ProductID'">
2225
- * </igx-grid>
2226
- * ```
2227
- */
2228
- cellEditDone: CustomEvent<IgcGridEditDoneEventArgs>;
2229
-
2230
- /**
2231
- * Emitted when a row enters edit mode.
2232
- *
2233
- * @remarks
2234
- * Emitted when [rowEditable]="true".
2235
- * This event is cancelable.
2236
- * @example
2237
- * ```html
2238
- * <igx-grid #grid3 (rowEditEnter)="editStart($event)" [primaryKey]="'ProductID'" [rowEditable]="true">
2239
- * </igx-grid>
2240
- * ```
2241
- */
2242
- rowEditEnter: CustomEvent<IgcGridEditEventArgs>;
2243
-
2244
- /**
2245
- * Emitted when exiting edit mode for a row.
2246
- *
2247
- * @remarks
2248
- * Emitted when [rowEditable]="true" & `endEdit(true)` is called.
2249
- * Emitted when changing rows during edit mode, selecting an un-editable cell in the edited row,
2250
- * performing paging operation, column resizing, pinning, moving or hitting `Done`
2251
- * button inside of the rowEditingOverlay, or hitting the `Enter` key while editing a cell.
2252
- * This event is cancelable.
2253
- * @example
2254
- * ```html
2255
- * <igx-grid #grid3 (rowEdit)="editDone($event)" [data]="data" [primaryKey]="'ProductID'" [rowEditable]="true">
2256
- * </igx-grid>
2257
- * ```
2258
- */
2259
- rowEdit: CustomEvent<IgcGridEditEventArgs>;
2260
-
2261
- /**
2262
- * Emitted after exiting edit mode for a row and editing has been committed.
2263
- *
2264
- * @remarks
2265
- * Emitted when [rowEditable]="true" & `endEdit(true)` is called.
2266
- * Emitted when changing rows during edit mode, selecting an un-editable cell in the edited row,
2267
- * performing paging operation, column resizing, pinning, moving or hitting `Done`
2268
- * button inside of the rowEditingOverlay, or hitting the `Enter` key while editing a cell.
2269
- * @example
2270
- * ```html
2271
- * <igx-grid #grid3 (rowEditDone)="editDone($event)" [data]="data" [primaryKey]="'ProductID'" [rowEditable]="true">
2272
- * </igx-grid>
2273
- * ```
2274
- */
2275
- rowEditDone: CustomEvent<IgcGridEditDoneEventArgs>;
2276
-
2277
- /**
2278
- * Emitted when row editing is canceled.
2279
- *
2280
- * @remarks
2281
- * Emits when [rowEditable]="true" & `endEdit(false)` is called.
2282
- * Emitted when changing hitting `Esc` key during cell editing and when click on the `Cancel` button
2283
- * in the row editing overlay.
2284
- * @example
2285
- * ```html
2286
- * <igx-grid #grid3 (rowEditExit)="editExit($event)" [data]="data" [primaryKey]="'ProductID'" [rowEditable]="true">
2287
- * </igx-grid>
2288
- * ```
2289
- */
2290
- rowEditExit: CustomEvent<IgcGridEditDoneEventArgs>;
2291
-
2292
- /**
2293
- * Emitted when a column is initialized.
2294
- *
2295
- * @remarks
2296
- * Returns the column object.
2297
- * @example
2298
- * ```html
2299
- * <igx-grid #grid [data]="localData" (columnInit)="initColumns($event)" [autoGenerate]="true"></igx-grid>
2300
- * ```
2301
- */
2302
- columnInit: CustomEvent<IgcColumnComponent>;
2303
-
2304
- /* blazorInclude */
2305
- /**
2306
- * @hidden @internal
2307
- */
2308
- columnsAutogenerated: CustomEvent<IgcColumnsAutoGeneratedEventArgs>;
2309
-
2310
- /**
2311
- * Emitted before sorting expressions are applied.
2312
- *
2313
- * @remarks
2314
- * Returns an `ISortingEventArgs` object. `sortingExpressions` key holds the sorting expressions.
2315
- * @example
2316
- * ```html
2317
- * <igx-grid #grid [data]="localData" [autoGenerate]="true" (sorting)="sorting($event)"></igx-grid>
2318
- * ```
2319
- */
2320
- sorting: CustomEvent<IgcSortingEventArgs>;
2321
-
2322
- /**
2323
- * Emitted after sorting is completed.
2324
- *
2325
- * @remarks
2326
- * Returns the sorting expression.
2327
- * @example
2328
- * ```html
2329
- * <igx-grid #grid [data]="localData" [autoGenerate]="true" (sortingDone)="sortingDone($event)"></igx-grid>
2330
- * ```
2331
- */
2332
- sortingDone: CustomEvent<IgcSortingExpression[]>;
2333
-
2334
- /**
2335
- * Emitted before filtering expressions are applied.
2336
- *
2337
- * @remarks
2338
- * Returns an `IFilteringEventArgs` object. `filteringExpressions` key holds the filtering expressions for the column.
2339
- * @example
2340
- * ```html
2341
- * <igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true" (filtering)="filtering($event)"></igx-grid>
2342
- * ```
2343
- */
2344
- filtering: CustomEvent<IgcFilteringEventArgs>;
2345
-
2346
- /**
2347
- * Emitted after filtering is performed through the UI.
2348
- *
2349
- * @remarks
2350
- * Returns the filtering expressions tree of the column for which filtering was performed.
2351
- * @example
2352
- * ```html
2353
- * <igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true" (filteringDone)="filteringDone($event)"></igx-grid>
2354
- * ```
2355
- */
2356
- filteringDone: CustomEvent<IgcFilteringExpressionsTree>;
2357
-
2358
- /* blazorCSSuppress */
2359
- /**
2360
- * Emitted when a row is added.
2361
- *
2362
- * @remarks
2363
- * Returns the data for the new `IgxGridRowComponent` object.
2364
- * @example
2365
- * ```html
2366
- * <igx-grid #grid [data]="localData" (rowAdded)="rowAdded($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>
2367
- * ```
2368
- */
2369
- rowAdded: CustomEvent<IgcRowDataEventArgs>;
2370
-
2371
- /* blazorCSSuppress */
2372
- /**
2373
- * Emitted when a row is deleted.
2374
- *
2375
- * @remarks
2376
- * Returns an `IRowDataEventArgs` object.
2377
- * @example
2378
- * ```html
2379
- * <igx-grid #grid [data]="localData" (rowDeleted)="rowDeleted($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>
2380
- * ```
2381
- */
2382
- rowDeleted: CustomEvent<IgcRowDataEventArgs>;
2383
-
2384
- /**
2385
- * Emmited when deleting a row.
2386
- *
2387
- * @remarks
2388
- * This event is cancelable.
2389
- * Returns an IRowDataCancellableEventArgs` object.
2390
- * @example
2391
- * ```html
2392
- * <igx-grid #grid [data]="localData" (rowDelete)="rowDelete($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>
2393
- * ```
2394
- */
2395
- rowDelete: CustomEvent<IgcRowDataCancelableEventArgs>;
2396
-
2397
- /**
2398
- * Emmited just before the newly added row is commited.
2399
- *
2400
- * @remarks
2401
- * This event is cancelable.
2402
- * Returns an IRowDataCancellableEventArgs` object.
2403
- * @example
2404
- * ```html
2405
- * <igx-grid #grid [data]="localData" (rowAdd)="rowAdd($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>
2406
- * ```
2407
- */
2408
- rowAdd: CustomEvent<IgcRowDataCancelableEventArgs>;
2409
-
2410
- /**
2411
- * Emitted after column is resized.
2412
- *
2413
- * @remarks
2414
- * Returns the `IgxColumnComponent` object's old and new width.
2415
- * @example
2416
- * ```html
2417
- * <igx-grid #grid [data]="localData" (columnResized)="resizing($event)" [autoGenerate]="true"></igx-grid>
2418
- * ```
2419
- */
2420
- columnResized: CustomEvent<IgcColumnResizeEventArgs>;
2421
-
2422
- /**
2423
- * Emitted when a cell or row is right clicked.
2424
- *
2425
- * @remarks
2426
- * Returns the `IgxGridCell` object if the immediate context menu target is a cell or an `IgxGridRow` otherwise.
2427
- * ```html
2428
- * <igx-grid #grid [data]="localData" (contextMenu)="contextMenu($event)" [autoGenerate]="true"></igx-grid>
2429
- * ```
2430
- */
2431
- contextMenu: CustomEvent<IgcGridContextMenuEventArgs>;
2432
-
2433
- /**
2434
- * Emitted when a cell is double clicked.
2435
- *
2436
- * @remarks
2437
- * Returns the `IgxGridCell` object.
2438
- * @example
2439
- * ```html
2440
- * <igx-grid #grid [data]="localData" (doubleClick)="dblClick($event)" [autoGenerate]="true"></igx-grid>
2441
- * ```
2442
- */
2443
- doubleClick: CustomEvent<IgcGridCellEventArgs>;
2444
-
2445
- /**
2446
- * Emitted before column visibility is changed.
2447
- *
2448
- * @remarks
2449
- * Args: { column: any, newValue: boolean }
2450
- * @example
2451
- * ```html
2452
- * <igx-grid (columnVisibilityChanging)="visibilityChanging($event)"></igx-grid>
2453
- * ```
2454
- */
2455
- columnVisibilityChanging: CustomEvent<IgcColumnVisibilityChangingEventArgs>;
2456
-
2457
- /**
2458
- * Emitted after column visibility is changed.
2459
- *
2460
- * @remarks
2461
- * Args: { column: IgxColumnComponent, newValue: boolean }
2462
- * @example
2463
- * ```html
2464
- * <igx-grid (columnVisibilityChanged)="visibilityChanged($event)"></igx-grid>
2465
- * ```
2466
- */
2467
- columnVisibilityChanged: CustomEvent<IgcColumnVisibilityChangedEventArgs>;
2468
-
2469
- /**
2470
- * Emitted when column moving starts.
2471
- *
2472
- * @remarks
2473
- * Returns the moved `IgxColumnComponent` object.
2474
- * @example
2475
- * ```html
2476
- * <igx-grid (columnMovingStart)="movingStart($event)"></igx-grid>
2477
- * ```
2478
- */
2479
- columnMovingStart: CustomEvent<IgcColumnMovingStartEventArgs>;
2480
-
2481
- /**
2482
- * Emitted during the column moving operation.
2483
- *
2484
- * @remarks
2485
- * Returns the source and target `IgxColumnComponent` objects. This event is cancelable.
2486
- * @example
2487
- * ```html
2488
- * <igx-grid (columnMoving)="moving($event)"></igx-grid>
2489
- * ```
2490
- */
2491
- columnMoving: CustomEvent<IgcColumnMovingEventArgs>;
2492
-
2493
- /**
2494
- * Emitted when column moving ends.
2495
- *
2496
- * @remarks
2497
- * Returns the source and target `IgxColumnComponent` objects.
2498
- * @example
2499
- * ```html
2500
- * <igx-grid (columnMovingEnd)="movingEnds($event)"></igx-grid>
2501
- * ```
2502
- */
2503
- columnMovingEnd: CustomEvent<IgcColumnMovingEndEventArgs>;
2504
-
2505
- /**
2506
- * Emitted when keydown is triggered over element inside grid's body.
2507
- *
2508
- * @remarks
2509
- * This event is fired only if the key combination is supported in the grid.
2510
- * Return the target type, target object and the original event. This event is cancelable.
2511
- * @example
2512
- * ```html
2513
- * <igx-grid (gridKeydown)="customKeydown($event)"></igx-grid>
2514
- * ```
2515
- */
2516
- gridKeydown: CustomEvent<IgcGridKeydownEventArgs>;
2517
-
2518
- /**
2519
- * Emitted when start dragging a row.
2520
- *
2521
- * @remarks
2522
- * Return the dragged row.
2523
- */
2524
- rowDragStart: CustomEvent<IgcRowDragStartEventArgs>;
2525
-
2526
- /**
2527
- * Emitted when dropping a row.
2528
- *
2529
- * @remarks
2530
- * Return the dropped row.
2531
- */
2532
- rowDragEnd: CustomEvent<IgcRowDragEndEventArgs>;
2533
-
2534
- /**
2535
- * Emitted when a copy operation is executed.
2536
- *
2537
- * @remarks
2538
- * Fired only if copy behavior is enabled through the [`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions}.
2539
- */
2540
- gridCopy: CustomEvent<IgcGridClipboardEvent>;
2541
-
2542
- /* blazorCSSuppress */
2543
- /**
2544
- * Emitted when the rows are expanded or collapsed.
2545
- *
2546
- * @example
2547
- * ```html
2548
- * <igx-grid [data]="employeeData" (expansionStatesChange)="expansionStatesChange($event)" [autoGenerate]="true"></igx-grid>
2549
- * ```
2550
- */
2551
- expansionStatesChange: CustomEvent<Map<any, boolean>>;
2552
-
2553
- /* blazorInclude */
2554
- /**
2555
- * Emitted when the rows are selected or deselected.
2556
- *
2557
- * @example
2558
- * ```html
2559
- * <igx-grid [data]="employeeData" (selectedRowsChange)="selectedRowsChange($event)" [autoGenerate]="true"></igx-grid>
2560
- * ```
2561
- */
2562
- selectedRowsChange: CustomEvent<any[]>;
2563
-
2564
- /**
2565
- * Emitted when the expanded state of a row gets changed.
2566
- *
2567
- * @example
2568
- * ```html
2569
- * <igx-grid [data]="employeeData" (rowToggle)="rowToggle($event)" [autoGenerate]="true"></igx-grid>
2570
- * ```
2571
- */
2572
- rowToggle: CustomEvent<IgcRowToggleEventArgs>;
2573
-
2574
- /**
2575
- * Emitted when the pinned state of a row is changed.
2576
- *
2577
- * @example
2578
- * ```html
2579
- * <igx-grid [data]="employeeData" (rowPinning)="rowPin($event)" [autoGenerate]="true"></igx-grid>
2580
- * ```
2581
- */
2582
- rowPinning: CustomEvent<IgcPinRowEventArgs>;
2583
-
2584
- /**
2585
- * Emitted when the pinned state of a row is changed.
2586
- *
2587
- * @example
2588
- * ```html
2589
- * <igx-grid [data]="employeeData" (rowPinned)="rowPin($event)" [autoGenerate]="true"></igx-grid>
2590
- * ```
2591
- */
2592
- rowPinned: CustomEvent<IgcPinRowEventArgs>;
2593
-
2594
- /**
2595
- * Emitted when the active node is changed.
2596
- *
2597
- * @example
2598
- * ```
2599
- * <igx-grid [data]="data" [autoGenerate]="true" (activeNodeChange)="activeNodeChange($event)"></igx-grid>
2600
- * ```
2601
- */
2602
- activeNodeChange: CustomEvent<IgcActiveNodeChangeEventArgs>;
2603
-
2604
- /**
2605
- * Emitted before sorting is performed.
2606
- *
2607
- * @remarks
2608
- * Returns the sorting expressions.
2609
- * @example
2610
- * ```html
2611
- * <igx-grid #grid [data]="localData" [autoGenerate]="true" (sortingExpressionsChange)="sortingExprChange($event)"></igx-grid>
2612
- * ```
2613
- */
2614
- sortingExpressionsChange: CustomEvent<IgcSortingExpression[]>;
2615
-
2616
- /**
2617
- * Emitted when an export process is initiated by the user.
2618
- *
2619
- * @example
2620
- * ```typescript
2621
- * toolbarExporting(event: IGridToolbarExportEventArgs){
2622
- * const toolbarExporting = event;
2623
- * }
2624
- * ```
2625
- */
2626
- toolbarExporting: CustomEvent<IgcGridToolbarExportEventArgs>;
2627
-
2628
- /* End of toolbar related definitions */
2629
- /**
2630
- * Emitted when making a range selection.
2631
- *
2632
- * @remarks
2633
- * Range selection can be made either through drag selection or through keyboard selection.
2634
- */
2635
- rangeSelected: CustomEvent<IgcGridSelectionRange>;
2636
-
2637
- /** Emitted after the ngAfterViewInit hook. At this point the grid exists in the DOM */
2638
- rendered: CustomEvent<boolean>;
2639
-
2640
- /**
2641
- * Emitted before the grid's data view is changed because of a data operation, rebinding, etc.
2642
- *
2643
- * @example
2644
- * ```typescript
2645
- * <igx-grid #grid [data]="localData" [autoGenerate]="true" (dataChanging)='handleDataChangingEvent()'></igx-grid>
2646
- * ```
2647
- */
2648
- dataChanging: CustomEvent<IgcForOfDataChangeEventArgs>;
2649
-
2650
- /**
2651
- * Emitted after the grid's data view is changed because of a data operation, rebinding, etc.
2652
- *
2653
- * @example
2654
- * ```typescript
2655
- * <igx-grid #grid [data]="localData" [autoGenerate]="true" (dataChanged)='handleDataChangedEvent()'></igx-grid>
2656
- * ```
2657
- */
2658
- dataChanged: CustomEvent<IgcForOfDataChangeEventArgs>;
2659
-
2660
- }
2661
-