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

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 +165 -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 +1945 -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
@@ -146,10 +146,37 @@ const NOTIFY_DELAY = 500;
146
146
  /**
147
147
  * Represents the Kendo UI for Angular Data Grid component.
148
148
  *
149
+ * Use the `kendo-grid` component to display and manage tabular data.
150
+ *
149
151
  * @example
150
152
  * ```html
151
153
  * <kendo-grid [data]="gridData"></kendo-grid>
152
154
  * ```
155
+ *
156
+ * @remarks
157
+ * Supported children components are:
158
+ * {@link CheckboxColumnComponent},
159
+ * {@link ColumnChooserComponent},
160
+ * {@link ColumnComponent},
161
+ * {@link ColumnGroupComponent},
162
+ * {@link ColumnMenuAutoSizeAllColumnsComponent},
163
+ * {@link ColumnMenuAutoSizeColumnComponent},
164
+ * {@link ColumnMenuChooserComponent},
165
+ * {@link ColumnMenuComponent},
166
+ * {@link ColumnMenuFilterComponent},
167
+ * {@link ColumnMenuItemComponent},
168
+ * {@link ColumnMenuLockComponent},
169
+ * {@link ColumnMenuPositionComponent},
170
+ * {@link ColumnMenuSortComponent},
171
+ * {@link ColumnMenuStickComponent},
172
+ * {@link CommandColumnComponent},
173
+ * {@link CustomMessagesComponent},
174
+ * {@link ExcelComponent},
175
+ * {@link GridSpacerComponent},
176
+ * {@link PDFComponent},
177
+ * {@link RowReorderColumnComponent},
178
+ * {@link SpanColumnComponent},
179
+ * {@link ToolBarComponent}.
153
180
  */
