@progress/kendo-angular-grid 19.1.2-develop.3 → 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
@@ -5,27 +5,27 @@
5
5
  import { GroupResult } from '@progress/kendo-data-query';
6
6
  import { GroupItem } from './group-item.interface';
7
7
  /**
8
- * Represents a group footer item of the Grid.
8
+ * Represents a group footer item in the Grid.
9
9
  */
10
10
  export interface GroupFooterItem {
11
11
  /**
12
- * The type of the Grid item.
12
+ * Sets the type of the Grid item.
13
13
  */
14
14
  type: 'footer';
15
15
  /**
16
- * The group data.
16
+ * Holds the group data.
17
17
  */
18
18
  data: GroupResult;
19
19
  /**
20
- * The index of the group item.
20
+ * Sets the index of the group item.
21
21
  */
22
22
  groupIndex: string;
23
23
  /**
24
- * The nesting level of the group. The root group is at level 0.
24
+ * Sets the nesting level of the group. The root group is at level 0.
25
25
  */
26
26
  level: number;
27
27
  /**
28
- * The current footer group item.
28
+ * Holds the current footer group item.
29
29
  */
30
30
  group: GroupItem;
31
31
  }
@@ -8,23 +8,23 @@ import { GroupResult } from '@progress/kendo-data-query';
8
8
  */
9
9
  export interface GroupItem {
10
10
  /**
11
- * The type of the Grid item.
11
+ * Sets the type of the Grid item.
12
12
  */
13
13
  type: 'group';
14
14
  /**
15
- * The group data.
15
+ * Holds the group data.
16
16
  */
17
17
  data: GroupResult;
18
18
  /**
19
- * The index of the group item.
19
+ * Sets the index of the group item.
20
20
  */
21
21
  index: string;
22
22
  /**
23
- * The nesting level of the group. The root group is at level 0.
23
+ * Sets the nesting level of the group. The root group is at level 0.
24
24
  */
25
25
  level: number;
26
26
  /**
27
- * The parent group item.
27
+ * Holds the parent group item.
28
28
  */
29
29
  parentGroup: GroupItem;
30
30
  }
@@ -12,14 +12,18 @@ import { RowReorderEvent } from './row-reordering/types';
12
12
  import { RowReorderService } from './row-reordering/row-reorder.service';
13
13
  import * as i0 from "@angular/core";
14
14
  /**
15
- * A directive which encapsulates the in-memory handling of data operations such as [paging]({% slug paging_grid %}),
16
- * [sorting]({% slug sorting_grid %}), and [grouping]({% slug grouping_grid %})
17
- * ([more information and examples]({% slug local_data_grid %}#toc-using-the-data-binding-directive)).
15
+ * A directive that handles in-memory data operations like [paging]({% slug paging_grid %}),
16
+ * [sorting]({% slug sorting_grid %}), and [grouping]({% slug grouping_grid %}).
17
+ *
18
+ * Use this directive with local data and enable the Grid data operations with minimal configuration.
19
+ * ([More information and examples]({% slug local_data_grid %}#toc-using-the-data-binding-directive)).
18
20
  *
19
21
  * @example
20
22
  * ```html
21
- * <kendo-grid [kendoGridBinding]="gridData" ...></kendo-grid>
23
+ * <kendo-grid [kendoGridBinding]="gridData"></kendo-grid>
22
24
  * ```
25
+ * @remarks
26
+ * Applied to: {@link GridComponent}.
23
27
  */
