@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
@@ -2,21 +2,4 @@
2
2
  * Copyright © 2025 Progress Software Corporation. All rights reserved.
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
- /**
6
- * Defines the settings for `position` property of the the Grid Toolbar Template. [See example](slug:toolbartemplate_grid#toc-setting-the-toolbar-position)
7
- *
8
- * The possible values are:
9
- * * `top`—Displays the Toolbar a the top of the Grid.
10
- * * `bottom`—Displays the Toolbar at the bottom of the Grid.
11
- * * `both`—Displays the Toolbar at the top and bottom of the Grid.
12
- *
13
- * @example
14
- * ```html
15
- * <kendo-grid >
16
- * <ng-template kendoGridToolbarTemplate position="bottom" let-position="position">
17
- * <button (click)="onClick()">Custom action</button>
18
- * </ng-template>
19
- * </kendo-grid>
20
- * ```
21
- */
22
5
  export {};
@@ -7,8 +7,8 @@ import * as i0 from "@angular/core";
7
7
  /**
8
8
  * Represents the toolbar template of the Grid.
9
9
  *
10
- * The template context has the following field:
11
- * - `position`&mdash;The position at which the toolbar template is rendered. The possible values are `top`, `bottom`, and `both`.
10
+ * The template context provides:
11
+ * - `position`&mdash;The position where the toolbar template renders. Possible values: `top`, `bottom`, and `both`.
12
12
  *
13
13
  * @example
14
14
  * ```html
@@ -25,7 +25,7 @@ export class ToolbarTemplateDirective {
25
25
  templateRef;
26
26
  _position = 'top';
27
27
  /**
28
- * The position of the toolbar ([see example]({% slug toolbartemplate_grid %}#toc-setting-the-toolbar-position)).
28
+ * Sets the position of the toolbar. ([See example]({% slug toolbartemplate_grid %}#toc-setting-the-toolbar-position)).
29
29
  *
30
30
  * @default 'top'
31
31
  */
@@ -23,9 +23,8 @@ import * as i4 from "../../../common/adaptiveness.service";
23
23
  import * as i5 from "../../../common/column-info.service";
24
24
  let incrementingId = 0;
25
25
  /**
26
- * Represents the `column-chooser` toolbar tool of the Grid.
27
- * You can apply this directive to any `kendo-toolbar-button` element inside a
28
- * ToolbarComponent used in the Grid.
26
+ * Represents a column chooser toolbar tool of the Grid.
27
+ * Use this directive on any `kendo-toolbar-button` inside a ToolbarComponent in the Grid.
29
28
  *
30
29
  * @example
31
30
  * ```html-no-run
@@ -35,6 +34,8 @@ let incrementingId = 0;
35
34
  * </kendo-toolbar>
36
35
  * </kendo-grid>
37
36
  * ```
37
+ * @remarks
38
+ * Applied to: {@link ToolBarButtonComponent}.
38
39
  */
