@progress/kendo-angular-grid 19.1.2-develop.4 → 19.1.2-develop.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (322) hide show
  1. package/adaptiveness/adaptive-mode.d.ts +1 -5
  2. package/aggregates/aggregate-types.d.ts +6 -6
  3. package/aggregates/status-bar-template.directive.d.ts +6 -4
  4. package/column-menu/column-locked-change-event.d.ts +1 -1
  5. package/column-menu/column-menu-autosize-all.component.d.ts +11 -2
  6. package/column-menu/column-menu-autosize.component.d.ts +14 -6
  7. package/column-menu/column-menu-chooser.component.d.ts +13 -5
  8. package/column-menu/column-menu-expandable-item.interface.d.ts +3 -3
  9. package/column-menu/column-menu-filter.component.d.ts +18 -5
  10. package/column-menu/column-menu-item-base.d.ts +2 -2
  11. package/column-menu/column-menu-item-content-template.directive.d.ts +4 -4
  12. package/column-menu/column-menu-item.component.d.ts +14 -7
  13. package/column-menu/column-menu-item.directive.d.ts +29 -1
  14. package/column-menu/column-menu-lock.component.d.ts +11 -3
  15. package/column-menu/column-menu-position.component.d.ts +16 -8
  16. package/column-menu/column-menu-settings.interface.d.ts +5 -4
  17. package/column-menu/column-menu-sort.component.d.ts +11 -9
  18. package/column-menu/column-menu-stick.component.d.ts +13 -5
  19. package/column-menu/column-menu-template.directive.d.ts +5 -7
  20. package/column-menu/column-menu.component.d.ts +17 -7
  21. package/column-menu/column-menu.service.d.ts +8 -9
  22. package/column-resizing/column-resize.interface.d.ts +9 -8
  23. package/columns/cell-rowspan.d.ts +5 -1
  24. package/columns/checkbox-column.component.d.ts +7 -5
  25. package/columns/column-base.d.ts +38 -52
  26. package/columns/column-group.component.d.ts +3 -2
  27. package/columns/column.component.d.ts +17 -12
  28. package/columns/command-column.component.d.ts +6 -7
  29. package/columns/reorder-column.component.d.ts +10 -2
  30. package/columns/sort-settings.d.ts +15 -18
  31. package/columns/span-column.component.d.ts +11 -11
  32. package/common/adaptiveness.service.d.ts +2 -2
  33. package/common/cell-click-event-args.interface.d.ts +8 -6
  34. package/common/clipboard-types.d.ts +27 -31
  35. package/common/clipboard.directive.d.ts +12 -8
  36. package/common/create-form-group.d.ts +3 -1
  37. package/common/fetch-data-callback.d.ts +4 -2
  38. package/common/field-datatype.d.ts +2 -2
  39. package/common/pager-settings.d.ts +36 -20
  40. package/common/preventable-event.d.ts +3 -7
  41. package/common/remove-confirmation.d.ts +12 -0
  42. package/common/resizable-settings.d.ts +6 -5
  43. package/common/single-popup.service.d.ts +7 -4
  44. package/common/size-options.d.ts +2 -1
  45. package/data/change-event-args.interface.d.ts +7 -7
  46. package/data/data-item.interface.d.ts +6 -6
  47. package/data/data.collection.d.ts +1 -1
  48. package/data/grid-item.interface.d.ts +1 -1
  49. package/data/group-footer-item.interface.d.ts +6 -6
  50. package/data/group-item.interface.d.ts +5 -5
  51. package/databinding.directive.d.ts +20 -10
  52. package/directives.d.ts +10 -1
  53. package/dragdrop/column-reorder-config.d.ts +2 -2
  54. package/dragdrop/column-reorder-event.d.ts +4 -6
  55. package/editing/add-command-tool.directive.d.ts +5 -7
  56. package/editing/add-command.directive.d.ts +3 -8
  57. package/editing/add-event-args.interface.d.ts +1 -1
  58. package/editing/cancel-command-tool.directive.d.ts +5 -5
  59. package/editing/cancel-command.directive.d.ts +6 -5
  60. package/editing/cancel-event-args.interface.d.ts +7 -1
  61. package/editing/cell-close-event.d.ts +9 -6
  62. package/editing/edit-command-tool.directive.d.ts +10 -9
  63. package/editing/edit-command.directive.d.ts +1 -1
  64. package/editing/edit-event-args.interface.d.ts +3 -3
  65. package/editing/edit-row-options.interface.d.ts +10 -4
  66. package/editing/edit-template.directive.d.ts +17 -9
  67. package/editing/form/models.d.ts +55 -48
  68. package/editing/remove-command-tool.directive.d.ts +10 -9
  69. package/editing/remove-command.directive.d.ts +4 -5
  70. package/editing/remove-event-args.interface.d.ts +2 -1
  71. package/editing/save-command-tool.directive.d.ts +7 -6
  72. package/editing/save-command.directive.d.ts +5 -5
  73. package/editing/save-event-args.interface.d.ts +2 -1
  74. package/editing-directives/create-form-group-args.interface.d.ts +1 -1
  75. package/editing-directives/edit-service.interface.d.ts +13 -6
  76. package/editing-directives/external-editing.directive.d.ts +11 -4
  77. package/editing-directives/in-cell-editing.directive.d.ts +9 -3
  78. package/editing-directives/reactive-editing.directive.d.ts +9 -3
  79. package/editing-directives/template-editing.directive.d.ts +9 -3
  80. package/esm2022/aggregates/status-bar-template.directive.mjs +6 -4
  81. package/esm2022/column-menu/column-locked-change-event.mjs +1 -1
  82. package/esm2022/column-menu/column-menu-autosize-all.component.mjs +11 -2
  83. package/esm2022/column-menu/column-menu-autosize.component.mjs +14 -6
  84. package/esm2022/column-menu/column-menu-chooser.component.mjs +13 -5
  85. package/esm2022/column-menu/column-menu-filter.component.mjs +18 -5
  86. package/esm2022/column-menu/column-menu-item-base.mjs +2 -2
  87. package/esm2022/column-menu/column-menu-item-content-template.directive.mjs +4 -4
  88. package/esm2022/column-menu/column-menu-item.component.mjs +14 -7
  89. package/esm2022/column-menu/column-menu-item.directive.mjs +29 -1
  90. package/esm2022/column-menu/column-menu-lock.component.mjs +11 -3
  91. package/esm2022/column-menu/column-menu-position.component.mjs +16 -8
  92. package/esm2022/column-menu/column-menu-sort.component.mjs +11 -9
  93. package/esm2022/column-menu/column-menu-stick.component.mjs +13 -5
  94. package/esm2022/column-menu/column-menu-template.directive.mjs +5 -7
  95. package/esm2022/column-menu/column-menu.component.mjs +17 -7
  96. package/esm2022/column-menu/column-menu.service.mjs +8 -9
  97. package/esm2022/columns/checkbox-column.component.mjs +7 -5
  98. package/esm2022/columns/column-base.mjs +38 -52
  99. package/esm2022/columns/column-group.component.mjs +3 -2
  100. package/esm2022/columns/column.component.mjs +17 -12
  101. package/esm2022/columns/command-column.component.mjs +6 -7
  102. package/esm2022/columns/reorder-column.component.mjs +10 -2
  103. package/esm2022/columns/span-column.component.mjs +11 -11
  104. package/esm2022/common/adaptiveness.service.mjs +2 -2
  105. package/esm2022/common/clipboard.directive.mjs +12 -8
  106. package/esm2022/common/preventable-event.mjs +3 -7
  107. package/esm2022/common/resizable-settings.mjs +2 -1
  108. package/esm2022/common/single-popup.service.mjs +7 -4
  109. package/esm2022/databinding.directive.mjs +20 -10
  110. package/esm2022/directives.mjs +10 -1
  111. package/esm2022/dragdrop/column-reorder-event.mjs +4 -6
  112. package/esm2022/editing/add-command-tool.directive.mjs +5 -7
  113. package/esm2022/editing/add-command.directive.mjs +3 -8
  114. package/esm2022/editing/cancel-command-tool.directive.mjs +5 -5
  115. package/esm2022/editing/cancel-command.directive.mjs +6 -5
  116. package/esm2022/editing/cell-close-event.mjs +7 -4
  117. package/esm2022/editing/edit-command-tool.directive.mjs +10 -9
  118. package/esm2022/editing/edit-command.directive.mjs +1 -1
  119. package/esm2022/editing/edit-template.directive.mjs +17 -9
  120. package/esm2022/editing/remove-command-tool.directive.mjs +10 -9
  121. package/esm2022/editing/remove-command.directive.mjs +4 -5
  122. package/esm2022/editing/save-command-tool.directive.mjs +7 -6
  123. package/esm2022/editing/save-command.directive.mjs +5 -5
  124. package/esm2022/editing-directives/external-editing.directive.mjs +11 -4
  125. package/esm2022/editing-directives/in-cell-editing.directive.mjs +9 -3
  126. package/esm2022/editing-directives/reactive-editing.directive.mjs +9 -3
  127. package/esm2022/editing-directives/template-editing.directive.mjs +9 -3
  128. package/esm2022/excel/excel-command-tool.directive.mjs +10 -13
  129. package/esm2022/excel/excel-command.directive.mjs +7 -11
  130. package/esm2022/excel/excel-export-event.mjs +4 -1
  131. package/esm2022/excel/excel.component.mjs +24 -25
  132. package/esm2022/excel/excel.module.mjs +4 -7
  133. package/esm2022/filtering/boolean-filter.component.mjs +3 -3
  134. package/esm2022/filtering/cell/boolean-filter-cell.component.mjs +1 -2
  135. package/esm2022/filtering/cell/date-filter-cell.component.mjs +5 -2
  136. package/esm2022/filtering/cell/filter-cell-operators.component.mjs +10 -7
  137. package/esm2022/filtering/cell/filter-cell-template.directive.mjs +4 -2
  138. package/esm2022/filtering/cell/numeric-filter-cell.component.mjs +10 -9
  139. package/esm2022/filtering/cell/string-filter-cell.component.mjs +7 -5
  140. package/esm2022/filtering/date-filter.component.mjs +17 -19
  141. package/esm2022/filtering/filter.service.mjs +4 -4
  142. package/esm2022/filtering/menu/boolean-filter-menu.component.mjs +3 -3
  143. package/esm2022/filtering/menu/date-filter-menu.component.mjs +5 -3
  144. package/esm2022/filtering/menu/filter-menu-template.directive.mjs +9 -7
  145. package/esm2022/filtering/menu/numeric-filter-menu-input.component.mjs +8 -8
  146. package/esm2022/filtering/menu/numeric-filter-menu.component.mjs +10 -6
  147. package/esm2022/filtering/menu/string-filter-menu.component.mjs +10 -5
  148. package/esm2022/filtering/numeric-filter.component.mjs +13 -13
  149. package/esm2022/filtering/operators/after-eq-filter-operator.component.mjs +26 -0
  150. package/esm2022/filtering/operators/after-filter-operator.component.mjs +26 -0
  151. package/esm2022/filtering/operators/before-eq-filter-operator.component.mjs +26 -0
  152. package/esm2022/filtering/operators/before-filter-operator.component.mjs +26 -0
  153. package/esm2022/filtering/operators/contains-filter-operator.component.mjs +27 -1
  154. package/esm2022/filtering/operators/ends-with-filter-operator.component.mjs +26 -1
  155. package/esm2022/filtering/operators/eq-filter-operator.component.mjs +74 -1
  156. package/esm2022/filtering/operators/gt-filter-operator.component.mjs +26 -0
  157. package/esm2022/filtering/operators/gte-filter-operator.component.mjs +26 -0
  158. package/esm2022/filtering/operators/is-empty-filter-operator.component.mjs +26 -1
  159. package/esm2022/filtering/operators/is-not-empty-filter-operator.component.mjs +26 -1
  160. package/esm2022/filtering/operators/is-not-null-filter-operator.component.mjs +73 -1
  161. package/esm2022/filtering/operators/isnull-filter-operator.component.mjs +73 -1
  162. package/esm2022/filtering/operators/lt-filter-operator.component.mjs +26 -1
  163. package/esm2022/filtering/operators/lte-filter-operator.component.mjs +26 -1
  164. package/esm2022/filtering/operators/neq-filter-operator.component.mjs +73 -1
  165. package/esm2022/filtering/operators/not-contains-filter-operator.component.mjs +26 -1
  166. package/esm2022/filtering/operators/starts-with-filter-operator.component.mjs +26 -1
  167. package/esm2022/filtering/string-filter.component.mjs +5 -4
  168. package/esm2022/grid.component.mjs +159 -173
  169. package/esm2022/grid.module.mjs +3 -2
  170. package/esm2022/grouping/group-footer-template.directive.mjs +5 -6
  171. package/esm2022/grouping/group-header-column-template.directive.mjs +5 -5
  172. package/esm2022/grouping/group-header-template.directive.mjs +5 -6
  173. package/esm2022/grouping/group-scroll-binding.directive.mjs +2 -0
  174. package/esm2022/localization/custom-messages.component.mjs +12 -2
  175. package/esm2022/localization/messages.mjs +154 -165
  176. package/esm2022/navigation/focus-group.mjs +2 -2
  177. package/esm2022/navigation/focusable.directive.mjs +5 -3
  178. package/esm2022/package-metadata.mjs +2 -2
  179. package/esm2022/pdf/pdf-command-tool.directive.mjs +8 -11
  180. package/esm2022/pdf/pdf-command.directive.mjs +5 -9
  181. package/esm2022/pdf/pdf-export-event.mjs +1 -1
  182. package/esm2022/pdf/pdf-margin.component.mjs +16 -6
  183. package/esm2022/pdf/pdf-template.directive.mjs +5 -5
  184. package/esm2022/pdf/pdf.component.mjs +15 -5
  185. package/esm2022/pdf/pdf.module.mjs +3 -6
  186. package/esm2022/rendering/cell-loading.template.directive.mjs +4 -7
  187. package/esm2022/rendering/cell-template.directive.mjs +7 -8
  188. package/esm2022/rendering/common/spacer.component.mjs +14 -3
  189. package/esm2022/rendering/details/detail-collapse-event.mjs +8 -3
  190. package/esm2022/rendering/details/detail-expand-event.mjs +8 -3
  191. package/esm2022/rendering/details/detail-template.directive.mjs +3 -2
  192. package/esm2022/rendering/details-expand.directive.mjs +18 -8
  193. package/esm2022/rendering/footer/footer-template.directive.mjs +7 -7
  194. package/esm2022/rendering/groups-expand.directive.mjs +15 -5
  195. package/esm2022/rendering/header/header-template.directive.mjs +11 -11
  196. package/esm2022/rendering/loading-template.directive.mjs +14 -3
  197. package/esm2022/rendering/no-records-template.directive.mjs +3 -5
  198. package/esm2022/rendering/table-body.component.mjs +3 -1
  199. package/esm2022/rendering/toolbar/toolbar-focusable.directive.mjs +10 -2
  200. package/esm2022/rendering/toolbar/toolbar-position.mjs +0 -17
  201. package/esm2022/rendering/toolbar/toolbar-template.directive.mjs +3 -3
  202. package/esm2022/rendering/toolbar/tools/column-chooser-tool.directive.mjs +6 -5
  203. package/esm2022/rendering/toolbar/tools/filter-command-tool.directive.mjs +5 -5
  204. package/esm2022/rendering/toolbar/tools/group-command-tool.directive.mjs +5 -3
  205. package/esm2022/rendering/toolbar/tools/sort-command-tool.directive.mjs +4 -4
  206. package/esm2022/row-reordering/drag-handle-template.directive.mjs +5 -6
  207. package/esm2022/row-reordering/drag-hint-template.directive.mjs +3 -5
  208. package/esm2022/selection/selectall-checkbox.directive.mjs +2 -2
  209. package/esm2022/selection/selection-checkbox.directive.mjs +9 -8
  210. package/esm2022/selection/selection-default.mjs +9 -8
  211. package/esm2022/selection/selection.directive.mjs +10 -1
  212. package/esm2022/state-management/grid-state.models.mjs +3 -3
  213. package/esm2022/state-management/redo-command-tool.mjs +17 -9
  214. package/esm2022/state-management/undo-command-tool.mjs +17 -9
  215. package/esm2022/state-management/undo-redo.directive.mjs +17 -6
  216. package/excel/excel-command-tool.directive.d.ts +10 -13
  217. package/excel/excel-command.directive.d.ts +7 -11
  218. package/excel/excel-export-event.d.ts +4 -1
  219. package/excel/excel.component.d.ts +24 -25
  220. package/excel/excel.module.d.ts +4 -7
  221. package/fesm2022/progress-kendo-angular-grid.mjs +1939 -1025
  222. package/filtering/boolean-filter.component.d.ts +3 -3
  223. package/filtering/cell/boolean-filter-cell.component.d.ts +1 -2
  224. package/filtering/cell/date-filter-cell.component.d.ts +5 -2
  225. package/filtering/cell/filter-cell-operators.component.d.ts +10 -7
  226. package/filtering/cell/filter-cell-template.directive.d.ts +4 -2
  227. package/filtering/cell/numeric-filter-cell.component.d.ts +10 -9
  228. package/filtering/cell/string-filter-cell.component.d.ts +7 -5
  229. package/filtering/date-filter.component.d.ts +17 -19
  230. package/filtering/filter.service.d.ts +4 -4
  231. package/filtering/filterable.d.ts +5 -5
  232. package/filtering/menu/boolean-filter-menu.component.d.ts +3 -3
  233. package/filtering/menu/date-filter-menu.component.d.ts +5 -3
  234. package/filtering/menu/filter-menu-template.directive.d.ts +9 -7
  235. package/filtering/menu/numeric-filter-menu-input.component.d.ts +8 -8
  236. package/filtering/menu/numeric-filter-menu.component.d.ts +10 -6
  237. package/filtering/menu/string-filter-menu.component.d.ts +10 -5
  238. package/filtering/numeric-filter.component.d.ts +13 -13
  239. package/filtering/operators/after-eq-filter-operator.component.d.ts +26 -0
  240. package/filtering/operators/after-filter-operator.component.d.ts +26 -0
  241. package/filtering/operators/before-eq-filter-operator.component.d.ts +26 -0
  242. package/filtering/operators/before-filter-operator.component.d.ts +26 -0
  243. package/filtering/operators/contains-filter-operator.component.d.ts +27 -1
  244. package/filtering/operators/ends-with-filter-operator.component.d.ts +26 -1
  245. package/filtering/operators/eq-filter-operator.component.d.ts +74 -1
  246. package/filtering/operators/gt-filter-operator.component.d.ts +26 -0
  247. package/filtering/operators/gte-filter-operator.component.d.ts +26 -0
  248. package/filtering/operators/is-empty-filter-operator.component.d.ts +26 -1
  249. package/filtering/operators/is-not-empty-filter-operator.component.d.ts +26 -1
  250. package/filtering/operators/is-not-null-filter-operator.component.d.ts +73 -1
  251. package/filtering/operators/isnull-filter-operator.component.d.ts +73 -1
  252. package/filtering/operators/lt-filter-operator.component.d.ts +26 -1
  253. package/filtering/operators/lte-filter-operator.component.d.ts +26 -1
  254. package/filtering/operators/neq-filter-operator.component.d.ts +73 -1
  255. package/filtering/operators/not-contains-filter-operator.component.d.ts +26 -1
  256. package/filtering/operators/starts-with-filter-operator.component.d.ts +26 -1
  257. package/filtering/string-filter.component.d.ts +5 -4
  258. package/grid.component.d.ts +159 -173
  259. package/grid.module.d.ts +3 -2
  260. package/grouping/group-footer-template.directive.d.ts +5 -6
  261. package/grouping/group-header-column-template.directive.d.ts +5 -5
  262. package/grouping/group-header-template.directive.d.ts +5 -6
  263. package/grouping/group-key.interface.d.ts +7 -7
  264. package/grouping/group-rows-args.interface.d.ts +5 -5
  265. package/grouping/group-scroll-binding.directive.d.ts +2 -0
  266. package/grouping/group-settings.d.ts +7 -7
  267. package/grouping/virtual-group-result.interface.d.ts +3 -3
  268. package/localization/custom-messages.component.d.ts +12 -2
  269. package/localization/messages.d.ts +154 -165
  270. package/navigation/focus-group.d.ts +2 -2
  271. package/navigation/focusable-element.interface.d.ts +8 -9
  272. package/navigation/focusable.directive.d.ts +5 -3
  273. package/navigation/navigable-settings.d.ts +10 -5
  274. package/navigation/navigation-cell.interface.d.ts +8 -8
  275. package/navigation/navigation-row.interface.d.ts +6 -7
  276. package/package.json +20 -20
  277. package/pdf/pdf-command-tool.directive.d.ts +8 -11
  278. package/pdf/pdf-command.directive.d.ts +5 -9
  279. package/pdf/pdf-export-event.d.ts +1 -1
  280. package/pdf/pdf-margin.component.d.ts +16 -6
  281. package/pdf/pdf-margin.interface.d.ts +2 -2
  282. package/pdf/pdf-template.directive.d.ts +5 -5
  283. package/pdf/pdf.component.d.ts +15 -5
  284. package/pdf/pdf.module.d.ts +3 -6
  285. package/rendering/cell-loading.template.directive.d.ts +4 -7
  286. package/rendering/cell-template.directive.d.ts +7 -8
  287. package/rendering/common/row-args.d.ts +2 -0
  288. package/rendering/common/row-class.d.ts +20 -21
  289. package/rendering/common/spacer.component.d.ts +14 -3
  290. package/rendering/details/detail-collapse-event.d.ts +8 -3
  291. package/rendering/details/detail-expand-event.d.ts +8 -3
  292. package/rendering/details/detail-template.directive.d.ts +8 -7
  293. package/rendering/details-expand.directive.d.ts +18 -8
  294. package/rendering/footer/footer-template.directive.d.ts +7 -7
  295. package/rendering/groups-expand.directive.d.ts +15 -5
  296. package/rendering/header/header-template.directive.d.ts +11 -11
  297. package/rendering/loading-template.directive.d.ts +14 -3
  298. package/rendering/no-records-template.directive.d.ts +3 -5
  299. package/rendering/toolbar/toolbar-focusable.directive.d.ts +10 -2
  300. package/rendering/toolbar/toolbar-position.d.ts +5 -5
  301. package/rendering/toolbar/toolbar-template.directive.d.ts +3 -3
  302. package/rendering/toolbar/tools/column-chooser-tool.directive.d.ts +6 -5
  303. package/rendering/toolbar/tools/filter-command-tool.directive.d.ts +5 -5
  304. package/rendering/toolbar/tools/group-command-tool.directive.d.ts +5 -3
  305. package/rendering/toolbar/tools/sort-command-tool.directive.d.ts +4 -4
  306. package/row-reordering/drag-handle-template.directive.d.ts +5 -6
  307. package/row-reordering/drag-hint-template.directive.d.ts +3 -5
  308. package/row-reordering/types.d.ts +10 -10
  309. package/schematics/ngAdd/index.js +4 -4
  310. package/scrolling/content-scroll-event.d.ts +11 -11
  311. package/scrolling/scroll-bottom-event.d.ts +2 -2
  312. package/scrolling/scroll-request.service.d.ts +6 -6
  313. package/scrolling/scrollmode.d.ts +3 -3
  314. package/selection/selectall-checkbox.directive.d.ts +2 -2
  315. package/selection/selection-checkbox.directive.d.ts +9 -8
  316. package/selection/selection-default.d.ts +9 -8
  317. package/selection/selection.directive.d.ts +10 -1
  318. package/selection/types.d.ts +41 -35
  319. package/state-management/grid-state.models.d.ts +16 -7
  320. package/state-management/redo-command-tool.d.ts +14 -6
  321. package/state-management/undo-command-tool.d.ts +14 -6
  322. package/state-management/undo-redo.directive.d.ts +17 -6
