@progress/kendo-angular-treelist 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 (244) hide show
  1. package/binding-directives/base-binding.directive.d.ts +6 -3
  2. package/binding-directives/flat-binding.directive.d.ts +7 -8
  3. package/binding-directives/hierarchy-binding.directive.d.ts +13 -6
  4. package/column-menu/column-chooser.component.d.ts +5 -8
  5. package/column-menu/column-locked-change-event.d.ts +4 -2
  6. package/column-menu/column-menu-autosize-all.component.d.ts +3 -5
  7. package/column-menu/column-menu-autosize.component.d.ts +5 -7
  8. package/column-menu/column-menu-chooser.component.d.ts +15 -6
  9. package/column-menu/column-menu-expandable-item.interface.d.ts +4 -3
  10. package/column-menu/column-menu-filter.component.d.ts +14 -4
  11. package/column-menu/column-menu-item-base.d.ts +1 -1
  12. package/column-menu/column-menu-item-content-template.directive.d.ts +3 -5
  13. package/column-menu/column-menu-item.component.d.ts +7 -10
  14. package/column-menu/column-menu-item.directive.d.ts +23 -1
  15. package/column-menu/column-menu-lock.component.d.ts +14 -4
  16. package/column-menu/column-menu-settings.interface.d.ts +5 -5
  17. package/column-menu/column-menu-sort.component.d.ts +12 -2
  18. package/column-menu/column-menu-template.directive.d.ts +3 -5
  19. package/column-menu/column-menu.component.d.ts +14 -2
  20. package/column-menu/column-menu.service.d.ts +1 -2
  21. package/column-menu/column-visibility-change-event.d.ts +2 -2
  22. package/column-resizing/column-resize.interface.d.ts +3 -2
  23. package/columns/checkbox-column.component.d.ts +16 -4
  24. package/columns/column-base.d.ts +15 -28
  25. package/columns/column-group.component.d.ts +1 -2
  26. package/columns/column.component.d.ts +22 -18
  27. package/columns/command-column.component.d.ts +3 -4
  28. package/columns/rowreorder-column.component.d.ts +9 -1
  29. package/columns/sort-settings.d.ts +5 -23
  30. package/columns/span-column.component.d.ts +11 -16
  31. package/common/cell-click-event-args.interface.d.ts +4 -3
  32. package/common/create-form-group.d.ts +2 -1
  33. package/common/pager-settings.d.ts +7 -8
  34. package/common/remove-confirmation.d.ts +1 -1
  35. package/common/single-popup.service.d.ts +7 -6
  36. package/data/change-event-args.interface.d.ts +6 -7
  37. package/data/data-item.interface.d.ts +5 -5
  38. package/data/data.collection.d.ts +4 -3
  39. package/data/treelist-item.interface.d.ts +2 -2
  40. package/directives.d.ts +10 -9
  41. package/dragdrop/column-reorder-config.d.ts +3 -2
  42. package/dragdrop/column-reorder-event.d.ts +4 -6
  43. package/editing/add-command-tool.directive.d.ts +9 -12
  44. package/editing/add-command.directive.d.ts +5 -9
  45. package/editing/add-event-args.interface.d.ts +3 -2
  46. package/editing/cancel-command.directive.d.ts +5 -8
  47. package/editing/cancel-event-args.interface.d.ts +1 -1
  48. package/editing/cell-close-event.d.ts +5 -5
  49. package/editing/edit-command.directive.d.ts +5 -9
  50. package/editing/edit-event-args.interface.d.ts +4 -3
  51. package/editing/edit-template.directive.d.ts +2 -4
  52. package/editing/remove-command.directive.d.ts +5 -8
  53. package/editing/remove-event-args.interface.d.ts +3 -2
  54. package/editing/save-command.directive.d.ts +5 -8
  55. package/editing/save-event-args.interface.d.ts +4 -3
  56. package/editing-directives/create-form-group-args.interface.d.ts +1 -1
  57. package/editing-directives/edit-service.interface.d.ts +13 -5
  58. package/editing-directives/editing-directive-base.d.ts +3 -3
  59. package/editing-directives/in-cell-editing.directive.d.ts +12 -2
  60. package/editing-directives/reactive-editing.directive.d.ts +12 -2
  61. package/editing-directives/template-editing.directive.d.ts +13 -3
  62. package/esm2022/binding-directives/base-binding.directive.mjs +6 -3
  63. package/esm2022/binding-directives/flat-binding.directive.mjs +7 -8
  64. package/esm2022/binding-directives/hierarchy-binding.directive.mjs +13 -6
  65. package/esm2022/column-menu/column-chooser.component.mjs +5 -8
  66. package/esm2022/column-menu/column-locked-change-event.mjs +4 -2
  67. package/esm2022/column-menu/column-menu-autosize-all.component.mjs +3 -5
  68. package/esm2022/column-menu/column-menu-autosize.component.mjs +5 -7
  69. package/esm2022/column-menu/column-menu-chooser.component.mjs +15 -6
  70. package/esm2022/column-menu/column-menu-filter.component.mjs +14 -4
  71. package/esm2022/column-menu/column-menu-item-base.mjs +1 -1
  72. package/esm2022/column-menu/column-menu-item-content-template.directive.mjs +3 -5
  73. package/esm2022/column-menu/column-menu-item.component.mjs +7 -10
  74. package/esm2022/column-menu/column-menu-item.directive.mjs +23 -1
  75. package/esm2022/column-menu/column-menu-lock.component.mjs +14 -4
  76. package/esm2022/column-menu/column-menu-sort.component.mjs +12 -2
  77. package/esm2022/column-menu/column-menu-template.directive.mjs +3 -5
  78. package/esm2022/column-menu/column-menu.component.mjs +14 -2
  79. package/esm2022/column-menu/column-menu.service.mjs +1 -2
  80. package/esm2022/column-menu/column-visibility-change-event.mjs +2 -2
  81. package/esm2022/columns/checkbox-column.component.mjs +16 -4
  82. package/esm2022/columns/column-base.mjs +15 -28
  83. package/esm2022/columns/column-group.component.mjs +1 -2
  84. package/esm2022/columns/column.component.mjs +22 -18
  85. package/esm2022/columns/command-column.component.mjs +3 -4
  86. package/esm2022/columns/rowreorder-column.component.mjs +9 -1
  87. package/esm2022/columns/span-column.component.mjs +11 -16
  88. package/esm2022/common/single-popup.service.mjs +7 -6
  89. package/esm2022/directives.mjs +10 -9
  90. package/esm2022/dragdrop/column-reorder-event.mjs +4 -6
  91. package/esm2022/editing/add-command-tool.directive.mjs +9 -12
  92. package/esm2022/editing/add-command.directive.mjs +5 -9
  93. package/esm2022/editing/cancel-command.directive.mjs +5 -8
  94. package/esm2022/editing/cell-close-event.mjs +5 -5
  95. package/esm2022/editing/edit-command.directive.mjs +5 -9
  96. package/esm2022/editing/edit-template.directive.mjs +2 -4
  97. package/esm2022/editing/remove-command.directive.mjs +5 -8
  98. package/esm2022/editing/save-command.directive.mjs +5 -8
  99. package/esm2022/editing-directives/editing-directive-base.mjs +3 -3
  100. package/esm2022/editing-directives/in-cell-editing.directive.mjs +12 -2
  101. package/esm2022/editing-directives/reactive-editing.directive.mjs +12 -2
  102. package/esm2022/editing-directives/template-editing.directive.mjs +13 -3
  103. package/esm2022/excel/excel-command-tool.directive.mjs +9 -11
  104. package/esm2022/excel/excel-command.directive.mjs +3 -7
  105. package/esm2022/excel/excel.component.mjs +22 -16
  106. package/esm2022/excel/excel.module.mjs +2 -2
  107. package/esm2022/expand-state/expand-event.mjs +3 -3
  108. package/esm2022/expand-state/expandable.directive.mjs +8 -5
  109. package/esm2022/filtering/base-filter-cell.component.mjs +3 -1
  110. package/esm2022/filtering/cell/boolean-filter-cell.component.mjs +1 -0
  111. package/esm2022/filtering/cell/date-filter-cell.component.mjs +5 -3
  112. package/esm2022/filtering/cell/filter-cell-operators.component.mjs +2 -1
  113. package/esm2022/filtering/cell/filter-cell-template.directive.mjs +18 -3
  114. package/esm2022/filtering/cell/numeric-filter-cell.component.mjs +7 -5
  115. package/esm2022/filtering/cell/string-filter-cell.component.mjs +7 -7
  116. package/esm2022/filtering/date-filter.component.mjs +8 -3
  117. package/esm2022/filtering/filter.service.mjs +2 -4
  118. package/esm2022/filtering/menu/boolean-filter-menu.component.mjs +3 -3
  119. package/esm2022/filtering/menu/date-filter-menu.component.mjs +6 -3
  120. package/esm2022/filtering/menu/filter-menu-template.directive.mjs +18 -2
  121. package/esm2022/filtering/menu/numeric-filter-menu.component.mjs +9 -5
  122. package/esm2022/filtering/menu/string-filter-menu.component.mjs +6 -4
  123. package/esm2022/filtering/numeric-filter.component.mjs +3 -3
  124. package/esm2022/filtering/operators/after-eq-filter-operator.component.mjs +27 -1
  125. package/esm2022/filtering/operators/after-filter-operator.component.mjs +27 -1
  126. package/esm2022/filtering/operators/before-eq-filter-operator.component.mjs +27 -1
  127. package/esm2022/filtering/operators/before-filter-operator.component.mjs +27 -1
  128. package/esm2022/filtering/operators/contains-filter-operator.component.mjs +28 -1
  129. package/esm2022/filtering/operators/ends-with-filter-operator.component.mjs +28 -1
  130. package/esm2022/filtering/operators/eq-filter-operator.component.mjs +76 -1
  131. package/esm2022/filtering/operators/filter-operator.base.mjs +1 -1
  132. package/esm2022/filtering/operators/gt-filter-operator.component.mjs +28 -2
  133. package/esm2022/filtering/operators/gte-filter-operator.component.mjs +27 -1
  134. package/esm2022/filtering/operators/is-empty-filter-operator.component.mjs +28 -1
  135. package/esm2022/filtering/operators/is-not-empty-filter-operator.component.mjs +28 -1
  136. package/esm2022/filtering/operators/is-not-null-filter-operator.component.mjs +76 -1
  137. package/esm2022/filtering/operators/isnull-filter-operator.component.mjs +76 -1
  138. package/esm2022/filtering/operators/lt-filter-operator.component.mjs +27 -1
  139. package/esm2022/filtering/operators/lte-filter-operator.component.mjs +28 -2
  140. package/esm2022/filtering/operators/neq-filter-operator.component.mjs +76 -1
  141. package/esm2022/filtering/operators/not-contains-filter-operator.component.mjs +28 -1
  142. package/esm2022/filtering/operators/starts-with-filter-operator.component.mjs +28 -1
  143. package/esm2022/filtering/string-filter.component.mjs +1 -1
  144. package/esm2022/localization/custom-messages.component.mjs +11 -2
  145. package/esm2022/navigation/focusable.directive.mjs +4 -4
  146. package/esm2022/package-metadata.mjs +2 -2
  147. package/esm2022/pdf/pdf-command-tool.directive.mjs +11 -9
  148. package/esm2022/pdf/pdf-command.directive.mjs +2 -2
  149. package/esm2022/pdf/pdf-export-event.mjs +3 -1
  150. package/esm2022/pdf/pdf-margin.component.mjs +10 -5
  151. package/esm2022/pdf/pdf-template.directive.mjs +2 -2
  152. package/esm2022/pdf/pdf.component.mjs +12 -2
  153. package/esm2022/pdf/pdf.module.mjs +6 -6
  154. package/esm2022/rendering/cell-template.directive.mjs +8 -9
  155. package/esm2022/rendering/common/spacer.component.mjs +16 -5
  156. package/esm2022/rendering/footer-template.directive.mjs +10 -12
  157. package/esm2022/rendering/header/header-template.directive.mjs +4 -4
  158. package/esm2022/rendering/no-records-template.directive.mjs +2 -2
  159. package/esm2022/rendering/toolbar/toolbar-focusable.directive.mjs +13 -2
  160. package/esm2022/rendering/toolbar/toolbar-template.directive.mjs +4 -6
  161. package/esm2022/selection/selectable.directive.mjs +12 -0
  162. package/esm2022/selection/selection-change-event.mjs +1 -1
  163. package/esm2022/treelist.component.mjs +145 -109
  164. package/esm2022/treelist.module.mjs +6 -8
  165. package/esm2022/utils.mjs +1 -1
  166. package/excel/excel-command-tool.directive.d.ts +9 -11
  167. package/excel/excel-command.directive.d.ts +3 -7
  168. package/excel/excel-export-data.interface.d.ts +4 -4
  169. package/excel/excel.component.d.ts +22 -16
  170. package/excel/excel.module.d.ts +2 -2
  171. package/expand-state/expand-event.d.ts +3 -3
  172. package/expand-state/expandable-tree-component.d.ts +4 -6
  173. package/expand-state/expandable.directive.d.ts +8 -5
  174. package/fesm2022/progress-kendo-angular-treelist.mjs +1470 -574
  175. package/filtering/base-filter-cell.component.d.ts +3 -1
  176. package/filtering/cell/boolean-filter-cell.component.d.ts +1 -0
  177. package/filtering/cell/date-filter-cell.component.d.ts +5 -3
  178. package/filtering/cell/filter-cell-operators.component.d.ts +2 -1
  179. package/filtering/cell/filter-cell-template.directive.d.ts +18 -3
  180. package/filtering/cell/numeric-filter-cell.component.d.ts +7 -5
  181. package/filtering/cell/string-filter-cell.component.d.ts +7 -7
  182. package/filtering/date-filter.component.d.ts +8 -3
  183. package/filtering/filter.service.d.ts +2 -4
  184. package/filtering/filterable.d.ts +3 -2
  185. package/filtering/menu/boolean-filter-menu.component.d.ts +3 -3
  186. package/filtering/menu/date-filter-menu.component.d.ts +6 -3
  187. package/filtering/menu/filter-menu-template.directive.d.ts +18 -2
  188. package/filtering/menu/numeric-filter-menu.component.d.ts +9 -5
  189. package/filtering/menu/string-filter-menu.component.d.ts +6 -4
  190. package/filtering/numeric-filter.component.d.ts +3 -3
  191. package/filtering/operators/after-eq-filter-operator.component.d.ts +27 -1
  192. package/filtering/operators/after-filter-operator.component.d.ts +27 -1
  193. package/filtering/operators/before-eq-filter-operator.component.d.ts +27 -1
  194. package/filtering/operators/before-filter-operator.component.d.ts +27 -1
  195. package/filtering/operators/contains-filter-operator.component.d.ts +28 -1
  196. package/filtering/operators/ends-with-filter-operator.component.d.ts +28 -1
  197. package/filtering/operators/eq-filter-operator.component.d.ts +76 -1
  198. package/filtering/operators/filter-operator.base.d.ts +1 -1
  199. package/filtering/operators/gt-filter-operator.component.d.ts +30 -0
  200. package/filtering/operators/gte-filter-operator.component.d.ts +27 -1
  201. package/filtering/operators/is-empty-filter-operator.component.d.ts +28 -1
  202. package/filtering/operators/is-not-empty-filter-operator.component.d.ts +28 -1
  203. package/filtering/operators/is-not-null-filter-operator.component.d.ts +76 -1
  204. package/filtering/operators/isnull-filter-operator.component.d.ts +76 -1
  205. package/filtering/operators/lt-filter-operator.component.d.ts +27 -1
  206. package/filtering/operators/lte-filter-operator.component.d.ts +30 -0
  207. package/filtering/operators/neq-filter-operator.component.d.ts +76 -1
  208. package/filtering/operators/not-contains-filter-operator.component.d.ts +28 -1
  209. package/filtering/operators/starts-with-filter-operator.component.d.ts +28 -1
  210. package/filtering/string-filter.component.d.ts +1 -1
  211. package/localization/custom-messages.component.d.ts +11 -2
  212. package/navigation/focusable-element.interface.d.ts +7 -11
  213. package/navigation/focusable.directive.d.ts +4 -4
  214. package/navigation/navigation-cell.interface.d.ts +5 -5
  215. package/navigation/navigation-row.interface.d.ts +4 -5
  216. package/package.json +18 -18
  217. package/pdf/pdf-command-tool.directive.d.ts +11 -9
  218. package/pdf/pdf-command.directive.d.ts +2 -2
  219. package/pdf/pdf-export-event.d.ts +3 -1
  220. package/pdf/pdf-margin.component.d.ts +10 -5
  221. package/pdf/pdf-margin.interface.d.ts +1 -1
  222. package/pdf/pdf-template.directive.d.ts +2 -2
  223. package/pdf/pdf.component.d.ts +12 -2
  224. package/pdf/pdf.module.d.ts +6 -6
  225. package/rendering/cell-template.directive.d.ts +8 -9
  226. package/rendering/common/row-class.d.ts +4 -7
  227. package/rendering/common/spacer.component.d.ts +16 -5
  228. package/rendering/footer-template.directive.d.ts +10 -12
  229. package/rendering/header/header-template.directive.d.ts +4 -4
  230. package/rendering/no-records-template.directive.d.ts +2 -2
  231. package/rendering/toolbar/toolbar-focusable.directive.d.ts +13 -2
  232. package/rendering/toolbar/toolbar-template.directive.d.ts +4 -6
  233. package/row-reordering/types.d.ts +4 -1
  234. package/schematics/ngAdd/index.js +3 -3
  235. package/scrolling/content-scroll-event.d.ts +2 -0
  236. package/scrolling/scroll-bottom-event.d.ts +2 -0
  237. package/scrolling/scroll-request.service.d.ts +3 -3
  238. package/scrolling/scrollmode.d.ts +3 -3
  239. package/selection/is-selected.d.ts +5 -4
  240. package/selection/selectable-settings.d.ts +6 -6
  241. package/selection/selectable.directive.d.ts +12 -0
  242. package/selection/selection-change-event.d.ts +2 -2
  243. package/treelist.component.d.ts +143 -107
  244. package/treelist.module.d.ts +6 -8
