@progress/kendo-angular-grid 19.1.2-develop.4 → 19.1.2-develop.5

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 (322) hide show
  1. package/adaptiveness/adaptive-mode.d.ts +1 -5
  2. package/aggregates/aggregate-types.d.ts +6 -6
  3. package/aggregates/status-bar-template.directive.d.ts +6 -4
  4. package/column-menu/column-locked-change-event.d.ts +1 -1
  5. package/column-menu/column-menu-autosize-all.component.d.ts +11 -2
  6. package/column-menu/column-menu-autosize.component.d.ts +14 -6
  7. package/column-menu/column-menu-chooser.component.d.ts +13 -5
  8. package/column-menu/column-menu-expandable-item.interface.d.ts +3 -3
  9. package/column-menu/column-menu-filter.component.d.ts +18 -5
  10. package/column-menu/column-menu-item-base.d.ts +2 -2
  11. package/column-menu/column-menu-item-content-template.directive.d.ts +4 -4
  12. package/column-menu/column-menu-item.component.d.ts +14 -7
  13. package/column-menu/column-menu-item.directive.d.ts +29 -1
  14. package/column-menu/column-menu-lock.component.d.ts +11 -3
  15. package/column-menu/column-menu-position.component.d.ts +16 -8
  16. package/column-menu/column-menu-settings.interface.d.ts +5 -4
  17. package/column-menu/column-menu-sort.component.d.ts +11 -9
  18. package/column-menu/column-menu-stick.component.d.ts +13 -5
  19. package/column-menu/column-menu-template.directive.d.ts +5 -7
  20. package/column-menu/column-menu.component.d.ts +17 -7
  21. package/column-menu/column-menu.service.d.ts +8 -9
  22. package/column-resizing/column-resize.interface.d.ts +9 -8
  23. package/columns/cell-rowspan.d.ts +5 -1
  24. package/columns/checkbox-column.component.d.ts +7 -5
  25. package/columns/column-base.d.ts +38 -52
  26. package/columns/column-group.component.d.ts +3 -2
  27. package/columns/column.component.d.ts +17 -12
  28. package/columns/command-column.component.d.ts +6 -7
  29. package/columns/reorder-column.component.d.ts +10 -2
  30. package/columns/sort-settings.d.ts +15 -18
  31. package/columns/span-column.component.d.ts +11 -11
  32. package/common/adaptiveness.service.d.ts +2 -2
  33. package/common/cell-click-event-args.interface.d.ts +8 -6
  34. package/common/clipboard-types.d.ts +27 -31
  35. package/common/clipboard.directive.d.ts +12 -8
  36. package/common/create-form-group.d.ts +3 -1
  37. package/common/fetch-data-callback.d.ts +4 -2
  38. package/common/field-datatype.d.ts +2 -2
  39. package/common/pager-settings.d.ts +36 -20
  40. package/common/preventable-event.d.ts +3 -7
  41. package/common/remove-confirmation.d.ts +12 -0
  42. package/common/resizable-settings.d.ts +6 -5
  43. package/common/single-popup.service.d.ts +7 -4
  44. package/common/size-options.d.ts +2 -1
  45. package/data/change-event-args.interface.d.ts +7 -7
  46. package/data/data-item.interface.d.ts +6 -6
  47. package/data/data.collection.d.ts +1 -1
  48. package/data/grid-item.interface.d.ts +1 -1
  49. package/data/group-footer-item.interface.d.ts +6 -6
  50. package/data/group-item.interface.d.ts +5 -5
  51. package/databinding.directive.d.ts +20 -10
  52. package/directives.d.ts +10 -1
  53. package/dragdrop/column-reorder-config.d.ts +2 -2
  54. package/dragdrop/column-reorder-event.d.ts +4 -6
  55. package/editing/add-command-tool.directive.d.ts +5 -7
  56. package/editing/add-command.directive.d.ts +3 -8
  57. package/editing/add-event-args.interface.d.ts +1 -1
  58. package/editing/cancel-command-tool.directive.d.ts +5 -5
  59. package/editing/cancel-command.directive.d.ts +6 -5
  60. package/editing/cancel-event-args.interface.d.ts +7 -1
  61. package/editing/cell-close-event.d.ts +9 -6
  62. package/editing/edit-command-tool.directive.d.ts +10 -9
  63. package/editing/edit-command.directive.d.ts +1 -1
  64. package/editing/edit-event-args.interface.d.ts +3 -3
  65. package/editing/edit-row-options.interface.d.ts +10 -4
  66. package/editing/edit-template.directive.d.ts +17 -9
  67. package/editing/form/models.d.ts +55 -48
  68. package/editing/remove-command-tool.directive.d.ts +10 -9
  69. package/editing/remove-command.directive.d.ts +4 -5
  70. package/editing/remove-event-args.interface.d.ts +2 -1
  71. package/editing/save-command-tool.directive.d.ts +7 -6
  72. package/editing/save-command.directive.d.ts +5 -5
  73. package/editing/save-event-args.interface.d.ts +2 -1
  74. package/editing-directives/create-form-group-args.interface.d.ts +1 -1
  75. package/editing-directives/edit-service.interface.d.ts +13 -6
  76. package/editing-directives/external-editing.directive.d.ts +11 -4
  77. package/editing-directives/in-cell-editing.directive.d.ts +9 -3
  78. package/editing-directives/reactive-editing.directive.d.ts +9 -3
  79. package/editing-directives/template-editing.directive.d.ts +9 -3
  80. package/esm2022/aggregates/status-bar-template.directive.mjs +6 -4
  81. package/esm2022/column-menu/column-locked-change-event.mjs +1 -1
  82. package/esm2022/column-menu/column-menu-autosize-all.component.mjs +11 -2
  83. package/esm2022/column-menu/column-menu-autosize.component.mjs +14 -6
  84. package/esm2022/column-menu/column-menu-chooser.component.mjs +13 -5
  85. package/esm2022/column-menu/column-menu-filter.component.mjs +18 -5
  86. package/esm2022/column-menu/column-menu-item-base.mjs +2 -2
  87. package/esm2022/column-menu/column-menu-item-content-template.directive.mjs +4 -4
  88. package/esm2022/column-menu/column-menu-item.component.mjs +14 -7
  89. package/esm2022/column-menu/column-menu-item.directive.mjs +29 -1
  90. package/esm2022/column-menu/column-menu-lock.component.mjs +11 -3
  91. package/esm2022/column-menu/column-menu-position.component.mjs +16 -8
  92. package/esm2022/column-menu/column-menu-sort.component.mjs +11 -9
  93. package/esm2022/column-menu/column-menu-stick.component.mjs +13 -5
  94. package/esm2022/column-menu/column-menu-template.directive.mjs +5 -7
  95. package/esm2022/column-menu/column-menu.component.mjs +17 -7
  96. package/esm2022/column-menu/column-menu.service.mjs +8 -9
  97. package/esm2022/columns/checkbox-column.component.mjs +7 -5
  98. package/esm2022/columns/column-base.mjs +38 -52
  99. package/esm2022/columns/column-group.component.mjs +3 -2
  100. package/esm2022/columns/column.component.mjs +17 -12
  101. package/esm2022/columns/command-column.component.mjs +6 -7
  102. package/esm2022/columns/reorder-column.component.mjs +10 -2
  103. package/esm2022/columns/span-column.component.mjs +11 -11
  104. package/esm2022/common/adaptiveness.service.mjs +2 -2
  105. package/esm2022/common/clipboard.directive.mjs +12 -8
  106. package/esm2022/common/preventable-event.mjs +3 -7
  107. package/esm2022/common/resizable-settings.mjs +2 -1
  108. package/esm2022/common/single-popup.service.mjs +7 -4
  109. package/esm2022/databinding.directive.mjs +20 -10
  110. package/esm2022/directives.mjs +10 -1
  111. package/esm2022/dragdrop/column-reorder-event.mjs +4 -6
  112. package/esm2022/editing/add-command-tool.directive.mjs +5 -7
  113. package/esm2022/editing/add-command.directive.mjs +3 -8
  114. package/esm2022/editing/cancel-command-tool.directive.mjs +5 -5
  115. package/esm2022/editing/cancel-command.directive.mjs +6 -5
  116. package/esm2022/editing/cell-close-event.mjs +7 -4
  117. package/esm2022/editing/edit-command-tool.directive.mjs +10 -9
  118. package/esm2022/editing/edit-command.directive.mjs +1 -1
  119. package/esm2022/editing/edit-template.directive.mjs +17 -9
  120. package/esm2022/editing/remove-command-tool.directive.mjs +10 -9
  121. package/esm2022/editing/remove-command.directive.mjs +4 -5
  122. package/esm2022/editing/save-command-tool.directive.mjs +7 -6
  123. package/esm2022/editing/save-command.directive.mjs +5 -5
  124. package/esm2022/editing-directives/external-editing.directive.mjs +11 -4
  125. package/esm2022/editing-directives/in-cell-editing.directive.mjs +9 -3
  126. package/esm2022/editing-directives/reactive-editing.directive.mjs +9 -3
  127. package/esm2022/editing-directives/template-editing.directive.mjs +9 -3
  128. package/esm2022/excel/excel-command-tool.directive.mjs +10 -13
  129. package/esm2022/excel/excel-command.directive.mjs +7 -11
  130. package/esm2022/excel/excel-export-event.mjs +4 -1
  131. package/esm2022/excel/excel.component.mjs +24 -25
  132. package/esm2022/excel/excel.module.mjs +4 -7
  133. package/esm2022/filtering/boolean-filter.component.mjs +3 -3
  134. package/esm2022/filtering/cell/boolean-filter-cell.component.mjs +1 -2
  135. package/esm2022/filtering/cell/date-filter-cell.component.mjs +5 -2
  136. package/esm2022/filtering/cell/filter-cell-operators.component.mjs +10 -7
  137. package/esm2022/filtering/cell/filter-cell-template.directive.mjs +4 -2
  138. package/esm2022/filtering/cell/numeric-filter-cell.component.mjs +10 -9
  139. package/esm2022/filtering/cell/string-filter-cell.component.mjs +7 -5
  140. package/esm2022/filtering/date-filter.component.mjs +17 -19
  141. package/esm2022/filtering/filter.service.mjs +4 -4
  142. package/esm2022/filtering/menu/boolean-filter-menu.component.mjs +3 -3
  143. package/esm2022/filtering/menu/date-filter-menu.component.mjs +5 -3
  144. package/esm2022/filtering/menu/filter-menu-template.directive.mjs +9 -7
  145. package/esm2022/filtering/menu/numeric-filter-menu-input.component.mjs +8 -8
  146. package/esm2022/filtering/menu/numeric-filter-menu.component.mjs +10 -6
  147. package/esm2022/filtering/menu/string-filter-menu.component.mjs +10 -5
  148. package/esm2022/filtering/numeric-filter.component.mjs +13 -13
  149. package/esm2022/filtering/operators/after-eq-filter-operator.component.mjs +26 -0
  150. package/esm2022/filtering/operators/after-filter-operator.component.mjs +26 -0
  151. package/esm2022/filtering/operators/before-eq-filter-operator.component.mjs +26 -0
  152. package/esm2022/filtering/operators/before-filter-operator.component.mjs +26 -0
  153. package/esm2022/filtering/operators/contains-filter-operator.component.mjs +27 -1
  154. package/esm2022/filtering/operators/ends-with-filter-operator.component.mjs +26 -1
  155. package/esm2022/filtering/operators/eq-filter-operator.component.mjs +74 -1
  156. package/esm2022/filtering/operators/gt-filter-operator.component.mjs +26 -0
  157. package/esm2022/filtering/operators/gte-filter-operator.component.mjs +26 -0
  158. package/esm2022/filtering/operators/is-empty-filter-operator.component.mjs +26 -1
  159. package/esm2022/filtering/operators/is-not-empty-filter-operator.component.mjs +26 -1
  160. package/esm2022/filtering/operators/is-not-null-filter-operator.component.mjs +73 -1
  161. package/esm2022/filtering/operators/isnull-filter-operator.component.mjs +73 -1
  162. package/esm2022/filtering/operators/lt-filter-operator.component.mjs +26 -1
  163. package/esm2022/filtering/operators/lte-filter-operator.component.mjs +26 -1
  164. package/esm2022/filtering/operators/neq-filter-operator.component.mjs +73 -1
  165. package/esm2022/filtering/operators/not-contains-filter-operator.component.mjs +26 -1
  166. package/esm2022/filtering/operators/starts-with-filter-operator.component.mjs +26 -1
  167. package/esm2022/filtering/string-filter.component.mjs +5 -4
  168. package/esm2022/grid.component.mjs +159 -173
  169. package/esm2022/grid.module.mjs +3 -2
  170. package/esm2022/grouping/group-footer-template.directive.mjs +5 -6
  171. package/esm2022/grouping/group-header-column-template.directive.mjs +5 -5
  172. package/esm2022/grouping/group-header-template.directive.mjs +5 -6
  173. package/esm2022/grouping/group-scroll-binding.directive.mjs +2 -0
  174. package/esm2022/localization/custom-messages.component.mjs +12 -2
  175. package/esm2022/localization/messages.mjs +154 -165
  176. package/esm2022/navigation/focus-group.mjs +2 -2
  177. package/esm2022/navigation/focusable.directive.mjs +5 -3
  178. package/esm2022/package-metadata.mjs +2 -2
  179. package/esm2022/pdf/pdf-command-tool.directive.mjs +8 -11
  180. package/esm2022/pdf/pdf-command.directive.mjs +5 -9
  181. package/esm2022/pdf/pdf-export-event.mjs +1 -1
  182. package/esm2022/pdf/pdf-margin.component.mjs +16 -6
  183. package/esm2022/pdf/pdf-template.directive.mjs +5 -5
  184. package/esm2022/pdf/pdf.component.mjs +15 -5
  185. package/esm2022/pdf/pdf.module.mjs +3 -6
  186. package/esm2022/rendering/cell-loading.template.directive.mjs +4 -7
  187. package/esm2022/rendering/cell-template.directive.mjs +7 -8
  188. package/esm2022/rendering/common/spacer.component.mjs +14 -3
  189. package/esm2022/rendering/details/detail-collapse-event.mjs +8 -3
  190. package/esm2022/rendering/details/detail-expand-event.mjs +8 -3
  191. package/esm2022/rendering/details/detail-template.directive.mjs +3 -2
  192. package/esm2022/rendering/details-expand.directive.mjs +18 -8
  193. package/esm2022/rendering/footer/footer-template.directive.mjs +7 -7
  194. package/esm2022/rendering/groups-expand.directive.mjs +15 -5
  195. package/esm2022/rendering/header/header-template.directive.mjs +11 -11
  196. package/esm2022/rendering/loading-template.directive.mjs +14 -3
  197. package/esm2022/rendering/no-records-template.directive.mjs +3 -5
  198. package/esm2022/rendering/table-body.component.mjs +3 -1
  199. package/esm2022/rendering/toolbar/toolbar-focusable.directive.mjs +10 -2
  200. package/esm2022/rendering/toolbar/toolbar-position.mjs +0 -17
  201. package/esm2022/rendering/toolbar/toolbar-template.directive.mjs +3 -3
  202. package/esm2022/rendering/toolbar/tools/column-chooser-tool.directive.mjs +6 -5
  203. package/esm2022/rendering/toolbar/tools/filter-command-tool.directive.mjs +5 -5
  204. package/esm2022/rendering/toolbar/tools/group-command-tool.directive.mjs +5 -3
  205. package/esm2022/rendering/toolbar/tools/sort-command-tool.directive.mjs +4 -4
  206. package/esm2022/row-reordering/drag-handle-template.directive.mjs +5 -6
  207. package/esm2022/row-reordering/drag-hint-template.directive.mjs +3 -5
  208. package/esm2022/selection/selectall-checkbox.directive.mjs +2 -2
  209. package/esm2022/selection/selection-checkbox.directive.mjs +9 -8
  210. package/esm2022/selection/selection-default.mjs +9 -8
  211. package/esm2022/selection/selection.directive.mjs +10 -1
  212. package/esm2022/state-management/grid-state.models.mjs +3 -3
  213. package/esm2022/state-management/redo-command-tool.mjs +17 -9
  214. package/esm2022/state-management/undo-command-tool.mjs +17 -9
  215. package/esm2022/state-management/undo-redo.directive.mjs +17 -6
  216. package/excel/excel-command-tool.directive.d.ts +10 -13
  217. package/excel/excel-command.directive.d.ts +7 -11
  218. package/excel/excel-export-event.d.ts +4 -1
  219. package/excel/excel.component.d.ts +24 -25
  220. package/excel/excel.module.d.ts +4 -7
  221. package/fesm2022/progress-kendo-angular-grid.mjs +1939 -1025
  222. package/filtering/boolean-filter.component.d.ts +3 -3
  223. package/filtering/cell/boolean-filter-cell.component.d.ts +1 -2
  224. package/filtering/cell/date-filter-cell.component.d.ts +5 -2
  225. package/filtering/cell/filter-cell-operators.component.d.ts +10 -7
  226. package/filtering/cell/filter-cell-template.directive.d.ts +4 -2
  227. package/filtering/cell/numeric-filter-cell.component.d.ts +10 -9
  228. package/filtering/cell/string-filter-cell.component.d.ts +7 -5
  229. package/filtering/date-filter.component.d.ts +17 -19
  230. package/filtering/filter.service.d.ts +4 -4
  231. package/filtering/filterable.d.ts +5 -5
  232. package/filtering/menu/boolean-filter-menu.component.d.ts +3 -3
  233. package/filtering/menu/date-filter-menu.component.d.ts +5 -3
  234. package/filtering/menu/filter-menu-template.directive.d.ts +9 -7
  235. package/filtering/menu/numeric-filter-menu-input.component.d.ts +8 -8
  236. package/filtering/menu/numeric-filter-menu.component.d.ts +10 -6
  237. package/filtering/menu/string-filter-menu.component.d.ts +10 -5
  238. package/filtering/numeric-filter.component.d.ts +13 -13
  239. package/filtering/operators/after-eq-filter-operator.component.d.ts +26 -0
  240. package/filtering/operators/after-filter-operator.component.d.ts +26 -0
  241. package/filtering/operators/before-eq-filter-operator.component.d.ts +26 -0
  242. package/filtering/operators/before-filter-operator.component.d.ts +26 -0
  243. package/filtering/operators/contains-filter-operator.component.d.ts +27 -1
  244. package/filtering/operators/ends-with-filter-operator.component.d.ts +26 -1
  245. package/filtering/operators/eq-filter-operator.component.d.ts +74 -1
  246. package/filtering/operators/gt-filter-operator.component.d.ts +26 -0
  247. package/filtering/operators/gte-filter-operator.component.d.ts +26 -0
  248. package/filtering/operators/is-empty-filter-operator.component.d.ts +26 -1
  249. package/filtering/operators/is-not-empty-filter-operator.component.d.ts +26 -1
  250. package/filtering/operators/is-not-null-filter-operator.component.d.ts +73 -1
  251. package/filtering/operators/isnull-filter-operator.component.d.ts +73 -1
  252. package/filtering/operators/lt-filter-operator.component.d.ts +26 -1
  253. package/filtering/operators/lte-filter-operator.component.d.ts +26 -1
  254. package/filtering/operators/neq-filter-operator.component.d.ts +73 -1
  255. package/filtering/operators/not-contains-filter-operator.component.d.ts +26 -1
  256. package/filtering/operators/starts-with-filter-operator.component.d.ts +26 -1
  257. package/filtering/string-filter.component.d.ts +5 -4
  258. package/grid.component.d.ts +159 -173
  259. package/grid.module.d.ts +3 -2
  260. package/grouping/group-footer-template.directive.d.ts +5 -6
  261. package/grouping/group-header-column-template.directive.d.ts +5 -5
  262. package/grouping/group-header-template.directive.d.ts +5 -6
  263. package/grouping/group-key.interface.d.ts +7 -7
  264. package/grouping/group-rows-args.interface.d.ts +5 -5
  265. package/grouping/group-scroll-binding.directive.d.ts +2 -0
  266. package/grouping/group-settings.d.ts +7 -7
  267. package/grouping/virtual-group-result.interface.d.ts +3 -3
  268. package/localization/custom-messages.component.d.ts +12 -2
  269. package/localization/messages.d.ts +154 -165
  270. package/navigation/focus-group.d.ts +2 -2
  271. package/navigation/focusable-element.interface.d.ts +8 -9
  272. package/navigation/focusable.directive.d.ts +5 -3
  273. package/navigation/navigable-settings.d.ts +10 -5
  274. package/navigation/navigation-cell.interface.d.ts +8 -8
  275. package/navigation/navigation-row.interface.d.ts +6 -7
  276. package/package.json +20 -20
  277. package/pdf/pdf-command-tool.directive.d.ts +8 -11
  278. package/pdf/pdf-command.directive.d.ts +5 -9
  279. package/pdf/pdf-export-event.d.ts +1 -1
  280. package/pdf/pdf-margin.component.d.ts +16 -6
  281. package/pdf/pdf-margin.interface.d.ts +2 -2
  282. package/pdf/pdf-template.directive.d.ts +5 -5
  283. package/pdf/pdf.component.d.ts +15 -5
  284. package/pdf/pdf.module.d.ts +3 -6
  285. package/rendering/cell-loading.template.directive.d.ts +4 -7
  286. package/rendering/cell-template.directive.d.ts +7 -8
  287. package/rendering/common/row-args.d.ts +2 -0
  288. package/rendering/common/row-class.d.ts +20 -21
  289. package/rendering/common/spacer.component.d.ts +14 -3
  290. package/rendering/details/detail-collapse-event.d.ts +8 -3
  291. package/rendering/details/detail-expand-event.d.ts +8 -3
  292. package/rendering/details/detail-template.directive.d.ts +8 -7
  293. package/rendering/details-expand.directive.d.ts +18 -8
  294. package/rendering/footer/footer-template.directive.d.ts +7 -7
  295. package/rendering/groups-expand.directive.d.ts +15 -5
  296. package/rendering/header/header-template.directive.d.ts +11 -11
  297. package/rendering/loading-template.directive.d.ts +14 -3
  298. package/rendering/no-records-template.directive.d.ts +3 -5
  299. package/rendering/toolbar/toolbar-focusable.directive.d.ts +10 -2
  300. package/rendering/toolbar/toolbar-position.d.ts +5 -5
  301. package/rendering/toolbar/toolbar-template.directive.d.ts +3 -3
  302. package/rendering/toolbar/tools/column-chooser-tool.directive.d.ts +6 -5
  303. package/rendering/toolbar/tools/filter-command-tool.directive.d.ts +5 -5
  304. package/rendering/toolbar/tools/group-command-tool.directive.d.ts +5 -3
  305. package/rendering/toolbar/tools/sort-command-tool.directive.d.ts +4 -4
  306. package/row-reordering/drag-handle-template.directive.d.ts +5 -6
  307. package/row-reordering/drag-hint-template.directive.d.ts +3 -5
  308. package/row-reordering/types.d.ts +10 -10
  309. package/schematics/ngAdd/index.js +4 -4
  310. package/scrolling/content-scroll-event.d.ts +11 -11
  311. package/scrolling/scroll-bottom-event.d.ts +2 -2
  312. package/scrolling/scroll-request.service.d.ts +6 -6
  313. package/scrolling/scrollmode.d.ts +3 -3
  314. package/selection/selectall-checkbox.directive.d.ts +2 -2
  315. package/selection/selection-checkbox.directive.d.ts +9 -8
  316. package/selection/selection-default.d.ts +9 -8
  317. package/selection/selection.directive.d.ts +10 -1
  318. package/selection/types.d.ts +41 -35
  319. package/state-management/grid-state.models.d.ts +16 -7
  320. package/state-management/redo-command-tool.d.ts +14 -6
  321. package/state-management/undo-command-tool.d.ts +14 -6
  322. package/state-management/undo-redo.directive.d.ts +17 -6