@@ -17,7 +17,7 @@ import * as i2 from "../common/provider.service";
17
17
  export class BooleanFilterComponent extends BaseFilterCellComponent {
18
18
  ctx;
19
19
  /**
20
- * The column with which the filter is associated.
20
+ * Sets the column for this filter.
21
21
  * @type {ColumnComponent}
22
22
  */
23
23
  column;
@@ -26,7 +26,7 @@ export class BooleanFilterComponent extends BaseFilterCellComponent {
26
26
  */
27
27
  operator = "eq";
28
28
  /**
29
- * The current filter for the associated column field.
29
+ * Gets the current filter for the column field.
30
30
  * @readonly
31
31
  * @type {FilterDescriptor}
32
32
  */
@@ -34,7 +34,7 @@ export class BooleanFilterComponent extends BaseFilterCellComponent {
34
34
  return this.filterByField(this.column.field);
35
35
  }
36
36
  /**
37
- * The current filter operator for the associated column field.
37
+ * Gets the current filter operator for the column field.
38
38
  * @readonly
39
39
  * @type {string}
40
40
  */
@@ -17,11 +17,10 @@ import * as i1 from "../filter.service";
17
17
  import * as i2 from "../../common/provider.service";
18
18
  import * as i3 from "../../layout/sizing-options.service";
19
19
  /**
20
- * Represents a Boolean filter-cell component.
20
+ * Represents a filter-cell component for boolean columns.
21
21
  * See the article about the [built-in filter components](slug:filter_row#toc-built-in-filter-row-components).
22
22
  *
23
23
  * @example
24
- *
25
24
  * ```html
26
25
  * <kendo-grid-column field="Discontinued">
27
26
  * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
@@ -17,7 +17,7 @@ import * as i1 from "../filter.service";
17
17
  import * as i2 from "../../common/provider.service";
18
18
  import * as i3 from "../../layout/sizing-options.service";
19
19
  /**
20
- * Represents a [DatePicker](slug:overview_datepicker) filter-cell component.
20
+ * Represents a [DatePicker](slug:overview_datepicker) cell component for filtering of date columns.
21
21
  * See the article about the [built-in filter components](slug:filter_row#toc-built-in-filter-row-components).
22
22
  *
23
23
  * @example
@@ -32,11 +32,14 @@ import * as i3 from "../../layout/sizing-options.service";
32
32
  * </ng-template>
33
33
  * </kendo-grid-column>
34
34
  * ```
35
+ *
36
+ * @remarks
37
+ * Supported children components are: {@link EqualFilterOperatorComponent}, {@link NotEqualFilterOperatorComponent}, {@link AfterEqFilterOperatorComponent}, {@link AfterFilterOperatorComponent}, {@link BeforeEqFilterOperatorComponent}, {@link BeforeFilterOperatorComponent}, {@link IsNullFilterOperatorComponent}, {@link IsNotNullFilterOperatorComponent}.
35
38
  */
36
39
  export class DateFilterCellComponent extends DateFilterComponent {
37
40
  ctx;
38
41
  /**
39
- * Determines if the drop-down filter operators will be displayed. The default value is `true`.
42
+ * Determines if the drop-down filter operators are displayed.
40
43
  * @type {boolean}
41
44
  * @default true
42
45
  */
@@ -17,7 +17,8 @@ import * as i0 from "@angular/core";
17
17
  import * as i1 from "../../common/provider.service";
18
18
  import * as i2 from "../../layout/sizing-options.service";
19
19
  /**
20
- * Represents a component which accommodates the filter operators.
20
+ * Represents a component that displays filter operators.
21
+ * Use this component to show a drop-down list of filter operators and a clear button.
21
22
  *
22
23
  * @example
23
24
  * ```html
@@ -57,31 +58,33 @@ export class FilterCellOperatorsComponent {
57
58
  */
58
59
  dropdown;
59
60
  /**
60
- * The filter operators that will be displayed.
61
+ * Specifies the filter operators to display.
62
+ * @type {Array<{ text: string, value: string }>}
61
63
  */
62
64
  operators = [];
63
65
  /**
64
- * Determines if the **Clear** button will be displayed.
66
+ * Determines if the **Clear** button is displayed.
65
67
  * @type {boolean}
66
68
  */
67
69
  showButton;
68
70
  /**
69
- * Determines if the list of operators will be displayed.
71
+ * Determines if the list of operators is displayed.
70
72
  * @type {boolean}
71
73
  * @default true
72
74
  */
73
75
  showOperators = true;
74
76
  /**
75
- * The selected operator.
77
+ * Represents the selected operator value.
76
78
  * @type {string}
77
79
  */
78
80
  value;
79
81
  /**
80
- * The Grid column which the filter operators are associated with.
82
+ * Sets the column instance for which the filter operators are displayed.
83
+ * @type {ColumnComponent}
81
84
  */
82
85
  column;
83
86
  /**
84
- * Fires when the operator is selected.
87
+ * Fires when the operator value changes.
85
88
  * @type {EventEmitter<string>}
86
89
  */
87
90
  valueChange = new EventEmitter();
@@ -5,14 +5,16 @@
5
5
  import { Directive, TemplateRef, Optional } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents the filter-cell template.
9
- * Helps to customize the content of the filter cell. To define the filter cell template, nest an `<ng-template>` tag with the
8
+ * Represents the filter-cell template directive.
9
+ * Use this directive to customize the content of the filter cell.
10
+ * To define the filter cell template, nest an `<ng-template>` tag with the
10
11
  * `kendoGridFilterCellTemplate` directive inside a `<kendo-grid-column>` tag ([see example]({% slug filter_row %}#toc-custom-filters)).
11
12
  *
12
13
  * The template context is set to the current data item and the following additional fields are passed:
13
14
  * - `column`&mdash;Defines an instance of the [`ColumnComponent`]({% slug api_grid_columncomponent %}) option. Use it as an alias for a template variable by utilizing the `let-column="column"` syntax.
14
15
  * - `filter`&mdash;The provided filter descriptors. Use it as an alias for a template variable by utilizing the `let-filter="filter"` syntax.
15
16
  *
17
+ * @example
16
18
  * ```html
17
19
  * <kendo-grid-column field="CategoryID" title="Category">
18
20
  * <ng-template kendoGridFilterCellTemplate
@@ -17,7 +17,7 @@ import * as i1 from "../filter.service";
17
17
  import * as i2 from "../../common/provider.service";
18
18
  import * as i3 from "../../layout/sizing-options.service";
19
19
  /**
20
- * Represents a numeric filter-cell component.
20
+ * Represents a filter cell component for filtering of numeric columns.
21
21
  * See the article about the [built-in filter components](slug:filter_row#toc-built-in-filter-row-components).
22
22
  *
23
23
  * @example
@@ -31,27 +31,28 @@ import * as i3 from "../../layout/sizing-options.service";
31
31
  * </ng-template>
32
32
  * </kendo-grid-column>
33
33
  * ```
34
+ * @remarks
35
+ * Supported children components are: {@link EqualFilterOperatorComponent}, {@link NotEqualFilterOperatorComponent}, {@link GreaterFilterOperatorComponent}, {@link GreaterOrEqualToFilterOperatorComponent}, {@link LessFilterOperatorComponent}, {@link LessOrEqualToFilterOperatorComponent}, {@link IsNullFilterOperatorComponent}, {@link IsNotNullFilterOperatorComponent}.
34
36
  */
35
37
  export class NumericFilterCellComponent extends NumericFilterComponent {
36
38
  ctx;
37
39
  /**
38
- * Determines the delay time (in milliseconds) before the filter value is submitted.
39
- * A value of `0` indicates no delay. The default value is `500`.
40
- * @type {boolean}\
40
+ * Sets the delay time in milliseconds before the filter value is submitted.
41
+ * A value of `0` means no delay.
42
+ * @type {number}
41
43
  * @default 500
42
44
  */
43
45
  filterDelay = 500;
44
46
  /**
45
- * Determines if the drop-down filter operators will be displayed.
46
- * The default value is `true`.
47
+ * Determines if the drop-down filter operators are displayed.
47
48
  * @type {boolean}
48
49
  * @default true
49
50
  */
50
51
  showOperators = true;
51
52
  /**
52
- * The placeholder text for the filter input.
53
- * @type {string}
54
- */
53
+ * The placeholder text for the filter input.
54
+ * @type {string}
55
+ */
55
56
  placeholder;
56
57
  subs;
57
58
  constructor(filterService, ctx, sizingService) {
@@ -19,7 +19,7 @@ import * as i2 from "../../common/provider.service";
19
19
  import * as i3 from "../../layout/sizing-options.service";
20
20
  import * as i4 from "@angular/forms";
21
21
  /**
22
- * Represents a string filter-cell component
22
+ * Represents a filter cell component for filtering of string columns.
23
23
  * See the article about the [built-in filter components](slug:filter_row#toc-built-in-filter-row-components).
24
24
  *
25
25
  * @example
@@ -33,17 +33,19 @@ import * as i4 from "@angular/forms";
33
33
  * </ng-template>
34
34
  * </kendo-grid-column>
35
35
  * ```
36
+ * @remarks
37
+ * Supported children components are: {@link EqualFilterOperatorComponent}, {@link NotEqualFilterOperatorComponent}, {@link ContainsFilterOperatorComponent}, {@link DoesNotContainFilterOperatorComponent}, {@link StartsWithFilterOperatorComponent}, {@link EndsWithFilterOperatorComponent}, {@link IsNullFilterOperatorComponent}, {@link IsNotNullFilterOperatorComponent}, {@link IsEmptyFilterOperatorComponent}, {@link IsNotEmptyFilterOperatorComponent}.
36
38
  */
37
39
  export class StringFilterCellComponent extends StringFilterComponent {
38
40
  /**
39
- * Determines the delay time (in milliseconds) before the filter value is submitted.
40
- * A value of `0` indicates no delay.
41
- * @type {boolean}
41
+ * Sets the delay time in milliseconds before the filter value is submitted.
42
+ * A value of `0` means no delay.
43
+ * @type {number}
42
44
  * @default 500
43
45
  */
44
46
  filterDelay = 500;
45
47
  /**
46
- * Determines if the drop-down filter operators will be displayed.
48
+ * Determines if the drop-down filter operators are displayed.
47
49
  * @type {boolean}
48
50
  * @default true
49
51
  */
@@ -29,18 +29,18 @@ const dateOperators = localizeOperators({
29
29
  export class DateFilterComponent extends BaseFilterCellComponent {
30
30
  ctx;
31
31
  /**
32
- * The column with which the filter is associated.
32
+ * Sets the column for this filter.
33
33
  * @type {ColumnComponent}
34
34
  */
35
35
  column;
36
36
  /**
37
- * The default filter operator. Defaults to `contains`.
37
+ * Sets the default filter operator.
38
38
  * @type {string}
39
39
  * @default 'gte'
40
40
  */
41
41
  operator = "gte";
42
42
  /**
43
- * The current filter for the associated column field.
43
+ * Gets the current filter for the column field.
44
44
  * @readonly
45
45
  * @type {FilterDescriptor}
46
46
  */
@@ -48,16 +48,15 @@ export class DateFilterComponent extends BaseFilterCellComponent {
48
48
  return this.filterByField(this.column.field);
49
49
  }
50
50
  /**
51
- * Specifies the date format that is used when the component is not focused.
52
- * By default, the `column.format` value is used (if set).
51
+ * Sets the date format used when the component is not focused.
52
+ * Uses `column.format` if set.
53
53
  */
54
54
  set format(value) {
55
55
  this._format = value;
56
56
  }
57
57
  /**
58
- * Specifies the date format that is used when the component is not focused.
59
- * By default, the `column.format` value is used (if set).
60
- *
58
+ * Gets the date format used when the component is not focused.
59
+ * Uses `column.format` if set.
61
60
  * @readonly
62
61
  * @type {string}
63
62
  */
@@ -65,49 +64,48 @@ export class DateFilterComponent extends BaseFilterCellComponent {
65
64
  return !isNullOrEmptyString(this._format) ? this._format : this.columnFormat;
66
65
  }
67
66
  /**
68
- * Specifies the smallest value that is valid.
67
+ * Sets the smallest valid date value.
69
68
  * @type {Date}
70
69
  */
71
70
  min;
72
71
  /**
73
- * Specifies the greatest value that is valid.
72
+ * Sets the largest valid date value.
74
73
  * @type {Date}
75
74
  */
76
75
  max;
77
76
  /**
78
- * Defines the descriptions of the format sections in the input field.
77
+ * Sets the descriptions for the format sections in the input field.
79
78
  * [See example](slug:placeholders_datepicker#toc-format-sections-description).
80
79
  */
81
80
  formatPlaceholder;
82
81
  /**
83
- * Specifies the hint that the component displays when its value is `null`.
82
+ * Sets the hint shown when the value is `null`.
84
83
  * [See example](slug:placeholders_datepicker#toc-text-hints).
85
84
  */
86
85
  placeholder;
87
86
  /**
88
- * Defines the active view that the calendar initially renders.
89
- * By default, the active view is `month`.
90
- * You have to set `activeView` within the `topView`-`bottomView` range.
87
+ * Sets the active calendar view when the calendar opens.
88
+ * Set `activeView` within the `topView`-`bottomView` range.
91
89
  * @default 'month'
92
90
  */
93
91
  activeView = "month";
94
92
  /**
95
- * Defines the bottommost calendar view, to which the user can navigate.
93
+ * Defines the lowest calendar view level the user can navigate to.
96
94
  * @default 'month'
97
95
  */
98
96
  bottomView = "month";
99
97
  /**
100
- * Defines the topmost calendar view, to which the user can navigate.
98
+ * Defines the highest calendar view level the user can navigate to.
101
99
  * @default 'century'
102
100
  */
103
101
  topView = "century";
104
102
  /**
105
- * Determines whether to display a week number column in the `month` view of the Calendar.
103
+ * When `true`, shows a week number column in the `month` view.
106
104
  * @default false
107
105
  */
108
106
  weekNumber = false;
109
107
  /**
110
- * The current filter operator for the associated column field.
108
+ * Gets the current filter operator for the column field.
111
109
  * @readonly
112
110
  * @type {string}
113
111
  */
@@ -8,8 +8,8 @@ import { MenuTabbingService } from './menu/menu-tabbing.service';
8
8
  import * as i0 from "@angular/core";
9
9
  import * as i1 from "./menu/menu-tabbing.service";
10
10
  /**
11
- * Represents a service to set the filter descriptor
12
- * ([see example]({% slug filter_row %}#toc-custom-filter-row-components)).
11
+ * Provides a service to set the filter descriptor.
12
+ * [See example]({% slug filter_row %}#toc-custom-filter-row-components).
13
13
  */
14
14
  export class FilterService {
15
15
  /**
@@ -17,13 +17,13 @@ export class FilterService {
17
17
  */
18
18
  menuTabbingService;
19
19
  /**
20
- * Fires when the filter descriptors is set.
20
+ * Fires when the filter descriptor is set.
21
21
  */
22
22
  changes = new Subject();
23
23
  /**
24
24
  * Sets the filter descriptor.
25
25
  *
26
- * @param {CompositeFilterDescriptor} value - The filter descriptor that will be set.
26
+ * @param {CompositeFilterDescriptor} value - The filter descriptor to set.
27
27
  */
28
28
  filter(value) {
29
29
  this.changes.next(value);
@@ -15,10 +15,10 @@ import { RadioButtonComponent } from '@progress/kendo-angular-inputs';
15
15
  import * as i0 from "@angular/core";
16
16
  import * as i1 from "../../common/provider.service";
17
17
  /**
18
- * Represents a Boolean-filter menu component. [See example](slug:filter_menu#toc-built-in-filter-menu-components)
18
+ * Represents a filtering menu component for boolean columns.
19
+ * [See example](slug:filter_menu#toc-built-in-filter-menu-components).
19
20
  *
20
21
  * @example
21
- *
22
22
  * ```html
23
23
  * <kendo-grid-column field="Discontinued" title="Discontinued">
24
24
  * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
@@ -44,7 +44,7 @@ export class BooleanFilterMenuComponent extends BooleanFilterComponent {
44
44
  */
45
45
  filter = { filters: [], logic: "and" };
46
46
  /**
47
- * The `FilterService` instance which is responsible for handling the changes in the filter descriptor.
47
+ * Represents the `FilterService` instance that handles changes in the filter descriptor.
48
48
  */
49
49
  filterService;
50
50
  /**
@@ -16,7 +16,7 @@ import { DropDownListComponent } from '@progress/kendo-angular-dropdowns';
16
16
  import * as i0 from "@angular/core";
17
17
  import * as i1 from "../../common/provider.service";
18
18
  /**
19
- * Represents a date filter-menu component.
19
+ * Represents a filtering menu component for date columns.
20
20
  *
21
21
  * @example
22
22
  * ```html
@@ -30,6 +30,8 @@ import * as i1 from "../../common/provider.service";
30
30
  * </ng-template>
31
31
  * </kendo-grid-column>
32
32
  * ```
33
+ * @remarks
34
+ * Supported children components are: {@link EqualFilterOperatorComponent}, {@link NotEqualFilterOperatorComponent}, {@link AfterEqFilterOperatorComponent}, {@link AfterFilterOperatorComponent}, {@link BeforeEqFilterOperatorComponent}, {@link BeforeFilterOperatorComponent}, {@link IsNullFilterOperatorComponent}, {@link IsNotNullFilterOperatorComponent}.
33
35
  */
34
36
  export class DateFilterMenuComponent extends DateFilterComponent {
35
37
  logicOperators = logicOperators(this.ctx.localization);
@@ -45,12 +47,12 @@ export class DateFilterMenuComponent extends DateFilterComponent {
45
47
  */
46
48
  filter = { filters: [], logic: "and" };
47
49
  /**
48
- * Determines if the inputs of second criteria will be displayed.
50
+ * Determines if the inputs for the second criteria are displayed.
49
51
  * @default true
50
52
  */
51
53
  extra = true;
52
54
  /**
53
- * The `FilterService` instance which is responsible for handling the changes in the filter descriptor.
55
+ * Represents the `FilterService` instance that handles changes in the filter descriptor.
54
56
  */
55
57
  filterService;
56
58
  /**
@@ -6,15 +6,17 @@ import { Directive, TemplateRef, Optional } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
8
  * Represents the filter-menu template.
9
- * Helps to customize the content of the filter menu. To define the filter menu template, nest an `<ng-template>` tag with the
10
- * `kendoGridFilterMenuTemplate` directive inside a `<kendo-grid-column>` tag
11
- * ([see example]({% slug filter_menu %}#toc-custom-filters)).
9
+ * Use this directive to customize the content of the filter menu.
10
+ * To define the filter menu template, nest an `<ng-template>` tag with the
11
+ * `kendoGridFilterMenuTemplate` directive inside a `<kendo-grid-column>` tag.
12
+ * [See example]({% slug filter_menu %}#toc-custom-filters).
12
13
  *
13
- * The template context is set to the current data item and the following additional fields are passed:
14
- * - `column`&mdash;Defines an instance of the [`ColumnComponent`]({% slug api_grid_columncomponent %}) option. Use it as an alias for a template variable by utilizing the `let-column="column"` syntax.
15
- * - `filter`&mdash;The provided filter descriptors. Use it as an alias for a template variable by utilizing the `let-filter="filter"` syntax.
16
- * - `filterService`&mdash;Represents the [`FilterService`]({% slug api_grid_filterservice %}). Use it as an alias for a template variable by utilizing the `let-filterService="filterService"` syntax.
14
+ * The template context is set to the current data item and provides these additional fields:
15
+ * - `column`&mdash;Defines an instance of the `ColumnComponent` option. Use it as an alias for a template variable by using the `let-column="column"` syntax.
16
+ * - `filter`&mdash;The provided filter descriptors. Use it as an alias for a template variable by using the `let-filter="filter"` syntax.
17
+ * - `filterService`&mdash;Represents the `FilterService`. Use it as an alias for a template variable by using the `let-filterService="filterService"` syntax.
17
18
  *
19
+ * @example
18
20
  * ```html
19
21
  * <kendo-grid-column field="CategoryID" title="Category">
20
22
  * <ng-template kendoGridFilterMenuTemplate
@@ -28,8 +28,8 @@ export class NumericFilterMenuInputComponent {
28
28
  isFirstDropDown;
29
29
  menuTabbingService;
30
30
  /**
31
- * Specifies the value which is used to increment or decrement the component value.
32
- * @type {numeric}
31
+ * Specifies the value used to increment or decrement the component value.
32
+ * @type {number}
33
33
  */
34
34
  step = 1;
35
35
  /**
@@ -43,20 +43,20 @@ export class NumericFilterMenuInputComponent {
43
43
  */
44
44
  max;
45
45
  /**
46
- * Specifies whether the **Up** and **Down** spin buttons will be rendered.
46
+ * Specifies whether the **Up** and **Down** spin buttons are rendered.
47
47
  * @type {boolean}
48
48
  */
49
49
  spinners = true;
50
50
  /**
51
- * Specifies the number precision tat is applied to the component value when it is focused.
52
- * If the user enters a number with a greater precision than is currently configured, the component value is rounded.
53
- *
51
+ * Specifies the number precision applied to the component value when focused.
52
+ * If the user enters a number with greater precision than configured, the component value is rounded.
54
53
  * @type {number}
55
54
  */
56
55
  decimals;
57
56
  /**
58
- * Specifies the number format that is used when the component is not focused.
59
- * By default, the `column.format` value is used (if set).
57
+ * Specifies the number format used when the component is not focused.
58
+ * By default, the `column.format` value is used if set.
59
+ * @type {string}
60
60
  */
61
61
  format;
62
62
  /**
@@ -17,6 +17,7 @@ import * as i0 from "@angular/core";
17
17
  import * as i1 from "../../common/provider.service";
18
18
  /**
19
19
  * Represents a numeric filter-menu component.
20
+ * Use this component to filter numeric values in the Grid.
20
21
  *
21
22
  * @example
22
23
  * ```html
@@ -30,6 +31,8 @@ import * as i1 from "../../common/provider.service";
30
31
  * </ng-template>
31
32
  * </kendo-grid-column>
32
33
  * ```
34
+ * @remarks
35
+ * Supported children components are: {@link EqualFilterOperatorComponent}, {@link NotEqualFilterOperatorComponent}, {@link GreaterFilterOperatorComponent}, {@link GreaterOrEqualToFilterOperatorComponent}, {@link LessFilterOperatorComponent}, {@link LessOrEqualToFilterOperatorComponent}, {@link IsNullFilterOperatorComponent}, {@link IsNotNullFilterOperatorComponent}.
33
36
  */
34
37
  export class NumericFilterMenuComponent extends NumericFilterComponent {
35
38
  logicOperators = logicOperators(this.ctx.localization);
@@ -40,22 +43,22 @@ export class NumericFilterMenuComponent extends NumericFilterComponent {
40
43
  return false;
41
44
  }
42
45
  /**
43
- * The current menu filter.
46
+ * Represents the current filter descriptor for the menu.
44
47
  * @type {CompositeFilterDescriptor}
45
48
  */
46
49
  filter = { filters: [], logic: "and" };
47
50
  /**
48
- * Determines if the inputs of second criteria will displayed.
51
+ * Determines if the inputs for the second criteria are displayed.
49
52
  * @default true
50
53
  */
51
54
  extra = true;
52
55
  /**
53
- * The `FilterService` instance which is responsible for handling the changes in the filter descriptor.
56
+ * Represents the `FilterService` instance that handles changes in the filter descriptor.
54
57
  */
55
58
  filterService;
56
59
  /**
57
- * Determines the delay (in milliseconds) before creating a filter descriptor based on the value. A value of 0 indicates no delay. The default value is 500.
58
- *
60
+ * Determines the delay in milliseconds before creating a filter descriptor based on the value.
61
+ * A value of `0` means no delay.
59
62
  * @default 500
60
63
  */
61
64
  filterDelay = 500;
@@ -65,7 +68,8 @@ export class NumericFilterMenuComponent extends NumericFilterComponent {
65
68
  */
66
69
  placeholder = '';
67
70
  /**
68
- * The placeholder text for the extra filter input. Applies when `extra` is set to `true`.
71
+ * Sets the placeholder text for the extra filter input.
72
+ * Applies when `extra` is set to `true`.
69
73
  * @type {string}
70
74
  */
71
75
  extraPlaceholder = '';
@@ -16,9 +16,11 @@ import { DropDownListComponent } from '@progress/kendo-angular-dropdowns';
16
16
  import * as i0 from "@angular/core";
17
17
  import * as i1 from "../../common/provider.service";
18
18
  /**
19
- * Represents a string-filter menu component
20
- * ([see example](slug:filter_menu#toc-built-in-filter-menu-components)).
19
+ * Represents a string-filter menu component.
20
+ * Use this component to filter string values in the Grid.
21
+ * [See example](slug:filter_menu#toc-built-in-filter-menu-components).
21
22
  *
23
+ * @example
22
24
  * ```html
23
25
  * <kendo-grid-column field="ProductName">
24
26
  * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
@@ -30,6 +32,8 @@ import * as i1 from "../../common/provider.service";
30
32
  * </ng-template>
31
33
  * </kendo-grid-column>
32
34
  * ```
35
+ * @remarks
36
+ * Supported children components are: {@link EqualFilterOperatorComponent}, {@link NotEqualFilterOperatorComponent}, {@link ContainsFilterOperatorComponent}, {@link DoesNotContainFilterOperatorComponent}, {@link StartsWithFilterOperatorComponent}, {@link EndsWithFilterOperatorComponent}, {@link IsNullFilterOperatorComponent}, {@link IsNotNullFilterOperatorComponent}, {@link IsEmptyFilterOperatorComponent}, {@link IsNotEmptyFilterOperatorComponent}.
33
37
  */
34
38
  export class StringFilterMenuComponent extends StringFilterComponent {
35
39
  ctx;
@@ -46,12 +50,12 @@ export class StringFilterMenuComponent extends StringFilterComponent {
46
50
  */
47
51
  filter = { filters: [], logic: "and" };
48
52
  /**
49
- * Determines if the inputs of second criteria will displayed.
53
+ * Determines if the inputs for the second criteria are displayed.
50
54
  * @default true
51
55
  */
52
56
  extra = true;
53
57
  /**
54
- * The `FilterService` instance which is responsible for handling the changes in the filter descriptor.
58
+ * Sets to `FilterService` instance that handles changes in the filter descriptor.
55
59
  */
56
60
  filterService;
57
61
  /**
@@ -60,7 +64,8 @@ export class StringFilterMenuComponent extends StringFilterComponent {
60
64
  */
61
65
  placeholder;
62
66
  /**
63
- * The placeholder text for the second filter input. Applies when `extra` is set to `true`.
67
+ * Sets the placeholder text for the second filter input.
68
+ * Applies when `extra` is set to `true`.
64
69
  * @type {string}
65
70
  */
66
71
  extraPlaceholder;
@@ -24,53 +24,53 @@ const numericOperators = localizeOperators({
24
24
  "filterIsNotNullOperator": "isnotnull"
25
25
  });
26
26
  /**
27
+ * @hidden
27
28
  * Represents a base numeric filter component.
28
29
  */
29
30
  export class NumericFilterComponent extends BaseFilterCellComponent {
30
31
  ctx;
31
32
  /**
32
- * The column with which the filter is associated.
33
+ * Specifies the column for this filter.
33
34
  * @type {ColumnComponent}
34
35
  */
35
36
  column;
36
37
  /**
37
- * The default filter operator.
38
+ * Sets the default filter operator.
38
39
  * @type {string}
39
40
  * @default 'eq'
40
41
  */
41
42
  operator = "eq";
42
43
  /**
43
- * Specifies the value that is used to increment or decrement the component value.
44
+ * Sets the value used to increment or decrement the component value.
44
45
  * @type {numeric}
45
46
  * @default 1
46
47
  */
47
48
  step = 1;
48
49
  /**
49
- * Specifies the smallest value that is valid.
50
+ * Sets the smallest valid value.
50
51
  * @type {number}
51
52
  */
52
53
  min;
53
54
  /**
54
- * Specifies the greatest value that is valid.
55
+ * Sets the greatest valid value.
55
56
  * @type {number}
56
57
  */
57
58
  max;
58
59
  /**
59
- * Specifies whether the **Up** and **Down** spin buttons will be rendered.
60
+ * When `true`, shows the **Up** and **Down** spin buttons.
60
61
  * @type {boolean}
61
62
  * @default true
62
63
  */
63
64
  spinners = true;
64
65
  /**
65
- * Specifies the number precision applied to the component value when it is focused.
66
- * If the user enters a number with a greater precision than is currently configured, the component value is rounded.
67
- *
66
+ * Sets the number precision for the value when focused.
67
+ * If the user enters a number with greater precision, the value is rounded.
68
68
  * @type {number}
69
69
  */
70
70
  decimals;
71
71
  /**
72
- * Specifies the number format used when the component is not focused.
73
- * By default, the `column.format` value is used (if set).
72
+ * Gets the number format used when the component is not focused.
73
+ * Uses `column.format` if set.
74
74
  */
75
75
  get format() {
76
76
  return !isNullOrEmptyString(this._format) ? this._format : this.columnFormat;
@@ -79,7 +79,7 @@ export class NumericFilterComponent extends BaseFilterCellComponent {
79
79
  this._format = value;
80
80
  }
81
81
  /**
82
- * The current filter for the associated column field.
82
+ * Gets the current filter for the column field.
83
83
  * @readonly
84
84
  * @type {FilterDescriptor}
85
85
  */
@@ -87,7 +87,7 @@ export class NumericFilterComponent extends BaseFilterCellComponent {
87
87
  return this.filterByField(this.column.field);
88
88
  }
89
89
  /**
90
- * The current filter operator for the associated column field.
90
+ * Gets the current filter operator for the column field.
91
91
  * @readonly
92
92
  * @type {string}
93
93
  */