@@ -12,14 +12,11 @@ import * as i0 from "@angular/core";
12
12
  import * as i1 from "./edit.service";
13
13
  import * as i2 from "@progress/kendo-angular-l10n";
14
14
  /**
15
- * Represents the `remove` command of the TreeList. You can apply this directive to any `button` element
16
- * inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
17
- * When an associated button with the directive is clicked, the
18
- * [`remove` event]({% slug api_treelist_treelistcomponent %}#toc-remove)
19
- * is triggered ([see example]({% slug editing_reactive_forms_treelist %})).
15
+ * Represents the `remove` command of the TreeList. Apply this directive to any `button` element inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
20
16
  *
21
- * When the row is in the `edit` mode, the button with the `kendoTreeListRemoveCommand` is automatically hidden.
22
- * The directive takes as input the `cellContext` from the cell template.
17
+ * When the user clicks a button with this directive, the [`remove` event]({% slug api_treelist_treelistcomponent %}#toc-remove) is triggered ([see example]({% slug editing_reactive_forms_treelist %})).
18
+ *
19
+ * The button with `kendoTreeListRemoveCommand` is automatically hidden when the row is in edit mode. The directive takes the `cellContext` from the cell template as input.
23
20
  *
24
21
  * @example
25
22
  * ```html
@@ -34,7 +31,7 @@ import * as i2 from "@progress/kendo-angular-l10n";
34
31
  */