24
28
  export declare class DataBindingDirective implements OnInit, OnDestroy, DoCheck, OnChanges {
25
29
  protected grid: GridComponent;
@@ -27,28 +31,34 @@ export declare class DataBindingDirective implements OnInit, OnDestroy, DoCheck,
27
31
  protected localDataChangesService?: LocalDataChangesService;
28
32
  private rowReorderService?;
29
33
  /**
30
- * Defines the number of records that will be skipped by the pager.
34
+ * Sets the number of records to skip in the Grid.
35
+ *
31
36
  * @default 0
32
37
  */
33
38
  set skip(value: number);
34
39
  /**
35
- * Defines the descriptors by which the data will be sorted.
40
+ * Sets the sort descriptors for the Grid data.
41
+ *
36
42
  */
37
43
  set sort(value: SortDescriptor[]);
38
44
  /**
39
- * Defines the descriptor by which the data will be filtered.
45
+ * Sets the filter descriptor for the Grid data.
46
+ *
40
47
  */
41
48
  set filter(value: CompositeFilterDescriptor);
42
49
  /**
43
- * Defines the page size used by the Grid pager.
50
+ * Sets the page size for the Grid pager.
51
+ *
44
52
  */
45
53
  set pageSize(value: number);
46
54
  /**
47
- * The descriptors by which the data will be grouped.
55
+ * Sets the group descriptors for the Grid data.
56
+ *
48
57
  */
49
58
  set group(value: GroupDescriptor[]);
50
59
  /**
51
- * The array of data which will be used to populate the Grid.
60
+ * Sets the data array for the Grid.
61
+ *
52
62
  */
53
63
  set data(value: any[]);
54
64
  protected state: State;
package/directives.d.ts CHANGED
@@ -257,6 +257,15 @@ export declare const KENDO_GRID_EXCEL_EXPORT: readonly [typeof ExcelComponent, t
257
257
  */
258
258
  export declare const KENDO_GRID_PDF_EXPORT: readonly [typeof PDFComponent, typeof PDFMarginComponent, typeof PDFCommandDirective, typeof PDFTemplateDirective, typeof PDFCommandToolbarDirective];
259
259
  /**
260
- * Utility array that contains all `Grid` related components and directives
260
+ * Contains all Grid-related components and directives.
261
+ *
262
+ * @example
263
+ * ```typescript
264
+ * import { KENDO_GRID } from '@progress/kendo-angular-grid';
265
+ * @NgModule({
266
+ * imports: [KENDO_GRID]
267
+ * })
268
+ * export class AppModule {}
269
+ * ```
261
270
  */
262
271
  export declare const KENDO_GRID: readonly [typeof GridComponent, typeof ToolbarTemplateDirective, typeof ToolbarComponent, typeof GridSpacerComponent, typeof StatusBarTemplateDirective, typeof DataBindingDirective, typeof SelectionDirective, typeof CustomMessagesComponent, typeof GroupBindingDirective, typeof TemplateEditingDirective, typeof ReactiveEditingDirective, typeof InCellEditingDirective, typeof ExternalEditingDirective, typeof ExpandDetailsDirective, typeof ExpandGroupDirective, typeof GridToolbarFocusableDirective, typeof GroupHeaderTemplateDirective, typeof GroupHeaderColumnTemplateDirective, typeof GroupFooterTemplateDirective, typeof GroupHeaderComponent, typeof GroupPanelComponent, typeof ColumnComponent, typeof ColumnGroupComponent, typeof LogicalCellDirective, typeof LogicalRowDirective, typeof FocusableDirective, typeof FooterTemplateDirective, typeof ColGroupComponent, typeof ResizableContainerDirective, typeof TemplateContextDirective, typeof FieldAccessorPipe, typeof DetailTemplateDirective, typeof SpanColumnComponent, typeof LoadingComponent, typeof GridTableDirective, typeof CommandColumnComponent, typeof CheckboxColumnComponent, typeof SelectionCheckboxDirective, typeof CellTemplateDirective, typeof EditTemplateDirective, typeof RowDragHandleTemplateDirective, typeof RowDragHintTemplateDirective, typeof TableBodyComponent, typeof NoRecordsTemplateDirective, typeof CellComponent, typeof EditCommandDirective, typeof CancelCommandDirective, typeof SaveCommandDirective, typeof RemoveCommandDirective, typeof AddCommandDirective, typeof AddCommandToolbarDirective, typeof EditCommandToolbarDirective, typeof SaveCommandToolbarDirective, typeof RemoveCommandToolbarDirective, typeof CancelCommandToolbarDirective, typeof CellLoadingTemplateDirective, typeof LoadingTemplateDirective, typeof RowReorderColumnComponent, typeof SortCommandToolbarDirective, typeof FilterCommandToolbarDirective, typeof GroupCommandToolbarDirective, typeof HeaderComponent, typeof HeaderTemplateDirective, typeof ColumnHandleDirective, typeof SelectAllCheckboxDirective, typeof FilterRowComponent, typeof FilterCellComponent, typeof FilterCellTemplateDirective, typeof StringFilterCellComponent, typeof NumericFilterCellComponent, typeof AutoCompleteFilterCellComponent, typeof BooleanFilterCellComponent, typeof FilterCellHostDirective, typeof FilterCellWrapperComponent, typeof DateFilterCellComponent, typeof FilterCellOperatorsComponent, typeof ContainsFilterOperatorComponent, typeof DoesNotContainFilterOperatorComponent, typeof EndsWithFilterOperatorComponent, typeof EqualFilterOperatorComponent, typeof IsEmptyFilterOperatorComponent, typeof IsNotEmptyFilterOperatorComponent, typeof IsNotNullFilterOperatorComponent, typeof IsNullFilterOperatorComponent, typeof NotEqualFilterOperatorComponent, typeof StartsWithFilterOperatorComponent, typeof GreaterFilterOperatorComponent, typeof GreaterOrEqualToFilterOperatorComponent, typeof LessFilterOperatorComponent, typeof LessOrEqualToFilterOperatorComponent, typeof AfterFilterOperatorComponent, typeof AfterEqFilterOperatorComponent, typeof BeforeEqFilterOperatorComponent, typeof BeforeFilterOperatorComponent, typeof FilterMenuComponent, typeof FilterMenuContainerComponent, typeof FilterMenuInputWrapperComponent, typeof StringFilterMenuInputComponent, typeof StringFilterMenuComponent, typeof FilterMenuTemplateDirective, typeof NumericFilterMenuComponent, typeof NumericFilterMenuInputComponent, typeof DateFilterMenuInputComponent, typeof DateFilterMenuComponent, typeof FilterMenuHostDirective, typeof BooleanFilterMenuComponent, typeof FilterMenuDropDownListDirective, typeof BooleanFilterRadioButtonDirective, typeof ColumnChooserComponent, typeof ColumnChooserToolbarDirective, typeof ColumnMenuFilterComponent, typeof ColumnMenuItemComponent, typeof ColumnMenuItemContentTemplateDirective, typeof ColumnMenuSortComponent, typeof ColumnMenuLockComponent, typeof ColumnMenuStickComponent, typeof ColumnMenuPositionComponent, typeof ColumnMenuChooserComponent, typeof ColumnMenuTemplateDirective, typeof ColumnMenuContainerComponent, typeof ColumnMenuItemDirective, typeof ColumnMenuComponent, typeof ColumnMenuAutoSizeColumnComponent, typeof ColumnMenuAutoSizeAllColumnsComponent, typeof GridClipboardDirective, typeof UndoRedoDirective, typeof UndoCommandToolbarDirective, typeof RedoCommandToolbarDirective, typeof ExcelComponent, typeof ExcelCommandDirective, typeof ExcelCommandToolbarDirective, typeof ExcelColumnComponent, typeof ExcelColumnGroupComponent, typeof ExcelFooterTemplateDirective, typeof ExcelGroupFooterTemplateDirective, typeof ExcelGroupHeaderColumnTemplateDirective, typeof ExcelGroupHeaderTemplateDirective, typeof PDFComponent, typeof PDFMarginComponent, typeof PDFCommandDirective, typeof PDFTemplateDirective, typeof PDFCommandToolbarDirective];
@@ -3,11 +3,11 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Additional configuration for the [`reorderColumn`](slug:api_grid_gridcomponent#toc-reordercolumn) method.
6
+ * Provides extra configuration for the [`reorderColumn`](slug:api_grid_gridcomponent#toc-reordercolumn) method.
7
7
  */
8
8
  export interface ColumnReorderConfig {
9
9
  /**
10
- * Indicates whether the reordered column will be positioned before or after the destination index.
10
+ * Indicates if the reordered column is placed before or after the destination index.
11
11
  */
12
12
  before: boolean;
13
13
  }
@@ -5,21 +5,19 @@
5
5
  import { PreventableEvent } from '../common/preventable-event';
6
6
  import { ColumnBase } from '../columns/column-base';
7
7
  /**
8
- * Arguments for the `columnReorder` event.
8
+ * Provides the arguments for the `columnReorder` event.
9
9
  */
10
10
  export declare class ColumnReorderEvent extends PreventableEvent {
11
11
  /**
12
- * The reordered column.
12
+ * Represents the reordered column.
13
13
  */
14
14
  readonly column: ColumnBase;
15
15
  /**
16
- * The new index of the column.
17
- * Relative to the collection of columns.
16
+ * Represents the new index of the column. This index is relative to the collection of columns.
18
17
  */
19
18
  readonly newIndex: number;
20
19
  /**
21
- * The original index of the column before reordering.
22
- * Relative to the collection of columns.
20
+ * Represents the original index of the column before reordering. This index is relative to the collection of columns.
23
21
  */
24
22
  readonly oldIndex: number;
25
23
  /**
@@ -10,21 +10,19 @@ import { ToolbarEditingToolBase } from './toolbar-editing-tool-base.directive';
10
10
  import * as i0 from "@angular/core";
11
11
  /**
12
12
  * Represents the command for adding a new item to the Grid.
13
- * You can apply this directive to any `kendo-toolbar-button` element inside a
14
- * ToolbarComponent used in the Grid.
15
- *
16
- * When the user clicks the toolbar button that is associated with the directive, , the
17
- * [add]({% slug api_grid_gridcomponent %}#toc-add) event is triggered
18
- * ([see example]({% slug basics_editing_grid %})).
13
+ * You can apply this directive to any `kendo-toolbar-button` element inside a ToolbarComponent used in the Grid.
14
+ * When you click the toolbar button associated with the directive, the [`add`]({% slug api_grid_gridcomponent %}#toc-add) event triggers ([see example]({% slug basics_editing_grid %})).
19
15
  *
20
16
  * @example
21
- * ```html-no-run
17
+ * ```html
22
18
  * <kendo-grid>
23
19
  * <kendo-toolbar>
24
20
  * <kendo-toolbar-button text="Add new" kendoGridAddTool></kendo-toolbar-button>
25
21
  * </kendo-toolbar>
26
22
  * </kendo-grid>
27
23
  * ```
24
+ * @remarks
25
+ * Applied to: {@link ToolBarButtonComponent}.
28
26
  */
29
27
  export declare class AddCommandToolbarDirective extends ToolbarEditingToolBase {
30
28
  editService: EditService;
@@ -8,19 +8,14 @@ import { ContextService } from '../common/provider.service';
8
8
  import { EditService } from './edit.service';
9
9
  import * as i0 from "@angular/core";
10
10
  /**
11
- * Represents the command for adding a new item to the Grid. You can apply this directive to any
11
+ * Represents the command for adding a new item to the Grid. Apply this directive to any
12
12
  * `button` element inside a [ToolbarTemplate]({% slug api_grid_commandcolumncomponent %}).
13
- * When an associated button with the directive is clicked, the
14
- * [add]({% slug api_grid_gridcomponent %}#toc-add) event is triggered
13
+ * When you click the button with this directive, the [`add`]({% slug api_grid_gridcomponent %}#toc-add) event is triggered
15
14
  * ([see example]({% slug basics_editing_grid %})).
16
15
  *
17
16
  * @example
18
17
  * ```html
19
- * <kendo-grid>
20
- * <ng-template kendoGridToolbarTemplate>
21
- * <button kendoGridAddCommand>Add new</button>
22
- * </ng-template>
23
- * </kendo-grid>
18
+ * <button kendoGridAddCommand>Add new item</button>
24
19
  * ```
25
20
  */
26
21
  export declare class AddCommandDirective extends Button {
@@ -4,7 +4,7 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { EditEvent } from "./edit-event-args.interface";
6
6
  /**
7
- * Arguments for the [`add`](slug:api_grid_gridcomponent#toc-add) event. [See example](slug:inline_editing_grid#toc-adding-records).
7
+ * Provides the arguments for the [`add`](slug:api_grid_gridcomponent#toc-add) event. [See example](slug:inline_editing_grid#toc-adding-records).
8
8
  */
9
9
  export interface AddEvent extends EditEvent {
10
10
  }
@@ -11,20 +11,20 @@ import { ToolbarEditingToolBase } from './toolbar-editing-tool-base.directive';
11
11
  import * as i0 from "@angular/core";
12
12
  /**
13
13
  * Represents the `cancel` command in the Grid.
14
- * You can apply this directive to any `kendo-toolbar-button` element inside a
15
- * ToolbarComponent used in the Grid.
14
+ * Apply this directive to any `kendo-toolbar-button` element inside a ToolbarComponent in the Grid.
16
15
  *
17
- * When the user clicks the toolbar button that is associated with the directive, the
18
- * [cancel]({% slug api_grid_gridcomponent %}#toc-cancel) event is triggered.
16
+ * When you click the toolbar button with this directive, the [`cancel`]({% slug api_grid_gridcomponent %}#toc-cancel) event triggers.
19
17
  *
20
18
  * @example
21
- * ```html-no-run
19
+ * ```html
22
20
  * <kendo-grid>
23
21
  * <kendo-toolbar>
24
22
  * <kendo-toolbar-button text="Cancel" kendoGridCancelTool></kendo-toolbar-button>
25
23
  * </kendo-toolbar>
26
24
  * </kendo-grid>
27
25
  * ```
26
+ * @remarks
27
+ * Applied to: {@link ToolBarButtonComponent}.
28
28
  */
29
29
  export declare class CancelCommandToolbarDirective extends ToolbarEditingToolBase {
30
30
  editService: EditService;
@@ -9,14 +9,15 @@ import { CellContext } from '../rendering/common/cell-context';
9
9
  import { ContextService } from '../common/provider.service';
10
10
  import * as i0 from "@angular/core";
11
11
  /**
12
- * Represents the `cancel` command of the Grid. You can apply this directive to any `button`
12
+ * Represents the `cancel` command of the Grid. Apply this directive to any `button`
13
13
  * element inside a [CommandColumnComponent]({% slug api_grid_commandcolumncomponent %})
14
14
  * ([see example](slug:editing_directives_grid#toc-command-column-directives)).
15
- * When an associated button with the directive is clicked, the
16
- * [cancel]({% slug api_grid_gridcomponent %}#toc-cancel) event
17
- * is triggered. When the row is not in the edit mode, the button with the `kendoGridCancelCommand` is automatically hidden.
18
15
  *
19
- * You can control the content of the button based on the state of the row.
16
+ * When a button with this directive is clicked, the
17
+ * [`cancel`]({% slug api_grid_gridcomponent %}#toc-cancel) event
18
+ * is triggered. If the row is not in edit mode, the button is automatically hidden.
19
+ *
20
+ * You can customize the button content based on the row's state.
20
21
  *
21
22
  * @example
22
23
  * ```html
@@ -4,7 +4,13 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { SaveEvent } from "./save-event-args.interface";
6
6
  /**
7
- * Arguments for the [`cancel`](slug:api_grid_gridcomponent#toc-cancel) event. [See example](slug:inline_editing_grid#toc-canceling-editing).
7
+ * Arguments for the [`cancel`](slug:api_grid_gridcomponent#toc-cancel) event.
8
+ *
9
+ * This event is emitted when the user cancels editing of a row or cell.
10
+ *
11
+ * The event exposes the same properties as the `SaveEvent`, allowing access to the data item, form group, and row or cell context being canceled.
12
+ *
13
+ * [See example](slug:inline_editing_grid#toc-canceling-editing).
8
14
  */
9
15
  export interface CancelEvent extends SaveEvent {
10
16
  }
@@ -3,10 +3,10 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { PreventableEvent } from '../common/preventable-event';
6
- import { EditEvent } from "./edit-event-args.interface";
7
- import type { GridComponent } from "../grid.component";
6
+ import { EditEvent } from './edit-event-args.interface';
7
+ import type { GridComponent } from '../grid.component';
8
8
  /**
9
- * Arguments for the `cellClose` event.
9
+ * Arguments for the [`cellClose`](slug:api_grid_gridcomponent#toc-cellclose) event.
10
10
  */
11
11
  export declare class CellCloseEvent extends PreventableEvent implements EditEvent {
12
12
  isNew: boolean;
@@ -22,13 +22,16 @@ export declare class CellCloseEvent extends PreventableEvent implements EditEven
22
22
  */
23
23
  column: any;
24
24
  /**
25
- * The [FormGroup](link:site.data.urls.angular['formgroupapi']) that is used to edit the cell which will be closed.
25
+ * The [FormGroup](link:site.data.urls.angular['formgroupapi']) used to edit the cell.
26
26
  */
27
27
  formGroup: any;
28
28
  /**
29
- * The DOM event that caused the `cellClose` event.
30
- * May not be present if `cellClose` was caused by an API call.
29
+ * The DOM event that triggered the `cellClose` event.
30
+ * May be undefined if the event was triggered programmatically.
31
31
  */
32
32
  originalEvent: any;
33
+ /**
34
+ * @hidden
35
+ */
33
36
  constructor(options: any);
34
37
  }
@@ -10,21 +10,22 @@ import { ContextService } from '../common/provider.service';
10
10
  import { ToolbarEditingToolBase } from './toolbar-editing-tool-base.directive';
11
11
  import * as i0 from "@angular/core";
12
12
  /**
13
- * Represents the `edit` command in the Grid.
14
- * You can apply this directive to any `kendo-toolbar-button` element inside a
15
- * ToolbarComponent used in the Grid.
13
+ * Represents the `edit` command in the Grid. Apply this directive to any `kendo-toolbar-button`
14
+ * element inside a ToolbarComponent used in the Grid.
16
15
  *
17
- * When the user clicks the toolbar button that is associated with the directive, the
18
- * [edit]({% slug api_grid_gridcomponent %}#toc-edit) event is triggered.
16
+ * When you click the toolbar button with this directive, the
17
+ * [`edit`]({% slug api_grid_gridcomponent %}#toc-edit) event fires.
19
18
  *
20
19
  * @example
21
- * ```html-no-run
20
+ * ```html
22
21
  * <kendo-grid>
23
- * <kendo-toolbar>
24
- * <kendo-toolbar-button text="Edit" kendoGridEditTool></kendo-toolbar-button>
25
- * </kendo-toolbar>
22
+ * <kendo-toolbar>
23
+ * <kendo-toolbar-button text="Edit" kendoGridEditTool></kendo-toolbar-button>
24
+ * </kendo-toolbar>
26
25
  * </kendo-grid>
27
26
  * ```
27
+ * @remarks
28
+ * Applied to: {@link ToolBarButtonComponent}.
28
29
  */
29
30
  export declare class EditCommandToolbarDirective extends ToolbarEditingToolBase {
30
31
  editService: EditService;
@@ -12,7 +12,7 @@ import * as i0 from "@angular/core";
12
12
  * Represents the `edit` command of the Grid. You can apply this directive to any `button`
13
13
  * element inside a [CommandColumnComponent]({% slug api_grid_commandcolumncomponent %}).
14
14
  * When an associated button with the directive is clicked, the
15
- * [edit]({% slug api_grid_gridcomponent %}#toc-edit) event
15
+ * [`edit`]({% slug api_grid_gridcomponent %}#toc-edit) event
16
16
  * is triggered ([see example]({% slug basics_editing_grid %})).
17
17
  *
18
18
  * When the row is in the `edit` mode, the button with `kendoGridEditCommand` is automatically hidden.
@@ -4,11 +4,11 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import type { GridComponent } from "../grid.component";
6
6
  /**
7
- * Arguments for the [`edit`](slug:api_grid_gridcomponent#toc-edit) event.
7
+ * Provides the arguments for the [`edit`](slug:api_grid_gridcomponent#toc-edit) event.
8
8
  */
9
9
  export interface EditEvent {
10
10
  /**
11
- * The data item.
11
+ * The data item for the row.
12
12
  */
13
13
  dataItem: any;
14
14
  /**
@@ -20,7 +20,7 @@ export interface EditEvent {
20
20
  */
21
21
  rowIndex: number;
22
22
  /**
23
- * The `GridComponent` instance.
23
+ * The `GridComponent` instance that triggered the event.
24
24
  */
25
25
  sender: GridComponent;
26
26
  }
@@ -3,16 +3,22 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Additional options for the [editRow]({% slug api_grid_gridcomponent %}#toc-editrow) method. [See example.]({% slug editing_rowclick_grid %}#toc-managing-focus)
6
+ * Provides additional options for the [`editRow`]({% slug api_grid_gridcomponent %}#toc-editrow) method. [See example]({% slug editing_rowclick_grid %}#toc-managing-focus).
7
+ *
8
+ * @example
9
+ * ```typescript
10
+ * public onEdit(grid: GridComponent): void {
11
+ * grid.editRow(2, { skipFocus: true, columnIndex: 1 });
12
+ * }
13
+ * ```
7
14
  */
8
15
  export interface EditRowOptions {
9
16
  /**
10
- * Determines if focusing the row's edit element should be skipped. Defaults to `false`.
17
+ * If set to `true`, skips focusing the row's edit element. Defaults to `false`.
11
18
  */
12
19
  skipFocus?: boolean;
13
20
  /**
14
- * Specifies which particular column should be focused after the row editor opens.
15
- * By default, the first column receives focus.
21
+ * Sets which column receives focus after the row editor opens. The first column receives focus by default.
16
22
  */
17
23
  columnIndex?: number;
18
24
  }
@@ -5,16 +5,24 @@
5
5
  import { TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents the column edit-cell template of the Grid ([see example](slug:custom_reactive_editing_grid#toc-setting-up-custom-inputs)).
9
- * Helps to customize the content of the edited cells. To define the cell template, nest an `<ng-template>`
10
- * tag with the `kendoGridEditTemplate` directive inside a `<kendo-grid-column>` tag.
8
+ * Lets you customize the content of edited cells by providing a column edit-cell template for the Grid ([see example](slug:custom_reactive_editing_grid#toc-setting-up-custom-inputs)).
9
+ * Place an `<ng-template>` tag with the `kendoGridEditTemplate` directive inside a `<kendo-grid-column>` tag to define the template.
11
10
  *
12
- * The template context is set to the current form group and the following additional fields are passed:
13
- * - `formGroup`&mdash;The current [FormGroup](link:site.data.urls.angular['formgroupapi']). Represents the default context that will be assigned to any template variable which utilizes the `let-x` syntax, for example, `let-formGroup`. If you use the Grid inside [Template-Driven Forms](link:site.data.urls.angular['forms']), it will be `undefined`.
14
- * - `rowIndex`&mdash;The current data row index. If inside a new item row, `rowIndex` is `-1`. Use it as an alias for a template variable by utilizing the `let-rowIndex="rowIndex"` syntax.
15
- * - `dataItem`&mdash;The current data item. Use it as an alias for a template variable by utilizing the `let-dataItem="dataItem"` syntax.
16
- * - `column`&mdash;The current column instance. Use it as an alias for a template variable by utilizing the `let-column="column"` syntax.
17
- * - `isNew`&mdash;The state of the current item. Use it as an alias for a template variable by utilizing the `let-isNew="isNew"` syntax.
11
+ * The template context includes:
12
+ * - `formGroup`&mdash;The current [FormGroup](link:site.data.urls.angular['formgroupapi']). This is the default context for template variables using `let-x`, such as `let-formGroup`. If you use the Grid in [Template-Driven Forms](link:site.data.urls.angular['forms']), this is `undefined`.
13
+ * - `rowIndex`&mdash;The current data row index. For a new item row, `rowIndex` is `-1`. Use `let-rowIndex="rowIndex"` to access it.
14
+ * - `dataItem`&mdash;The current data item. Use `let-dataItem="dataItem"` to access it.
15
+ * - `column`&mdash;The current column instance. Use `let-column="column"` to access it.
16
+ * - `isNew`&mdash;The state of the current item. Use `let-isNew="isNew"` to access it.
17
+ *
18
+ * @example
19
+ * ```html
20
+ * <kendo-grid-column>
21
+ * <ng-template kendoGridEditTemplate let-formGroup="formGroup" let-dataItem="dataItem">
22
+ * <kendo-textbox [formControl]="formGroup.get('field')"></kendo-textbox>
23
+ * </ng-template>
24
+ * </kendo-grid-column>
25
+ * ```
18
26
  */
19
27
  export declare class EditTemplateDirective {
20
28
  templateRef: TemplateRef<any>;