@@ -90,10 +90,37 @@ import * as i0 from "@angular/core";
90
90
  /**
91
91
  * Represents the Kendo UI for Angular Data Grid component.
92
92
  *
93
+ * Use the `kendo-grid` component to display and manage tabular data.
94
+ *
93
95
  * @example
94
96
  * ```html
95
97
  * <kendo-grid [data]="gridData"></kendo-grid>
96
98
  * ```
99
+ *
100
+ * @remarks
101
+ * Supported children components are:
102
+ * {@link CheckboxColumnComponent},
103
+ * {@link ColumnChooserComponent},
104
+ * {@link ColumnComponent},
105
+ * {@link ColumnGroupComponent},
106
+ * {@link ColumnMenuAutoSizeAllColumnsComponent},
107
+ * {@link ColumnMenuAutoSizeColumnComponent},
108
+ * {@link ColumnMenuChooserComponent},
109
+ * {@link ColumnMenuComponent},
110
+ * {@link ColumnMenuFilterComponent},
111
+ * {@link ColumnMenuItemComponent},
112
+ * {@link ColumnMenuLockComponent},
113
+ * {@link ColumnMenuPositionComponent},
114
+ * {@link ColumnMenuSortComponent},
115
+ * {@link ColumnMenuStickComponent},
116
+ * {@link CommandColumnComponent},
117
+ * {@link CustomMessagesComponent},
118
+ * {@link ExcelComponent},
119
+ * {@link GridSpacerComponent},
120
+ * {@link PDFComponent},
121
+ * {@link RowReorderColumnComponent},
122
+ * {@link SpanColumnComponent},
123
+ * {@link ToolBarComponent}.
97
124
  */