154
181
  export class GridComponent {
155
182
  supportService;
@@ -183,7 +210,7 @@ export class GridComponent {
183
210
  adaptiveGridService;
184
211
  rowReorderService;
185
212
  /**
186
- * Sets the data of the Grid. If an array is provided, the Grid automatically gets the total count
213
+ * Sets the data of the Grid. If you provide an array, the Grid gets the total count automatically.
187
214
  * ([more information and example]({% slug binding_grid %})).
188
215
  */
189
216
  set data(value) {
@@ -233,34 +260,35 @@ export class GridComponent {
233
260
  }
234
261
  /**
235
262
  * Defines the page size used by the Grid pager.
236
- * Required by the [paging]({% slug paging_grid %}) functionality.
263
+ * Required for the [`paging`]({% slug paging_grid %}) feature.
237
264
  */
238
265
  pageSize;
239
266
  /**
240
- * Defines the height (in pixels) that is used when the `scrollable` option of the Grid is set.
241
- * To set the height of the Grid, you can also use `style.height`. The `style.height`
242
- * option supports units such as `px`, `%`, `em`, `rem`, and others.
267
+ * Defines the height in pixels for the Grid when `scrollable` is set.
268
+ * You can also set the height using `style.height` with units like `px`, `%`, `em`, or `rem`.
243
269
  */
244
270
  height;
245
271
  /**
246
- * Represent the actual height of each Grid row (`tr`) element in the DOM.
247
- * Required by the [virtual scrolling functionality]({% slug scrollmmodes_grid %}).
248
- * Set the `rowHeight` option to the exact pixels as the height of the `tr` element appears in the DOM.
272
+ * Represents the row height in pixels for each Grid row (`tr`) element.
273
+ * Required for [virtual scrolling]({% slug scrollmmodes_grid %}).
274
+ * Set `rowHeight` to match the actual DOM row height. The property does not change the height of the rows in the UI.
249
275
  */
250
276
  rowHeight;
251
277
  /**
252
- * Enables or disables the adaptive mode. By default, adaptive rendering is disabled.
278
+ * Enables or disables adaptive mode. Adaptive rendering is off by default.
279
+ *
280
+ * @default 'none'
253
281
  */
254
282
  adaptiveMode = 'none';
255
283
  /**
256
- * Represent the actual height of each Grid detail row (`tr`) element in the DOM.
257
- * Required by the [virtual scrolling functionality]({% slug scrollmmodes_grid %}).
258
- * Set the `detailRowHeight` option to the exact pixels as the height of the detail Grid `tr` element appears in the DOM.
284
+ * Represents the height in pixels for each Grid detail row (`tr`) element.
285
+ * Required for [virtual scrolling]({% slug scrollmmodes_grid %}).
286
+ * Set `detailRowHeight` to match the actual DOM detail row height. The property does not change the height of the rows in the UI.
259
287
  */
260
288
  detailRowHeight;
261
289
  /**
262
- * Defines the number of records to be skipped by the pager.
263
- * Required by the [paging]({% slug paging_grid %}) functionality.
290
+ * Defines the number of records to skip in the pager.
291
+ * Required for the [`paging`]({% slug paging_grid %}) feature.
264
292
  */
265
293
  get skip() {
266
294
  return this._skip;
@@ -271,19 +299,20 @@ export class GridComponent {
271
299
  }
272
300
  }
273
301
  /**
274
- * Defines the scroll mode used by the Grid.
302
+ * Defines the scroll mode for the Grid.
275
303
  *
276
304
  * @default 'scrollable'
277
305
  */
278
306
  scrollable = 'scrollable';
279
307
  /**
280
- * Enables the [single-row selection](slug:grid_row_selection) of the Grid.
308
+ * Enables the selection feature of the Grid. The `selectable` property can be set to `true`, `false`, or an object with additional settings.
309
+ * [See example](slug:grid_row_selection).
281
310
  *
282
311
  * @default false
283
312
  */
284
313
  selectable = false;
285
314
  /**
286
- * The descriptors by which the data will be sorted ([see example]({% slug sorting_grid %})).
315
+ * Sets the descriptors for sorting the data ([see example]({% slug sorting_grid %})).
287
316
  */
288
317
  set sort(value) {
289
318
  if (isArray(value)) {
@@ -294,7 +323,8 @@ export class GridComponent {
294
323
  return this._sort;
295
324
  }
296
325
  /**
297
- * Specifies the sizing of various Grid building blocks (e.g. tables, buttons, inputs, dropdowns, etc.)
326
+ * Specifies the sizing for Grid elements like tables, buttons, and inputs.
327
+ *
298
328
  * @default 'medium'
299
329
  */
300
330
  set size(size) {
@@ -311,15 +341,15 @@ export class GridComponent {
311
341
  * A function that defines how to track changes for the data rows.
312
342
  * By default, the Grid tracks changes by the index of the data item.
313
343
  * Edited rows are tracked by reference.
314
- * [See example](slug:track_changes_grid)
344
+ * [See example](slug:track_changes_grid).
315
345
  */
316
346
  trackBy = defaultTrackBy;
317
347
  /**
318
- * The descriptor by which the data will be filtered ([see examples]({% slug filtering_grid %})).
348
+ * Sets the filter descriptor for the data ([see examples]({% slug filtering_grid %})).
319
349
  */
320
350
  filter;
321
351
  /**
322
- * The descriptors by which the data will be grouped ([see example]({% slug grouping_grid %})).
352
+ * Sets the descriptors for grouping the data ([see example]({% slug grouping_grid %})).
323
353
  */
324
354
  set group(value) {
325
355
  if (isArray(value)) {
@@ -330,7 +360,8 @@ export class GridComponent {
330
360
  return this._group;
331
361
  }
332
362
  /**
333
- * If set to `true`, the grid will render only the columns in the current viewport.
363
+ * If `true`, renders only columns in the current viewport.
364
+ *
334
365
  * @default false
335
366
  */
336
367
  virtualColumns = false;
@@ -421,17 +452,18 @@ export class GridComponent {
421
452
  */
422
453
  gridData = () => { return this.flatData; };
423
454
  /**
424
- * Enables the [filtering]({% slug filtering_grid %}) of the Grid columns that have their `field` option set.
455
+ * Enables the [filtering](slug:filtering_grid) feature of the Grid for columns with a `field` option.
456
+ *
425
457
  * @default false
426
458
  */
427
459
  filterable = false;
428
460
  /**
429
- * Enables the [sorting]({% slug sorting_grid %}) of the Grid columns that have their `field` option set.
461
+ * Enables [sorting]({% slug sorting_grid %}) feature of the Grid for columns with a `field` option.
430
462
  * @default false
431
463
  */
432
464
  sortable = false;
433
465
  /**
434
- * Configures the pager of the Grid ([see example](slug:paging_grid_settings)).
466
+ * Configures the Grid pager ([see example](slug:paging_grid_settings)).
435
467
  * @default false
436
468
  */
437
469
  pageable = false;
@@ -439,17 +471,20 @@ export class GridComponent {
439
471
  return normalize(this.pageable);
440
472
  }
441
473
  /**
442
- * If set to `true`, the user can group the Grid by dragging the column header cells ([see example]({% slug grouping_grid %})).
474
+ * If `true`, allows grouping by dragging column headers ([see example]({% slug grouping_grid %})).
475
+ *
443
476
  * @default false
444
477
  */
445
478
  groupable = false;
446
479
  /**
447
- * Determines whether the Grid can be resized.
480
+ * Determines if the Grid can be resized.
481
+ *
448
482
  * @default false
449
483
  */
450
484
  gridResizable = false;
451
485
  /**
452
- * Enables the [row reordering]({% slug reordering_rows_grid %}) of the Grid.
486
+ * Enables row reordering feature of the Grid ([see example]({% slug reordering_rows_grid %})).
487
+ *
453
488
  * @default false
454
489
  */
455
490
  set rowReorderable(value) {
@@ -469,9 +504,8 @@ export class GridComponent {
469
504
  return this._rowReorderable;
470
505
  }
471
506
  /**
472
- * When the keyboard navigation is enabled, the user can use dedicated shortcuts to interact with the Grid.
473
- * By default, navigation is enabled. To disable it altogether, and include the Grid content in the normal tab sequence, set the property to `false`.
474
- * To enable navigation through separate Grid sections only, provide a [`GridNavigableSection`]({% slug api_grid_gridnavigablesection %}) array.
507
+ * By default, navigation is enabled. To disable, set to `false`.
508
+ * To enable navigation for specific sections, provide a [`GridNavigableSection`](slug:api_grid_gridnavigablesection).
475
509
  */
476
510
  set navigable(value) {
477
511
  if (typeof value === 'boolean') {
@@ -488,17 +522,15 @@ export class GridComponent {
488
522
  return this._navigable;
489
523
  }
490
524
  /**
491
- * Indicates whether the Grid columns will be resized during initialization so that
492
- * they fit their headers and row content.
525
+ * If `true`, resizes columns during initialization to fit headers and content.
493
526
  * Columns with `autoSize` set to `false` are excluded.
494
- * To dynamically update the column width to match the new content,
495
- * refer to [this example]({% slug resizing_columns_grid %}).
527
+ * [See example](slug:resizing_columns_grid).
528
+ *
496
529
  * @default false
497
530
  */
498
531
  autoSize = false;
499
532
  /**
500
- * Defines a function that is executed for every data row in the component
501
- * ([see example](slug:styling_grid_rows)).
533
+ * Sets a function to apply custom CSS classes to each data row ([see example](slug:styling_grid_rows)).
502
534
  */
503
535
  set rowClass(fn) {
504
536
  if (isDevMode() && typeof fn !== 'function') {
@@ -510,8 +542,7 @@ export class GridComponent {
510
542
  return this._rowClass;
511
543
  }
512
544
  /**
513
- * Defines a function that is executed for every data row in the component,
514
- * and determines whether the row will be sticky, i.e. always visible after scrolling.
545
+ * Sets a function to determine if a data row is sticky (always visible after scrolling).
515
546
  */
516
547
  set rowSticky(fn) {
517
548
  if (isDevMode() && isPresent(fn) && typeof fn !== 'function') {
@@ -525,9 +556,7 @@ export class GridComponent {
525
556
  return this._rowSticky;
526
557
  }
527
558
  /**
528
- * Defines a Boolean function that is executed for each data row in the component
529
- * ([see example]({% slug grid_selection_custom %}#toc-setting-the-selected-rows)).
530
- * Determines whether the row will be selected.
559
+ * Sets a function to determine if a data row is selected ([see example]({% slug grid_selection_custom %}#toc-setting-the-selected-rows)).
531
560
  */
532
561
  set rowSelected(fn) {
533
562
  if (isDevMode() && typeof fn !== 'function') {
@@ -539,8 +568,7 @@ export class GridComponent {
539
568
  return this._rowSelected;
540
569
  }
541
570
  /**
542
- * Defines a Boolean function that is executed for each data row in the component.
543
- * Determines whether the row will be selectable.
571
+ * Sets a function to determine if a data row is selectable.
544
572
  */
545
573
  set isRowSelectable(fn) {
546
574
  if (isDevMode() && typeof fn !== 'function') {
@@ -552,12 +580,8 @@ export class GridComponent {
552
580
  return this._isRowSelectable;
553
581
  }
554
582
  /**
555
- * Defines a function that determines the selected state of a data cell.
556
- * Returns an object with `selected` and `item` properties.
557
- * The cell is marked as selected only if the `selected` property equals `true`.
558
- *
559
- * The function is executed for each data cell and may be called more than once
560
- * as part of a change detection cycle. ([see example]({% slug grid_selection_custom %}#toc-setting-the-selected-cells))
583
+ * Sets a function to determine if a data cell is selected.
584
+ * The function returns an object with `selected` and `item` properties ([see example]({% slug grid_selection_custom %}#toc-setting-the-selected-cells)).
561
585
  */
562
586
  set cellSelected(fn) {
563
587
  if (isDevMode() && typeof fn !== 'function') {
@@ -591,8 +615,8 @@ export class GridComponent {
591
615
  [];
592
616
  }
593
617
  /**
594
- * The current Grid `GridState` objects. Contains the information about data operations and column state, required
595
- * to store and restore the Grid state.
618
+ * Gets the current `GridState`, including data operations and column state.
619
+ * Use this to store and restore the Grid state.
596
620
  */
597
621
  get currentState() {
598
622
  return {
@@ -606,21 +630,19 @@ export class GridComponent {
606
630
  };
607
631
  }
608
632
  /**
609
- * If set to `true`, the user can resize columns by dragging the edges (resize handles) of their header cells
610
- * ([see example]({% slug resizing_columns_grid %})).
633
+ * If `true`, allows resizing columns by dragging header cell edges ([see example]({% slug resizing_columns_grid %})).
611
634
  *
612
635
  * @default false
613
636
  */
614
637
  resizable = false;
615
638
  /**
616
- * If set to `true`, the user can reorder columns by dragging their header cells
617
- * ([see example]({% slug reordering_columns_grid %})).
639
+ * If `true`, allows reordering columns by dragging header cells ([see example]({% slug reordering_columns_grid %})).
618
640
  *
619
641
  * @default false
620
642
  */
621
643
  reorderable = false;
622
644
  /**
623
- * Specifies if the loading indicator of the Grid will be displayed ([see example]({% slug binding_grid %})).
645
+ * If `true`, displays the Grid loading indicator ([see example]({% slug binding_grid %})).
624
646
  *
625
647
  * @default false
626
648
  */
@@ -632,14 +654,15 @@ export class GridComponent {
632
654
  return this._loading;
633
655
  }
634
656
  /**
635
- * Specifies if the column menu of the columns will be displayed ([see example]({% slug columnmenu_grid %})).
657
+ * If `true`, displays the column menu for columns ([see example]({% slug columnmenu_grid %})).
636
658
  *
637
659
  * @default false
638
660
  */
639
661
  columnMenu = false;
640
662
  /**
641
- * Specifies if the header of the grid will be hidden. The header is visible by default.
663
+ * If `true`, hides the Grid header. The header is visible by default.
642
664
  * The header includes column headers and the [filter row](slug:filter_row).
665
+ *
643
666
  * @default false
644
667
  */
645
668
  hideHeader = false;
@@ -650,7 +673,7 @@ export class GridComponent {
650
673
  */
651
674
  showInactiveTools = false;
652
675
  /**
653
- * A function which determines if a specific row is expanded.
676
+ * Sets a function to determine if a specific row is expanded.
654
677
  */
655
678
  set isDetailExpanded(callback) {
656
679
  this.detailsService.userCallback = callback;
@@ -659,7 +682,7 @@ export class GridComponent {
659
682
  return this.detailsService.userCallback;
660
683
  }
661
684
  /**
662
- * A function which determines if a specific group row is expanded.
685
+ * Sets a function to determine if a specific group row is expanded.
663
686
  */
664
687
  set isGroupExpanded(callback) {
665
688
  this.groupsService.userCallback = callback;
@@ -669,31 +692,27 @@ export class GridComponent {
669
692
  return this.groupsService.userCallback;
670
693
  }
671
694
  /**
672
- * Fires when the Grid filter is modified through the UI.
673
- * You have to handle the event yourself and filter the data.
695
+ * Fires when the Grid data is filtered through the UI and the filter descriptor changes.
674
696
  */
675
697
  filterChange = new EventEmitter();
676
698
  /**
677
- * Fires when the page of the Grid is changed ([see example]({% slug paging_grid %})).
678
- * You have to handle the event yourself and page the data.
699
+ * Fires when the page is changed through the UI ([see example]({% slug paging_grid %})).
679
700
  */
680
701
  pageChange = new EventEmitter();
681
702
  /**
682
- * Fires when the grouping of the Grid is changed.
683
- * You have to handle the event yourself and group the data ([see example]({% slug grouping_grid %})).
703
+ * Fires when the Grid data is grouped through the UI and the group descriptors change ([see example]({% slug grouping_grid %})).
684
704
  */
685
705
  groupChange;
686
706
  /**
687
- * Fires when the sorting of the Grid is changed ([see example]({% slug sorting_grid %})).
688
- * You have to handle the event yourself and sort the data.
707
+ * Fires when the Grid data is sorted through the UI and the sort descriptors change ([see example]({% slug sorting_grid %})).
689
708
  */
690
709
  sortChange = new EventEmitter();
691
710
  /**
692
- * Fires when the user selects a Grid row.
711
+ * Fires when the Grid selection changes through the UI.
693
712
  */
694
713
  selectionChange = new EventEmitter();
695
714
  /**
696
- * Fires when the user drops the dragged row and reordering is performed.
715
+ * Fires when a row is reordered through the UI.
697
716
  */
698
717
  rowReorder = new EventEmitter();
699
718
  /**
@@ -705,91 +724,84 @@ export class GridComponent {
705
724
  */
706
725
  gridStateChange = new EventEmitter();
707
726
  /**
708
- * Fires when the user expands a group header.
727
+ * Fires when a group is expanded through the UI.
709
728
  */
710
729
  groupExpand = new EventEmitter();
711
730
  /**
712
- * Fires when the user collapses a group header.
731
+ * Fires when a group is collapsed through the UI.
713
732
  */
714
733
  groupCollapse = new EventEmitter();
715
734
  /**
716
- * Fires when the user expands a master row.
735
+ * Fires when a detail row is expanded through the UI.
717
736
  */
718
737
  detailExpand = new EventEmitter();
719
738
  /**
720
- * Fires when the user collapses a master row.
739
+ * Fires when a detail row is collapsed through the UI.
721
740
  */
722
741
  detailCollapse = new EventEmitter();
723
742
  /**
724
- * Fires when the user clicks the **Edit** command button to edit a row
725
- * ([see example](slug:inline_editing_grid#editing-records-1)).
743
+ * Fires when a row enters edit mode ([see example](slug:inline_editing_grid#editing-records-1)).
726
744
  */
727
745
  edit = new EventEmitter();
728
746
  /**
729
- * Fires when the user clicks the **Cancel** command button to close a row
730
- * ([see example]({% slug inline_editing_grid %}#toc-canceling-editing-1)).
747
+ * Fires when editing is canceled by clicking the **Cancel** command button ([see example]({% slug inline_editing_grid %}#toc-canceling-editing-1)).
731
748
  */
732
749
  cancel = new EventEmitter();
733
750
  /**
734
- * Fires when the user clicks the **Save** command button to save changes in a row
735
- * ([see example]({% slug inline_editing_grid %}#toc-saving-records-1)).
751
+ * Fires when a row is saved by clicking the **Save** command button ([see example]({% slug inline_editing_grid %}#toc-saving-records-1)).
736
752
  */
737
753
  save = new EventEmitter();
738
754
  /**
739
- * Fires when the user clicks the **Remove** command button to remove a row
740
- * ([see example]({% slug inline_editing_grid %}#toc-removing-records-1)).
755
+ * Fires when a row is removed by clicking the **Remove** command button ([see example]({% slug inline_editing_grid %}#toc-removing-records-1)).
741
756
  */
742
757
  remove = new EventEmitter();
743
758
  /**
744
- * Fires when the user clicks the **Add** command button to add a new row
745
- * ([see example]({% slug inline_editing_grid %}#toc-adding-records-1)).
759
+ * Fires when a new row is added by clicking the **Add** command button ([see example]({% slug inline_editing_grid %}#toc-adding-records-1)).
746
760
  */
747
761
  add = new EventEmitter();
748
762
  /**
749
- * Fires when the user leaves an edited cell ([see example](slug:editing_incell_grid)).
763
+ * Fires when a cell edit is closed ([see example](slug:editing_incell_grid)).
750
764
  */
751
765
  cellClose = new EventEmitter();
752
766
  /**
753
- * Fires when the user clicks a cell ([see example](slug:editing_incell_grid)).
767
+ * Fires when a cell is clicked ([see example](slug:editing_incell_grid)).
754
768
  */
755
769
  cellClick;
756
770
  /**
757
- * Fires when the user clicks the **Export to PDF** command button.
771
+ * Fires when the PDF export command is triggered.
758
772
  */
759
773
  pdfExport = new EventEmitter();
760
774
  /**
761
- * Fires when the user clicks the **Export to Excel** command button.
775
+ * Fires when the Excel export command is triggered.
762
776
  */
763
777
  excelExport = new EventEmitter();
764
778
  /**
765
- * Fires when the user completes the resizing of the column.
779
+ * Fires when columns are resized.
766
780
  */
767
781
  columnResize;
768
782
  /**
769
- * Fires when the user completes the reordering of the column.
783
+ * Fires when columns are reordered.
770
784
  */
771
785
  columnReorder = new EventEmitter();
772
786
  /**
773
- * Fires when the user changes the visibility of the columns from the column menu or column chooser.
787
+ * Fires when column visibility changes.
774
788
  */
775
789
  columnVisibilityChange = new EventEmitter();
776
790
  /**
777
- * Fires when the user changes the locked state of the columns from the column menu or by reordering the columns.
791
+ * Fires when columns are locked or unlocked.
778
792
  */
779
793
  columnLockedChange = new EventEmitter();
780
794
  /**
781
- * Fires when the user changes the sticky state of the columns from the column menu.
795
+ * Fires when columns are made sticky or unsticky.
782
796
  */
783
797
  columnStickyChange = new EventEmitter();
784
798
  /**
785
- * Fires when the user scrolls to the last record on the page and enables endless scrolling
786
- * ([see example]({% slug scrollmmodes_grid %}#toc-endless-scrolling)).
787
- * You have to handle the event yourself and page the data.
799
+ * Fires when the last record is scrolled into view ([see example]({% slug scrollmmodes_grid %}#toc-endless-scrolling)).
788
800
  */
789
801
  scrollBottom = new EventEmitter();
790
802
  /**
791
803
  * Fires when the grid content is scrolled.
792
- * For performance reasons, the event is triggered outside the Angular zone. Enter the Angular zone if you make any changes that require change detection.
804
+ * The event is triggered outside the Angular zone for performance. Enter the Angular zone if you make changes that require change detection.
793
805
  */
794
806
  contentScroll = new EventEmitter();
795
807
  /**
@@ -1205,59 +1217,47 @@ export class GridComponent {
1205
1217
  this.columnRangeChangeSubscription = this.columnInfoService.columnRangeChange.subscribe(this.onColumnRangeChange.bind(this));
1206
1218
  }
1207
1219
  /**
1208
- * Expands the specified master row ([see example]({% slug hierarchy_grid %})).
1209
- *
1210
- * This method is provided only for backwards-compatibility with legacy versions.
1211
- * These versions tracked the expanded state internally using the data row index.
1220
+ * Expands the master row at the specified data row index ([see example]({% slug hierarchy_grid %})).
1212
1221
  *
1213
- * For new development, use the [kendoGridDetailsExpandBy directive]({% slug api_grid_expanddetailsdirective %})
1214
- * or provide an isDetailExpanded callback. See [Controlling the Expanded State]({% slug master_detail_expanded_state_grid %})
1215
- * for examples on how to control the expanded state.
1222
+ * This method is for backwards compatibility with legacy versions that track expanded state by row index.
1223
+ * For new development, use the [`kendoGridDetailsExpandBy` directive]({% slug api_grid_expanddetailsdirective %})
1224
+ * or provide an `isDetailExpanded` callback. See [Controlling the Expanded State]({% slug master_detail_expanded_state_grid %}) for examples.
1216
1225
  *
1217
- * @param index - The data row index of the master row.
1226
+ * @param index The data row index of the master row.
1218
1227
  */
1219
1228
  expandRow(index) {
1220
1229
  this.toggleDetailRowLegacy(index, true);
1221
1230
  }
1222
1231
  /**
1223
- * Collapses the specified master row ([see example]({% slug hierarchy_grid %})).
1224
- *
1225
- * This method is provided only for backwards-compatibility with legacy versions.
1226
- * These versions tracked the expanded state internally using the data row index.
1232
+ * Collapses the master row at the specified data row index ([see example]({% slug hierarchy_grid %})).
1227
1233
  *
1228
- * For new development, use the [kendoGridDetailsExpandBy directive]({% slug api_grid_expanddetailsdirective %})
1229
- * or provide an isDetailExpanded callback. See [Controlling the Expanded State]({% slug master_detail_expanded_state_grid %})
1230
- * for examples on how to control the expanded state.
1234
+ * This method is for backwards compatibility with legacy versions that track expanded state by row index.
1235
+ * For new development, use the [`kendoGridDetailsExpandBy` directive]({% slug api_grid_expanddetailsdirective %})
1236
+ * or provide an `isDetailExpanded` callback. See [Controlling the Expanded State]({% slug master_detail_expanded_state_grid %}) for examples.
1231
1237
  *
1232
- * @param index - The data row index of the master row.
1238
+ * @param index The data row index of the master row.
1233
1239
  */
1234
1240
  collapseRow(index) {
1235
1241
  this.toggleDetailRowLegacy(index, false);
1236
1242
  }
1237
1243
  /**
1238
- * Expands a group header item for the given index. For example,
1239
- * `0_1` expands the second inner group of the first master group.
1244
+ * Expands a group header at the given hierarchical index, such as `0_1` for the second inner group of the first master group.
1240
1245
  *
1241
- * This method is provided only for backwards-compatibility with legacy versions.
1242
- * These versions tracked the expanded group state internally using the hierarchical group index.
1246
+ * This method is for backwards compatibility with legacy versions that track expanded group state by hierarchical group index.
1247
+ * If the Grid is pageable, the group indexes are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
1243
1248
  *
1244
- * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
1245
- *
1246
- * @param {string} index - The underscore separated hierarchical index of the group.
1249
+ * @param {string} index The underscore-separated hierarchical index of the group.
1247
1250
  */
1248
1251
  expandGroup(index) {
1249
1252
  this.toggleGroupRowLegacy(index, true);
1250
1253
  }
1251
1254
  /**
1252
- * Collapses a group header item for the given index. For example,
1253
- * `0_1` collapses the second inner group of the first master group.
1254
- *
1255
- * This method is provided only for backwards-compatibility with legacy versions.
1256
- * These versions tracked the expanded group state internally using the hierarchical group index.
1255
+ * Collapses a group header at the given hierarchical index, such as `0_1` for the second inner group of the first master group.
1257
1256
  *
1258
- * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
1257
+ * This method is for backwards compatibility with legacy versions that track expanded group state by hierarchical group index.
1258
+ * If the Grid is pageable, the group indexes are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
1259
1259
  *
1260
- * @param {string} index - The underscore separated hierarchical index of the group.
1260
+ * @param {string} index The underscore-separated hierarchical index of the group.
1261
1261
  */
1262
1262
  collapseGroup(index) {
1263
1263
  this.toggleGroupRowLegacy(index, false);
@@ -1472,12 +1472,11 @@ export class GridComponent {
1472
1472
  */
1473
1473
  messageFor = token => this.localization.get(token);
1474
1474
  /**
1475
- * Switches the specified table row in the edit mode ([see example]({% slug inline_editing_grid %}#toc-editing-records-1)).
1475
+ * Switches the specified table row to edit mode ([see example]({% slug inline_editing_grid %}#toc-editing-records-1)).
1476
1476
  *
1477
- * @param rowIndex - The data row index that will be switched in the edit mode.
1478
- * @param group - The [FormGroup](link:site.data.urls.angular['formgroupapi'])
1479
- * that describes the edit form.
1480
- * @param options - Additional options configuring the focus target once the editor opens.
1477
+ * @param rowIndex The data row index to switch to edit mode.
1478
+ * @param group The [`FormGroup`](link:site.data.urls.angular['formgroupapi']) that describes the edit form.
1479
+ * @param options Additional options to configure the focus target when the editor opens.
1481
1480
  */
1482
1481
  editRow(rowIndex, group, options) {
1483
1482
  this.editService.editRow(rowIndex, group);
@@ -1496,10 +1495,9 @@ export class GridComponent {
1496
1495
  this.rowReorderService[evType](ev);
1497
1496
  }
1498
1497
  /**
1499
- * Closes the editor for a given row ([see example]({% slug inline_editing_grid %}#toc-canceling-editing-1)).
1498
+ * Closes the editor for the specified row ([see example]({% slug inline_editing_grid %}#toc-canceling-editing-1)).
1500
1499
  *
1501
- * @param {number} index - The row index that will be switched out of the edit mode. If no index is provided, it is assumed
1502
- * that the new item editor will be closed.
1500
+ * @param {number} index The row index to switch out of edit mode. If you do not provide an index, the new item editor closes.
1503
1501
  */
1504
1502
  closeRow(index) {
1505
1503
  this.editService.close(index);
@@ -1507,8 +1505,7 @@ export class GridComponent {
1507
1505
  /**
1508
1506
  * Creates a new row editor ([see example]({% slug inline_editing_grid %}#toc-adding-records-1)).
1509
1507
  *
1510
- * @param {FormGroup} group - The [FormGroup](link:site.data.urls.angular['formgroupapi']) that describes
1511
- * the edit form. If called with a data item, it will build the `FormGroup` from the data item fields.
1508
+ * @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.
1512
1509
  */
1513
1510
  addRow(group) {
1514
1511
  const isFormGroup = group instanceof FormGroup;
@@ -1520,12 +1517,11 @@ export class GridComponent {
1520
1517
  this.focusEditElement('.k-grid-add-row');
1521
1518
  }
1522
1519
  /**
1523
- * Puts the cell that is specified by the table row and column in edit mode ([see example](slug:editing_incell_grid)).
1520
+ * Puts the specified cell in edit mode ([see example](slug:editing_incell_grid)).
1524
1521
  *
1525
- * @param {number} rowIndex - The data row index that will be switched in the edit mode.
1526
- * @param {number|string|any} column - The leaf column index, or the field name or the column instance that should be edited.
1527
- * @param {FormGroup} group - The [FormGroup](link:site.data.urls.angular['formgroupapi'])
1528
- * that describes the edit form.
1522
+ * @param {number} rowIndex The data row index to switch to edit mode.
1523
+ * @param {number|string|any} column The leaf column index, field name, or column instance to edit.
1524
+ * @param {FormGroup} group The [`FormGroup`](link:site.data.urls.angular['formgroupapi']) that describes the edit form.
1529
1525
  */
1530
1526
  editCell(rowIndex, column, group) {
1531
1527
  const instance = this.columnInstance(column);
@@ -1533,12 +1529,9 @@ export class GridComponent {
1533
1529
  this.focusEditElement('.k-grid-edit-cell');
1534
1530
  }
1535
1531
  /**
1536
- * Closes the current cell in edit mode and fires
1537
- * the [cellClose]({% slug api_grid_gridcomponent %}#toc-cellclose) event.
1532
+ * Closes the current cell in edit mode and fires the [`cellClose`]({% slug api_grid_gridcomponent %}#toc-cellclose) event.
1538
1533
  *
1539
- * @return {boolean} Indicates whether the edited cell was closed.
1540
- * A `false` value indicates that the
1541
- * [cellClose]({% slug api_grid_gridcomponent %}#toc-cellclose) event was prevented.
1534
+ * @returns {boolean} `true` if the cell closed. Returns `false` if the [`cellClose`]({% slug api_grid_gridcomponent %}#toc-cellclose) event was prevented.
1542
1535
  */
1543
1536
  closeCell() {
1544
1537
  return !this.editService.closeCell();
@@ -1550,17 +1543,17 @@ export class GridComponent {
1550
1543
  this.editService.cancelCell();
1551
1544
  }
1552
1545
  /**
1553
- * Returns a flag which indicates if a row or a cell is currently edited.
1546
+ * Returns `true` if a row or cell is currently edited.
1554
1547
  *
1555
- * @return {boolean} A flag which indicates if a row or a cell is currently edited.
1548
+ * @returns {boolean} `true` if a row or cell is currently edited.
1556
1549
  */
1557
1550
  isEditing() {
1558
1551
  return this.editService.isEditing();
1559
1552
  }
1560
1553
  /**
1561
- * Returns a flag which indicates if a cell is currently edited.
1554
+ * Returns `true` if a cell is currently edited.
1562
1555
  *
1563
- * @return {boolean} A flag which indicates if a cell is currently being edited.
1556
+ * @returns {boolean} `true` if a cell is currently being edited.
1564
1557
  */
1565
1558
  isEditingCell() {
1566
1559
  return this.editService.isEditingCell();
@@ -1572,10 +1565,10 @@ export class GridComponent {
1572
1565
  this.pdfService.save(this);
1573
1566
  }
1574
1567
  /**
1575
- * Exports the Grid element to a Drawing [Group]({% slug api_kendo-drawing_group %}) by using the `kendo-grid-pdf` component options.
1568
+ * Exports the Grid element to a Drawing [Group]({% slug api_kendo-drawing_group %}) using the `kendo-grid-pdf` component options
1576
1569
  * ([see example]({% slug pdfexport_grid %}#toc-exporting-multiple-grids-to-the-same-pdf)).
1577
1570
  *
1578
- * @return {Promise} A promise that will be resolved with the Drawing `Group`.
1571
+ * @returns {Promise} A promise that resolves with the Drawing `Group`.
1579
1572
  */
1580
1573
  drawPDF() {
1581
1574
  const promise = createPromise();
@@ -1589,7 +1582,7 @@ export class GridComponent {
1589
1582
  this.excelService.save(this);
1590
1583
  }
1591
1584
  /**
1592
- * Applies the provided `GridState` object to the Grid.
1585
+ * Applies the given `GridState` object to the Grid.
1593
1586
  */
1594
1587
  loadState(state) {
1595
1588
  if (state.columnsState) {
@@ -1627,10 +1620,8 @@ export class GridComponent {
1627
1620
  });
1628
1621
  }
1629
1622
  /**
1630
- * Applies the minimum possible width for the specified column,
1631
- * so that the whole text fits without wrapping. This method expects the Grid
1632
- * to be [resizable](slug:resizing_columns_grid). The method must be executed
1633
- * after the Grid is already populated with data.
1623
+ * Applies the minimum possible width for the specified column so the whole text fits without wrapping.
1624
+ * This method expects the Grid to be [`resizable`](slug:resizing_columns_grid). Run this method after the Grid is populated with data.
1634
1625
  * [See example](slug:resizing_columns_grid#toc-auto-fitting-the-content)
1635
1626
  */
1636
1627
  autoFitColumn(column) {
@@ -1638,10 +1629,8 @@ export class GridComponent {
1638
1629
  }
1639
1630
  /**
1640
1631
  * Adjusts the width of the specified columns to fit the entire content, including headers, without wrapping.
1641
- * If no columns are specified, `autoFitColumns` is applied to all columns.The method must be executed
1642
- * after the Grid is already populated with data.
1632
+ * If you do not specify columns, `autoFitColumns` applies to all columns. Run this method after the Grid is populated with data.
1643
1633
  * [See example](slug:resizing_columns_grid#toc-auto-fitting-the-content)
1644
- *
1645
1634
  */
1646
1635
  autoFitColumns(columns = this.columns) {
1647
1636
  let cols;
@@ -1716,8 +1705,8 @@ export class GridComponent {
1716
1705
  * If the Grid is configured for scrolling, including virtual scrolling, the scroll position will be updated.
1717
1706
  * If the row is not present on the current page, the method will have no effect.
1718
1707
  *
1719
- * @param rowIndex - The logical row index to focus. The top header row has an index 0.
1720
- * @param colIndex - The column index to focus.
1708
+ * @param rowIndex The logical row index to focus. The top header row has an index 0.
1709
+ * @param colIndex The column index to focus.
1721
1710
  * @returns {NavigationCell} The focused cell.
1722
1711
  *
1723
1712
  */
@@ -1728,7 +1717,7 @@ export class GridComponent {
1728
1717
  /**
1729
1718
  * Focuses the next cell, optionally wrapping to the next row.
1730
1719
  *
1731
- * @param wrap - A Boolean value which indicates if the focus will move to the next row. Defaults to `true`.
1720
+ * @param wrap A Boolean value which indicates if the focus will move to the next row. Defaults to `true`.
1732
1721
  * @returns {NavigationCell} The focused cell. If the focus is already on the last cell, returns `null`.
1733
1722
  */
1734
1723
  focusNextCell(wrap = true) {
@@ -1759,15 +1748,12 @@ export class GridComponent {
1759
1748
  }
1760
1749
  /**
1761
1750
  * Changes the position of the specified column.
1762
- * The reordering of columns operates only on the level
1763
- * which is inferred by the source column.
1764
- * For the `reorderColumn` method to work properly,
1765
- * the `source` column has to be visible.
1766
- *
1767
- * @param {ColumnBase} source - The column whose position will be changed.
1768
- * @param {number} destIndex - The new position of the column.
1769
- * @param {ColumnReorderConfig} options - Additional options.
1751
+ * The reordering of columns operates only on the level inferred by the source column.
1752
+ * For this method to work, the `source` column must be visible.
1770
1753
  *
1754
+ * @param {ColumnBase} source The column to move.
1755
+ * @param {number} destIndex The new position of the column.
1756
+ * @param {ColumnReorderConfig} options Additional options.
1771
1757
  */
1772
1758
  reorderColumn(source, destIndex, options = { before: false }) {
1773
1759
  const columnsForLevel = sortColumns(this.allColumnsForLevel(source.level));
@@ -3006,6 +2992,7 @@ export class GridComponent {
3006
2992
  [style.table-layout]="resizable ? 'fixed' : null"
3007
2993
  kendoGridTable
3008
2994
  kendoGridResizableTable
2995
+ class="k-grid-table"
3009
2996
  role="presentation"
3010
2997
  [size]="size">
3011
2998
  <colgroup kendoGridColGroup
@@ -3042,6 +3029,8 @@ export class GridComponent {
3042
3029
  [data]="$any(view)"
3043
3030
  [skip]="skip"
3044
3031
  [columns]="$any(leafColumns)"
3032
+ [totalColumnsCount]="leafColumns.length"
3033
+ [totalColumns]="columnsContainer"
3045
3034
  [selectable]="selectable"
3046
3035
  [filterable]="filterable"
3047
3036
  [noRecordsTemplate]="noRecordsTemplate"
@@ -3829,6 +3818,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3829
3818
  [style.table-layout]="resizable ? 'fixed' : null"
3830
3819
  kendoGridTable
3831
3820
  kendoGridResizableTable
3821
+ class="k-grid-table"
3832
3822
  role="presentation"
3833
3823
  [size]="size">
3834
3824
  <colgroup kendoGridColGroup
@@ -3865,6 +3855,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3865
3855
  [data]="$any(view)"
3866
3856
  [skip]="skip"
3867
3857
  [columns]="$any(leafColumns)"
3858
+ [totalColumnsCount]="leafColumns.length"
3859
+ [totalColumns]="columnsContainer"
3868
3860
  [selectable]="selectable"
3869
3861
  [filterable]="filterable"
3870
3862
  [noRecordsTemplate]="noRecordsTemplate"