39
40
  export class ColumnChooserToolbarDirective extends ToolbarToolBase {
40
41
  renderer;
@@ -46,13 +47,13 @@ export class ColumnChooserToolbarDirective extends ToolbarToolBase {
46
47
  adaptiveGridService;
47
48
  columnInfoService;
48
49
  /**
49
- * Specifies if the changes in the visibility of the column will be immediately applied.
50
+ * When `true`, changes to column visibility apply immediately.
50
51
  *
51
52
  * @default false
52
53
  */
53
54
  autoSync = false;
54
55
  /**
55
- * Specifies if all columns can be hidden.
56
+ * When `true`, enables the hiding of all columns.
56
57
  *
57
58
  * @default true
58
59
  */
@@ -24,20 +24,20 @@ import * as i6 from "../../../common/adaptiveness.service";
24
24
  let incrementingId = 0;
25
25
  /**
26
26
  * Represents the toolbar tool for filtering columns of the Grid.
27
- * You can apply this directive to any `kendo-toolbar-button` element inside a
28
- * ToolbarComponent used in the Grid.
27
+ * Use this directive on any `kendo-toolbar-button` inside a ToolbarComponent in the Grid.
29
28
  *
30
- * When the user clicks the toolbar button that is associated with the directive, the
31
- * filter event is triggered.
29
+ * When you click the toolbar button with this directive, the `filter` event is triggered.
32
30
  *
33
31
  * @example
34
- * ```html-no-run
32
+ * ```html
35
33
  * <kendo-grid>
36
34
  * <kendo-toolbar>
37
35
  * <kendo-toolbar-button text="Filter" kendoGridFilterTool></kendo-toolbar-button>
38
36
  * </kendo-toolbar>
39
37
  * </kendo-grid>
40
38
  * ```
39
+ * @remarks
40
+ * Applied to: {@link ToolBarButtonComponent}.
41
41
  */
42
42
  export class FilterCommandToolbarDirective {
43
43
  host;
@@ -20,17 +20,19 @@ import * as i4 from "../../../common/adaptiveness.service";
20
20
  let incrementingId = 0;
21
21
  /**
22
22
  * Represents the toolbar tool for grouping columns of the Grid.
23
- * You can apply this directive to any `kendo-toolbar-button` element inside a
24
- * ToolbarComponent used in the Grid.
23
+ * Use this directive on any `kendo-toolbar-button` inside a ToolbarComponent in the Grid.
24
+ * When you click the toolbar button with this directive, the `group` event is triggered.
25
25
  *
26
26
  * @example
27
- * ```html-no-run
27
+ * ```html
28
28
  * <kendo-grid>
29
29
  * <kendo-toolbar>
30
30
  * <kendo-toolbar-button text="Group" kendoGridGroupTool></kendo-toolbar-button>
31
31
  * </kendo-toolbar>
32
32
  * </kendo-grid>
33
33
  * ```
34
+ * @remarks
35
+ * Applied to: {@link ToolBarButtonComponent}.
34
36
  */
35
37
  export class GroupCommandToolbarDirective {
36
38
  host;
@@ -24,11 +24,9 @@ import * as i6 from "../../../common/adaptiveness.service";
24
24
  let incrementingId = 0;
25
25
  /**
26
26
  * Represents the toolbar tool for sorting columns of the Grid.
27
- * You can apply this directive to any `kendo-toolbar-button` element inside a
28
- * ToolbarComponent used in the Grid.
27
+ * Use this directive on any `kendo-toolbar-button` inside a ToolbarComponent in the Grid.
29
28
  *
30
- * When the user clicks the toolbar button that is associated with the directive, the
31
- * sort event is triggered.
29
+ * When you click the toolbar button with this directive, the `sort` event is triggered.
32
30
  *
33
31
  * @example
34
32
  * ```html-no-run
@@ -38,6 +36,8 @@ let incrementingId = 0;
38
36
  * </kendo-toolbar>
39
37
  * </kendo-grid>
40
38
  * ```
39
+ * @remarks
40
+ * Applied to: {@link ToolBarButtonComponent}.
41
41
  */
42
42
  export class SortCommandToolbarDirective {
43
43
  host;
@@ -5,13 +5,12 @@
5
5
  import { Directive, TemplateRef, Optional } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents the column row reorder cell template of the Grid.
9
- * Helps to customize the content of the drag handle cells. To define the cell template, nest an `<ng-template>`
10
- * tag with the `kendoGridRowDragHandleTemplate` directive inside the `<kendo-grid-rowreorder-column>` tag.
8
+ * The directive allows customizing the drag handle cell in the Grid row reorder column.
9
+ * Place an `<ng-template>` tag with the `kendoGridRowDragHandleTemplate` directive inside the `<kendo-grid-rowreorder-column>` tag to set the cell template.
11
10
  *
12
- * The template context is set to the current data item and the following additional fields are passed:
13
- * - `columnIndex`&mdash;The current column index. Use it as an alias for a template variable by utilizing the `let-columnIndex="columnIndex"` syntax.
14
- * - `rowIndex`&mdash;The provided data row index. Use it as an alias for a template variable by utilizing the `let-rowIndex="rowIndex"` syntax.
11
+ * The template context is the current data item. You also get access to the following additional fields:
12
+ * - `columnIndex`&mdash;The current column index. Use it as a template variable with `let-columnIndex="columnIndex"`.
13
+ * - `rowIndex`&mdash;The data row index. Use it as a template variable with `let-rowIndex="rowIndex"`.
15
14
  *
16
15
  * @example
17
16
  * ```html
@@ -5,12 +5,10 @@
5
5
  import { Directive, TemplateRef, Optional } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents the drag hint template of the Grid.
9
- * Helps to customize the content of the hint during row reordering. To define the hint template, nest an `<ng-template>`
10
- * tag with the `kendoGridRowDragHintTemplate` directive inside the `<kendo-grid-rowreorder-column>` tag.
8
+ * The directive allows customizing the drag hint in the Grid row reorder column.
9
+ * Place an `<ng-template>` tag with the `kendoGridRowDragHintTemplate` directive inside the `<kendo-grid-rowreorder-column>` tag to set the hint template.
11
10
  *
12
- * The template context is set to the current data item.
13
- * The provided data row index is passed as an additional field. Use it as an alias for a template variable by utilizing the `let-rowIndex="rowIndex"` syntax.
11
+ * The template context is the current data item. You also get the data row index as an extra field. Use it as a template variable with `let-rowIndex="rowIndex"`.
14
12
  *
15
13
  * @example
16
14
  * ```html
@@ -13,7 +13,7 @@ import * as i1 from "./selection.service";
13
13
  import * as i2 from "./cell-selection.service";
14
14
  import * as i3 from "@progress/kendo-angular-inputs";
15
15
  /**
16
- * Represents the select-all checkbox feature of the Grid ([see example](slug:grid_selection_persistence#toc-selecting-all-items)).
16
+ * Adds a select-all checkbox to the Grid. ([See example](slug:grid_selection_persistence#toc-selecting-all-items)).
17
17
  *
18
18
  * @example
19
19
  * ```html
@@ -38,7 +38,7 @@ export class SelectAllCheckboxDirective {
38
38
  */
39
39
  state;
40
40
  /**
41
- * Fires when the user clicks the `kendoGridSelectAllCheckbox` select-all checkbox
41
+ * Emits when the user clicks the select-all checkbox.
42
42
  * ([see example](slug:grid_row_selection#toc-select-all-checkbox)).
43
43
  */
44
44
  selectAllChange = new EventEmitter();
@@ -14,22 +14,23 @@ import * as i2 from "./cell-selection.service";
14
14
  import * as i3 from "../aggregates/selection-aggregate.service";
15
15
  import * as i4 from "@progress/kendo-angular-inputs";
16
16
  /**
17
- * Represents the row-selection checkbox of the Grid. The directive expects the
18
- * index of the current row as an input parameter. Inside the [`CellTemplateDirective`](slug:api_grid_celltemplatedirective), apply the
19
- * `kendoGridSelectionCheckbox` to a `<kendo-checkbox></kendo-checkbox>` or an `<input type="checkbox"/>` element. When the user clicks the checkbox that is associated
20
- * with the directive, a [selectionChange](slug:api_grid_gridcomponent#toc-selectionChange)
21
- * event is triggered.
17
+ * Adds a row-selection checkbox to the Grid.
18
+ * Use this directive on a `<kendo-checkbox>` component or `<input type="checkbox">` element inside a cell template.
19
+ * When the user clicks the checkbox, the Grid triggers a [`selectionChange`](slug:api_grid_gridcomponent#toc-selectionChange) event.
22
20
  *
23
21
  * @example
24
22
  * ```html
25
- * <kendo-grid ... >
23
+ * <kendo-grid>
26
24
  * <kendo-grid-column>
27
25
  * <ng-template kendoGridCellTemplate let-rowIndex="rowIndex">
28
- * <input ... [kendoGridSelectionCheckbox]="rowIndex"/>
26
+ * <input [kendoGridSelectionCheckbox]="rowIndex"/>
27
+ * <kendo-checkbox [kendoGridSelectionCheckbox]="rowIndex"></kendo-checkbox>
29
28
  * </ng-template>
30
29
  * </kendo-grid-column>
31
30
  * </kendo-grid>
32
31
  * ```
32
+ * @remarks
33
+ * Applied to: {@link CheckBoxComponent}.
33
34
  */
34
35
  export class SelectionCheckboxDirective {
35
36
  selectionService;
@@ -40,7 +41,7 @@ export class SelectionCheckboxDirective {
40
41
  ngZone;
41
42
  checkbox;
42
43
  /**
43
- * The current index of the `dataItem` that will be selected.
44
+ * Sets the index of the `dataItem` to select.
44
45
  */
45
46
  itemIndex;
46
47
  destroyClick;
@@ -15,35 +15,36 @@ export class Selection {
15
15
  ctx;
16
16
  cd;
17
17
  /**
18
- * Defines the collection that will store the selected item keys.
18
+ * Stores the selected item keys.
19
19
  * @default []
20
20
  */
21
21
  selectedKeys = [];
22
22
  /**
23
- * Defines the initial shift-click range selection starting row index.
23
+ * Sets the starting row index for `Shift`+click range selection.
24
24
  *
25
25
  * @default 0
26
26
  */
27
27
  rangeSelectionStartRow;
28
28
  /**
29
- * Defines the initial shift-click range selection starting column index when cell selection is enabled.
29
+ * Sets the starting column index for `Shift`+click range selection when cell selection is on.
30
30
  *
31
31
  * @default 0
32
32
  */
33
33
  rangeSelectionStartColumnIndex = 0;
34
34
  /**
35
- * Defines the item key that will be stored in the `selectedKeys` collection. [See example](slug:grid_selection_persistence#by-a-custom-key).
35
+ * Sets the item key to store in `selectedKeys`.
36
+ * [See example](slug:grid_selection_persistence#by-a-custom-key).
36
37
  */
37
38
  selectionKey;
38
39
  /**
39
- * Defines a function that determines the column key of a data cell.
40
+ * Sets a function to get the column key for a data cell.
40
41
  *
41
- * The function should return an unique value for each column.
42
- * By default, the Grid uses the column index as a column key.
42
+ * The function must return a unique value for each column.
43
+ * The Grid uses the column index as the default column key.
43
44
  */
44
45
  columnKey;
45
46
  /**
46
- * Fires when the `selectedKeys` collection has been updated.
47
+ * Emits when the `selectedKeys` collection changes.
47
48
  */
48
49
  selectedKeysChange = new EventEmitter();
49
50
  rowSelectionState = new Set();
@@ -8,8 +8,17 @@ import { Selection } from "./selection-default";
8
8
  import * as i0 from "@angular/core";
9
9
  import * as i1 from "../common/provider.service";
10
10
  /**
11
- * A directive which stores the row selection state of the Grid in memory
11
+ * Stores the row selection state of the Grid in memory
12
12
  * ([see example]({% slug selection_grid %}#toc-toggling-the-selection-functionality)).
13
+ *
14
+ * @example
15
+ * ```typescript
16
+ * <kendo-grid kendoGridSelectBy="ProductID"></kendo-grid>
17
+ *
18
+ * <kendo-grid [kendoGridSelectBy]="myKey"></kendo-grid>
19
+ * ```
20
+ * @remarks
21
+ * Applied to: {@link GridComponent}.
13
22
  */
14
23
  export class SelectionDirective extends Selection {
15
24
  ctx;
@@ -4,15 +4,15 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { PreventableEvent } from "@progress/kendo-angular-common";
6
6
  /**
7
- * Arguments for the `undo` and `redo` events.
7
+ * Provides arguments for the `undo` and `redo` events.
8
8
  */
9
9
  export class UndoRedoEvent extends PreventableEvent {
10
10
  /**
11
- * The event data of the original action that triggered the state change.
11
+ * The event data for the action that changed the state.
12
12
  */
13
13
  originalEvent;
14
14
  /**
15
- * The grid state and rendered data at the time of the action.
15
+ * The Grid state and rendered data at the time of the action.
16
16
  */
17
17
  gridState;
18
18
  /**
@@ -11,15 +11,14 @@ import * as i0 from "@angular/core";
11
11
  import * as i1 from "./undo-redo.service";
12
12
  import * as i2 from "@progress/kendo-angular-toolbar";
13
13
  /**
14
- * Represents the command for triggering the redo action in the Grid.
15
- * You can apply this directive to any `kendo-toolbar-button` element inside a
16
- * ToolbarComponent used in the Grid.
14
+ * Represents the command that triggers the redo action in the Grid.
15
+ * Apply this directive to any `kendo-toolbar-button` inside a ToolbarComponent in the Grid.
17
16
  *
18
- * When the user clicks the toolbar button that is associated with the directive, the
19
- * [redo]({% slug api_grid_undoredodirective %}#toc-redo) event is triggered.
17
+ * When users click the toolbar button with this directive, the
18
+ * [`redo`]({% slug api_grid_undoredodirective %}#toc-redo) event is triggered.
20
19
  *
21
20
  * @example
22
- * ```html-no-run
21
+ * ```html
23
22
  * <kendo-grid>
24
23
  * <kendo-toolbar>
25
24
  * <kendo-toolbar-button kendoGridRedoTool></kendo-toolbar-button>
@@ -31,19 +30,28 @@ export class RedoCommandToolbarDirective {
31
30
  undoRedoService;
32
31
  host;
33
32
  subs = new Subscription();
33
+ /**
34
+ * @hidden
35
+ */
34
36
  constructor(undoRedoService, host) {
35
37
  this.undoRedoService = undoRedoService;
36
38
  this.host = host;
37
39
  }
40
+ /**
41
+ * @hidden
42
+ */
38
43
  ngOnInit() {
39
- this.subs = this.host.click.subscribe(e => this.onClick(e));
44
+ this.subs = this.host.click.subscribe((e) => this.onClick(e));
40
45
  this.host.className = 'k-grid-redo-command';
41
46
  this.host.svgIcon = redoIcon;
42
47
  this.host.icon = 'redo';
43
48
  this.host.text = 'Redo';
44
49
  this.host.disabled = true;
45
- this.subs.add(this.undoRedoService.stackEndReached.subscribe((stackEnd) => this.host.disabled = stackEnd === 'end'));
50
+ this.subs.add(this.undoRedoService.stackEndReached.subscribe((stackEnd) => (this.host.disabled = stackEnd === 'end')));
46
51
  }
52
+ /**
53
+ * @hidden
54
+ */
47
55
  ngOnDestroy() {
48
56
  this.subs.unsubscribe();
49
57
  }
@@ -61,6 +69,6 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
61
69
  type: Directive,
62
70
  args: [{
63
71
  selector: '[kendoGridRedoTool]',
64
- standalone: true
72
+ standalone: true,
65
73
  }]
66
74
  }], ctorParameters: function () { return [{ type: i1.UndoRedoService }, { type: i2.ToolBarButtonComponent }]; } });
@@ -11,15 +11,14 @@ import * as i0 from "@angular/core";
11
11
  import * as i1 from "./undo-redo.service";
12
12
  import * as i2 from "@progress/kendo-angular-toolbar";
13
13
  /**
14
- * Represents the command for triggering the undo action in the Grid.
15
- * You can apply this directive to any `kendo-toolbar-button` element inside a
16
- * ToolbarComponent used in the Grid.
14
+ * Represents the command that triggers the undo action in the Grid.
15
+ * Apply this directive to any `kendo-toolbar-button` inside a ToolbarComponent in the Grid.
17
16
  *
18
- * When the user clicks the toolbar button that is associated with the directive, the
19
- * [undo]({% slug api_grid_undoredodirective %}#toc-undo) event is triggered.
17
+ * When users click the toolbar button with this directive, the
18
+ * [`undo`]({% slug api_grid_undoredodirective %}#toc-undo) event is triggered.
20
19
  *
21
20
  * @example
22
- * ```html-no-run
21
+ * ```html
23
22
  * <kendo-grid>
24
23
  * <kendo-toolbar>
25
24
  * <kendo-toolbar-button kendoGridUndoTool></kendo-toolbar-button>
@@ -31,19 +30,28 @@ export class UndoCommandToolbarDirective {
31
30
  undoRedoService;
32
31
  host;
33
32
  subs = new Subscription();
33
+ /**
34
+ * @hidden
35
+ */
34
36
  constructor(undoRedoService, host) {
35
37
  this.undoRedoService = undoRedoService;
36
38
  this.host = host;
37
39
  }
40
+ /**
41
+ * @hidden
42
+ */
38
43
  ngOnInit() {
39
- this.subs = this.host.click.subscribe(e => this.onClick(e));
44
+ this.subs = this.host.click.subscribe((e) => this.onClick(e));
40
45
  this.host.className = 'k-grid-undo-command';
41
46
  this.host.svgIcon = undoIcon;
42
47
  this.host.icon = 'undo';
43
48
  this.host.text = 'Undo';
44
49
  this.host.disabled = true;
45
- this.subs.add(this.undoRedoService.stackEndReached.subscribe((stackEnd) => this.host.disabled = stackEnd === 'start'));
50
+ this.subs.add(this.undoRedoService.stackEndReached.subscribe((stackEnd) => (this.host.disabled = stackEnd === 'start')));
46
51
  }
52
+ /**
53
+ * @hidden
54
+ */
47
55
  ngOnDestroy() {
48
56
  this.subs.unsubscribe();
49
57
  }
@@ -61,6 +69,6 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
61
69
  type: Directive,
62
70
  args: [{
63
71
  selector: '[kendoGridUndoTool]',
64
- standalone: true
72
+ standalone: true,
65
73
  }]
66
74
  }], ctorParameters: function () { return [{ type: i1.UndoRedoService }, { type: i2.ToolBarButtonComponent }]; } });
@@ -17,26 +17,37 @@ import * as i1 from "../grid.component";
17
17
  import * as i2 from "../editing/edit.service";
18
18
  import * as i3 from "./undo-redo.service";
19
19
  import * as i4 from "../data/change-notification.service";
20
+ /**
21
+ * Represents the directive that manages undo-redo operations in the Grid.
22
+ * Use this directive to enable undo and redo functionality for user actions in the Grid.
23
+ *
24
+ * @example
25
+ * ```html
26
+ * <kendo-grid [data]="data" kendoGridUndoRedo></kendo-grid>
27
+ * ```
28
+ * @remarks
29
+ * Applied to: {@link GridComponent}.
30
+ */
20
31
  export class UndoRedoDirective {
21
32
  host;
22
33
  editService;
23
34
  undoRedoService;
24
35
  changeNotification;
25
36
  /**
26
- * Determines the maximum number of actions to keep in the undo-redo stack.
37
+ * Sets the maximum number of actions to keep in the undo-redo stack.
27
38
  * @default 10
28
39
  */
29
40
  maxStoredStates = 10;
30
41
  /**
31
- * Fires when undo action is performed. Exposes the state of the grid that will be applied.
42
+ * Fires when you perform the undo action. Provides the Grid state to apply.
32
43
  */
33
44
  onUndo = new EventEmitter();
34
45
  /**
35
- * Fires when undo action is performed. Exposes the state of the grid that will be applied.
46
+ * Fires when you perform the redo action. Provides the Grid state to apply.
36
47
  */
37
48
  onRedo = new EventEmitter();
38
49
  /**
39
- * Returns an array of all undo-redo actions that are currently in the stack.
50
+ * Returns all undo-redo actions currently in the stack.
40
51
  */
41
52
  get undoRedoItems() {
42
53
  return this.stack.toArray();
@@ -122,7 +133,7 @@ export class UndoRedoDirective {
122
133
  this.subs.unsubscribe();
123
134
  }
124
135
  /**
125
- * Re-applies the last action, reverted by the `undo` method.
136
+ * Re-applies the last action that you reverted with the `undo` method.
126
137
  */
127
138
  redo() {
128
139
  if (this.stack.canRedo) {
@@ -134,7 +145,7 @@ export class UndoRedoDirective {
134
145
  }
135
146
  }
136
147
  /**
137
- * Reverts the last user action.
148
+ * Reverts the last user action that you performed.
138
149
  */
139
150
  undo() {
140
151
  if (this.stack.canUndo) {
@@ -9,24 +9,21 @@ import { ContextService } from '../common/provider.service';
9
9
  import { ToolbarToolBase } from '../common/toolbar-tool-base.directive';
10
10
  import * as i0 from "@angular/core";
11
11
  /**
12
- * Represents the `export-to-Excel` toolbar tool of 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 a button associated with the directive, the
17
- * [excelExport]({% slug api_grid_gridcomponent %}#toc-excelexport) event
18
- * fires ([see example]({% slug excelexport_grid %})).
12
+ * Represents the **Export to Excel** toolbar tool of the Grid.
13
+ * Apply this directive to any `kendo-toolbar-button` element inside a ToolbarComponent used in the Grid.
14
+ * When the user clicks the button, the [`excelExport`]({% slug api_grid_gridcomponent %}#toc-excelexport) event fires ([see example]({% slug excelexport_grid %})).
19
15
  *
20
16
  * @example
21
- * ```html-no-run
17
+ * ```html
22
18
  * <kendo-grid>
23
- * <kendo-toolbar>
24
- * <kendo-toolbar-button text="Excel Export" kendoGridExcelTool></kendo-toolbar-button>
25
- * </kendo-toolbar>
26
- * <kendo-grid-excel fileName="Grid.xlsx">
27
- * </kendo-grid-excel>
19
+ * <kendo-toolbar>
20
+ * <kendo-toolbar-button text="Excel Export" kendoGridExcelTool></kendo-toolbar-button>
21
+ * </kendo-toolbar>
22
+ * <kendo-grid-excel fileName="Grid.xlsx"></kendo-grid-excel>
28
23
  * </kendo-grid>
29
24
  * ```
25
+ * @remarks
26
+ * Applied to: {@link ToolBarButtonComponent}.
30
27
  */
31
28
  export declare class ExcelCommandToolbarDirective extends ToolbarToolBase {
32
29
  private excelService;
@@ -8,21 +8,17 @@ import { ContextService } from '../common/provider.service';
8
8
  import { ExcelService } from './excel.service';
9
9
  import * as i0 from "@angular/core";
10
10
  /**
11
- * Represents the `export-to-Excel` command of the Grid. You can apply this
12
- * directive to any `button` element inside a
13
- * [ToolbarTemplate]({% slug api_grid_toolbartemplatedirective %}).
14
- * When the user clicks a button associated with the directive, the
15
- * [excelExport]({% slug api_grid_gridcomponent %}#toc-excelexport) event
16
- * fires ([see example]({% slug excelexport_grid %})).
11
+ * Represents the `excelExport` command of the Grid. Apply this
12
+ * directive to any `button` element inside a [`ToolbarTemplate`]({% slug api_grid_toolbartemplatedirective %}).
13
+ * When the user clicks the button, the [`excelExport`]({% slug api_grid_gridcomponent %}#toc-excelexport) event fires ([see example]({% slug excelexport_grid %})).
17
14
  *
18
15
  * @example
19
16
  * ```html
20
17
  * <kendo-grid>
21
- * <ng-template kendoGridToolbarTemplate>
22
- * <button kendoGridExcelCommand>Export to Excel</button>
23
- * </ng-template>
24
- * <kendo-grid-excel fileName="Grid.xlsx">
25
- * </kendo-grid-excel>
18
+ * <ng-template kendoGridToolbarTemplate>
19
+ * <button kendoGridExcelCommand>Export to Excel</button>
20
+ * </ng-template>
21
+ * <kendo-grid-excel fileName="Grid.xlsx"></kendo-grid-excel>
26
22
  * </kendo-grid>
27
23
  * ```
28
24
  */
@@ -4,9 +4,12 @@
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 declare class ExcelExportEvent extends PreventableEvent {
10
10
  workbook: any;
11
+ /**
12
+ * @hidden
13
+ */
11
14
  constructor(workbook: any);
12
15
  }