98
125
  export declare class GridComponent implements AfterContentInit, AfterViewInit, OnDestroy, OnChanges, OnInit {
99
126
  private supportService;
@@ -127,7 +154,7 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
127
154
  adaptiveGridService: AdaptiveGridService;
128
155
  rowReorderService: RowReorderService;
129
156
  /**
130
- * Sets the data of the Grid. If an array is provided, the Grid automatically gets the total count
157
+ * Sets the data of the Grid. If you provide an array, the Grid gets the total count automatically.
131
158
  * ([more information and example]({% slug binding_grid %})).
132
159
  */
133
160
  set data(value: Array<any> | GridDataResult | null);
@@ -143,56 +170,59 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
143
170
  get hintContext(): any;
144
171
  /**
145
172
  * Defines the page size used by the Grid pager.
146
- * Required by the [paging]({% slug paging_grid %}) functionality.
173
+ * Required for the [`paging`]({% slug paging_grid %}) feature.
147
174
  */
148
175
  pageSize: number | null | undefined;
149
176
  /**
150
- * Defines the height (in pixels) that is used when the `scrollable` option of the Grid is set.
151
- * To set the height of the Grid, you can also use `style.height`. The `style.height`
152
- * option supports units such as `px`, `%`, `em`, `rem`, and others.
177
+ * Defines the height in pixels for the Grid when `scrollable` is set.
178
+ * You can also set the height using `style.height` with units like `px`, `%`, `em`, or `rem`.
153
179
  */
154
180
  height: number;
155
181
  /**
156
- * Represent the actual height of each Grid row (`tr`) element in the DOM.
157
- * Required by the [virtual scrolling functionality]({% slug scrollmmodes_grid %}).
158
- * Set the `rowHeight` option to the exact pixels as the height of the `tr` element appears in the DOM.
182
+ * Represents the row height in pixels for each Grid row (`tr`) element.
183
+ * Required for [virtual scrolling]({% slug scrollmmodes_grid %}).
184
+ * Set `rowHeight` to match the actual DOM row height. The property does not change the height of the rows in the UI.
159
185
  */
160
186
  rowHeight: number;
161
187
  /**
162
- * Enables or disables the adaptive mode. By default, adaptive rendering is disabled.
188
+ * Enables or disables adaptive mode. Adaptive rendering is off by default.
189
+ *
190
+ * @default 'none'
163
191
  */
164
192
  adaptiveMode: AdaptiveMode;
165
193
  /**
166
- * Represent the actual height of each Grid detail row (`tr`) element in the DOM.
167
- * Required by the [virtual scrolling functionality]({% slug scrollmmodes_grid %}).
168
- * Set the `detailRowHeight` option to the exact pixels as the height of the detail Grid `tr` element appears in the DOM.
194
+ * Represents the height in pixels for each Grid detail row (`tr`) element.
195
+ * Required for [virtual scrolling]({% slug scrollmmodes_grid %}).
196
+ * Set `detailRowHeight` to match the actual DOM detail row height. The property does not change the height of the rows in the UI.
169
197
  */
170
198
  detailRowHeight: number;
171
199
  /**
172
- * Defines the number of records to be skipped by the pager.
173
- * Required by the [paging]({% slug paging_grid %}) functionality.
200
+ * Defines the number of records to skip in the pager.
201
+ * Required for the [`paging`]({% slug paging_grid %}) feature.
174
202
  */
175
203
  get skip(): number | null | undefined;
176
204
  set skip(value: number | null | undefined);
177
205
  /**
178
- * Defines the scroll mode used by the Grid.
206
+ * Defines the scroll mode for the Grid.
179
207
  *
180
208
  * @default 'scrollable'
181
209
  */
182
210
  scrollable: ScrollMode;
183
211
  /**
184
- * Enables the [single-row selection](slug:grid_row_selection) of the Grid.
212
+ * Enables the selection feature of the Grid. The `selectable` property can be set to `true`, `false`, or an object with additional settings.
213
+ * [See example](slug:grid_row_selection).
185
214
  *
186
215
  * @default false
187
216
  */
188
217
  selectable: SelectableSettings | boolean;
189
218
  /**
190
- * The descriptors by which the data will be sorted ([see example]({% slug sorting_grid %})).
219
+ * Sets the descriptors for sorting the data ([see example]({% slug sorting_grid %})).
191
220
  */
192
221
  set sort(value: Array<SortDescriptor> | null | undefined);
193
222
  get sort(): Array<SortDescriptor> | null | undefined;
194
223
  /**
195
- * Specifies the sizing of various Grid building blocks (e.g. tables, buttons, inputs, dropdowns, etc.)
224
+ * Specifies the sizing for Grid elements like tables, buttons, and inputs.
225
+ *
196
226
  * @default 'medium'
197
227
  */
198
228
  set size(size: GridSize);
@@ -201,20 +231,21 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
201
231
  * A function that defines how to track changes for the data rows.
202
232
  * By default, the Grid tracks changes by the index of the data item.
203
233
  * Edited rows are tracked by reference.
204
- * [See example](slug:track_changes_grid)
234
+ * [See example](slug:track_changes_grid).
205
235
  */
206
236
  trackBy: TrackByFunction<GridItem>;
207
237
  /**
208
- * The descriptor by which the data will be filtered ([see examples]({% slug filtering_grid %})).
238
+ * Sets the filter descriptor for the data ([see examples]({% slug filtering_grid %})).
209
239
  */
210
240
  filter: CompositeFilterDescriptor | null | undefined;
211
241
  /**
212
- * The descriptors by which the data will be grouped ([see example]({% slug grouping_grid %})).
242
+ * Sets the descriptors for grouping the data ([see example]({% slug grouping_grid %})).
213
243
  */
214
244
  set group(value: Array<GroupDescriptor> | null | undefined);
215
245
  get group(): Array<GroupDescriptor> | null | undefined;
216
246
  /**
217
- * If set to `true`, the grid will render only the columns in the current viewport.
247
+ * If `true`, renders only columns in the current viewport.
248
+ *
218
249
  * @default false
219
250
  */
220
251
  virtualColumns: boolean;
@@ -277,85 +308,78 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
277
308
  */
278
309
  gridData: DragTargetDataFn;
279
310
  /**
280
- * Enables the [filtering]({% slug filtering_grid %}) of the Grid columns that have their `field` option set.
311
+ * Enables the [filtering](slug:filtering_grid) feature of the Grid for columns with a `field` option.
312
+ *
281
313
  * @default false
282
314
  */
283
315
  filterable: FilterableSettings;
284
316
  /**
285
- * Enables the [sorting]({% slug sorting_grid %}) of the Grid columns that have their `field` option set.
317
+ * Enables [sorting]({% slug sorting_grid %}) feature of the Grid for columns with a `field` option.
286
318
  * @default false
287
319
  */
288
320
  sortable: SortSettings;
289
321
  /**
290
- * Configures the pager of the Grid ([see example](slug:paging_grid_settings)).
322
+ * Configures the Grid pager ([see example](slug:paging_grid_settings)).
291
323
  * @default false
292
324
  */
293
325
  pageable: PagerSettings | boolean;
294
326
  get normalizedPageableSettings(): any;
295
327
  /**
296
- * If set to `true`, the user can group the Grid by dragging the column header cells ([see example]({% slug grouping_grid %})).
328
+ * If `true`, allows grouping by dragging column headers ([see example]({% slug grouping_grid %})).
329
+ *
297
330
  * @default false
298
331
  */
299
332
  groupable: GroupableSettings | boolean;
300
333
  /**
301
- * Determines whether the Grid can be resized.
334
+ * Determines if the Grid can be resized.
335
+ *
302
336
  * @default false
303
337
  */
304
338
  gridResizable: GridResizableSettings | boolean;
305
339
  /**
306
- * Enables the [row reordering]({% slug reordering_rows_grid %}) of the Grid.
340
+ * Enables row reordering feature of the Grid ([see example]({% slug reordering_rows_grid %})).
341
+ *
307
342
  * @default false
308
343
  */
309
344
  set rowReorderable(value: boolean);
310
345
  get rowReorderable(): boolean;
311
346
  /**
312
- * When the keyboard navigation is enabled, the user can use dedicated shortcuts to interact with the Grid.
313
- * By default, navigation is enabled. To disable it altogether, and include the Grid content in the normal tab sequence, set the property to `false`.
314
- * To enable navigation through separate Grid sections only, provide a [`GridNavigableSection`]({% slug api_grid_gridnavigablesection %}) array.
347
+ * By default, navigation is enabled. To disable, set to `false`.
348
+ * To enable navigation for specific sections, provide a [`GridNavigableSection`](slug:api_grid_gridnavigablesection).
315
349
  */
316
350
  set navigable(value: GridNavigableSettings);
317
351
  get navigable(): GridNavigableSettings;
318
352
  /**
319
- * Indicates whether the Grid columns will be resized during initialization so that
320
- * they fit their headers and row content.
353
+ * If `true`, resizes columns during initialization to fit headers and content.
321
354
  * Columns with `autoSize` set to `false` are excluded.
322
- * To dynamically update the column width to match the new content,
323
- * refer to [this example]({% slug resizing_columns_grid %}).
355
+ * [See example](slug:resizing_columns_grid).
356
+ *
324
357
  * @default false
325
358
  */
326
359
  autoSize: boolean;
327
360
  /**
328
- * Defines a function that is executed for every data row in the component
329
- * ([see example](slug:styling_grid_rows)).
361
+ * Sets a function to apply custom CSS classes to each data row ([see example](slug:styling_grid_rows)).
330
362
  */
331
363
  set rowClass(fn: RowClassFn);
332
364
  get rowClass(): RowClassFn;
333
365
  /**
334
- * Defines a function that is executed for every data row in the component,
335
- * and determines whether the row will be sticky, i.e. always visible after scrolling.
366
+ * Sets a function to determine if a data row is sticky (always visible after scrolling).
336
367
  */
337
368
  set rowSticky(fn: RowStickyFn);
338
369
  get rowSticky(): RowStickyFn;
339
370
  /**
340
- * Defines a Boolean function that is executed for each data row in the component
341
- * ([see example]({% slug grid_selection_custom %}#toc-setting-the-selected-rows)).
342
- * Determines whether the row will be selected.
371
+ * Sets a function to determine if a data row is selected ([see example]({% slug grid_selection_custom %}#toc-setting-the-selected-rows)).
343
372
  */
344
373
  set rowSelected(fn: RowSelectedFn);
345
374
  get rowSelected(): RowSelectedFn;
346
375
  /**
347
- * Defines a Boolean function that is executed for each data row in the component.
348
- * Determines whether the row will be selectable.
376
+ * Sets a function to determine if a data row is selectable.
349
377
  */
350
378
  set isRowSelectable(fn: RowSelectableFn);
351
379
  get isRowSelectable(): RowSelectableFn;
352
380
  /**
353
- * Defines a function that determines the selected state of a data cell.
354
- * Returns an object with `selected` and `item` properties.
355
- * The cell is marked as selected only if the `selected` property equals `true`.
356
- *
357
- * The function is executed for each data cell and may be called more than once
358
- * as part of a change detection cycle. ([see example]({% slug grid_selection_custom %}#toc-setting-the-selected-cells))
381
+ * Sets a function to determine if a data cell is selected.
382
+ * The function returns an object with `selected` and `item` properties ([see example]({% slug grid_selection_custom %}#toc-setting-the-selected-cells)).
359
383
  */
360
384
  set cellSelected(fn: CellSelectedFn);
361
385
  get cellSelected(): CellSelectedFn;
@@ -374,40 +398,39 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
374
398
  */
375
399
  get selection(): GridSelectionItem[];
376
400
  /**
377
- * The current Grid `GridState` objects. Contains the information about data operations and column state, required
378
- * to store and restore the Grid state.
401
+ * Gets the current `GridState`, including data operations and column state.
402
+ * Use this to store and restore the Grid state.
379
403
  */
380
404
  get currentState(): GridState;
381
405
  /**
382
- * If set to `true`, the user can resize columns by dragging the edges (resize handles) of their header cells
383
- * ([see example]({% slug resizing_columns_grid %})).
406
+ * If `true`, allows resizing columns by dragging header cell edges ([see example]({% slug resizing_columns_grid %})).
384
407
  *
385
408
  * @default false
386
409
  */
387
410
  resizable: boolean | ResizeMode;
388
411
  /**
389
- * If set to `true`, the user can reorder columns by dragging their header cells
390
- * ([see example]({% slug reordering_columns_grid %})).
412
+ * If `true`, allows reordering columns by dragging header cells ([see example]({% slug reordering_columns_grid %})).
391
413
  *
392
414
  * @default false
393
415
  */
394
416
  reorderable: boolean;
395
417
  /**
396
- * Specifies if the loading indicator of the Grid will be displayed ([see example]({% slug binding_grid %})).
418
+ * If `true`, displays the Grid loading indicator ([see example]({% slug binding_grid %})).
397
419
  *
398
420
  * @default false
399
421
  */
400
422
  set loading(value: boolean);
401
423
  get loading(): boolean;
402
424
  /**
403
- * Specifies if the column menu of the columns will be displayed ([see example]({% slug columnmenu_grid %})).
425
+ * If `true`, displays the column menu for columns ([see example]({% slug columnmenu_grid %})).
404
426
  *
405
427
  * @default false
406
428
  */
407
429
  columnMenu: boolean | ColumnMenuSettings;
408
430
  /**
409
- * Specifies if the header of the grid will be hidden. The header is visible by default.
431
+ * If `true`, hides the Grid header. The header is visible by default.
410
432
  * The header includes column headers and the [filter row](slug:filter_row).
433
+ *
411
434
  * @default false
412
435
  */
413
436
  hideHeader: boolean;
@@ -418,41 +441,37 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
418
441
  */
419
442
  showInactiveTools: boolean;
420
443
  /**
421
- * A function which determines if a specific row is expanded.
444
+ * Sets a function to determine if a specific row is expanded.
422
445
  */
423
446
  set isDetailExpanded(callback: (args: RowArgs) => boolean);
424
447
  get isDetailExpanded(): (args: RowArgs) => boolean;
425
448
  /**
426
- * A function which determines if a specific group row is expanded.
449
+ * Sets a function to determine if a specific group row is expanded.
427
450
  */
428
451
  set isGroupExpanded(callback: (args: GroupRowArgs) => boolean);
429
452
  get isGroupExpanded(): (args: GroupRowArgs) => boolean;
430
453
  /**
431
- * Fires when the Grid filter is modified through the UI.
432
- * You have to handle the event yourself and filter the data.
454
+ * Fires when the Grid data is filtered through the UI and the filter descriptor changes.
433
455
  */
434
456
  filterChange: EventEmitter<CompositeFilterDescriptor>;
435
457
  /**
436
- * Fires when the page of the Grid is changed ([see example]({% slug paging_grid %})).
437
- * You have to handle the event yourself and page the data.
458
+ * Fires when the page is changed through the UI ([see example]({% slug paging_grid %})).
438
459
  */
439
460
  pageChange: EventEmitter<PageChangeEvent>;
440
461
  /**
441
- * Fires when the grouping of the Grid is changed.
442
- * You have to handle the event yourself and group the data ([see example]({% slug grouping_grid %})).
462
+ * Fires when the Grid data is grouped through the UI and the group descriptors change ([see example]({% slug grouping_grid %})).
443
463
  */
444
464
  groupChange: EventEmitter<Array<GroupDescriptor>>;
445
465
  /**
446
- * Fires when the sorting of the Grid is changed ([see example]({% slug sorting_grid %})).
447
- * You have to handle the event yourself and sort the data.
466
+ * Fires when the Grid data is sorted through the UI and the sort descriptors change ([see example]({% slug sorting_grid %})).
448
467
  */
449
468
  sortChange: EventEmitter<Array<SortDescriptor>>;
450
469
  /**
451
- * Fires when the user selects a Grid row.
470
+ * Fires when the Grid selection changes through the UI.
452
471
  */
453
472
  selectionChange: EventEmitter<SelectionEvent>;
454
473
  /**
455
- * Fires when the user drops the dragged row and reordering is performed.
474
+ * Fires when a row is reordered through the UI.
456
475
  */
457
476
  rowReorder: EventEmitter<RowReorderEvent>;
458
477
  /**
@@ -464,91 +483,84 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
464
483
  */
465
484
  gridStateChange: EventEmitter<GridState>;
466
485
  /**
467
- * Fires when the user expands a group header.
486
+ * Fires when a group is expanded through the UI.
468
487
  */
469
488
  groupExpand: EventEmitter<GroupRowArgs>;
470
489
  /**
471
- * Fires when the user collapses a group header.
490
+ * Fires when a group is collapsed through the UI.
472
491
  */
473
492
  groupCollapse: EventEmitter<GroupRowArgs>;
474
493
  /**
475
- * Fires when the user expands a master row.
494
+ * Fires when a detail row is expanded through the UI.
476
495
  */
477
496
  detailExpand: EventEmitter<DetailExpandEvent>;
478
497
  /**
479
- * Fires when the user collapses a master row.
498
+ * Fires when a detail row is collapsed through the UI.
480
499
  */
481
500
  detailCollapse: EventEmitter<DetailCollapseEvent>;
482
501
  /**
483
- * Fires when the user clicks the **Edit** command button to edit a row
484
- * ([see example](slug:inline_editing_grid#editing-records-1)).
502
+ * Fires when a row enters edit mode ([see example](slug:inline_editing_grid#editing-records-1)).
485
503
  */
486
504
  edit: EventEmitter<EditEvent>;
487
505
  /**
488
- * Fires when the user clicks the **Cancel** command button to close a row
489
- * ([see example]({% slug inline_editing_grid %}#toc-canceling-editing-1)).
506
+ * Fires when editing is canceled by clicking the **Cancel** command button ([see example]({% slug inline_editing_grid %}#toc-canceling-editing-1)).
490
507
  */
491
508
  cancel: EventEmitter<CancelEvent>;
492
509
  /**
493
- * Fires when the user clicks the **Save** command button to save changes in a row
494
- * ([see example]({% slug inline_editing_grid %}#toc-saving-records-1)).
510
+ * Fires when a row is saved by clicking the **Save** command button ([see example]({% slug inline_editing_grid %}#toc-saving-records-1)).
495
511
  */
496
512
  save: EventEmitter<SaveEvent>;
497
513
  /**
498
- * Fires when the user clicks the **Remove** command button to remove a row
499
- * ([see example]({% slug inline_editing_grid %}#toc-removing-records-1)).
514
+ * Fires when a row is removed by clicking the **Remove** command button ([see example]({% slug inline_editing_grid %}#toc-removing-records-1)).
500
515
  */
501
516
  remove: EventEmitter<RemoveEvent>;
502
517
  /**
503
- * Fires when the user clicks the **Add** command button to add a new row
504
- * ([see example]({% slug inline_editing_grid %}#toc-adding-records-1)).
518
+ * Fires when a new row is added by clicking the **Add** command button ([see example]({% slug inline_editing_grid %}#toc-adding-records-1)).
505
519
  */
506
520
  add: EventEmitter<AddEvent>;
507
521
  /**
508
- * Fires when the user leaves an edited cell ([see example](slug:editing_incell_grid)).
522
+ * Fires when a cell edit is closed ([see example](slug:editing_incell_grid)).
509
523
  */
510
524
  cellClose: EventEmitter<CellCloseEvent>;
511
525
  /**
512
- * Fires when the user clicks a cell ([see example](slug:editing_incell_grid)).
526
+ * Fires when a cell is clicked ([see example](slug:editing_incell_grid)).
513
527
  */
514
528
  cellClick: EventEmitter<CellClickEvent>;
515
529
  /**
516
- * Fires when the user clicks the **Export to PDF** command button.
530
+ * Fires when the PDF export command is triggered.
517
531
  */
518
532
  pdfExport: EventEmitter<PDFExportEvent>;
519
533
  /**
520
- * Fires when the user clicks the **Export to Excel** command button.
534
+ * Fires when the Excel export command is triggered.
521
535
  */
522
536
  excelExport: EventEmitter<ExcelExportEvent>;
523
537
  /**
524
- * Fires when the user completes the resizing of the column.
538
+ * Fires when columns are resized.
525
539
  */
526
540
  columnResize: EventEmitter<Array<ColumnResizeArgs>>;
527
541
  /**
528
- * Fires when the user completes the reordering of the column.
542
+ * Fires when columns are reordered.
529
543
  */
530
544
  columnReorder: EventEmitter<ColumnReorderEvent>;
531
545
  /**
532
- * Fires when the user changes the visibility of the columns from the column menu or column chooser.
546
+ * Fires when column visibility changes.
533
547
  */
534
548
  columnVisibilityChange: EventEmitter<ColumnVisibilityChangeEvent>;
535
549
  /**
536
- * Fires when the user changes the locked state of the columns from the column menu or by reordering the columns.
550
+ * Fires when columns are locked or unlocked.
537
551
  */
538
552
  columnLockedChange: EventEmitter<ColumnLockedChangeEvent>;
539
553
  /**
540
- * Fires when the user changes the sticky state of the columns from the column menu.
554
+ * Fires when columns are made sticky or unsticky.
541
555
  */
542
556
  columnStickyChange: EventEmitter<ColumnStickyChangeEvent>;
543
557
  /**
544
- * Fires when the user scrolls to the last record on the page and enables endless scrolling
545
- * ([see example]({% slug scrollmmodes_grid %}#toc-endless-scrolling)).
546
- * You have to handle the event yourself and page the data.
558
+ * Fires when the last record is scrolled into view ([see example]({% slug scrollmmodes_grid %}#toc-endless-scrolling)).
547
559
  */
548
560
  scrollBottom: EventEmitter<ScrollBottomEvent>;
549
561
  /**
550
562
  * Fires when the grid content is scrolled.
551
- * For performance reasons, the event is triggered outside the Angular zone. Enter the Angular zone if you make any changes that require change detection.
563
+ * The event is triggered outside the Angular zone for performance. Enter the Angular zone if you make changes that require change detection.
552
564
  */
553
565
  contentScroll: EventEmitter<ContentScrollEvent>;
554
566
  /**
@@ -710,53 +722,41 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
710
722
  private _rowSticky;
711
723
  constructor(supportService: BrowserSupportService, selectionService: SelectionService, cellSelectionService: CellSelectionService, wrapper: ElementRef, groupInfoService: GroupInfoService, groupsService: GroupsService, changeNotification: ChangeNotificationService, detailsService: DetailsService, editService: EditService, filterService: FilterService, pdfService: PDFService, responsiveService: ResponsiveService, renderer: Renderer2, excelService: ExcelService, ngZone: NgZone, scrollSyncService: ScrollSyncService, domEvents: DomEventsService, columnResizingService: ColumnResizingService, changeDetectorRef: ChangeDetectorRef, columnReorderService: ColumnReorderService, columnInfoService: ColumnInfoService, navigationService: NavigationService, sortService: SortService, scrollRequestService: ScrollRequestService, localization: LocalizationService, ctx: ContextService, sizingService: SizingOptionsService, adaptiveService: AdaptiveService, adaptiveGridService: AdaptiveGridService, rowReorderService: RowReorderService);
712
724
  /**
713
- * Expands the specified master row ([see example]({% slug hierarchy_grid %})).
714
- *
715
- * This method is provided only for backwards-compatibility with legacy versions.
716
- * These versions tracked the expanded state internally using the data row index.
725
+ * Expands the master row at the specified data row index ([see example]({% slug hierarchy_grid %})).
717
726
  *
718
- * For new development, use the [kendoGridDetailsExpandBy directive]({% slug api_grid_expanddetailsdirective %})
719
- * or provide an isDetailExpanded callback. See [Controlling the Expanded State]({% slug master_detail_expanded_state_grid %})
720
- * for examples on how to control the expanded state.
727
+ * This method is for backwards compatibility with legacy versions that track expanded state by row index.
728
+ * For new development, use the [`kendoGridDetailsExpandBy` directive]({% slug api_grid_expanddetailsdirective %})
729
+ * or provide an `isDetailExpanded` callback. See [Controlling the Expanded State]({% slug master_detail_expanded_state_grid %}) for examples.
721
730
  *
722
- * @param index - The data row index of the master row.
731
+ * @param index The data row index of the master row.
723
732
  */
724
733
  expandRow(index: number): void;
725
734
  /**
726
- * Collapses the specified master row ([see example]({% slug hierarchy_grid %})).
735
+ * Collapses the master row at the specified data row index ([see example]({% slug hierarchy_grid %})).
727
736
  *
728
- * This method is provided only for backwards-compatibility with legacy versions.
729
- * These versions tracked the expanded state internally using the data row index.
737
+ * This method is for backwards compatibility with legacy versions that track expanded state by row index.
738
+ * For new development, use the [`kendoGridDetailsExpandBy` directive]({% slug api_grid_expanddetailsdirective %})
739
+ * or provide an `isDetailExpanded` callback. See [Controlling the Expanded State]({% slug master_detail_expanded_state_grid %}) for examples.
730
740
  *
731
- * For new development, use the [kendoGridDetailsExpandBy directive]({% slug api_grid_expanddetailsdirective %})
732
- * or provide an isDetailExpanded callback. See [Controlling the Expanded State]({% slug master_detail_expanded_state_grid %})
733
- * for examples on how to control the expanded state.
734
- *
735
- * @param index - The data row index of the master row.
741
+ * @param index The data row index of the master row.
736
742
  */
737
743
  collapseRow(index: number): void;
738
744
  /**
739
- * Expands a group header item for the given index. For example,
740
- * `0_1` expands the second inner group of the first master group.
741
- *
742
- * This method is provided only for backwards-compatibility with legacy versions.
743
- * These versions tracked the expanded group state internally using the hierarchical group index.
745
+ * Expands a group header at the given hierarchical index, such as `0_1` for the second inner group of the first master group.
744
746
  *
745
- * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
747
+ * This method is for backwards compatibility with legacy versions that track expanded group state by hierarchical group index.
748
+ * If the Grid is pageable, the group indexes are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
746
749
  *
747
- * @param {string} index - The underscore separated hierarchical index of the group.
750
+ * @param {string} index The underscore-separated hierarchical index of the group.
748
751
  */
749
752
  expandGroup(index: string): void;
750
753
  /**
751
- * Collapses a group header item for the given index. For example,
752
- * `0_1` collapses the second inner group of the first master group.
754
+ * Collapses a group header at the given hierarchical index, such as `0_1` for the second inner group of the first master group.
753
755
  *
754
- * This method is provided only for backwards-compatibility with legacy versions.
755
- * These versions tracked the expanded group state internally using the hierarchical group index.
756
+ * This method is for backwards compatibility with legacy versions that track expanded group state by hierarchical group index.
757
+ * If the Grid is pageable, the group indexes are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
756
758
  *
757
- * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
758
- *
759
- * @param {string} index - The underscore separated hierarchical index of the group.
759
+ * @param {string} index The underscore-separated hierarchical index of the group.
760
760
  */
761
761
  collapseGroup(index: string): void;
762
762
  /**
@@ -788,12 +788,11 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
788
788
  */
789
789
  messageFor: (token: string) => string;
790
790
  /**
791
- * Switches the specified table row in the edit mode ([see example]({% slug inline_editing_grid %}#toc-editing-records-1)).
791
+ * Switches the specified table row to edit mode ([see example]({% slug inline_editing_grid %}#toc-editing-records-1)).
792
792
  *
793
- * @param rowIndex - The data row index that will be switched in the edit mode.
794
- * @param group - The [FormGroup](link:site.data.urls.angular['formgroupapi'])
795
- * that describes the edit form.
796
- * @param options - Additional options configuring the focus target once the editor opens.
793
+ * @param rowIndex The data row index to switch to edit mode.
794
+ * @param group The [`FormGroup`](link:site.data.urls.angular['formgroupapi']) that describes the edit form.
795
+ * @param options Additional options to configure the focus target when the editor opens.
797
796
  */
798
797
  editRow(rowIndex: number, group?: FormGroup, options?: EditRowOptions): void;
799
798
  /**
@@ -801,35 +800,29 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
801
800
  */
802
801
  handleReorderEvents(ev: any, evType: string): void;
803
802
  /**
804
- * Closes the editor for a given row ([see example]({% slug inline_editing_grid %}#toc-canceling-editing-1)).
803
+ * Closes the editor for the specified row ([see example]({% slug inline_editing_grid %}#toc-canceling-editing-1)).
805
804
  *
806
- * @param {number} index - The row index that will be switched out of the edit mode. If no index is provided, it is assumed
807
- * that the new item editor will be closed.
805
+ * @param {number} index The row index to switch out of edit mode. If you do not provide an index, the new item editor closes.
808
806
  */
809
807
  closeRow(index?: number): void;
810
808
  /**
811
809
  * Creates a new row editor ([see example]({% slug inline_editing_grid %}#toc-adding-records-1)).
812
810
  *
813
- * @param {FormGroup} group - The [FormGroup](link:site.data.urls.angular['formgroupapi']) that describes
814
- * the edit form. If called with a data item, it will build the `FormGroup` from the data item fields.
811
+ * @param {FormGroup} group The [`FormGroup`](link:site.data.urls.angular['formgroupapi']) that describes the edit form. If you pass a data item, the method builds the `FormGroup` from the data item fields.
815
812
  */
816
813
  addRow(group: any): void;
817
814
  /**
818
- * Puts the cell that is specified by the table row and column in edit mode ([see example](slug:editing_incell_grid)).
815
+ * Puts the specified cell in edit mode ([see example](slug:editing_incell_grid)).
819
816
  *
820
- * @param {number} rowIndex - The data row index that will be switched in the edit mode.
821
- * @param {number|string|any} column - The leaf column index, or the field name or the column instance that should be edited.
822
- * @param {FormGroup} group - The [FormGroup](link:site.data.urls.angular['formgroupapi'])
823
- * that describes the edit form.
817
+ * @param {number} rowIndex The data row index to switch to edit mode.
818
+ * @param {number|string|any} column The leaf column index, field name, or column instance to edit.
819
+ * @param {FormGroup} group The [`FormGroup`](link:site.data.urls.angular['formgroupapi']) that describes the edit form.
824
820
  */
825
821
  editCell(rowIndex: number, column: number | string | any, group?: any): void;
826
822
  /**
827
- * Closes the current cell in edit mode and fires
828
- * the [cellClose]({% slug api_grid_gridcomponent %}#toc-cellclose) event.
823
+ * Closes the current cell in edit mode and fires the [`cellClose`]({% slug api_grid_gridcomponent %}#toc-cellclose) event.
829
824
  *
830
- * @return {boolean} Indicates whether the edited cell was closed.
831
- * A `false` value indicates that the
832
- * [cellClose]({% slug api_grid_gridcomponent %}#toc-cellclose) event was prevented.
825
+ * @returns {boolean} `true` if the cell closed. Returns `false` if the [`cellClose`]({% slug api_grid_gridcomponent %}#toc-cellclose) event was prevented.
833
826
  */
834
827
  closeCell(): boolean;
835
828
  /**
@@ -837,15 +830,15 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
837
830
  */
838
831
  cancelCell(): void;
839
832
  /**
840
- * Returns a flag which indicates if a row or a cell is currently edited.
833
+ * Returns `true` if a row or cell is currently edited.
841
834
  *
842
- * @return {boolean} A flag which indicates if a row or a cell is currently edited.
835
+ * @returns {boolean} `true` if a row or cell is currently edited.
843
836
  */
844
837
  isEditing(): boolean;
845
838
  /**
846
- * Returns a flag which indicates if a cell is currently edited.
839
+ * Returns `true` if a cell is currently edited.
847
840
  *
848
- * @return {boolean} A flag which indicates if a cell is currently being edited.
841
+ * @returns {boolean} `true` if a cell is currently being edited.
849
842
  */
850
843
  isEditingCell(): boolean;
851
844
  /**
@@ -853,10 +846,10 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
853
846
  */
854
847
  saveAsPDF(): void;
855
848
  /**
856
- * Exports the Grid element to a Drawing [Group]({% slug api_kendo-drawing_group %}) by using the `kendo-grid-pdf` component options.
849
+ * Exports the Grid element to a Drawing [Group]({% slug api_kendo-drawing_group %}) using the `kendo-grid-pdf` component options
857
850
  * ([see example]({% slug pdfexport_grid %}#toc-exporting-multiple-grids-to-the-same-pdf)).
858
851
  *
859
- * @return {Promise} A promise that will be resolved with the Drawing `Group`.
852
+ * @returns {Promise} A promise that resolves with the Drawing `Group`.
860
853
  */
861
854
  drawPDF(): Promise<any>;
862
855
  /**
@@ -864,24 +857,20 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
864
857
  */
865
858
  saveAsExcel(): void;
866
859
  /**
867
- * Applies the provided `GridState` object to the Grid.
860
+ * Applies the given `GridState` object to the Grid.
868
861
  */
869
862
  loadState(state: GridState): void;
870
863
  private traverseColumns;
871
864
  /**
872
- * Applies the minimum possible width for the specified column,
873
- * so that the whole text fits without wrapping. This method expects the Grid
874
- * to be [resizable](slug:resizing_columns_grid). The method must be executed
875
- * after the Grid is already populated with data.
865
+ * Applies the minimum possible width for the specified column so the whole text fits without wrapping.
866
+ * This method expects the Grid to be [`resizable`](slug:resizing_columns_grid). Run this method after the Grid is populated with data.
876
867
  * [See example](slug:resizing_columns_grid#toc-auto-fitting-the-content)
877
868
  */
878
869
  autoFitColumn(column: ColumnBase): void;
879
870
  /**
880
871
  * Adjusts the width of the specified columns to fit the entire content, including headers, without wrapping.
881
- * If no columns are specified, `autoFitColumns` is applied to all columns.The method must be executed
882
- * after the Grid is already populated with data.
872
+ * If you do not specify columns, `autoFitColumns` applies to all columns. Run this method after the Grid is populated with data.
883
873
  * [See example](slug:resizing_columns_grid#toc-auto-fitting-the-content)
884
- *
885
874
  */
886
875
  autoFitColumns(columns?: Array<ColumnBase> | QueryList<ColumnBase>): void;
887
876
  /**
@@ -917,8 +906,8 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
917
906
  * If the Grid is configured for scrolling, including virtual scrolling, the scroll position will be updated.
918
907
  * If the row is not present on the current page, the method will have no effect.
919
908
  *
920
- * @param rowIndex - The logical row index to focus. The top header row has an index 0.
921
- * @param colIndex - The column index to focus.
909
+ * @param rowIndex The logical row index to focus. The top header row has an index 0.
910
+ * @param colIndex The column index to focus.
922
911
  * @returns {NavigationCell} The focused cell.
923
912
  *
924
913
  */
@@ -926,7 +915,7 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
926
915
  /**
927
916
  * Focuses the next cell, optionally wrapping to the next row.
928
917
  *
929
- * @param wrap - A Boolean value which indicates if the focus will move to the next row. Defaults to `true`.
918
+ * @param wrap A Boolean value which indicates if the focus will move to the next row. Defaults to `true`.
930
919
  * @returns {NavigationCell} The focused cell. If the focus is already on the last cell, returns `null`.
931
920
  */
932
921
  focusNextCell(wrap?: boolean): NavigationCell;
@@ -947,15 +936,12 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
947
936
  scrollToItem(request: ScrollToItemRequest): void;
948
937
  /**
949
938
  * Changes the position of the specified column.
950
- * The reordering of columns operates only on the level
951
- * which is inferred by the source column.
952
- * For the `reorderColumn` method to work properly,
953
- * the `source` column has to be visible.
954
- *
955
- * @param {ColumnBase} source - The column whose position will be changed.
956
- * @param {number} destIndex - The new position of the column.
957
- * @param {ColumnReorderConfig} options - Additional options.
939
+ * The reordering of columns operates only on the level inferred by the source column.
940
+ * For this method to work, the `source` column must be visible.
958
941
  *
942
+ * @param {ColumnBase} source The column to move.
943
+ * @param {number} destIndex The new position of the column.
944
+ * @param {ColumnReorderConfig} options Additional options.
959
945
  */
960
946
  reorderColumn(source: ColumnBase, destIndex: number, options?: ColumnReorderConfig): void;
961
947
  /**