35
32
  export class RemoveCommandDirective extends BaseCommandDirective {
36
33
  /**
37
- * The `cellContext` provided to the template.
34
+ * Provides the `cellContext` to the template.
38
35
  */
39
36
  cellContext;
40
37
  commandClass = true;
@@ -12,14 +12,11 @@ import * as i0 from "@angular/core";
12
12
  import * as i1 from "./edit.service";
13
13
  import * as i2 from "@progress/kendo-angular-l10n";
14
14
  /**
15
- * Represents the `save` command of the TreeList. You can apply this directive to any `button`
16
- * element inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
17
- * When an associated button with the directive is clicked, the
18
- * [`save`]({% slug api_treelist_treelistcomponent %}#toc-save) event
19
- * is triggered ([see example]({% slug editing_treelist %})).
15
+ * Represents the `save` command of the TreeList. Apply this directive to any `button` element inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
20
16
  *
21
- * When the row is not in the `edit` mode, the button with `kendoTreeListSaveCommand` is automatically hidden.
22
- * The directive takes as input the `cellContext` from the cell template.
17
+ * When the user clicks a button with this directive, the [`save`]({% slug api_treelist_treelistcomponent %}#toc-save) event is triggered ([see example]({% slug editing_treelist %})).
18
+ *
19
+ * The button with `kendoTreeListSaveCommand` is automatically hidden when the row is not in edit mode. The directive takes the `cellContext` from the cell template as input.
23
20
  *
24
21
  * @example
25
22
  * ```html
@@ -34,7 +31,7 @@ import * as i2 from "@progress/kendo-angular-l10n";
34
31
  */
35
32
  export class SaveCommandDirective extends BaseCommandDirective {
36
33
  /**
37
- * The `cellContext` provided to the template.
34
+ * Provides the `cellContext` to the template.
38
35
  */
39
36
  cellContext;
40
37
  commandClass = true;
@@ -14,7 +14,7 @@ import * as i1 from "../treelist.component";
14
14
  export class EditingDirectiveBase {
15
15
  treelist;
16
16
  /**
17
- * The edit service that will handle the operations.
17
+ * The edit service that handles the operations.
18
18
  */
19
19
  set editService(value) {
20
20
  this.userEditService = value;
@@ -23,7 +23,7 @@ export class EditingDirectiveBase {
23
23
  return this.userEditService || this.defaultEditService;
24
24
  }
25
25
  /**
26
- * Gets or sets a function that will be called to determine the unique identifier
26
+ * Gets or sets a function that determines the unique identifier
27
27
  * for new items. The function receives the `item` and its `parent` as parameters
28
28
  * and must return an ID.
29
29
  */
@@ -34,7 +34,7 @@ export class EditingDirectiveBase {
34
34
  return this.idCallback;
35
35
  }
36
36
  /**
37
- * A function that is called to confirm if the `dataItem` will be removed.
37
+ * A function that confirms if the `dataItem` will be removed.
38
38
  */
39
39
  removeConfirmation;
40
40
  subscriptions = new Subscription();
@@ -9,8 +9,18 @@ import { markAllAsTouched } from './utils';
9
9
  import * as i0 from "@angular/core";
10
10
  import * as i1 from "../treelist.component";
11
11
  /**
12
- * A directive which encapsulates the editing operations of the TreeList when using the in-cell
13
- * editing with Reactive Forms ([see example](slug:editing_directives_treelist#toc-in-cell-editing-directive)).
12
+ * A directive that encapsulates the editing operations of the TreeList when using the in-cell
13
+ * editing with Reactive Forms. [See example](slug:editing_directives_treelist#toc-in-cell-editing-directive).
14
+ *
15
+ * @example
16
+ * ```html
17
+ * <kendo-treelist [kendoTreeListInCellEditing]="createFormGroup">
18
+ * <kendo-treelist-column field="name" title="Name"></kendo-treelist-column>
19
+ * <kendo-treelist-column field="age" title="Age"></kendo-treelist-column>
20
+ * </kendo-treelist>
21
+ * ```
22
+ * @remarks
23
+ * Applied to: {@link TreeListComponent}.
14
24
  */
15
25
  export class InCellEditingDirective extends EditingDirectiveBase {
16
26
  treelist;
@@ -9,8 +9,18 @@ import { markAllAsTouched } from './utils';
9
9
  import * as i0 from "@angular/core";
10
10
  import * as i1 from "../treelist.component";
11
11
  /**
12
- * A directive which encapsulates the editing operations of the TreeList when using the
13
- * Reactive Forms ([see example](slug:editing_directives_treelist#toc-reactive-editing-directive)).
12
+ * A directive that encapsulates the editing operations of the TreeList when using the
13
+ * Reactive Forms. [See example](slug:editing_directives_treelist#toc-reactive-editing-directive).
14
+ *
15
+ * @example
16
+ * ```html
17
+ * <kendo-treelist [kendoTreeListReactiveEditing]="createFormGroup">
18
+ * <kendo-treelist-column field="name" title="Name"></kendo-treelist-column>
19
+ * <kendo-treelist-column field="age" title="Age"></kendo-treelist-column>
20
+ * </kendo-treelist>
21
+ * ```
22
+ * @remarks
23
+ * Applied to: {@link TreeListComponent}.
14
24
  */
15
25
  export class ReactiveEditingDirective extends RowEditingDirectiveBase {
16
26
  treelist;
@@ -8,13 +8,23 @@ import { TreeListComponent } from '../treelist.component';
8
8
  import * as i0 from "@angular/core";
9
9
  import * as i1 from "../treelist.component";
10
10
  /**
11
- * A directive which encapsulates the editing operations of the TreeList when using
12
- * the Template-Driven Angular Forms ([see example](slug:editing_directives_treelist#toc-template-editing-directive)).
11
+ * A directive that encapsulates the editing operations of the TreeList when using
12
+ * Template-Driven Angular Forms. [See example](slug:editing_directives_treelist#toc-template-editing-directive).
13
+ *
14
+ * @example
15
+ * ```html
16
+ * <kendo-treelist [kendoTreeListTemplateEditing]="createNewItem">
17
+ * <kendo-treelist-column field="name" title="Name"></kendo-treelist-column>
18
+ * <kendo-treelist-column field="age" title="Age"></kendo-treelist-column>
19
+ * </kendo-treelist>
20
+ * ```
21
+ * @remarks
22
+ * Applied to: {@link TreeListComponent}.
13
23
  */
14
24
  export class TemplateEditingDirective extends RowEditingDirectiveBase {
15
25
  treelist;
16
26
  /**
17
- * The function that creates the `dataItem` for the new rows.
27
+ * The function that creates the `dataItem` for new rows.
18
28
  */
19
29
  createNewItem;
20
30
  originalValues;
@@ -11,24 +11,22 @@ import * as i0 from "@angular/core";
11
11
  import * as i1 from "./excel.service";
12
12
  import * as i2 from "@progress/kendo-angular-toolbar";
13
13
  /**
14
- * Represents the `export-to-Excel` toolbar tool of the TreeList.
15
- * You can apply this directive to any `kendo-toolbar-button` element inside a
16
- * ToolbarComponent used in the TreeList.
14
+ * Represents the `export-to-Excel` toolbar tool of the TreeList. Apply this directive to any `kendo-toolbar-button` element inside a ToolbarComponent used in the TreeList.
17
15
  *
18
- * When the user clicks a button associated with the directive, the
19
- * [excelExport]({% slug api_treelist_treelistcomponent %}#toc-excelexport) event
20
- * fires ([see example]({% slug excelexport_treelist %})).
16
+ * When the user clicks a button with this directive, the [excelExport]({% slug api_treelist_treelistcomponent %}#toc-excelexport) event fires ([see example]({% slug excelexport_treelist %})).
21
17
  *
22
18
  * @example
23
- * ```html-no-run
19
+ * ```html
24
20
  * <kendo-treelist>
25
- * <kendo-toolbar>
21
+ * <kendo-toolbar>
26
22
  * <kendo-toolbar-button text="Excel Export" kendoTreeListExcelTool></kendo-toolbar-button>
27
- * </kendo-toolbar>
28
- * <kendo-treelist-excel fileName="TreeList.xlsx">
29
- * </kendo-treelist-excel>
23
+ * </kendo-toolbar>
24
+ * <kendo-treelist-excel fileName="TreeList.xlsx">
25
+ * </kendo-treelist-excel>
30
26
  * </kendo-treelist>
31
27
  * ```
28
+ * @remarks
29
+ * Applied to: {@link ToolBarButtonComponent}
32
30
  */
33
31
  export class ExcelCommandToolbarDirective {
34
32
  excelService;
@@ -12,18 +12,14 @@ import * as i0 from "@angular/core";
12
12
  import * as i1 from "./excel.service";
13
13
  import * as i2 from "@progress/kendo-angular-l10n";
14
14
  /**
15
- * Represents the `export-to-Excel` command of the TreeList. You can apply this
16
- * directive to any `button` element inside a
17
- * [`ToolbarTemplate`](slug:toolbartemplate_treelist).
18
- * When the user clicks a button associated with the directive, the
19
- * [`excelExport`]({% slug api_treelist_treelistcomponent %}#toc-excelexport) event
20
- * fires ([see example]({% slug excelexport_treelist %})).
15
+ * Represents the `export-to-Excel` command of the TreeList. Apply this directive to any `button` element inside a [`ToolbarTemplate`](slug:toolbartemplate_treelist).
16
+ * When the user clicks a button with this directive, the [`excelExport`]({% slug api_treelist_treelistcomponent %}#toc-excelexport) event fires ([see example]({% slug excelexport_treelist %})).
21
17
  *
22
18
  * @example
23
19
  * ```html
24
20
  * <kendo-treelist ...>
25
21
  * <ng-template kendoTreeListToolbarTemplate>
26
- * <button kendoTreeListExcelCommand>Export to PDF</button>
22
+ * <button kendoTreeListExcelCommand>Export to Excel</button>
27
23
  * </ng-template>
28
24
  * <kendo-treelist-excel fileName="TreeList.xlsx"> </kendo-treelist-excel>
29
25
  * </kendo-treelist>
@@ -76,7 +76,14 @@ const componentColumns = (component) => {
76
76
  return orderBy(columns, [{ field: 'locked', dir: 'desc' }]);
77
77
  };
78
78
  /**
79
- * Configures the settings for the export of TreeList in Excel ([see example]({% slug excelexport_treelist %})).
79
+ * Configures the settings for exporting the TreeList to Excel. [See example]({% slug excelexport_treelist %}).
80
+ *
81
+ * @example
82
+ * ```html
83
+ * <kendo-treelist [data]="data" [height]="500">
84
+ * <kendo-treelist-excel fileName="Employees.xlsx"></kendo-treelist-excel>
85
+ * </kendo-treelist>
86
+ * ```
80
87
  */
81
88
  export class ExcelComponent {
82
89
  excelService;
@@ -88,57 +95,56 @@ export class ExcelComponent {
88
95
  */
89
96
  fileName = 'Export.xlsx';
90
97
  /**
91
- * Enables or disables column filtering in the Excel file. This behavior is different from the filtering feature of the TreeList.
98
+ * Enables or disables column filtering in the Excel file. This is different from the TreeList filtering feature.
92
99
  */
93
100
  filterable;
94
101
  /**
95
- * The author of the workbook.
102
+ * Sets the author of the workbook.
96
103
  */
97
104
  creator;
98
105
  /**
99
- * The date on which the workbook was created. Defaults to `new Date()`.
106
+ * Sets the date the workbook was created. Defaults to `new Date()`.
100
107
  */
101
108
  date;
102
109
  /**
103
- * If set to `true`, the content is forwarded to `proxyURL` even if the browser supports the saving of files locally.
110
+ * If set to `true`, forwards the content to `proxyURL` even if the browser supports saving files locally.
104
111
  */
105
112
  forceProxy;
106
113
  /**
107
- * The URL of the server-side proxy which streams the file to the end user.
108
- * Using a proxy is required if the browser is not capable of saving files locally.
114
+ * The URL of the server-side proxy that streams the file to the user.
115
+ * Use a proxy if the browser cannot save files locally.
109
116
  *
110
117
  * Optionally, set up a proxy to reduce memory usage. This avoids copying the file contents into memory,
111
118
  * but transmits it over the network instead. For this use case, set [forceProxy](#toc-forceproxy) to `true`
112
119
  * to skip client-side saving even in browsers that support it.
113
120
  *
114
- * In the request body, the proxy receives a POST request with the specific parameters. [See example](slug:server_proxy#toc-implementations).
121
+ * The proxy receives a POST request with specific parameters in the request body. [See example](slug:server_proxy#toc-implementations).
115
122
  * The proxy returns the decoded file with the `"Content-Disposition"` header set to `attachment; filename="<fileName.xslx>"`.
116
123
  *
117
- * For details on the server-side proxy usage and implementation, see the [File Saver]({% slug overview_filesaver %}) documentation.
118
- *
124
+ * For details on server-side proxy usage and implementation, see the [File Saver]({% slug overview_filesaver %}) documentation.
119
125
  */
120
126
  proxyURL;
121
127
  /**
122
- * The function that is used to get the exported data options. By default, uses the current data of the TreeList.
123
- * To export data that is different from the current TreeList data, provide a custom function.
128
+ * The function used to get the exported data options. By default, uses the current TreeList data.
129
+ * To export data different from the current TreeList data, provide a custom function.
124
130
  */
125
131
  fetchData;
126
132
  /**
127
- * Specifies if the item levels in the Excel file are collapsible. Applicable only if the treelist has footers.
133
+ * Specifies if item levels in the Excel file are collapsible. Applies only if the TreeList has footers.
128
134
  */
129
135
  collapsible;
130
136
  /**
131
- * Specifies if export should include all pages
137
+ * Specifies if export should include all pages.
132
138
  * @default true
133
139
  */
134
140
  allPages = true;
135
141
  /**
136
- * Specifies if the export should expand all items or should use the current TreeList state.
142
+ * Specifies if the export should expand all items or use the current TreeList state.
137
143
  * @default true
138
144
  */
139
145
  expandAll = true;
140
146
  /**
141
- * The options of the cells that are inserted before the data to indicate the hierarchy.
147
+ * The options for the cells inserted before the data to indicate the hierarchy.
142
148
  */
143
149
  paddingCellOptions;
144
150
  /**
@@ -12,7 +12,7 @@ import * as i3 from "./excel-command-tool.directive";
12
12
  import * as i4 from "@progress/kendo-angular-excel-export";
13
13
  // IMPORTANT: NgModule export kept for backwards compatibility
14
14
  /**
15
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
15
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi'])
16
16
  * definition for the Excel component of the TreeList.
17
17
  *
18
18
  * @example
@@ -22,7 +22,7 @@ import * as i4 from "@progress/kendo-angular-excel-export";
22
22
  * import { TreeListModule, ExcelModule } from '@progress/kendo-angular-treelist';
23
23
  * import { AppComponent } from './app.component';
24
24
  *
25
- * _@NgModule({
25
+ * @NgModule({
26
26
  * declarations: [AppComponent],
27
27
  * imports: [BrowserModule, TreeListModule, ExcelModule],
28
28
  * bootstrap: [AppComponent]
@@ -4,15 +4,15 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { PreventableEvent } from '../common/preventable-event';
6
6
  /**
7
- * Arguments for the TreeList expand and collapse events ([see examples]({% slug treelist_expanded_state %})).
7
+ * Arguments for the TreeList expand and collapse events. [See example]({% slug treelist_expanded_state %}).
8
8
  */
9
9
  export class ExpandEvent extends PreventableEvent {
10
10
  /**
11
- * The expanded/collapsed data item.
11
+ * The expanded or collapsed data item.
12
12
  */
13
13
  dataItem;
14
14
  /**
15
- * The TreeList component that triggered the event.
15
+ * The TreeList component that triggers the event.
16
16
  */
17
17
  sender;
18
18
  /**
@@ -9,7 +9,7 @@ import { isString } from '../utils';
9
9
  import * as i0 from "@angular/core";
10
10
  import * as i1 from "./expandable-tree-component";
11
11
  /**
12
- * A directive which controls the expanded state of the items. [See example](slug:treelist_expanded_state#toc-built-in-directive).
12
+ * A directive which controls the expanded state of items in the TreeList. [See example](slug:treelist_expanded_state#toc-built-in-directive).
13
13
  *
14
14
  * @example
15
15
  * ```html
@@ -18,15 +18,18 @@ import * as i1 from "./expandable-tree-component";
18
18
  * kendoTreeListExpandable> ...
19
19
  * </kendo-treelist>
20
20
  * ```
21
+ * @remarks
22
+ * Applied to: {@link TreeListComponent},
21
23
  */
22
24
  export class ExpandableDirective {
23
25
  component;
24
26
  /**
25
- * Fires when the expandedKeys are changed.
27
+ * Emits when the `expandedKeys` change.
26
28
  */
27
29
  expandedKeysChange = new EventEmitter();
28
30
  /**
29
31
  * Sets the expanded item keys.
32
+ * Use this property to control which items are expanded.
30
33
  */
31
34
  set expandedKeys(value) {
32
35
  if (value !== this._expandedKeys) {
@@ -38,13 +41,13 @@ export class ExpandableDirective {
38
41
  return Array.from(this.state.keys());
39
42
  }
40
43
  /**
41
- * Specifies if the items should be initially expanded.
44
+ * Specifies if items are initially expanded.
42
45
  * @default false
43
46
  */
44
47
  initiallyExpanded = false;
45
48
  /**
46
- * Defines the item key that will be stored in the expandedKeys collection.
47
- * Defaults to the component idField.
49
+ * Defines the item key stored in the `expandedKeys` collection.
50
+ * Uses the component `idField` by default.
48
51
  */
49
52
  set expandBy(key) {
50
53
  if (isString(key)) {
@@ -85,7 +85,9 @@ export const localizeOperators = operators => localization => Object.keys(operat
85
85
  value: operators[key]
86
86
  }));
87
87
  /**
88
- * An abstract base class for the filter-cell component ([see example](slug:filter_row_treelist#toc-custom-filter-row-components).
88
+ * An abstract base class for the filter-cell component in the TreeList.
89
+ * Use this class to implement custom filter cell components.
90
+ * [See example](slug:filter_row_treelist#toc-custom-filter-row-components).
89
91
  */
90
92
  export class BaseFilterCellComponent {
91
93
  filterService;
@@ -16,6 +16,7 @@ import * as i1 from "../filter.service";
16
16
  import * as i2 from "@progress/kendo-angular-l10n";
17
17
  /**
18
18
  * Represents a Boolean filter-cell component.
19
+ * Use this component to filter Boolean values in the TreeList.
19
20
  * See the article about the [built-in filter components](slug:filter_row_treelist#toc-built-in-filter-row-components).
20
21
  *
21
22
  * @example
@@ -16,9 +16,10 @@ import * as i1 from "../filter.service";
16
16
  import * as i2 from "@progress/kendo-angular-l10n";
17
17
  /**
18
18
  * Represents a date-filter cell component.
19
+ * Use this component to filter date values in the TreeList.
19
20
  * See the article about the [built-in filter components](slug:filter_row_treelist#toc-built-in-filter-row-components).
20
- * @example
21
21
  *
22
+ * @example
22
23
  * ```html
23
24
  * <kendo-treelist-column field="OrderDate">
24
25
  * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
@@ -29,12 +30,13 @@ import * as i2 from "@progress/kendo-angular-l10n";
29
30
  * </ng-template>
30
31
  * </kendo-treelist-column>
31
32
  * ```
33
+ * @remarks
34
+ * Supported children components are: {@link EqualFilterOperatorComponent}, {@link NotEqualFilterOperatorComponent}, {@link AfterEqFilterOperatorComponent}, {@link AfterFilterOperatorComponent}, {@link BeforeEqFilterOperatorComponent}, {@link BeforeFilterOperatorComponent}, {@link IsNullFilterOperatorComponent}, {@link IsNotNullFilterOperatorComponent}.
32
35
  */
33
36
  export class DateFilterCellComponent extends DateFilterComponent {
34
37
  localization;
35
38
  /**
36
- * Determines if the drop-down filter operators will be displayed. The default value is `true`.
37
- * @type {boolean}
39
+ * Shows or hides the drop-down filter operators.
38
40
  * @default true
39
41
  */
40
42
  showOperators = true;
@@ -15,7 +15,8 @@ import { FocusableDirective } from '../../navigation/focusable.directive';
15
15
  import * as i0 from "@angular/core";
16
16
  import * as i1 from "@progress/kendo-angular-l10n";
17
17
  /**
18
- * Represents a component which accommodates the filter operators.
18
+ * Represents a component that displays filter operators for the TreeList filter row.
19
+ * Use this component to let users select filter operators for a column.
19
20
  *
20
21
  * @example
21
22
  * ```html
@@ -5,12 +5,27 @@
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 ([see example](slug:filter_row_treelist#toc-custom-filter-row-components).
8
+ * Represents the filter-cell template for the TreeList.
9
+ * Use this directive to customize the filter row cell for a column.
10
+ * See [custom filter row components](slug:filter_row_treelist#toc-custom-filters).
9
11
  *
10
- * The template context is set to the filter descriptor and the following additional fields are passed:
11
- * - `column`&mdash;The current column instance. Use it as an alias for a template variable by utilizing the `let-column="column"` syntax.
12
+ * The template context is set to the filter descriptor and provides the following fields:
13
+ * - `column`&mdash;The current column instance. Use as an alias for a template variable with `let-column="column"`.
12
14
  * - `filter`&mdash;The filter descriptor.
13
15
  * - `cellContext`&mdash;An object used to pass context information to built-in directives.
16
+ *
17
+ * @example
18
+ * ```html
19
+ * <kendo-treelist-column field="name" title="Name">
20
+ * <ng-template kendoTreeListFilterCellTemplate let-column="column" let-filter="filter" let-cellContext="cellContext">
21
+ * <kendo-maskedtextbox mask="(999) 000-0000"
22
+ * [promptPlaceholder]="prompt" [includeLiterals]="true"
23
+ * (valueChange)="phoneChange($event)"
24
+ * >
25
+ * </kendo-maskedtextbox>
26
+ * </ng-template>
27
+ * </kendo-treelist-column>
28
+ * ```
14
29
  */
15
30
  export class FilterCellTemplateDirective {
16
31
  templateRef;
@@ -16,7 +16,9 @@ import * as i1 from "../filter.service";
16
16
  import * as i2 from "@progress/kendo-angular-l10n";
17
17
  /**
18
18
  * Represents a numeric filter cell.
19
+ * Use this component to filter numeric values in the TreeList.
19
20
  * See the article about the [built-in filter components](slug:filter_row_treelist#toc-built-in-filter-row-components).
21
+ *
20
22
  * @example
21
23
  * ```html
22
24
  * <kendo-treelist-column field="ProductName" title="Product Name">
@@ -28,19 +30,19 @@ import * as i2 from "@progress/kendo-angular-l10n";
28
30
  * </ng-template>
29
31
  * </kendo-treelist-column>
30
32
  * ```
33
+ * @remarks
34
+ * Supported children components are: {@link EqualFilterOperatorComponent}, {@link NotEqualFilterOperatorComponent}, {@link GreaterFilterOperatorComponent}, {@link GreaterOrEqualToFilterOperatorComponent}, {@link LessFilterOperatorComponent}, {@link LessOrEqualToFilterOperatorComponent}, {@link IsNullFilterOperatorComponent}, {@link IsNotNullFilterOperatorComponent}.
31
35
  */
32
36
  export class NumericFilterCellComponent extends NumericFilterComponent {
33
37
  localization;
34
38
  /**
35
- * Determines the delay time (in milliseconds) before the filter value is submitted.
36
- * A value of `0` indicates no delay.
37
- * @type {boolean}
39
+ * Sets the delay time (in milliseconds) before the filter value is submitted.
40
+ * A value of `0` means no delay.
38
41
  * @default 500
39
42
  */
40
43
  filterDelay = 500;
41
44
  /**
42
- * Determines if the drop-down filter operators will be displayed.
43
- * @type {boolean}
45
+ * Shows or hides the drop-down filter operators.
44
46
  * @default true
45
47
  */
46
48
  showOperators = true;
@@ -18,9 +18,10 @@ import * as i2 from "@progress/kendo-angular-l10n";
18
18
  import * as i3 from "@angular/forms";
19
19
  /**
20
20
  * Represents a string-filter cell component.
21
+ * Use this component to filter string values in the TreeList.
21
22
  * See the article about the [built-in filter components](slug:filter_row_treelist#toc-built-in-filter-row-components).
22
- * @example
23
23
  *
24
+ * @example
24
25
  * ```html
25
26
  * <kendo-treelist-column field="ProductName">
26
27
  * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
@@ -31,19 +32,18 @@ import * as i3 from "@angular/forms";
31
32
  * </ng-template>
32
33
  * </kendo-treelist-column>
33
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}.
34
37
  */
35
38
  export class StringFilterCellComponent extends StringFilterComponent {
36
39
  /**
37
- * Determines the delay time (in milliseconds) before the filter value is submitted.
38
- * A value of `0` indicates no delay. The default value is `500`.
39
- * @type {boolean}
40
+ * Sets the delay time (in milliseconds) before the filter value is submitted.
41
+ * A value of `0` means no delay.
40
42
  * @default 500
41
43
  */
42
44
  filterDelay = 500;
43
45
  /**
44
- * Determines if the drop-down filter operators will be displayed.
45
- * The default value is `true`.
46
- * @type {boolean}
46
+ * Shows or hides the drop-down filter operators.
47
47
  * @default true
48
48
  */
49
49
  showOperators = true;
@@ -34,7 +34,7 @@ export class DateFilterComponent extends BaseFilterCellComponent {
34
34
  */
35
35
  column;
36
36
  /**
37
- * The default filter operator. Defaults to `contains`.
37
+ * The default filter operator.
38
38
  * @type {string}
39
39
  * @default 'gte'
40
40
  */
@@ -50,6 +50,7 @@ export class DateFilterComponent extends BaseFilterCellComponent {
50
50
  /**
51
51
  * Specifies the date format that is used when the component is not focused.
52
52
  * By default, the `column.format` value is used (if set).
53
+ * @type {string}
53
54
  */
54
55
  set format(value) {
55
56
  this._format = value;
@@ -57,7 +58,6 @@ export class DateFilterComponent extends BaseFilterCellComponent {
57
58
  /**
58
59
  * Specifies the date format that is used when the component is not focused.
59
60
  * By default, the `column.format` value is used (if set).
60
- *
61
61
  * @readonly
62
62
  * @type {string}
63
63
  */
@@ -77,32 +77,37 @@ export class DateFilterComponent extends BaseFilterCellComponent {
77
77
  /**
78
78
  * Defines the descriptions of the format sections in the input field.
79
79
  * [See possible format options](slug:placeholders_dateinput#toc-format-sections-description).
80
+ * @type {DateInputFormatPlaceholder}
80
81
  */
81
82
  formatPlaceholder;
82
83
  /**
83
84
  * Specifies the hint that the component displays when its value is `null`.
85
+ * @type {string}
84
86
  */
85
87
  placeholder;
86
88
  /**
87
89
  * Defines the active view that the calendar initially renders.
88
90
  * By default, the active view is `month`.
89
- *
90
91
  * You have to set `activeView` within the `topView`-`bottomView` range.
92
+ * @type {CalendarView}
91
93
  * @default 'month'
92
94
  */
93
95
  activeView = "month";
94
96
  /**
95
97
  * Defines the bottommost calendar view, to which the user can navigate.
98
+ * @type {CalendarView}
96
99
  * @default 'month'
97
100
  */
98
101
  bottomView = "month";
99
102
  /**
100
103
  * Defines the topmost calendar view, to which the user can navigate.
104
+ * @type {CalendarView}
101
105
  * @default 'century'
102
106
  */
103
107
  topView = "century";
104
108
  /**
105
109
  * Determines whether to display a week number column in the `month` view of the Calendar.
110
+ * @type {boolean}
106
111
  * @default false
107
112
  */
108
113
  weekNumber = false;
@@ -8,8 +8,7 @@ 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_menu_treelist %})).
11
+ * Represents a service to set the filter descriptor for the TreeList. ([See example]({% slug filter_menu_treelist %})).
13
12
  */
14
13
  export class FilterService {
15
14
  /**
@@ -22,8 +21,7 @@ export class FilterService {
22
21
  changes = new Subject();
23
22
  /**
24
23
  * Sets the filter descriptor.
25
- *
26
- * @param {CompositeFilterDescriptor} value - The filter descriptor that will be set.
24
+ * @param {CompositeFilterDescriptor} value The filter descriptor to set.
27
25
  */
28
26
  filter(value) {
29
27
  this.changes.next(value);