@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
@@ -27,6 +27,8 @@ const isColumnContainer = column => column.isColumnGroup || isSpanColumn(column)
27
27
  let columnId = 0;
28
28
  /**
29
29
  * The base class for the column components of the Grid.
30
+ *
31
+ * Use this class as a foundation for custom column implementations.
30
32
  */
31
33
  export class ColumnBase {
32
34
  parent;
@@ -47,7 +49,7 @@ export class ColumnBase {
47
49
  */
48
50
  matchesMedia = true;
49
51
  /**
50
- * The column index after reordering. The `orderIndex` is a read-only property. Setting this field does not affect column order.
52
+ * Gets the column index after reordering. The `orderIndex` property is read-only. Setting this field does not change the column order.
51
53
  *
52
54
  * @default 0
53
55
  */
@@ -74,33 +76,33 @@ export class ColumnBase {
74
76
  */
75
77
  isSpanColumn = false;
76
78
  /**
77
- * Indicates whether the column is resizable.
79
+ * Specifies if the column is resizable.
78
80
  * @default true
79
81
  */
80
82
  resizable = true;
81
83
  /**
82
- * Indicates whether the column is reorderable.
84
+ * Specifies if the column is reorderable.
83
85
  * @default true
84
86
  */
85
87
  reorderable = true;
86
88
  /**
87
- * 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)).
89
+ * Sets the minimum width (in pixels) for resizing the column by using the UI ([see example]({% slug resizing_columns_grid %}#toc-limiting-the-resizing)).
88
90
  * The `autoFitColumn` and `autoFitColumns` methods have higher priority.
89
91
  * @default 10
90
92
  */
91
93
  minResizableWidth = 10;
92
94
  /**
93
- * 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)).
95
+ * Sets the maximum width (in pixels) for resizing the column by using the UI ([see example]({% slug resizing_columns_grid %}#toc-limiting-the-resizing)).
94
96
  * By default, the maximum width is not restricted.
95
97
  * The `autoFitColumn` and `autoFitColumns` methods have higher priority.
96
98
  */
97
99
  maxResizableWidth;
98
100
  /**
99
- * The title of the column.
101
+ * Sets the column title.
100
102
  */
101
103
  title;
102
104
  /**
103
- * The width of the column (in pixels).
105
+ * Sets the column width (in pixels).
104
106
  */
105
107
  set width(value) {
106
108
  if (typeof value === 'string') {
@@ -115,14 +117,13 @@ export class ColumnBase {
115
117
  }
116
118
  get width() { return this._width; }
117
119
  /**
118
- * Indicates whether the column will be resized during initialization so that it fits its header and row content.
120
+ * Specifies if the column is automatically resized during initialization to fit its header and row content.
119
121
  */
120
122
  autoSize;
121
123
  /**
122
- * Toggles the locked (frozen) state of the columns ([more information and example]({% slug locked_columns_grid %})).
124
+ * Toggles the locked (frozen) state of the column ([more information and example]({% slug locked_columns_grid %})).
123
125
  *
124
126
  * @default false
125
- *
126
127
  */
127
128
  set locked(value) {
128
129
  this._locked = value;
@@ -132,7 +133,7 @@ export class ColumnBase {
132
133
  }
133
134
  _locked = false;
134
135
  /**
135
- * Determines whether the column will be always visible when scrolling the Grid horizontally.
136
+ * Specifies if the column is always visible when scrolling the Grid horizontally.
136
137
  *
137
138
  * @default false
138
139
  */
@@ -144,15 +145,15 @@ export class ColumnBase {
144
145
  */
145
146
  hidden;
146
147
  /**
147
- * Sets the condition that needs to be satisfied for a column to remain visible ([see example]({% slug styling_responsive_grid %}#toc-columns)).
148
- * If you set the `hidden` property, the behavior of `media` is overridden.
148
+ * Sets the condition for the column to remain visible ([see example]({% slug styling_responsive_grid %}#toc-columns)).
149
+ * If you set the `hidden` property, `media` is ignored.
149
150
  *
150
- * Accepts the device identifiers that are [available in Bootstrap 4](https://v4-alpha.getbootstrap.com/layout/grid/#grid-options)
151
- * ([see example](slug:styling_responsive_grid)):
151
+ * Accepts device identifiers from [Bootstrap 4](https://v4-alpha.getbootstrap.com/layout/grid/#grid-options)
152
+ * ([see example](slug:styling_responsive_grid)).
152
153
  */
153
154
  media;
154
155
  /**
155
- * Specifies if the column can be locked or unlocked from the column menu or by reordering the columns.
156
+ * Specifies if the column can be locked or unlocked from the column menu or by reordering.
156
157
  * @default true
157
158
  */
158
159
  lockable = true;
@@ -162,80 +163,65 @@ export class ColumnBase {
162
163
  */
163
164
  stickable = true;
164
165
  /**
165
- * Specifies if the column menu will be shown for the column.
166
+ * Specifies if the column menu is shown for the column.
166
167
  * @default true
167
168
  */
168
169
  columnMenu = true;
169
170
  /**
170
- * Specifies if the column will be included in the column-chooser list.
171
+ * Specifies if the column is included in the column-chooser list.
171
172
  * @default true
172
173
  */
173
174
  includeInChooser = true;
174
175
  /**
175
- * Allows setting the `role` attribute for the table cells (excluding the footer and header ones) of the column.
176
+ * Sets the `role` attribute for the table cells (excluding footer and header) of the column.
176
177
  * @default "gridcell"
177
178
  */
178
179
  tableCellsRole = 'gridcell';
179
180
  /**
180
- * Sets the custom styles for the table cells (excluding the footer and header ones) of the column. Under the hood,
181
- * to apply the property, the `style` option uses the
182
- * [NgStyle](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-cells).
183
- *
181
+ * Sets custom styles for the table cells (excluding footer and header) of the column.
182
+ * Uses the [`NgStyle`](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-cells).
184
183
  */
185
184
  style;
186
185
  /**
187
- * Sets the custom styles for the header cell of the column. Under the hood, to apply the property,
188
- * the `headerStyle` option uses the
189
- * [NgStyle](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-header).
190
- *
186
+ * Sets custom styles for the header cell of the column.
187
+ * Uses the [`NgStyle`](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-header).
191
188
  */
192
189
  headerStyle;
193
190
  /**
194
- * Sets the custom styles for the filter row cell. Under the hood, to apply the property,
195
- * the `filterStyle` option uses the
196
- * [NgStyle](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-filter-row-cells).
197
- *
191
+ * Sets custom styles for the filter row cell.
192
+ * Uses the [`NgStyle`](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-filter-row-cells).
198
193
  */
199
194
  filterStyle;
200
195
  /**
201
- * Sets the custom styles for the footer cell of the column. Under the hood, to apply the property,
202
- * the `footerStyle` option uses the
203
- * [NgStyle](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-footer).
204
- *
196
+ * Sets custom styles for the footer cell of the column.
197
+ * Uses the [`NgStyle`](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-footer).
205
198
  */
206
199
  footerStyle;
207
200
  /**
208
- * Sets the custom CSS classes to the column cells. Under the hood, to apply the property, the `class` option uses the
209
- * [NgClass](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-cells).
201
+ * Sets custom CSS classes to the column cells.
202
+ * Uses the [`NgClass`](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-cells).
210
203
  * To customize header and footer column cells, use the [headerClass]({% slug api_grid_columncomponent %}#toc-headerclass)
211
204
  * and [footerClass]({% slug api_grid_columncomponent %}#toc-footerclass) inputs.
212
- *
213
205
  */
214
206
  cssClass;
215
207
  /**
216
- * Sets the custom CSS classes to the column header cell. Under the hood, to apply the property,
217
- * the `headerClass` option uses the
218
- * [NgClass](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-header).
219
- *
208
+ * Sets custom CSS classes to the column header cell.
209
+ * Uses the [`NgClass`](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-header).
220
210
  */
221
211
  headerClass;
222
212
  /**
223
- * Sets the custom CSS classes to the filter row cell. Under the hood, to apply the property,
224
- * the `filterClass` option uses the
225
- * [NgClass](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-filter-row-cells).
226
- *
213
+ * Sets custom CSS classes to the filter row cell.
214
+ * Uses the [`NgClass`](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-filter-row-cells).
227
215
  */
228
216
  filterClass;
229
217
  /**
230
- * Sets the custom CSS classes to the column footer cell. Under the hood, to apply the property,
231
- * the `footerClass` option uses the
232
- * [NgClass](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-footer).
233
- *
218
+ * Sets custom CSS classes to the column footer cell.
219
+ * Uses the [`NgClass`](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_grid_columns#toc-customizing-column-footer).
234
220
  */
235
221
  footerClass;
236
222
  /**
237
- * Defines a function that is used to determine the rowspan of each column cell.
238
- * If set to `true`, a default function is used that spans adjacent cells containing equal values.
223
+ * Defines a function to determine the rowspan of each column cell.
224
+ * If you set this to `true`, a default function is used that spans adjacent cells with equal values.
239
225
  * Cells have equal values when their data items' values for the respective field are equal.
240
226
  */
241
227
  set cellRowspan(cellRowspan) {
@@ -17,8 +17,9 @@ export function isColumnGroupComponent(column) {
17
17
  return column.isColumnGroup;
18
18
  }
19
19
  /**
20
- * Represents the column group header of the Grid
21
- * ([more information and examples](slug:multicolumnheaders_columns_grid)).
20
+ * Represents the column group header of the Grid ([more information and examples](slug:multicolumnheaders_columns_grid)).
21
+ *
22
+ * Use this component to group columns under a common header.
22
23
  *
23
24
  * @example
24
25
  * ```html
@@ -23,7 +23,9 @@ export function isColumnComponent(column) {
23
23
  return isPresent(column.field);
24
24
  }
25
25
  /**
26
- * Represents the column of the Grid. [See example](slug:columns_config#toc-using-the-column-component)
26
+ * Represents a column in the Grid.
27
+ *
28
+ * Use the `kendo-grid-column` component to define columns in the Grid.
27
29
  *
28
30
  * @example
29
31
  * ```html
@@ -33,51 +35,54 @@ export function isColumnComponent(column) {
33
35
  * <kendo-grid-column field="UnitPrice" title="Unit Price"></kendo-grid-column>
34
36
  * </kendo-grid>
35
37
  * ```
38
+ * @remarks
39
+ * 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}.
36
40
  */
37
41
  export class ColumnComponent extends ColumnBase {
38
42
  /**
39
- * The field to which the column is bound.
43
+ * Sets the field that the column binds to.
40
44
  */
41
45
  field;
42
46
  /**
43
- * The format that is applied to the value before it is displayed. For more information on the supported date and number formats,
44
- * refer to the [Column Formats](slug:formats_columns_grid) documentation article.
47
+ * Sets the format for displaying the column value.
48
+ * For supported date and number formats, see the [Column Formats](slug:formats_columns_grid) article.
45
49
  */
46
50
  format;
47
51
  /**
48
- * Allows the user to click the column headers and emits the `sortChange` event. [See example](slug:sorting_grid).
52
+ * Enables sorting when the user clicks the column header. [See example](slug:sorting_grid).
53
+ * Emits the `sortChange` event.
49
54
  *
50
55
  * @default true
51
56
  */
52
57
  sortable = true;
53
58
  /**
54
- * Determines if the column can be dragged to the group panel.
55
- * If set to `false`, you can group the columns by the column field by using the API of the Grid.
59
+ * Allows dragging the column to the group panel.
60
+ * Set to `false` to group by this column only through the Grid API.
56
61
  *
57
62
  * @default true
58
63
  */
59
64
  groupable = true;
60
65
  /**
61
- * Defines the editor type. [See example](slug:inline_editing_grid#toc-using-reactive-forms).
62
- * Used when the column enters the edit mode.
66
+ * Sets the editor type for the column. [See example](slug:inline_editing_grid#toc-using-reactive-forms).
67
+ * Used when the column enters edit mode.
63
68
  *
64
69
  * @default 'text'
65
70
  */
66
71
  editor = 'text';
67
72
  /**
68
- * Defines the filter type that is displayed inside the filter row. [See example](slug:filtering_grid#toc-filter-data-types).
73
+ * Sets the filter type for the filter row UI. [See example](slug:filtering_grid#toc-filter-data-types).
69
74
  *
70
75
  * @default 'text'
71
76
  */
72
77
  filter = 'text';
73
78
  /**
74
- * Defines if a filter UI will be displayed for this column. [See example](slug:filtering_grid).
79
+ * Shows or hides the filter UI for this column. [See example](slug:filtering_grid).
75
80
  *
76
81
  * @default true
77
82
  */
78
83
  filterable = true;
79
84
  /**
80
- * Defines whether the column is editable. [See example](slug:make_fields_uneditable_grid).
85
+ * Sets whether the column is editable. [See example](slug:make_fields_uneditable_grid).
81
86
  *
82
87
  * @default true
83
88
  */
@@ -10,17 +10,16 @@ import * as i0 from "@angular/core";
10
10
  import * as i1 from "./column-base";
11
11
  import * as i2 from "../common/id.service";
12
12
  /**
13
- * Represents the command columns of the Grid. You have to define the content of the
14
- * column inside an `<ng-template>` tag.
15
- * For more information and examples, refer to the [Command Column Directives](slug:editing_directives_grid#toc-command-column-directives) article.
13
+ * Represents the command columns of the Grid. Define the content of the column inside an `<ng-template>` tag.
14
+ * For more information and examples, see the [Command Column Directives](slug:editing_directives_grid#toc-command-column-directives) article.
16
15
  *
17
16
  * @example
18
17
  * ```html
19
- * <kendo-grid [data]="gridData">
20
- * <kendo-grid-column field="ProductID"></kendo-grid-column>
18
+ * <kendo-grid [data]="data">
19
+ * <kendo-grid-column field="ID"></kendo-grid-column>
21
20
  * <kendo-grid-command-column title="command" [width]="220">
22
21
  * <ng-template kendoGridCellTemplate>
23
- * <button kendoGridEditCommand class="k-primary">Edit</button>
22
+ * <button kendoGridEditCommand>Edit</button>
24
23
  * <button kendoGridRemoveCommand>Remove</button>
25
24
  * </ng-template>
26
25
  * </kendo-grid-command-column>
@@ -38,7 +37,7 @@ export class CommandColumnComponent extends ColumnBase {
38
37
  return this.template ? this.template.templateRef : undefined;
39
38
  }
40
39
  /**
41
- * Defines a function that is used to determine the rowspan of each column cell.
40
+ * Sets a function to determine the rowspan of each column cell.
42
41
  */
43
42
  set cellRowspan(cellRowspan) {
44
43
  super.cellRowspan = cellRowspan;
@@ -11,7 +11,15 @@ import * as i0 from "@angular/core";
11
11
  import * as i1 from "./column-base";
12
12
  import * as i2 from "../common/id.service";
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 class RowReorderColumnComponent extends ColumnBase {
17
25
  parent;
@@ -56,7 +64,7 @@ export class RowReorderColumnComponent extends ColumnBase {
56
64
  this.parent = parent;
57
65
  }
58
66
  /**
59
- * Defines a function that is used to determine the rowspan of each column cell.
67
+ * Sets a function to determine the rowspan of each column cell.
60
68
  */
61
69
  set cellRowspan(cellRowspan) {
62
70
  super.cellRowspan = cellRowspan;
@@ -20,20 +20,20 @@ export function isSpanColumnComponent(column) {
20
20
  return column.isSpanColumn;
21
21
  }
22
22
  /**
23
- * Represents a column which can be spanned over multiple data cells while the individual
24
- * header and footer cells are retained ([see example]({% slug spanned_columns_grid %})).
25
- * Enables you to achieve more flexible layout while keeping the built-in UI element for
23
+ * Represents a column that spans multiple data cells while keeping the individual
24
+ * header and footer cells ([see example]({% slug spanned_columns_grid %})).
25
+ * Use this column to create flexible layouts and keep built-in UI for
26
26
  * [sorting]({% slug sorting_grid %}), [filtering]({% slug filtering_grid %}), and
27
- * [grouping]({% slug grouping_grid %}). Wrap the columns that will be
28
- * merged inside the `<kendo-grid-span-column>` tag.
27
+ * [grouping]({% slug grouping_grid %}). Wrap the columns you want to merge inside the `<kendo-grid-span-column>` tag.
29
28
  *
29
+ * @example
30
30
  * ```html
31
31
  * <kendo-grid-span-column>
32
- * <kendo-grid-column field="field1"></kendo-grid-column>
33
- * <kendo-grid-column field="field2"></kendo-grid-column>
32
+ * <kendo-grid-column field="ID"></kendo-grid-column>
33
+ * <kendo-grid-column field="Name"></kendo-grid-column>
34
34
  * <ng-template kendoGridCellTemplate let-dataItem>
35
- * <h5>{{ dataItem.field1 }}</h5>
36
- * <p>{{ dataItem.field2 }}</p>
35
+ * <p>{{ dataItem.ID }}</p>
36
+ * <p>{{ dataItem.Name }}</p>
37
37
  * </ng-template>
38
38
  * </kendo-grid-span-column>
39
39
  * ```
@@ -74,8 +74,8 @@ export class SpanColumnComponent extends ColumnBase {
74
74
  */
75
75
  includeInChooser = false;
76
76
  /**
77
- * Defines whether the edit template of the column will be rendered.
78
- * To enable the editing functionality for a spanned column, set an edit template for it ([see example](slug:custom_reactive_editing_grid)).
77
+ * Sets whether the edit template of the column is rendered.
78
+ * To enable editing for a spanned column, set an edit template for it ([see example](slug:custom_reactive_editing_grid)).
79
79
  * @default false
80
80
  */
81
81
  set editable(value) {
@@ -18,7 +18,7 @@ export class AdaptiveGridService {
18
18
  ctx;
19
19
  adaptiveService;
20
20
  /**
21
- * Observable that emits when the ActionSheet's views change animation ends.
21
+ * Emits when the ActionSheet view animation ends.
22
22
  */
23
23
  get animationEnd() {
24
24
  return this.animationEndSubject.asObservable();
@@ -56,7 +56,7 @@ export class AdaptiveGridService {
56
56
  this.secondaryView = null;
57
57
  }
58
58
  /**
59
- * Emits an event to notify that the animation has ended.
59
+ * Notifies that the ActionSheet animation has ended.
60
60
  */
61
61
  notifyAnimationEnd() {
62
62
  this.animationEndSubject.next();
@@ -15,8 +15,14 @@ import * as i0 from "@angular/core";
15
15
  import * as i1 from "../grid.component";
16
16
  import * as i2 from "./clipboard.service";
17
17
  /**
18
- * The directive that enables the Grid built-in clipboard support. Allows copy, cut, and paste interactions
19
- * with the Grid.
18
+ * Enables built-in clipboard support for the Grid. Allows copy, cut, and paste interactions.
19
+ *
20
+ * @example
21
+ * ```html
22
+ * <kendo-grid kendoGridClipboard></kendo-grid>
23
+ * ```
24
+ * @remarks
25
+ * Applied to: {@link GridComponent}.
20
26
  */
21
27
  export class GridClipboardDirective {
22
28
  host;
@@ -24,9 +30,7 @@ export class GridClipboardDirective {
24
30
  renderer;
25
31
  zone;
26
32
  /**
27
- * Determines the target of the clipboard operation ([see example]({% slug clipboard_grid %}#toc-clipboard-target)). The possible options are:
28
- * - `activeCell`
29
- * - `selection`
33
+ * Sets the clipboard operation target. Possible values are `'activeCell'` and `'selection'`.([See example]({% slug clipboard_grid %}#toc-clipboard-target))
30
34
  *
31
35
  * @default 'selection'
32
36
  */
@@ -47,9 +51,9 @@ export class GridClipboardDirective {
47
51
  return this._target;
48
52
  }
49
53
  /**
50
- * The `GridClipboardDirective` settings.
54
+ * Configures the clipboard directive settings.
51
55
  *
52
- * @default { wholeRow: false, copyHeaders: false copy: true, cut: true, paste: true }
56
+ * @default { wholeRow: false, copyHeaders: false, copy: true, cut: true, paste: true }
53
57
  */
54
58
  set clipboardSettings(value) {
55
59
  this._clipboardSettings = Object.assign({}, this._clipboardSettings, value);
@@ -58,7 +62,7 @@ export class GridClipboardDirective {
58
62
  return this._clipboardSettings;
59
63
  }
60
64
  /**
61
- * Fires when the user performs `cut`, `copy` or `paste` action within the Grid content area.
65
+ * Fires when a clipboard action (`cut`, `copy`, or `paste`) occurs in the Grid.
62
66
  */
63
67
  clipboard = new EventEmitter();
64
68
  _target = 'selection';
@@ -9,18 +9,14 @@ export class PreventableEvent {
9
9
  prevented = false;
10
10
  /**
11
11
  * Prevents the default action for a specified event.
12
- * In this way, the source component suppresses
13
- * the built-in behavior that follows the event.
12
+ * In this way, the source component suppresses the built-in behavior that follows the event.
14
13
  */
15
14
  preventDefault() {
16
15
  this.prevented = true;
17
16
  }
18
17
  /**
19
- * Returns a respective boolean if the event was prevented
20
- * by any of its subscribers.
21
- *
22
- * @returns `true` if the default action was prevented.
23
- * Otherwise, returns `false`.
18
+ * Returns whether the default action for a specified event was prevented.
19
+ * @returns `true` if the default action was prevented. Otherwise, returns `false`.
24
20
  */
25
21
  isDefaultPrevented() {
26
22
  return this.prevented;
@@ -3,6 +3,7 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * The size restrictions that will be applied to the resizable Grid.
6
+ * Configures size restrictions for a resizable Grid.
7
+ * Use this interface to set min and max width and height for the Grid.
7
8
  */
8
9
  export {};
@@ -34,6 +34,9 @@ export class PopupCloseEvent extends PreventableEvent {
34
34
  * The original DOM event that causes the popup to close.
35
35
  */
36
36
  originalEvent;
37
+ /**
38
+ * @hidden
39
+ */
37
40
  constructor(e) {
38
41
  super();
39
42
  this.originalEvent = e;
@@ -41,8 +44,8 @@ export class PopupCloseEvent extends PreventableEvent {
41
44
  }
42
45
  const DEFAULT_POPUP_CLASS = 'k-grid-filter-popup';
43
46
  /**
44
- * The service that is used for the popups of the filter and column menus
45
- * ([see example]({% slug filter_menu %}#toc-filter-menu-with-popup)).
47
+ * Provides popup management for filter and column menus.
48
+ * Use this service to open and close popups for the Grid filter and column menus ([see example]({% slug filter_menu %}#toc-filter-menu-with-popup)).
46
49
  */
47
50
  export class SinglePopupService {
48
51
  popupService;
@@ -51,8 +54,8 @@ export class SinglePopupService {
51
54
  ctx;
52
55
  adaptiveGridService;
53
56
  /**
54
- * Fires when the filter or column menus are about to close because the user clicked outside their popups.
55
- * Used to prevent the popup from closing.
57
+ * Emits when the filter or column menu popup is about to close because the user clicked outside.
58
+ * Use this event to prevent the popup from closing.
56
59
  */
57
60
  onClose = new Subject();
58
61
  removeClick;
@@ -13,14 +13,18 @@ import * as i1 from "./grid.component";
13
13
  import * as i2 from "./editing/local-data-changes.service";
14
14
  import * as i3 from "./row-reordering/row-reorder.service";
15
15
  /**
16
- * A directive which encapsulates the in-memory handling of data operations such as [paging]({% slug paging_grid %}),
17
- * [sorting]({% slug sorting_grid %}), and [grouping]({% slug grouping_grid %})
18
- * ([more information and examples]({% slug local_data_grid %}#toc-using-the-data-binding-directive)).
16
+ * A directive that handles in-memory data operations like [paging]({% slug paging_grid %}),
17
+ * [sorting]({% slug sorting_grid %}), and [grouping]({% slug grouping_grid %}).
18
+ *
19
+ * Use this directive with local data and enable the Grid data operations with minimal configuration.
20
+ * ([More information and examples]({% slug local_data_grid %}#toc-using-the-data-binding-directive)).
19
21
  *
20
22
  * @example
21
23
  * ```html
22
- * <kendo-grid [kendoGridBinding]="gridData" ...></kendo-grid>
24
+ * <kendo-grid [kendoGridBinding]="gridData"></kendo-grid>
23
25
  * ```
26
+ * @remarks
27
+ * Applied to: {@link GridComponent}.
24
28
  */
25
29
  export class DataBindingDirective {
26
30
  grid;
@@ -28,7 +32,8 @@ export class DataBindingDirective {
28
32
  localDataChangesService;
29
33
  rowReorderService;
30
34
  /**
31
- * Defines the number of records that will be skipped by the pager.
35
+ * Sets the number of records to skip in the Grid.
36
+ *
32
37
  * @default 0
33
38
  */
34
39
  set skip(value) {
@@ -41,31 +46,36 @@ export class DataBindingDirective {
41
46
  }
42
47
  }
43
48
  /**
44
- * Defines the descriptors by which the data will be sorted.
49
+ * Sets the sort descriptors for the Grid data.
50
+ *
45
51
  */
46
52
  set sort(value) {
47
53
  this.grid.sort = this.state.sort = value;
48
54
  }
49
55
  /**
50
- * Defines the descriptor by which the data will be filtered.
56
+ * Sets the filter descriptor for the Grid data.
57
+ *
51
58
  */
52
59
  set filter(value) {
53
60
  this.grid.filter = this.state.filter = value;
54
61
  }
55
62
  /**
56
- * Defines the page size used by the Grid pager.
63
+ * Sets the page size for the Grid pager.
64
+ *
57
65
  */
58
66
  set pageSize(value) {
59
67
  this.grid.pageSize = this.state.take = value;
60
68
  }
61
69
  /**
62
- * The descriptors by which the data will be grouped.
70
+ * Sets the group descriptors for the Grid data.
71
+ *
63
72
  */
64
73
  set group(value) {
65
74
  this.grid.group = this.state.group = value;
66
75
  }
67
76
  /**
68
- * The array of data which will be used to populate the Grid.
77
+ * Sets the data array for the Grid.
78
+ *
69
79
  */
70
80
  set data(value) {
71
81
  this.originalData = value || [];
@@ -484,7 +484,16 @@ export const KENDO_GRID_PDF_EXPORT = [
484
484
  PDFCommandToolbarDirective
485
485
  ];
486
486
  /**
487
- * Utility array that contains all `Grid` related components and directives
487
+ * Contains all Grid-related components and directives.
488
+ *
489
+ * @example
490
+ * ```typescript
491
+ * import { KENDO_GRID } from '@progress/kendo-angular-grid';
492
+ * @NgModule({
493
+ * imports: [KENDO_GRID]
494
+ * })
495
+ * export class AppModule {}
496
+ * ```
488
497
  */
489
498
  export const KENDO_GRID = [
490
499
  ...KENDO_GRID_EXPORTS,
@@ -4,21 +4,19 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { PreventableEvent } from '../common/preventable-event';
6
6
  /**
7
- * Arguments for the `columnReorder` event.
7
+ * Provides the arguments for the `columnReorder` event.
8
8
  */
9
9
  export class ColumnReorderEvent extends PreventableEvent {
10
10
  /**
11
- * The reordered column.
11
+ * Represents the reordered column.
12
12
  */
13
13
  column;
14
14
  /**
15
- * The new index of the column.
16
- * Relative to the collection of columns.
15
+ * Represents the new index of the column. This index is relative to the collection of columns.
17
16
  */
18
17
  newIndex;
19
18
  /**
20
- * The original index of the column before reordering.
21
- * Relative to the collection of columns.
19
+ * Represents the original index of the column before reordering. This index is relative to the collection of columns.
22
20
  */
23
21
  oldIndex;
24
22
  /**