@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
@@ -14,21 +14,19 @@ import * as i2 from "@progress/kendo-angular-toolbar";
14
14
  import * as i3 from "../common/provider.service";
15
15
  /**
16
16
  * Represents the command for adding a new item to the Grid.
17
- * You can apply this directive to any `kendo-toolbar-button` element inside a
18
- * ToolbarComponent used in the Grid.
19
- *
20
- * When the user clicks the toolbar button that is associated with the directive, , the
21
- * [add]({% slug api_grid_gridcomponent %}#toc-add) event is triggered
22
- * ([see example]({% slug basics_editing_grid %})).
17
+ * You can apply this directive to any `kendo-toolbar-button` element inside a ToolbarComponent used in the Grid.
18
+ * 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 %})).
23
19
  *
24
20
  * @example
25
- * ```html-no-run
21
+ * ```html
26
22
  * <kendo-grid>
27
23
  * <kendo-toolbar>
28
24
  * <kendo-toolbar-button text="Add new" kendoGridAddTool></kendo-toolbar-button>
29
25
  * </kendo-toolbar>
30
26
  * </kendo-grid>
31
27
  * ```
28
+ * @remarks
29
+ * Applied to: {@link ToolBarButtonComponent}.
32
30
  */
33
31
  export class AddCommandToolbarDirective extends ToolbarEditingToolBase {
34
32
  editService;
@@ -12,19 +12,14 @@ import * as i0 from "@angular/core";
12
12
  import * as i1 from "./edit.service";
13
13
  import * as i2 from "../common/provider.service";
14
14
  /**
15
- * Represents the command for adding a new item to the Grid. You can apply this directive to any
15
+ * Represents the command for adding a new item to the Grid. Apply this directive to any
16
16
  * `button` element inside a [ToolbarTemplate]({% slug api_grid_commandcolumncomponent %}).
17
- * When an associated button with the directive is clicked, the
18
- * [add]({% slug api_grid_gridcomponent %}#toc-add) event is triggered
17
+ * When you click the button with this directive, the [`add`]({% slug api_grid_gridcomponent %}#toc-add) event is triggered
19
18
  * ([see example]({% slug basics_editing_grid %})).
20
19
  *
21
20
  * @example
22
21
  * ```html
23
- * <kendo-grid>
24
- * <ng-template kendoGridToolbarTemplate>
25
- * <button kendoGridAddCommand>Add new</button>
26
- * </ng-template>
27
- * </kendo-grid>
22
+ * <button kendoGridAddCommand>Add new item</button>
28
23
  * ```
29
24
  */
30
25
  export class AddCommandDirective extends Button {
@@ -16,20 +16,20 @@ import * as i3 from "../selection/selection.service";
16
16
  import * as i4 from "../common/provider.service";
17
17
  /**
18
18
  * Represents the `cancel` command in the Grid.
19
- * You can apply this directive to any `kendo-toolbar-button` element inside a
20
- * ToolbarComponent used in the Grid.
19
+ * Apply this directive to any `kendo-toolbar-button` element inside a ToolbarComponent in the Grid.
21
20
  *
22
- * When the user clicks the toolbar button that is associated with the directive, the
23
- * [cancel]({% slug api_grid_gridcomponent %}#toc-cancel) event is triggered.
21
+ * When you click the toolbar button with this directive, the [`cancel`]({% slug api_grid_gridcomponent %}#toc-cancel) event triggers.
24
22
  *
25
23
  * @example
26
- * ```html-no-run
24
+ * ```html
27
25
  * <kendo-grid>
28
26
  * <kendo-toolbar>
29
27
  * <kendo-toolbar-button text="Cancel" kendoGridCancelTool></kendo-toolbar-button>
30
28
  * </kendo-toolbar>
31
29
  * </kendo-grid>
32
30
  * ```
31
+ * @remarks
32
+ * Applied to: {@link ToolBarButtonComponent}.
33
33
  */
34
34
  export class CancelCommandToolbarDirective extends ToolbarEditingToolBase {
35
35
  editService;
@@ -13,14 +13,15 @@ import * as i0 from "@angular/core";
13
13
  import * as i1 from "./edit.service";
14
14
  import * as i2 from "../common/provider.service";
15
15
  /**
16
- * Represents the `cancel` command of the Grid. You can apply this directive to any `button`
16
+ * Represents the `cancel` command of the Grid. Apply this directive to any `button`
17
17
  * element inside a [CommandColumnComponent]({% slug api_grid_commandcolumncomponent %})
18
18
  * ([see example](slug:editing_directives_grid#toc-command-column-directives)).
19
- * When an associated button with the directive is clicked, the
20
- * [cancel]({% slug api_grid_gridcomponent %}#toc-cancel) event
21
- * is triggered. When the row is not in the edit mode, the button with the `kendoGridCancelCommand` is automatically hidden.
22
19
  *
23
- * You can control the content of the button based on the state of the row.
20
+ * When a button with this directive is clicked, the
21
+ * [`cancel`]({% slug api_grid_gridcomponent %}#toc-cancel) event
22
+ * is triggered. If the row is not in edit mode, the button is automatically hidden.
23
+ *
24
+ * You can customize the button content based on the row's state.
24
25
  *
25
26
  * @example
26
27
  * ```html
@@ -4,7 +4,7 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { PreventableEvent } from '../common/preventable-event';
6
6
  /**
7
- * Arguments for the `cellClose` event.
7
+ * Arguments for the [`cellClose`](slug:api_grid_gridcomponent#toc-cellclose) event.
8
8
  */
9
9
  export class CellCloseEvent extends PreventableEvent {
10
10
  isNew;
@@ -20,14 +20,17 @@ export class CellCloseEvent extends PreventableEvent {
20
20
  */
21
21
  column;
22
22
  /**
23
- * The [FormGroup](link:site.data.urls.angular['formgroupapi']) that is used to edit the cell which will be closed.
23
+ * The [FormGroup](link:site.data.urls.angular['formgroupapi']) used to edit the cell.
24
24
  */
25
25
  formGroup;
26
26
  /**
27
- * The DOM event that caused the `cellClose` event.
28
- * May not be present if `cellClose` was caused by an API call.
27
+ * The DOM event that triggered the `cellClose` event.
28
+ * May be undefined if the event was triggered programmatically.
29
29
  */
30
30
  originalEvent;
31
+ /**
32
+ * @hidden
33
+ */
31
34
  constructor(options) {
32
35
  super();
33
36
  Object.assign(this, options);
@@ -15,21 +15,22 @@ import * as i2 from "@progress/kendo-angular-toolbar";
15
15
  import * as i3 from "../selection/selection.service";
16
16
  import * as i4 from "../common/provider.service";
17
17
  /**
18
- * Represents the `edit` command in the Grid.
19
- * You can apply this directive to any `kendo-toolbar-button` element inside a
20
- * ToolbarComponent used in the Grid.
18
+ * Represents the `edit` command in the Grid. Apply this directive to any `kendo-toolbar-button`
19
+ * element inside a ToolbarComponent used in the Grid.
21
20
  *
22
- * When the user clicks the toolbar button that is associated with the directive, the
23
- * [edit]({% slug api_grid_gridcomponent %}#toc-edit) event is triggered.
21
+ * When you click the toolbar button with this directive, the
22
+ * [`edit`]({% slug api_grid_gridcomponent %}#toc-edit) event fires.
24
23
  *
25
24
  * @example
26
- * ```html-no-run
25
+ * ```html
27
26
  * <kendo-grid>
28
- * <kendo-toolbar>
29
- * <kendo-toolbar-button text="Edit" kendoGridEditTool></kendo-toolbar-button>
30
- * </kendo-toolbar>
27
+ * <kendo-toolbar>
28
+ * <kendo-toolbar-button text="Edit" kendoGridEditTool></kendo-toolbar-button>
29
+ * </kendo-toolbar>
31
30
  * </kendo-grid>
32
31
  * ```
32
+ * @remarks
33
+ * Applied to: {@link ToolBarButtonComponent}.
33
34
  */
34
35
  export class EditCommandToolbarDirective extends ToolbarEditingToolBase {
35
36
  editService;
@@ -16,7 +16,7 @@ import * as i2 from "../common/provider.service";
16
16
  * Represents the `edit` command of the Grid. You can apply this directive to any `button`
17
17
  * element inside a [CommandColumnComponent]({% slug api_grid_commandcolumncomponent %}).
18
18
  * When an associated button with the directive is clicked, the
19
- * [edit]({% slug api_grid_gridcomponent %}#toc-edit) event
19
+ * [`edit`]({% slug api_grid_gridcomponent %}#toc-edit) event
20
20
  * is triggered ([see example]({% slug basics_editing_grid %})).
21
21
  *
22
22
  * When the row is in the `edit` mode, the button with `kendoGridEditCommand` is automatically hidden.
@@ -5,16 +5,24 @@
5
5
  import { Directive, TemplateRef, Optional } 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 class EditTemplateDirective {
20
28
  templateRef;
@@ -15,21 +15,22 @@ import * as i2 from "@progress/kendo-angular-toolbar";
15
15
  import * as i3 from "../selection/selection.service";
16
16
  import * as i4 from "../common/provider.service";
17
17
  /**
18
- * Represents the `remove` command in the Grid.
19
- * You can apply this directive to any `kendo-toolbar-button` element inside a
20
- * ToolbarComponent used in the Grid.
18
+ * Represents the `remove` command in the Grid. Apply this directive to any `kendo-toolbar-button`
19
+ * element inside a ToolbarComponent used in the Grid.
21
20
  *
22
- * When the user clicks the toolbar button that is associated with the directive, the
23
- * [remove]({% slug api_grid_gridcomponent %}#toc-remove) event is triggered.
21
+ * When you click the toolbar button with this directive, the
22
+ * [`remove`]({% slug api_grid_gridcomponent %}#toc-remove) event fires.
24
23
  *
25
24
  * @example
26
- * ```html-no-run
25
+ * ```html
27
26
  * <kendo-grid>
28
- * <kendo-toolbar>
29
- * <kendo-toolbar-button text="Remove row" kendoGridRemoveTool></kendo-toolbar-button>
30
- * </kendo-toolbar>
27
+ * <kendo-toolbar>
28
+ * <kendo-toolbar-button text="Remove row" kendoGridRemoveTool></kendo-toolbar-button>
29
+ * </kendo-toolbar>
31
30
  * </kendo-grid>
32
31
  * ```
32
+ * @remarks
33
+ * Applied to: {@link ToolBarButtonComponent}.
33
34
  */
34
35
  export class RemoveCommandToolbarDirective extends ToolbarEditingToolBase {
35
36
  editService;
@@ -13,13 +13,12 @@ import * as i0 from "@angular/core";
13
13
  import * as i1 from "./edit.service";
14
14
  import * as i2 from "../common/provider.service";
15
15
  /**
16
- * Represents the `remove` command of the Grid. You can apply this directive to any `button` element
16
+ * Represents the `remove` command of the Grid. Apply this directive to any `button` element
17
17
  * inside a [CommandColumnComponent]({% slug api_grid_commandcolumncomponent %})
18
18
  * ([see example](slug:editing_directives_grid#toc-command-column-directives)).
19
- * When an associated button with the directive is clicked, the
20
- * [remove]({% slug api_grid_gridcomponent %}#toc-remove) event
21
- * is triggered.
22
- * When the row is in the `edit` mode, the button with the `kendoGridRemoveCommand` is automatically hidden.
19
+ * When you click the button with this directive, the
20
+ * [`remove`]({% slug api_grid_gridcomponent %}#toc-remove) event fires.
21
+ * The button with `kendoGridRemoveCommand` is automatically hidden when the row is in edit mode.
23
22
  *
24
23
  * @example
25
24
  * ```html
@@ -15,21 +15,22 @@ import * as i2 from "@progress/kendo-angular-toolbar";
15
15
  import * as i3 from "../selection/selection.service";
16
16
  import * as i4 from "../common/provider.service";
17
17
  /**
18
- * Represents the `save` command in the Grid.
19
- * You can apply this directive to any `kendo-toolbar-button` element inside a
20
- * ToolbarComponent used in the Grid.
18
+ * Represents the `save` command in the Grid. Apply this directive to any `kendo-toolbar-button`
19
+ * element inside a ToolbarComponent used in the Grid.
21
20
  *
22
- * When the user clicks the toolbar button that is associated with the directive, the
23
- * [save]({% slug api_grid_gridcomponent %}#toc-save) event is triggered.
21
+ * When you click the toolbar button with this directive, the
22
+ * [`save`]({% slug api_grid_gridcomponent %}#toc-save) event fires.
24
23
  *
25
24
  * @example
26
- * ```html-no-run
25
+ * ```html
27
26
  * <kendo-grid>
28
27
  * <kendo-toolbar>
29
28
  * <kendo-toolbar-button text="Save" kendoGridSaveTool></kendo-toolbar-button>
30
29
  * </kendo-toolbar>
31
30
  * </kendo-grid>
32
31
  * ```
32
+ * @remarks
33
+ * Applied to: {@link ToolBarButtonComponent}.
33
34
  */
34
35
  export class SaveCommandToolbarDirective extends ToolbarEditingToolBase {
35
36
  editService;
@@ -13,14 +13,14 @@ import * as i0 from "@angular/core";
13
13
  import * as i1 from "./edit.service";
14
14
  import * as i2 from "../common/provider.service";
15
15
  /**
16
- * Represents the `save` command of the Grid. You can apply this directive to any `button`
16
+ * Represents the `save` command of the Grid. Apply this directive to any `button`
17
17
  * element inside a [CommandColumnComponent]({% slug api_grid_commandcolumncomponent %})
18
18
  * ([see example](slug:editing_directives_grid#toc-command-column-directives)).
19
- * When an associated button with the directive is clicked, the
20
- * [save]({% slug api_grid_gridcomponent %}#toc-save) event
21
- * is triggered. When the row is not in the edit mode, the button with `kendoGridSaveCommand` is automatically hidden.
19
+ * When you click the button with this directive, the
20
+ * [`save`]({% slug api_grid_gridcomponent %}#toc-save) event fires.
21
+ * The button with `kendoGridSaveCommand` is automatically hidden when the row is not in edit mode.
22
22
  *
23
- * You can control the content of the button based on the state of the row.
23
+ * You can change the button content based on the row state.
24
24
  *
25
25
  * @example
26
26
  * ```html
@@ -15,23 +15,30 @@ import * as i1 from "../grid.component";
15
15
  import * as i2 from "../editing/local-data-changes.service";
16
16
  import * as i3 from "../common/adaptiveness.service";
17
17
  /**
18
- * A directive which encapsulates the editing operations of the Grid when using the
18
+ * Represents the Kendo UI Grid external editing directive. The directive manages editing operations in the Grid when using the
19
19
  * External Form ([see example](slug:editing_directives_grid#external-editing)).
20
+ *
21
+ * @example
22
+ * ```typescript
23
+ * <kendo-grid [data]="data" kendoGridExternalEditing></kendo-grid>
24
+ * ```
25
+ * @remarks
26
+ * Applied to: {@link GridComponent}.
20
27
  */
21
28
  export class ExternalEditingDirective extends EditingDirectiveBase {
22
29
  grid;
23
30
  localDataChangesService;
24
31
  adaptiveGridService;
25
32
  /**
26
- * The function that creates the `FormGroup` for the edited model.
33
+ * Specifies the function that creates the `FormGroup` for the edited model.
27
34
  */
28
35
  createFormGroup;
29
36
  /**
30
- * Allows you to customize form orientation, hints, labels and error messages.
37
+ * Customizes form orientation, hints, labels, and error messages.
31
38
  */
32
39
  formSettings;
33
40
  /**
34
- * Allows you to customize the Dialog that contains the edit form.
41
+ * Customizes the Dialog that contains the edit form.
35
42
  */
36
43
  dialogSettings;
37
44
  constructor(grid, localDataChangesService, adaptiveGridService) {
@@ -12,15 +12,21 @@ import * as i0 from "@angular/core";
12
12
  import * as i1 from "../grid.component";
13
13
  import * as i2 from "../editing/local-data-changes.service";
14
14
  /**
15
- * A directive which encapsulates the editing operations of the Grid when using the in-cell
16
- * editing with Reactive Forms ([see example]({% slug editing_directives_grid %}#toc-in-cell-editing)).
15
+ * Represent the directive that manages in-cell editing operations in the Grid when using Reactive Forms ([see example]({% slug editing_directives_grid %}#toc-in-cell-editing)).
16
+ *
17
+ * @example
18
+ * ```typescript
19
+ * <kendo-grid [data]="data" kendoGridInCellEditing></kendo-grid>
20
+ * ```
21
+ * @remarks
22
+ * Applied to: {@link GridComponent}.
17
23
  */
18
24
  export class InCellEditingDirective extends EditingDirectiveBase {
19
25
  grid;
20
26
  localDataChangesService;
21
27
  cdr;
22
28
  /**
23
- * The function that creates the `FormGroup` for the edited model.
29
+ * Specifies the function that creates the `FormGroup` for the edited model.
24
30
  */
25
31
  createFormGroup;
26
32
  constructor(grid, localDataChangesService, cdr) {
@@ -11,14 +11,20 @@ import * as i0 from "@angular/core";
11
11
  import * as i1 from "../grid.component";
12
12
  import * as i2 from "../editing/local-data-changes.service";
13
13
  /**
14
- * A directive which encapsulates the editing operations of the Grid when using the
15
- * Reactive Forms ([see example](slug:editing_directives_grid#toc-reactive-editing-directive)).
14
+ * Represents the directive that manages editing operations in the Grid when using Reactive Forms ([see example](slug:editing_directives_grid#toc-reactive-editing-directive)).
15
+ *
16
+ * @example
17
+ * ```typescript
18
+ * <kendo-grid [data]="data" kendoGridReactiveEditing></kendo-grid>
19
+ * ```
20
+ * @remarks
21
+ * Applied to: {@link GridComponent}.
16
22
  */
17
23
  export class ReactiveEditingDirective extends RowEditingDirectiveBase {
18
24
  grid;
19
25
  localDataChangesService;
20
26
  /**
21
- * The function that creates the `FormGroup` for the edited model.
27
+ * Specifies the function that creates the `FormGroup` for the edited model.
22
28
  */
23
29
  createFormGroup;
24
30
  constructor(grid, localDataChangesService) {
@@ -10,14 +10,20 @@ import * as i0 from "@angular/core";
10
10
  import * as i1 from "../grid.component";
11
11
  import * as i2 from "../editing/local-data-changes.service";
12
12
  /**
13
- * A directive which encapsulates the editing operations of the Grid when using
14
- * the Template-Driven Angular Forms ([see example]({% slug editing_directives_grid %}#toc-template-editing-directive)).
13
+ * Represents the directive that manages editing operations in the Grid when using Template-Driven Angular Forms ([see example]({% slug editing_directives_grid %}#toc-template-editing-directive)).
14
+ *
15
+ * @example
16
+ * ```typescript
17
+ * <kendo-grid [data]="data" kendoGridTemplateEditing></kendo-grid>
18
+ * ```
19
+ * @remarks
20
+ * Applied to: {@link GridComponent}.
15
21
  */
16
22
  export class TemplateEditingDirective extends RowEditingDirectiveBase {
17
23
  grid;
18
24
  localDataChangesService;
19
25
  /**
20
- * The function that creates the `dataItem` for the new rows.
26
+ * Specifies the function that creates the `dataItem` for new rows.
21
27
  */
22
28
  createNewItem;
23
29
  dataItem;
@@ -13,24 +13,21 @@ import * as i1 from "./excel.service";
13
13
  import * as i2 from "@progress/kendo-angular-toolbar";
14
14
  import * as i3 from "../common/provider.service";
15
15
  /**
16
- * Represents the `export-to-Excel` toolbar tool of the Grid.
17
- * You can apply this directive to any `kendo-toolbar-button` element inside a
18
- * ToolbarComponent used in the Grid.
19
- *
20
- * When the user clicks a button associated with the directive, the
21
- * [excelExport]({% slug api_grid_gridcomponent %}#toc-excelexport) event
22
- * fires ([see example]({% slug excelexport_grid %})).
16
+ * Represents the **Export to Excel** toolbar tool of the Grid.
17
+ * Apply this directive to any `kendo-toolbar-button` element inside a ToolbarComponent used in the Grid.
18
+ * When the user clicks the button, the [`excelExport`]({% slug api_grid_gridcomponent %}#toc-excelexport) event fires ([see example]({% slug excelexport_grid %})).
23
19
  *
24
20
  * @example
25
- * ```html-no-run
21
+ * ```html
26
22
  * <kendo-grid>
27
- * <kendo-toolbar>
28
- * <kendo-toolbar-button text="Excel Export" kendoGridExcelTool></kendo-toolbar-button>
29
- * </kendo-toolbar>
30
- * <kendo-grid-excel fileName="Grid.xlsx">
31
- * </kendo-grid-excel>
23
+ * <kendo-toolbar>
24
+ * <kendo-toolbar-button text="Excel Export" kendoGridExcelTool></kendo-toolbar-button>
25
+ * </kendo-toolbar>
26
+ * <kendo-grid-excel fileName="Grid.xlsx"></kendo-grid-excel>
32
27
  * </kendo-grid>
33
28
  * ```
29
+ * @remarks
30
+ * Applied to: {@link ToolBarButtonComponent}.
34
31
  */
35
32
  export class ExcelCommandToolbarDirective extends ToolbarToolBase {
36
33
  excelService;
@@ -12,21 +12,17 @@ import * as i0 from "@angular/core";
12
12
  import * as i1 from "./excel.service";
13
13
  import * as i2 from "../common/provider.service";
14
14
  /**
15
- * Represents the `export-to-Excel` command of the Grid. You can apply this
16
- * directive to any `button` element inside a
17
- * [ToolbarTemplate]({% slug api_grid_toolbartemplatedirective %}).
18
- * When the user clicks a button associated with the directive, the
19
- * [excelExport]({% slug api_grid_gridcomponent %}#toc-excelexport) event
20
- * fires ([see example]({% slug excelexport_grid %})).
15
+ * Represents the `excelExport` command of the Grid. Apply this
16
+ * directive to any `button` element inside a [`ToolbarTemplate`]({% slug api_grid_toolbartemplatedirective %}).
17
+ * When the user clicks the button, the [`excelExport`]({% slug api_grid_gridcomponent %}#toc-excelexport) event fires ([see example]({% slug excelexport_grid %})).
21
18
  *
22
19
  * @example
23
20
  * ```html
24
21
  * <kendo-grid>
25
- * <ng-template kendoGridToolbarTemplate>
26
- * <button kendoGridExcelCommand>Export to Excel</button>
27
- * </ng-template>
28
- * <kendo-grid-excel fileName="Grid.xlsx">
29
- * </kendo-grid-excel>
22
+ * <ng-template kendoGridToolbarTemplate>
23
+ * <button kendoGridExcelCommand>Export to Excel</button>
24
+ * </ng-template>
25
+ * <kendo-grid-excel fileName="Grid.xlsx"></kendo-grid-excel>
30
26
  * </kendo-grid>
31
27
  * ```
32
28
  */
@@ -4,10 +4,13 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { PreventableEvent } from '../common/preventable-event';
6
6
  /**
7
- * Arguments for the `excelExport` event.
7
+ * Provides arguments for the `excelExport` event.
8
8
  */
9
9
  export class ExcelExportEvent extends PreventableEvent {
10
10
  workbook;
11
+ /**
12
+ * @hidden
13
+ */
11
14
  constructor(workbook) {
12
15
  super();
13
16
  this.workbook = workbook;
@@ -57,64 +57,63 @@ const componentColumns = (component) => {
57
57
  return orderBy(columns, [{ field: 'locked', dir: 'desc' }]);
58
58
  };
59
59
  /**
60
- * Configures the settings for the export of Grid in Excel ([see example]({% slug excelexport_grid %})).
60
+ * The component is required when exporting the data to an Excel file. The componnet provides different options to further configure the Excel export settings of the Grid ([see example]({% slug excelexport_grid %})).
61
+ *
62
+ * @example
63
+ * ```html
64
+ * <kendo-grid>
65
+ * <kendo-grid-excel fileName="Export.xlsx"></kendo-grid-excel>
66
+ * </kendo-grid>
67
+ * ```
61
68
  */
62
69
  export class ExcelComponent {
63
70
  ctx;
64
71
  zone;
65
72
  /**
66
- * Specifies the file name of the exported Excel file.
73
+ * Sets the file name for the exported Excel file.
67
74
  * @default "Export.xlsx"
68
75
  */
69
76
  fileName = 'Export.xlsx';
70
77
  /**
71
- * Enables or disables column filtering in the Excel file. This behavior is different from the filtering feature of the Grid.
78
+ * Enables or disables column filtering in the Excel file. This option is different from the Grid's filtering feature.
72
79
  */
73
80
  filterable;
74
81
  /**
75
- * The author of the workbook.
82
+ * Sets the author of the workbook.
76
83
  */
77
84
  creator;
78
85
  /**
79
- * The date on which the workbook was created. Defaults to `new Date()`.
86
+ * Sets the creation date of the workbook.
80
87
  */
81
88
  date;
82
89
  /**
83
- * If set to `true`, the content is forwarded to [proxyURL](#toc-proxyurl) even if the browser supports the saving of files locally.
90
+ * Forwards the content to [`proxyURL`](#toc-proxyurl) even if the browser supports local file saving when set to `true`.
84
91
  */
85
92
  forceProxy;
86
93
  /**
87
- * The URL of the server-side proxy which streams the file to the end user.
88
- *
89
- * Using a proxy is required if the browser is not capable of saving files locally.
90
- *
91
- * Optionally, set up a proxy to reduce memory usage. This avoids copying the file contents in memory,
92
- * but transmits it over the network instead. For this use case, set [forceProxy](#toc-forceproxy) to `true`
93
- * to skip client-side saving even in browser that support it.
94
- *
95
- * In the request body, the proxy receives a POST request with the specific parameters. [See example](slug:server_proxy#toc-implementations).
96
- * The proxy returns the decoded file with the `"Content-Disposition"` header set to `attachment; filename="<fileName.xslx>"`.
97
- *
98
- * For details on the server-side proxy usage and implementation, see the [File Saver]({% slug overview_filesaver %}) documentation.
94
+ * Sets the URL of the server-side proxy that streams the file to the user. Use a proxy if the browser cannot save files locally.
95
+ * You can also use a proxy to reduce memory usage by transmitting the file over the network.
96
+ * Set [`forceProxy`](#toc-forceproxy) to `true` to skip client-side saving.
97
+ * The proxy receives a POST request with specific parameters and returns the decoded file with the `"Content-Disposition"` header set to `attachment; filename="<fileName.xslx>"`.
98
+ * For more details, see the [File Saver]({% slug overview_filesaver %}) documentation.
99
99
  */
100
100
  proxyURL;
101
101
  /**
102
- * The function that is used to get the exported data options. By default, uses the current data and group of the Grid.
103
- * To export data that is different from the current Grid data, provide a custom function.
102
+ * Provides a function to get the exported data options. By default, uses the current Grid data and group.
103
+ * Supply a custom function to export different data. Typically used to export all data, not just the current page [see example](slug:excelexport_grid#exporting-specific-data).
104
104
  */
105
105
  fetchData;
106
106
  /**
107
- * If the data is grouped, the options of the cells that are inserted before the data,
108
- * group, and footer cells to indicate the group hierarchy.
107
+ * Sets options for cells inserted before the data, group, and footer cells to indicate the group hierarchy if the data is grouped.
108
+ *
109
109
  */
110
110
  paddingCellOptions;
111
111
  /**
112
- * If the data is grouped, the options of the cells that are inserted before the
113
- * header cells to align the headers and the column values.
112
+ * Sets the options for cells inserted before the header cells to align the headers and the column values when the data is grouped.
114
113
  */
115
114
  headerPaddingCellOptions;
116
115
  /**
117
- * Specifies if the groups in the Excel file are collapsible.
116
+ * Specifies if groups in the Excel file are collapsible.
118
117
  */
119
118
  collapsible;
120
119
  /**
@@ -13,11 +13,9 @@ import * as i4 from "./excel-command-tool.directive";
13
13
  import * as i5 from "@progress/kendo-angular-excel-export";
14
14
  // IMPORTANT: NgModule export kept for backwards compatibility
15
15
  /**
16
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
17
- * definition for the Excel component of the Grid.
16
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the Excel component of the Grid.
18
17
  *
19
18
  * @example
20
- *
21
19
  * ```ts
22
20
  * import { NgModule } from '@angular/core';
23
21
  * import { BrowserModule } from "@angular/platform-browser";
@@ -25,12 +23,11 @@ import * as i5 from "@progress/kendo-angular-excel-export";
25
23
  * import { AppComponent } from './app.component';
26
24
  *
27
25
  * _@NgModule({
28
- * declarations: [AppComponent],
29
- * imports: [BrowserModule, GridModule, ExcelModule],
30
- * bootstrap: [AppComponent]
26
+ * declarations: [AppComponent],
27
+ * imports: [BrowserModule, GridModule, ExcelModule],
28
+ * bootstrap: [AppComponent]
31
29
  * })
32
30
  * export class AppModule {}
33
- *
34
31
  * ```
35
32
  */
36
33
  export class ExcelModule {