@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
@@ -16,15 +16,25 @@ import { AdaptiveGridService } from '../common/adaptiveness.service';
16
16
  import * as i0 from "@angular/core";
17
17
  /**
18
18
  * Represents the [column menu](slug:columnmenu_grid#toc-customizing-the-position) component.
19
+ *
20
+ * @example
19
21
  * ```html
20
22
  * <kendo-grid ...>
21
23
  * <kendo-grid-column field="ProductName" [columnMenu]="false">
22
24
  * <ng-template kendoGridHeaderTemplate let-column>
23
- * <kendo-grid-column-menu [column]="column"> </kendo-grid-column-menu>
25
+ * <kendo-grid-column-menu [column]="column"></kendo-grid-column-menu>
24
26
  * </ng-template>
25
27
  * </kendo-grid-column>
26
28
  * </kendo-grid>
27
29
  * ```
30
+ * @example
31
+ * ```html
32
+ * <kendo-grid-column field="ProductName">
33
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
34
+ * <kendo-grid-column-menu [column]="column"></kendo-grid-column-menu>
35
+ * </ng-template>
36
+ * </kendo-grid-column>
37
+ * ```
28
38
  */
29
39
  export declare class ColumnMenuComponent implements AfterViewInit, OnChanges, OnDestroy {
30
40
  protected navigationService: NavigationService;
@@ -41,21 +51,21 @@ export declare class ColumnMenuComponent implements AfterViewInit, OnChanges, On
41
51
  */
42
52
  standalone: boolean;
43
53
  /**
44
- * The Grid column instance to control with the menu.
54
+ * The Grid column instance controlled by the menu.
45
55
  */
46
56
  column: any;
47
57
  /**
48
- * The settings for the Column Menu.
58
+ * The settings for the column menu.
49
59
  */
50
60
  settings: ColumnMenuSettings;
51
61
  /**
52
- * The descriptors by which the data will be sorted.
53
- * Typically bound to the same value as [GridComponent.sort]({% slug api_grid_gridcomponent %}#toc-sort).
62
+ * The sort descriptors for the Grid data.
63
+ * Typically bound to [`GridComponent.sort`]({% slug api_grid_gridcomponent %}#toc-sort).
54
64
  */
55
65
  sort: any;
56
66
  /**
57
- * The descriptor by which the data will be filtered.
58
- * Typically bound to the same value as [GridComponent.filter]({% slug api_grid_gridcomponent %}#toc-filter).
67
+ * The filter descriptor for the Grid data.
68
+ * Typically bound to [`GridComponent.filter`]({% slug api_grid_gridcomponent %}#toc-filter).
59
69
  */
60
70
  filter: any;
61
71
  /**
@@ -7,20 +7,19 @@ import { EventEmitter } from '@angular/core';
7
7
  import type { ColumnMenuContainerComponent } from './column-menu-container.component';
8
8
  import * as i0 from "@angular/core";
9
9
  /**
10
- * Represents the service that is passed to the
11
- * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
10
+ * Represents the service passed to the [`ColumnMenuTemplate`]({% slug api_grid_columnmenutemplatedirective %}) directive.
11
+ *
12
+ * Use this service to interact with the column menu from a custom template.
12
13
  *
13
14
  * @example
14
15
  * ```html
15
16
  * <kendo-grid [data]="data" [columnMenu]="true">
16
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
17
- * <span class="k-icon k-font-icon k-i-x" (click)="service.close()" </span>
18
- * <kendo-grid-columnmenu-sort [service]="service">
19
- * </kendo-grid-columnmenu-sort>
20
- * </ng-template>
21
- * <kendo-grid-column field="Field1"></kendo-grid-column>
17
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
18
+ * <span class="k-icon k-font-icon k-i-x" (click)="service.close()"></span>
19
+ * <kendo-grid-columnmenu-sort [service]="service"></kendo-grid-columnmenu-sort>
20
+ * </ng-template>
21
+ * <kendo-grid-column field="Field1"></kendo-grid-column>
22
22
  * </kendo-grid>
23
- *
24
23
  * ```
25
24
  */
26
25
  export declare class ColumnMenuService {
@@ -5,35 +5,36 @@
5
5
  import { Observable } from 'rxjs';
6
6
  import { ColumnBase } from '../columns/column-base';
7
7
  /**
8
- * The type of the [`resizable`](slug:api_grid_gridcomponent#toc-resizable) property. [See example](slug:resizing_columns_grid#constrained-mode)
8
+ * Defines the type for the `resizable` property. [See example](slug:resizing_columns_grid#constrained-mode)
9
9
  *
10
10
  * The possible values are:
11
11
  *
12
- * * `constrained` - Adjacent columns resize only up to their outer borders.
13
- * * `unconstrained` - Columns are resized relative to the entire component.
12
+ * * `constrained`&mdash;Adjacent columns resize only up to their outer borders.
13
+ * * `unconstrained`&mdash;Columns resize relative to the entire component.
14
14
  *
15
+ * @example
15
16
  * ```html
16
17
  * <kendo-grid [kendoGridBinding]="gridData" [height]="370" resizable="constrained">
17
- * <kendo-grid-column field="ProductID" title="ID"> </kendo-grid-column>
18
+ * <kendo-grid-column field="ProductID" title="ID"></kendo-grid-column>
18
19
  * ...
19
20
  * </kendo-grid>
20
21
  * ```
21
22
  */
22
23
  export type ResizeMode = 'unconstrained' | 'constrained';
23
24
  /**
24
- * The returned type of the [`columnResize`](slug:api_grid_gridcomponent#toc-columnresize) event.
25
+ * Represents the returned type of the `columnResize` event.
25
26
  */
26
27
  export interface ColumnResizeArgs {
27
28
  /**
28
- * The resized column.
29
+ * Specifies the resized column.
29
30
  */
30
31
  column: ColumnBase;
31
32
  /**
32
- * The new width (in pixels) of the column.
33
+ * Specifies the new width (in pixels) of the column.
33
34
  */
34
35
  newWidth?: number;
35
36
  /**
36
- * The actual width (in pixels) of the column prior to resizing.
37
+ * Specifies the actual width (in pixels) of the column before resizing.
37
38
  */
38
39
  oldWidth: number;
39
40
  }
@@ -5,6 +5,10 @@
5
5
  import { RowArgs } from "../rendering/common/row-args";
6
6
  import { ColumnBase } from "./column-base";
7
7
  /**
8
- * Represents the callback that is used to determine the rowspan of each cell in a given column.
8
+ * Represents the callback function that determines the rowspan of each cell in a column.
9
+ * @param row The row arguments.
10
+ * @param column The column instance.
11
+ * @param data The data array.
12
+ * @returns The rowspan value for the cell.
9
13
  */
10
14
  export type CellRowspanFn = (row: RowArgs, column: ColumnBase, data: any[]) => number;
@@ -13,11 +13,13 @@ import * as i0 from "@angular/core";
13
13
  /**
14
14
  * Represents the checkbox column for selecting rows in the Grid. [See example](slug:grid_row_selection#toc-select-all-checkbox).
15
15
  *
16
+ * Use this column to add checkboxes for row selection.
17
+ *
16
18
  * @example
17
19
  * ```html
18
20
  * <kendo-grid [selectable]="{enabled: true, checkboxOnly: true}">
19
- * <kendo-grid-checkbox-column title="Default checkbox"></kendo-grid-checkbox-column>
20
- * <kendo-grid-column field="ProductID"></kendo-grid-column>
21
+ * <kendo-grid-checkbox-column title="Select"></kendo-grid-checkbox-column>
22
+ * <kendo-grid-column field="ID"></kendo-grid-column>
21
23
  * </kendo-grid>
22
24
  * ```
23
25
  */
@@ -26,11 +28,11 @@ export declare class CheckboxColumnComponent extends ColumnBase {
26
28
  private cellSelectionService;
27
29
  parent?: ColumnBase;
28
30
  /**
29
- * Determines whether a select-all `kendoGridSelectAllCheckbox` checkbox will be displayed in the header.
31
+ * Shows a select-all `kendoGridSelectAllCheckbox` checkbox in the header.
30
32
  */
31
33
  showSelectAll: boolean;
32
34
  /**
33
- * Determines whether checkboxes will be rendered for rows which are marked as non-selectable. By default, such checkboxes are visible and disabled.
35
+ * Shows checkboxes for rows marked as non-selectable. By default, these checkboxes are visible and disabled.
34
36
  */
35
37
  showDisabledCheckbox: boolean;
36
38
  readonly isCheckboxColumn: boolean;
@@ -42,7 +44,7 @@ export declare class CheckboxColumnComponent extends ColumnBase {
42
44
  */
43
45
  rowSelectable(rowIdx: number): boolean;
44
46
  /**
45
- * Defines a function that is used to determine the rowspan of each column cell.
47
+ * Defines a function to determine the rowspan of each column cell.
46
48
  */
47
49
  set cellRowspan(cellRowspan: CellRowspanFn);
48
50
  get cellRowspan(): CellRowspanFn;
@@ -23,6 +23,8 @@ export declare const isCheckboxColumn: (column: any) => any;
23
23
  export declare const isRowReorderColumn: (column: any) => any;
24
24
  /**
25
25
  * The base class for the column components of the Grid.
26
+ *
27
+ * Use this class as a foundation for custom column implementations.
26
28
  */
27
29
  export declare class ColumnBase implements AfterViewInit {
28
30
  parent?: ColumnBase;
@@ -43,7 +45,7 @@ export declare class ColumnBase implements AfterViewInit {
43
45
  */
44
46
  matchesMedia: boolean;
45
47
  /**
46
- * The column index after reordering. The `orderIndex` is a read-only property. Setting this field does not affect column order.
48
+ * Gets the column index after reordering. The `orderIndex` property is read-only. Setting this field does not change the column order.
47
49
  *
48
50
  * @default 0
49
51
  */
@@ -66,51 +68,50 @@ export declare class ColumnBase implements AfterViewInit {
66
68
  */
67
69
  isSpanColumn: boolean;
68
70
  /**
69
- * Indicates whether the column is resizable.
71
+ * Specifies if the column is resizable.
70
72
  * @default true
71
73
  */
72
74
  resizable: boolean;
73
75
  /**
74
- * Indicates whether the column is reorderable.
76
+ * Specifies if the column is reorderable.
75
77
  * @default true
76
78
  */
77
79
  reorderable: boolean;
78
80
  /**
79
- * The width (in pixels) below which the user is not able to resize the column by using the UI ([see example]({% slug resizing_columns_grid %}#toc-limiting-the-resizing)).
81
+ * Sets the minimum width (in pixels) for resizing the column by using the UI ([see example]({% slug resizing_columns_grid %}#toc-limiting-the-resizing)).
80
82
  * The `autoFitColumn` and `autoFitColumns` methods have higher priority.
81
83
  * @default 10
82
84
  */
83
85
  minResizableWidth: number;
84
86
  /**
85
- * The width (in pixels) above which the user is not able to resize the column by using the UI ([see example]({% slug resizing_columns_grid %}#toc-limiting-the-resizing)).
87
+ * Sets the maximum width (in pixels) for resizing the column by using the UI ([see example]({% slug resizing_columns_grid %}#toc-limiting-the-resizing)).
86
88
  * By default, the maximum width is not restricted.
87
89
  * The `autoFitColumn` and `autoFitColumns` methods have higher priority.
88
90
  */
89
91
  maxResizableWidth: number;
90
92
  /**
91
- * The title of the column.
93
+ * Sets the column title.
92
94
  */
93
95
  title: string;
94
96
  /**
95
- * The width of the column (in pixels).
97
+ * Sets the column width (in pixels).
96
98
  */
97
99
  set width(value: number);
98
100
  get width(): number;
99
101
  /**
100
- * Indicates whether the column will be resized during initialization so that it fits its header and row content.
102
+ * Specifies if the column is automatically resized during initialization to fit its header and row content.
101
103
  */
102
104
  autoSize: boolean;
103
105
  /**
104
- * Toggles the locked (frozen) state of the columns ([more information and example]({% slug locked_columns_grid %})).
106
+ * Toggles the locked (frozen) state of the column ([more information and example]({% slug locked_columns_grid %})).
105
107
  *
106
108
  * @default false
107
- *
108
109
  */
109
110
  set locked(value: boolean);
110
111
  get locked(): boolean;
111
112
  protected _locked: boolean;
112
113
  /**
113
- * Determines whether the column will be always visible when scrolling the Grid horizontally.
114
+ * Specifies if the column is always visible when scrolling the Grid horizontally.
114
115
  *
115
116
  * @default false
116
117
  */
@@ -122,15 +123,15 @@ export declare class ColumnBase implements AfterViewInit {
122
123
  */
123
124
  hidden: boolean;
124
125
  /**
125
- * Sets the condition that needs to be satisfied for a column to remain visible ([see example]({% slug styling_responsive_grid %}#toc-columns)).
126
- * If you set the `hidden` property, the behavior of `media` is overridden.
126
+ * Sets the condition for the column to remain visible ([see example]({% slug styling_responsive_grid %}#toc-columns)).
127
+ * If you set the `hidden` property, `media` is ignored.
127
128
  *
128
- * Accepts the device identifiers that are [available in Bootstrap 4](https://v4-alpha.getbootstrap.com/layout/grid/#grid-options)
129
- * ([see example](slug:styling_responsive_grid)):
129
+ * Accepts device identifiers from [Bootstrap 4](https://v4-alpha.getbootstrap.com/layout/grid/#grid-options)
130
+ * ([see example](slug:styling_responsive_grid)).
130
131
  */
131
132
  media: string;
132
133
  /**
133
- * Specifies if the column can be locked or unlocked from the column menu or by reordering the columns.
134
+ * Specifies if the column can be locked or unlocked from the column menu or by reordering.
134
135
  * @default true
135
136
  */
136
137
  lockable: boolean;
@@ -140,96 +141,81 @@ export declare class ColumnBase implements AfterViewInit {
140
141
  */
141
142
  stickable: boolean;
142
143
  /**
143
- * Specifies if the column menu will be shown for the column.
144
+ * Specifies if the column menu is shown for the column.
144
145
  * @default true
145
146
  */
146
147
  columnMenu: boolean;
147
148
  /**
148
- * Specifies if the column will be included in the column-chooser list.
149
+ * Specifies if the column is included in the column-chooser list.
149
150
  * @default true
150
151
  */
151
152
  includeInChooser: boolean;
152
153
  /**
153
- * Allows setting the `role` attribute for the table cells (excluding the footer and header ones) of the column.
154
+ * Sets the `role` attribute for the table cells (excluding footer and header) of the column.
154
155
  * @default "gridcell"
155
156
  */
156
157
  tableCellsRole: string;
157
158
  /**
158
- * Sets the custom styles for the table cells (excluding the footer and header ones) of the column. Under the hood,
159
- * to apply the property, the `style` option uses the
160
- * [NgStyle](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-cells).
161
- *
159
+ * Sets custom styles for the table cells (excluding footer and header) of the column.
160
+ * Uses the [`NgStyle`](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-cells).
162
161
  */
163
162
  style: {
164
163
  [key: string]: string;
165
164
  };
166
165
  /**
167
- * Sets the custom styles for the header cell of the column. Under the hood, to apply the property,
168
- * the `headerStyle` option uses the
169
- * [NgStyle](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-header).
170
- *
166
+ * Sets custom styles for the header cell of the column.
167
+ * Uses the [`NgStyle`](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-header).
171
168
  */
172
169
  headerStyle: {
173
170
  [key: string]: string;
174
171
  };
175
172
  /**
176
- * Sets the custom styles for the filter row cell. Under the hood, to apply the property,
177
- * the `filterStyle` option uses the
178
- * [NgStyle](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-filter-row-cells).
179
- *
173
+ * Sets custom styles for the filter row cell.
174
+ * Uses the [`NgStyle`](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-filter-row-cells).
180
175
  */
181
176
  filterStyle: {
182
177
  [key: string]: string;
183
178
  };
184
179
  /**
185
- * Sets the custom styles for the footer cell of the column. Under the hood, to apply the property,
186
- * the `footerStyle` option uses the
187
- * [NgStyle](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-footer).
188
- *
180
+ * Sets custom styles for the footer cell of the column.
181
+ * Uses the [`NgStyle`](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-footer).
189
182
  */
190
183
  footerStyle: {
191
184
  [key: string]: string;
192
185
  };
193
186
  /**
194
- * Sets the custom CSS classes to the column cells. Under the hood, to apply the property, the `class` option uses the
195
- * [NgClass](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-cells).
187
+ * Sets custom CSS classes to the column cells.
188
+ * Uses the [`NgClass`](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-cells).
196
189
  * To customize header and footer column cells, use the [headerClass]({% slug api_grid_columncomponent %}#toc-headerclass)
197
190
  * and [footerClass]({% slug api_grid_columncomponent %}#toc-footerclass) inputs.
198
- *
199
191
  */
200
192
  cssClass: string | string[] | Set<string> | {
201
193
  [key: string]: any;
202
194
  };
203
195
  /**
204
- * Sets the custom CSS classes to the column header cell. Under the hood, to apply the property,
205
- * the `headerClass` option uses the
206
- * [NgClass](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-header).
207
- *
196
+ * Sets custom CSS classes to the column header cell.
197
+ * Uses the [`NgClass`](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-header).
208
198
  */
209
199
  headerClass: string | string[] | Set<string> | {
210
200
  [key: string]: any;
211
201
  };
212
202
  /**
213
- * Sets the custom CSS classes to the filter row cell. Under the hood, to apply the property,
214
- * the `filterClass` option uses the
215
- * [NgClass](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-filter-row-cells).
216
- *
203
+ * Sets custom CSS classes to the filter row cell.
204
+ * Uses the [`NgClass`](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-filter-row-cells).
217
205
  */
218
206
  filterClass: string | string[] | Set<string> | {
219
207
  [key: string]: any;
220
208
  };
221
209
  /**
222
- * Sets the custom CSS classes to the column footer cell. Under the hood, to apply the property,
223
- * the `footerClass` option uses the
224
- * [NgClass](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-footer).
225
- *
210
+ * Sets custom CSS classes to the column footer cell.
211
+ * Uses the [`NgClass`](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-footer).
226
212
  */
227
213
  footerClass: string | string[] | Set<string> | {
228
214
  [key: string]: any;
229
215
  };
230
216
  /**
231
- * Defines a function that is used to determine the rowspan of each column cell.
232
- * If set to `true`, a default function is used that spans adjacent cells containing equal values.
217
+ * Defines a function to determine the rowspan of each column cell.
218
+ * If you set this to `true`, a default function is used that spans adjacent cells with equal values.
233
219
  * Cells have equal values when their data items' values for the respective field are equal.
234
220
  */
235
221
  set cellRowspan(cellRowspan: CellRowspanFn | boolean);
@@ -11,8 +11,9 @@ import * as i0 from "@angular/core";
11
11
  */
12
12
  export declare function isColumnGroupComponent(column: any): column is ColumnGroupComponent;
13
13
  /**
14
- * Represents the column group header of the Grid
15
- * ([more information and examples](slug:multicolumnheaders_columns_grid)).
14
+ * Represents the column group header of the Grid ([more information and examples](slug:multicolumnheaders_columns_grid)).
15
+ *
16
+ * Use this component to group columns under a common header.
16
17
  *
17
18
  * @example
18
19
  * ```html
@@ -20,7 +20,9 @@ import * as i0 from "@angular/core";
20
20
  */
21
21
  export declare function isColumnComponent(column: any): column is ColumnComponent;
22
22
  /**
23
- * Represents the column of the Grid. [See example](slug:columns_config#toc-using-the-column-component)
23
+ * Represents a column in the Grid.
24
+ *
25
+ * Use the `kendo-grid-column` component to define columns in the Grid.
24
26
  *
25
27
  * @example
26
28
  * ```html
@@ -30,51 +32,54 @@ export declare function isColumnComponent(column: any): column is ColumnComponen
30
32
  * <kendo-grid-column field="UnitPrice" title="Unit Price"></kendo-grid-column>
31
33
  * </kendo-grid>
32
34
  * ```
35
+ * @remarks
36
+ * Supported children components are: {@link StringFilterCellComponent}, {@link NumericFilterCellComponent}, {@link BooleanFilterCellComponent}, {@link DateFilterCellComponent}, {@link StringFilterMenuComponent}, {@link NumericFilterMenuComponent}, {@link BooleanFilterMenuComponent}, {@link DateFilterMenuComponent}, {@link FilterCellOperatorsComponent}, {@link ColumnMenuAutoSizeAllColumnsComponent}, {@link ColumnMenuAutoSizeColumnComponent}, {@link ColumnMenuChooserComponent}, {@link ColumnMenuComponent}, {@link ColumnMenuFilterComponent}, {@link ColumnMenuItemComponent}, {@link ColumnMenuLockComponent}, {@link ColumnMenuPositionComponent}, {@link ColumnMenuSortComponent}, {@link ColumnMenuStickComponent}.
33
37
  */
34
38
  export declare class ColumnComponent extends ColumnBase {
35
39
  /**
36
- * The field to which the column is bound.
40
+ * Sets the field that the column binds to.
37
41
  */
38
42
  field: string;
39
43
  /**
40
- * The format that is applied to the value before it is displayed. For more information on the supported date and number formats,
41
- * refer to the [Column Formats](slug:formats_columns_grid) documentation article.
44
+ * Sets the format for displaying the column value.
45
+ * For supported date and number formats, see the [Column Formats](slug:formats_columns_grid) article.
42
46
  */
43
47
  format: any;
44
48
  /**
45
- * Allows the user to click the column headers and emits the `sortChange` event. [See example](slug:sorting_grid).
49
+ * Enables sorting when the user clicks the column header. [See example](slug:sorting_grid).
50
+ * Emits the `sortChange` event.
46
51
  *
47
52
  * @default true
48
53
  */
49
54
  sortable: boolean | ColumnSortSettings;
50
55
  /**
51
- * Determines if the column can be dragged to the group panel.
52
- * If set to `false`, you can group the columns by the column field by using the API of the Grid.
56
+ * Allows dragging the column to the group panel.
57
+ * Set to `false` to group by this column only through the Grid API.
53
58
  *
54
59
  * @default true
55
60
  */
56
61
  groupable: boolean;
57
62
  /**
58
- * Defines the editor type. [See example](slug:inline_editing_grid#toc-using-reactive-forms).
59
- * Used when the column enters the edit mode.
63
+ * Sets the editor type for the column. [See example](slug:inline_editing_grid#toc-using-reactive-forms).
64
+ * Used when the column enters edit mode.
60
65
  *
61
66
  * @default 'text'
62
67
  */
63
68
  editor: FieldDataType;
64
69
  /**
65
- * Defines the filter type that is displayed inside the filter row. [See example](slug:filtering_grid#toc-filter-data-types).
70
+ * Sets the filter type for the filter row UI. [See example](slug:filtering_grid#toc-filter-data-types).
66
71
  *
67
72
  * @default 'text'
68
73
  */
69
74
  filter: FieldDataType;
70
75
  /**
71
- * Defines if a filter UI will be displayed for this column. [See example](slug:filtering_grid).
76
+ * Shows or hides the filter UI for this column. [See example](slug:filtering_grid).
72
77
  *
73
78
  * @default true
74
79
  */
75
80
  filterable: boolean;
76
81
  /**
77
- * Defines whether the column is editable. [See example](slug:make_fields_uneditable_grid).
82
+ * Sets whether the column is editable. [See example](slug:make_fields_uneditable_grid).
78
83
  *
79
84
  * @default true
80
85
  */
@@ -9,17 +9,16 @@ import { IdService } from '../common/id.service';
9
9
  import { CellRowspanFn } from './cell-rowspan';
10
10
  import * as i0 from "@angular/core";
11
11
  /**
12
- * Represents the command columns of the Grid. You have to define the content of the
13
- * column inside an `<ng-template>` tag.
14
- * For more information and examples, refer to the [Command Column Directives](slug:editing_directives_grid#toc-command-column-directives) article.
12
+ * Represents the command columns of the Grid. Define the content of the column inside an `<ng-template>` tag.
13
+ * For more information and examples, see the [Command Column Directives](slug:editing_directives_grid#toc-command-column-directives) article.
15
14
  *
16
15
  * @example
17
16
  * ```html
18
- * <kendo-grid [data]="gridData">
19
- * <kendo-grid-column field="ProductID"></kendo-grid-column>
17
+ * <kendo-grid [data]="data">
18
+ * <kendo-grid-column field="ID"></kendo-grid-column>
20
19
  * <kendo-grid-command-column title="command" [width]="220">
21
20
  * <ng-template kendoGridCellTemplate>
22
- * <button kendoGridEditCommand class="k-primary">Edit</button>
21
+ * <button kendoGridEditCommand>Edit</button>
23
22
  * <button kendoGridRemoveCommand>Remove</button>
24
23
  * </ng-template>
25
24
  * </kendo-grid-command-column>
@@ -32,7 +31,7 @@ export declare class CommandColumnComponent extends ColumnBase {
32
31
  constructor(parent?: ColumnBase, idService?: IdService);
33
32
  get templateRef(): TemplateRef<any>;
34
33
  /**
35
- * Defines a function that is used to determine the rowspan of each column cell.
34
+ * Sets a function to determine the rowspan of each column cell.
36
35
  */
37
36
  set cellRowspan(cellRowspan: CellRowspanFn);
38
37
  get cellRowspan(): CellRowspanFn;
@@ -11,7 +11,15 @@ import { RowDragHintTemplateDirective } from '../row-reordering/drag-hint-templa
11
11
  import { CellRowspanFn } from './cell-rowspan';
12
12
  import * as i0 from "@angular/core";
13
13
  /**
14
- * Represents the drag handle for reordering rows in the Grid ([see example](slug:reordering_rows_grid))
14
+ * Represents the drag handle for reordering rows in the Grid. [See example](slug:reordering_rows_grid).
15
+ *
16
+ * @example
17
+ * ```html
18
+ * <kendo-grid>
19
+ * <kendo-grid-rowreorder-column></kendo-grid-rowreorder-column>
20
+ * <kendo-grid-column field="ProductID"></kendo-grid-column>
21
+ * </kendo-grid>
22
+ * ```
15
23
  */
16
24
  export declare class RowReorderColumnComponent extends ColumnBase {
17
25
  parent?: ColumnBase;
@@ -47,7 +55,7 @@ export declare class RowReorderColumnComponent extends ColumnBase {
47
55
  get rowDragHintTemplateRef(): TemplateRef<any>;
48
56
  constructor(parent?: ColumnBase, idService?: IdService);
49
57
  /**
50
- * Defines a function that is used to determine the rowspan of each column cell.
58
+ * Sets a function to determine the rowspan of each column cell.
51
59
  */
52
60
  set cellRowspan(cellRowspan: CellRowspanFn);
53
61
  get cellRowspan(): CellRowspanFn;
@@ -3,31 +3,29 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Defines the settings for sorting the Grid column.
6
+ * Defines the settings for sorting a Grid column.
7
7
  */
8
8
  export interface ColumnSortSettings {
9
9
  /**
10
- * Enables the removal of the column sorting.
10
+ * Enables removing the column sorting.
11
11
  */
12
12
  allowUnsort?: boolean;
13
13
  /**
14
- * Determines the initial (from the unsorted to the sorted state) sort direction.
15
- *
16
- * The available values for setting the initial sort direction.
14
+ * Sets the initial sort direction when sorting from the unsorted state.
17
15
  */
18
16
  initialDirection?: 'asc' | 'desc';
19
17
  }
20
18
  /**
21
- * Specifies settings for sorting by single column.
19
+ * Specifies settings for sorting by a single column.
22
20
  */
23
21
  export interface SingleSortSettings extends ColumnSortSettings {
24
22
  /**
25
- * The sort mode of the Grid.
23
+ * Sets the sort mode of the Grid.
26
24
  */
27
25
  mode?: 'single';
28
26
  }
29
27
  /**
30
- * Specifies a modifier key when multiple sort. [See example](slug:multi_sort_grid#toc-sort-key-modifier).
28
+ * Specifies a modifier key for multiple column sorting [see example](slug:multi_sort_grid#toc-sort-key-modifier).
31
29
  *
32
30
  * @example
33
31
  * ```html
@@ -39,27 +37,26 @@ export interface SingleSortSettings extends ColumnSortSettings {
39
37
  */
40
38
  export type ModifierKey = 'none' | 'ctrl' | 'shift' | 'alt';
41
39
  /**
42
- * Specifies settings for sorting by multiple columns. [See example](slug:multi_sort_grid).
40
+ * Specifies settings for sorting by multiple columns. [see example](slug:multi_sort_grid).
43
41
  */
44
42
  export interface MultipleSortSettings extends ColumnSortSettings {
45
43
  /**
46
- * The sort mode of the Grid.
44
+ * Sets the sort mode of the Grid.
47
45
  */
48
46
  mode?: 'multiple';
49
47
  /**
50
- * Enables the sort-sequence indicators for sorting multiple columns.
48
+ * Shows sort-sequence indicators for sorting multiple columns.
51
49
  */
52
50
  showIndexes?: boolean;
53
51
  /**
54
- * Specifies the modifier key for sorting by 2nd or more columns.
55
- *
56
- * By default, clicking a column adds it to the sort order (corresponds to `'none'`).
57
- * Selecting a key modifier along with the click will remove sorting from all other columns.
52
+ * Sets the modifier key for sorting by a second or more columns.
58
53
  *
59
- * If the key is set to 'ctrl', 'shift' or 'alt', clicking a column will remove sorting from all other columns.
60
- * The specified key must be pressed to add the column to the sort order instead.
61
- * The `ctrl` value corresponds to the `Command` key in a macOS environment. [See example](slug:multi_sort_grid#toc-sort-key-modifier).
54
+ * By default, clicking a column adds it to the sort order (`'none'`).
55
+ * Selecting a key modifier with the click removes sorting from all other columns.
62
56
  *
57
+ * If set to `'ctrl'`, `'shift'`, or `'alt'`, clicking a column removes sorting from all other columns.
58
+ * The specified key must be pressed to add the column to the sort order.
59
+ * The `ctrl` value matches the `Command` key on macOS [see example](slug:multi_sort_grid#toc-sort-key-modifier).
63
60
  */
64
61
  multiSortKey?: ModifierKey;
65
62
  }