@progress/kendo-angular-treelist 19.1.2-develop.3 → 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
@@ -49,26 +49,25 @@ const packageMetadata = {
49
49
  productName: 'Kendo UI for Angular',
50
50
  productCode: 'KENDOUIANGULAR',
51
51
  productCodes: ['KENDOUIANGULAR'],
52
- publishDate: 1750152699,
53
- version: '19.1.2-develop.3',
52
+ publishDate: 1750431037,
53
+ version: '19.1.2-develop.5',
54
54
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
55
55
  };
56
56
 
57
57
  /**
58
58
  * Represents the column cell template of the TreeList ([more information and example]({% slug templates_columns_treelist %}#toc-cell-template)).
59
- * Helps to customize the content of the cells. To define the cell template, nest an `<ng-template>` tag
60
- * with the `kendoTreeListCellTemplate` directive inside a `<kendo-treelist-column>` tag.
59
+ * Use this directive to customize the content of the cells. To define the cell template, nest an `<ng-template>` tag with the `kendoTreeListCellTemplate` directive inside a `<kendo-treelist-column>` tag.
61
60
  *
62
- * The template context is set to the current data item and the following additional fields are passed:
63
- * - `columnIndex`&mdash;The current column index. Use it as an alias for a template variable by utilizing the `let-columnIndex="columnIndex"` syntax.
64
- * - `column`&mdash;The current column instance. Use it as an alias for a template variable by utilizing the `let-column="column"` syntax.
65
- * - `dataItem`&mdash;The current data item. Represents the default context that will be assigned to any template variable which utilizes the `let-x` syntax&mdash;for example, `let-dataItem`.
66
- * - `cellContext`&mdash;An object used to pass context information to built-in directives.
61
+ * The template context is set to the current data item and provides the following fields:
62
+ * - `columnIndex`&mdash;The current column index. Use as an alias for a template variable with `let-columnIndex="columnIndex"`.
63
+ * - `column`&mdash;The current column instance. Use as an alias for a template variable with `let-column="column"`.
64
+ * - `dataItem`&mdash;The current data item. Represents the default context for any template variable using `let-x` syntax, for example, `let-dataItem`.
65
+ * - `cellContext`&mdash;An object for passing context information to built-in directives.
67
66
  * - `hasChildren`&mdash;Specifies if the item has children.
68
67
  * - `isExpanded`&mdash;Specifies if the item is expanded.
69
68
  * - `level`&mdash;The hierarchy level of the item.
70
69
  * - `loading`&mdash;Specifies if the item children are currently loading.
71
- * - `rowIndex`&mdash;The current row index. Use it as an alias for a template variable by utilizing the `let-rowIndex="rowIndex"` syntax.
70
+ * - `rowIndex`&mdash;The current row index. Use it as an alias for a template variable with `let-rowIndex="rowIndex"`.
72
71
  *
73
72
  * @example
74
73
  * ```html
@@ -79,7 +78,7 @@ const packageMetadata = {
79
78
  * </ng-template>
80
79
  * </kendo-treelist-column>
81
80
  * </kendo-treelist>
82
- *```
81
+ * ```
83
82
  */
84
83
  class CellTemplateDirective {
85
84
  templateRef;
@@ -100,15 +99,13 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
100
99
  }] }]; } });
101
100
 
102
101
  /**
103
- * Represents the column edit-cell template of the TreeList ([see example]({% slug editing_template_forms_treelist %})).
104
- * Helps to customize the content of the edited cells. To define the cell template, nest an `<ng-template>`
105
- * tag with the `kendoTreeListEditTemplate` directive inside a `<kendo-treelist-column>` tag.
102
+ * Represents the column edit-cell template of the TreeList ([see example](slug:editing_template_forms_treelist)). Use this directive to customize the content of edited cells. To define the cell template, nest an `<ng-template>` tag with the `kendoTreeListEditTemplate` directive inside a `<kendo-treelist-column>` tag.
106
103
  *
107
104
  * The template context contains the following fields:
108
105
  * - `column`&mdash;The current column instance.
109
106
  * - `dataItem`&mdash;The current data item.
110
107
  * - `cellContext`&mdash;An object used to pass context information to built-in directives.
111
- * - `formGroup`&mdash;The current [`FormGroup`](link:site.data.urls.angular['formgroupapi']). If you use the TreeList inside [Template-Driven Forms](link:site.data.urls.angular['forms']), `formGroup` will be `undefined`.
108
+ * - `formGroup`&mdash;The current [`FormGroup`](link:site.data.urls.angular['formgroupapi']). If you use the TreeList inside [Template-Driven Forms](link:site.data.urls.angular['forms']), `formGroup` is `undefined`.
112
109
  * - `isNew`&mdash;The state of the current item.
113
110
  * - `rowIndex`&mdash;The current row index. If inside a new item row, `rowIndex` is `-1`.
114
111
  *
@@ -142,12 +139,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
142
139
  }] }]; } });
143
140
 
144
141
  /**
145
- * Represents the template for the column menu in the TreeList. Provides an option for
146
- * customizing the content of the column menu for all or for specific columns.
147
- * To define the content template, nest an `<ng-template>` tag with the
148
- * `kendoTreeListColumnMenuTemplate` directive inside the `kendo-treelist` or the `<kendo-treelist-column>` component.
142
+ * Represents the template for the column menu in the TreeList. Use this directive to customize the content of the column menu for all or specific columns.
143
+ * To define the content template, nest an `<ng-template>` tag with the `kendoTreeListColumnMenuTemplate` directive inside the `kendo-treelist` or the `<kendo-treelist-column>` component.
149
144
  *
150
- * The template context is passes through the following fields:
145
+ * The template context is passed through the following fields:
151
146
  * - `service`&mdash;Represents the [ColumnMenuService]({% slug api_treelist_columnmenuservice %}).
152
147
  * - `column`&mdash;Represents the TreeList column.
153
148
  *
@@ -205,19 +200,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
205
200
  }] });
206
201
 
207
202
  /**
208
- * Represents the column footer cell template of the TreeList
209
- * ([more information and example]({% slug templates_columns_treelist %}#toc-footer-template)).
210
- * Helps to customize the table footer cell for the column.
211
- * To define a footer template, nest an `<ng-template>` tag with the
212
- * `kendoTreeListFooterTemplate` directive inside the `<kendo-treelist-column>` tag.
203
+ * Represents the column footer cell template of the TreeList ([more information and example]({% slug templates_columns_treelist %}#toc-footer-template)).
204
+ * Use this directive to customize the table footer cell for the column.
205
+ * To define a footer template, nest an `<ng-template>` tag with the `kendoTreeListFooterTemplate` directive inside the `<kendo-treelist-column>` tag.
213
206
  *
214
- * The template context is set to the aggregate values and the following additional fields are passed:
215
- * * `aggregates`&mdash;The aggregates for the level items.
216
- * * `column`&mdash;Defines an instance of the [`ColumnComponent`]({% slug api_treelist_columncomponent %}) option.
217
- * * `columnIndex`&mdash;Defines the current column index.
218
- * * `field`&mdash;The name of the column field, if set.
219
- * * `items`&mdash;The data items on this level.
220
- * * `parentItem`&mdash;The parent data item; `null` for root level items.
207
+ * The template context is set to the aggregate values and provides the following fields:
208
+ * - `aggregates`&mdash;The aggregates for the level items.
209
+ * - `column`&mdash;Defines an instance of the [`ColumnComponent`]({% slug api_treelist_columncomponent %}) option.
210
+ * - `columnIndex`&mdash;Defines the current column index.
211
+ * - `field`&mdash;The name of the column field, if set.
212
+ * - `items`&mdash;The data items on this level.
213
+ * - `parentItem`&mdash;The parent data item; `null` for root level items.
221
214
  *
222
215
  * @example
223
216
  * ```html
@@ -249,13 +242,13 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
249
242
  /**
250
243
  * Represents the column header cell template of the TreeList
251
244
  * ([more information and example]({% slug templates_columns_treelist %}#toc-header-template)).
252
- * Helps to customize the table header cell for the column.
245
+ * Use this directive to customize the table header cell for the column.
253
246
  * To define a header template, nest an `<ng-template>` tag with the
254
247
  * [`kendoTreeListHeaderTemplate`]({% slug api_treelist_headertemplatedirective %}) directive inside the `<kendo-treelist-column>` tag.
255
248
  *
256
- * The template context is set to the current column and then the following additional fields are passed:
257
- * * `column`&mdash;Defines an instance of the [`ColumnComponent`]({% slug api_treelist_columncomponent %}) option.
258
- * * `columnIndex`&mdash;Defines the current column index.
249
+ * The template context is set to the current column and provides the following fields:
250
+ * - `column`&mdash;Defines an instance of the [`ColumnComponent`]({% slug api_treelist_columncomponent %}) option.
251
+ * - `columnIndex`&mdash;Defines the current column index.
259
252
  *
260
253
  * @example
261
254
  * ```html
@@ -300,7 +293,7 @@ const isCheckboxColumn = column => column.isCheckboxColumn;
300
293
  const isRowReorderColumn = column => column.isRowReorderColumn;
301
294
  const isColumnContainer = column => column.isColumnGroup || isSpanColumn(column);
302
295
  /**
303
- * The base class for the column components of the TreeList.
296
+ * Serves as the base class for column components in the TreeList.
304
297
  */
305
298
  class ColumnBase {
306
299
  parent;
@@ -347,28 +340,27 @@ class ColumnBase {
347
340
  */
348
341
  reorderable = true;
349
342
  /**
350
- * The width (in pixels) below which the user is not able to resize the column by using the UI.
343
+ * Sets the minimum width (in pixels) for resizing the column using the UI.
351
344
  * @default 10
352
345
  */
353
346
  minResizableWidth = 10;
354
347
  /**
355
- * The title of the column.
348
+ * Sets the title of the column.
356
349
  */
357
350
  title;
358
351
  /**
359
- * The width of the column (in pixels).
352
+ * Sets the width of the column (in pixels).
360
353
  */
361
354
  set width(value) {
362
355
  this._width = parseInt(value, 10);
363
356
  }
364
357
  get width() { return this._width; }
365
358
  /**
366
- * Indicates whether the column will be resized during initialization so that it fits its header and row content.
359
+ * Indicates whether the column is automatically resized during initialization to fit its header and row content.
367
360
  */
368
361
  autoSize;
369
362
  /**
370
363
  * Toggles the locked (frozen) state of the columns ([more information and example](slug:locked_columns_treelist)).
371
- *
372
364
  * @default false
373
365
  */
374
366
  set locked(value) {
@@ -380,12 +372,11 @@ class ColumnBase {
380
372
  _locked = false;
381
373
  /**
382
374
  * Sets the visibility of the column ([see example](slug:hidden_columns_treelist#toc-using-the-built-in-options)).
383
- *
384
375
  * @default false
385
376
  */
386
377
  hidden;
387
378
  /**
388
- * Sets the condition that needs to be satisfied for a column to remain visible ([see example](slug:responsive_treelist#toc-columns)).
379
+ * Sets the condition that must be satisfied for a column to remain visible ([see example](slug:responsive_treelist#toc-columns)).
389
380
  * If you set the `hidden` property, the behavior of `media` is overridden.
390
381
  */
391
382
  media;
@@ -395,55 +386,44 @@ class ColumnBase {
395
386
  */
396
387
  lockable = true;
397
388
  /**
398
- * Specifies if the column menu will be shown for the column.
389
+ * Specifies if the column menu is shown for the column.
399
390
  * @default true
400
391
  */
401
392
  columnMenu = true;
402
393
  /**
403
- * Specifies if the column will be included in the column-chooser list.
394
+ * Specifies if the column is included in the column-chooser list.
404
395
  * @default true
405
396
  */
406
397
  includeInChooser = true;
407
398
  /**
408
- * Allows setting the `role` attribute for the table cells (excluding the footer and header ones) of the column.
399
+ * Sets the `role` attribute for the table cells (excluding the footer and header) of the column.
409
400
  * @default "gridcell"
410
401
  */
411
402
  tableCellsRole = 'gridcell';
412
403
  /**
413
- * Sets the custom styles for the table cells (excluding the footer and header ones) of the column. Under the hood,
414
- * to apply the property, the `style` option uses the
415
- * [NgStyle](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_treelist_columns).
404
+ * Sets custom styles for the table cells (excluding the footer and header) of the column. Uses the [`NgStyle`](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_treelist_columns).
416
405
  */
417
406
  style;
418
407
  /**
419
- * Sets the custom styles for the header cell of the column. Under the hood, to apply the property,
420
- * the `headerStyle` option uses the
421
- * [NgStyle](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_treelist_columns).
408
+ * Sets custom styles for the header cell of the column. Uses the [`NgStyle`](link:site.data.urls.angular['ngstyleapi']) directive. [See example.](slug:styling_treelist_columns)
422
409
  */
423
410
  headerStyle;
424
411
  /**
425
- * Sets the custom styles for the footer cell of the column. Under the hood, to apply the property,
426
- * the `footerStyle` option uses the
427
- * [NgStyle](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_treelist_columns).
412
+ * Sets custom styles for the footer cell of the column. Uses the [`NgStyle`](link:site.data.urls.angular['ngstyleapi']) directive. [See example.](slug:styling_treelist_columns)
428
413
  */
429
414
  footerStyle;
430
415
  /**
431
- * Sets the custom CSS classes to the column cells. Under the hood, to apply the property, the `class` option uses the
432
- * [NgClass](link:site.data.urls.angular['ngclassapi']) directive.
433
- * To customize header and footer column cells, use the [`headerClass`]({% slug api_treelist_columncomponent %}#toc-headerclass)
434
- * and [`footerClass`]({% slug api_treelist_columncomponent %}#toc-footerclass) inputs.
416
+ * Sets custom CSS classes to the column cells. Uses the [`NgClass`](link:site.data.urls.angular['ngclassapi']) directive. To customize header and footer column cells, use the [`headerClass`]({% slug api_treelist_columncomponent %}#toc-headerclass) and [`footerClass`]({% slug api_treelist_columncomponent %}#toc-footerclass) inputs.
435
417
  */
436
418
  cssClass;
437
419
  /**
438
- * Sets the custom CSS classes to the column header cell. Under the hood, to apply the property,
439
- * the `headerClass` option uses the
440
- * [NgClass](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_treelist_columns).
420
+ * Sets custom CSS classes to the column header cell. Uses the [`NgClass`](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_treelist_columns).
441
421
  */
442
422
  headerClass;
443
423
  /**
444
424
  * Sets the custom CSS classes to the column footer cell. Under the hood, to apply the property,
445
425
  * the `footerClass` option uses the
446
- * [NgClass](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_treelist_columns).
426
+ * [`NgClass`](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_treelist_columns).
447
427
  */
448
428
  footerClass;
449
429
  /**
@@ -708,15 +688,30 @@ const isColumnEditable = (column, formGroup) => column.isEditable !== false &&
708
688
  /**
709
689
  * @hidden
710
690
  */
711
- const replaceMessagePlaceholder = (message, name, value) => message.replace(new RegExp(`\{\\s*${name}\\s*\}`, 'g'), value);
691
+ const replaceMessagePlaceholder = (message, name, value) => message.replace(new RegExp(`{\\s*${name}\\s*}`, 'g'), value);
712
692
 
713
693
  /**
714
- * Represents the filter-cell template ([see example](slug:filter_row_treelist#toc-custom-filter-row-components).
694
+ * Represents the filter-cell template for the TreeList.
695
+ * Use this directive to customize the filter row cell for a column.
696
+ * See [custom filter row components](slug:filter_row_treelist#toc-custom-filters).
715
697
  *
716
- * The template context is set to the filter descriptor and the following additional fields are passed:
717
- * - `column`&mdash;The current column instance. Use it as an alias for a template variable by utilizing the `let-column="column"` syntax.
698
+ * The template context is set to the filter descriptor and provides the following fields:
699
+ * - `column`&mdash;The current column instance. Use as an alias for a template variable with `let-column="column"`.
718
700
  * - `filter`&mdash;The filter descriptor.
719
701
  * - `cellContext`&mdash;An object used to pass context information to built-in directives.
702
+ *
703
+ * @example
704
+ * ```html
705
+ * <kendo-treelist-column field="name" title="Name">
706
+ * <ng-template kendoTreeListFilterCellTemplate let-column="column" let-filter="filter" let-cellContext="cellContext">
707
+ * <kendo-maskedtextbox mask="(999) 000-0000"
708
+ * [promptPlaceholder]="prompt" [includeLiterals]="true"
709
+ * (valueChange)="phoneChange($event)"
710
+ * >
711
+ * </kendo-maskedtextbox>
712
+ * </ng-template>
713
+ * </kendo-treelist-column>
714
+ * ```
720
715
  */
721
716
  class FilterCellTemplateDirective {
722
717
  templateRef;
@@ -737,8 +732,24 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
737
732
  }] }]; } });
738
733
 
739
734
  /**
740
- * Represents the filter-menu template
741
- * ([see example](slug:filter_menu_treelist#toc-custom-filter-menu-components).
735
+ * Represents the filter-menu template for the TreeList filter menu.
736
+ *
737
+ * Use this directive to provide a custom template for the filter menu in a TreeList column
738
+ * ([see example](slug:filter_menu_treelist#toc-custom-filter-menu-components)).
739
+ *
740
+ * @example
741
+ * ```html
742
+ * <kendo-treelist-column field="title" title="Title" [width]="180">
743
+ * <ng-template kendoTreeListFilterMenuTemplate
744
+ * let-filter="filter"
745
+ * let-filterService="filterService">
746
+ * <my-custom-filter-menu-component
747
+ * [currentFilter]="filter"
748
+ * [filterService]="filterService">
749
+ * </my-custom-filter-menu-component>
750
+ * </ng-template>
751
+ * </kendo-treelist-column>
752
+ * ```
742
753
  */
743
754
  class FilterMenuTemplateDirective {
744
755
  templateRef;
@@ -765,58 +776,62 @@ function isColumnComponent(column) {
765
776
  return isPresent(column.field);
766
777
  }
767
778
  /**
768
- * Represents the columns of the TreeList.
779
+ * Represents a column in the TreeList. Use this component to define a data-bound column.
769
780
  *
770
781
  * @example
771
782
  * ```html
772
783
  * <kendo-treelist [kendoTreeListFlatBinding]="data" ...>
773
784
  * <kendo-treelist-column field="name" title="Name"></kendo-treelist-column>
774
- * <kendo-treelist-column field="title"title="Title"></kendo-treelist-column>
785
+ * <kendo-treelist-column field="title" title="Title"></kendo-treelist-column>
775
786
  * </kendo-treelist>
776
787
  * ```
788
+ * @remarks
789
+ * Supported children components are:
790
+ * {@link StringFilterCellComponent},
791
+ * {@link NumericFilterCellComponent},
792
+ * {@link BooleanFilterCellComponent},
793
+ * {@link DateFilterCellComponent},
794
+ * {@link StringFilterMenuComponent},
795
+ * {@link NumericFilterMenuComponent},
796
+ * {@link BooleanFilterMenuComponent},
797
+ * {@link DateFilterMenuComponent},
798
+ * {@link FilterCellOperatorsComponent}.
777
799
  */
778
800
  class ColumnComponent extends ColumnBase {
779
801
  /**
780
- * Defines whether the expanded indicator should be rendered in the column.
781
- * @default false
802
+ * Specifies if the expanded indicator appears in the column.
782
803
  */
783
804
  expandable;
784
805
  /**
785
- * The field to which the column is bound.
806
+ * Sets the field to which the column is bound.
786
807
  */
787
808
  field;
788
809
  /**
789
- * The format that is applied to the value before it is displayed. For more information on the supported date and number formats,
790
- * refer to the [Column Formats](slug:formats_columns_treelist) documentation article.
810
+ * Sets the format applied to the value before display. For supported date and number formats, see the [Column Formats](slug:formats_columns_treelist) article.
791
811
  */
792
812
  format;
793
813
  /**
794
- * Allows the column headers to be clicked and the `sortChange` event emitted.
795
- * You have to handle the `sortChange` event yourself and sort the data.
814
+ * Allows the column headers to be clicked and the `sortChange` event emitted. You must handle the `sortChange` event and sort the data.
815
+ * @default true
796
816
  */
797
817
  sortable = true;
798
818
  /**
799
- * Defines the editor type ([see example]({% slug editing_reactive_forms_treelist %}#toc-setup)).
800
- * Used when the column enters the edit mode. [See example](slug:editing_reactive_forms_treelist).
801
- *
819
+ * Sets the editor type ([see example]({% slug editing_reactive_forms_treelist %}#toc-setup)). Used when the column enters edit mode. [See example](slug:editing_reactive_forms_treelist).
802
820
  * @default 'text'
803
821
  */
804
822
  editor = 'text';
805
823
  /**
806
- * Defines the filter type that is displayed inside the filter row.
807
- *
824
+ * Sets the filter type displayed inside the filter row.
808
825
  * @default 'text'
809
826
  */
810
827
  filter = 'text';
811
828
  /**
812
- * Defines if a filter UI will be displayed for this column.
813
- *
829
+ * Specifies if a filter UI appears for this column.
814
830
  * @default true
815
831
  */
816
832
  filterable = true;
817
833
  /**
818
- * Defines whether the column is editable.
819
- *
834
+ * Specifies if the column is editable.
820
835
  * @default true
821
836
  */
822
837
  editable = true;
@@ -912,16 +927,15 @@ function isSpanColumnComponent(column) {
912
927
  return column.isSpanColumn;
913
928
  }
914
929
  /**
915
- * Represents a column which can be spanned over multiple data cells while the individual
916
- * header and footer cells are retained ([see example]({% slug spanned_columns_treelist %})).
917
- * Enables you to achieve more flexible layout while keeping the built-in UI element for
918
- * [sorting]({% slug sorting_treelist %}) and [filtering]({% slug filtering_treelist %}). Wrap the columns that will be
919
- * merged inside the `<kendo-treelist-span-column>` tag.
930
+ * Represents a column that spans multiple data cells while keeping individual header and footer cells.
931
+ * Use this component to create flexible layouts and retain built-in UI for [sorting]({% slug sorting_treelist %}) and [filtering]({% slug filtering_treelist %}).
932
+ * Wrap the columns to merge inside the `<kendo-treelist-span-column>` tag.
920
933
  *
934
+ * @example
921
935
  * ```html
922
936
  * <kendo-treelist-span-column>
923
- * <kendo-treelist-column field="field1" ></kendo-treelist-column>
924
- * <kendo-treelist-column field="field2" ></kendo-treelist-column>
937
+ * <kendo-treelist-column field="field1"></kendo-treelist-column>
938
+ * <kendo-treelist-column field="field2"></kendo-treelist-column>
925
939
  * <ng-template kendoTreeListCellTemplate let-dataItem>
926
940
  * <h5>{{ dataItem.field1 }}</h5>
927
941
  * <p>{{ dataItem.field2 }}</p>
@@ -931,8 +945,7 @@ function isSpanColumnComponent(column) {
931
945
  */
932
946
  class SpanColumnComponent extends ColumnBase {
933
947
  /**
934
- * Defines whether the expanded indicator should be rendered in the column.
935
- * @default false
948
+ * Specifies if the expanded indicator appears in the column.
936
949
  */
937
950
  expandable;
938
951
  /*
@@ -970,10 +983,9 @@ class SpanColumnComponent extends ColumnBase {
970
983
  */
971
984
  includeInChooser = false;
972
985
  /**
973
- * Defines whether the edit template of the column will be rendered. The default value is `false`.
974
- *
975
- * To enable the editing functionality for a spanned column, set an edit template for it.
976
- *
986
+ * Defines whether the edit template of the column is rendered.
987
+ * To enable editing for a spanned column, set an edit template for it.
988
+ * @default false
977
989
  */
978
990
  set editable(value) {
979
991
  this._editable = value;
@@ -1024,9 +1036,7 @@ class SpanColumnComponent extends ColumnBase {
1024
1036
  return this.childColumns.filter(c => c.isVisible).length;
1025
1037
  }
1026
1038
  /**
1027
- * Toggles the locked (frozen) state of the columns. Locked columns are visible
1028
- * at all times during the horizontal scrolling of the TreeList. [See example](slug:locked_columns_treelist).
1029
- *
1039
+ * Toggles the locked (frozen) state of the columns. Locked columns are visible at all times during horizontal scrolling. [See example](slug:locked_columns_treelist).
1030
1040
  * @default false
1031
1041
  */
1032
1042
  set locked(value) {
@@ -1172,8 +1182,7 @@ function isColumnGroupComponent(column) {
1172
1182
  return column.isColumnGroup;
1173
1183
  }
1174
1184
  /**
1175
- * Represents the column group header of the TreeList
1176
- * ([more information and examples]({% slug multicolumnheaders_columns_treelist %})).
1185
+ * Represents the column group header of the TreeList. ([More information and examples]({% slug multicolumnheaders_columns_treelist %})).
1177
1186
  *
1178
1187
  * @example
1179
1188
  * ```html
@@ -1836,7 +1845,8 @@ class PreventableEvent {
1836
1845
  }
1837
1846
 
1838
1847
  /**
1839
- * Arguments for the `cellClose` event.
1848
+ * Provides arguments for the `cellClose` event.
1849
+ *
1840
1850
  */
1841
1851
  class CellCloseEvent extends PreventableEvent {
1842
1852
  isNew;
@@ -1847,16 +1857,15 @@ class CellCloseEvent extends PreventableEvent {
1847
1857
  */
1848
1858
  action = 'cellClose';
1849
1859
  /**
1850
- * The TreeList column that will be closed.
1860
+ * Specifies the TreeList column that will be closed.
1851
1861
  */
1852
1862
  column;
1853
1863
  /**
1854
- * The [`FormGroup`](link:site.data.urls.angular['formgroupapi']) that is used to edit the cell which will be closed.
1864
+ * Provides the [`FormGroup`](link:site.data.urls.angular['formgroupapi']) used to edit the cell that will be closed.
1855
1865
  */
1856
1866
  formGroup;
1857
1867
  /**
1858
- * The DOM event that caused the `cellClose` event.
1859
- * May not be present if `cellClose` was caused by an API call.
1868
+ * Provides the DOM event that caused the `cellClose` event. May not be present if `cellClose` was caused by an API call.
1860
1869
  */
1861
1870
  originalEvent;
1862
1871
  constructor(options) {
@@ -2139,7 +2148,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
2139
2148
  }], ctorParameters: function () { return [{ type: i0.NgZone }]; } });
2140
2149
 
2141
2150
  /**
2142
- * Represents the no-records template of the TreeList ([see example](slug:norecordtemplate_treelist)). Provides an option to customize the
2151
+ * Represents the no-records template of the TreeList ([see example](slug:norecordtemplate_treelist)). Use this directive to customize the
2143
2152
  * appearance of the item that is displayed when no data is present. To define the no-records template,
2144
2153
  * nest an `<ng-template>` tag with the `kendoTreeListNoRecordsTemplate` directive inside `<kendo-treelist>`.
2145
2154
  *
@@ -2148,7 +2157,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
2148
2157
  * @example
2149
2158
  * ```html
2150
2159
  * <kendo-treelist ... >
2151
- * <kendo-treelist-column field="name" ></kendo-treelist-column>
2160
+ * <kendo-treelist-column field="name"></kendo-treelist-column>
2152
2161
  * <ng-template kendoTreeListNoRecordsTemplate>
2153
2162
  * No data loaded.
2154
2163
  * </ng-template>
@@ -2234,8 +2243,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
2234
2243
  }] });
2235
2244
 
2236
2245
  /**
2237
- * Represents a service to set the filter descriptor
2238
- * ([see example]({% slug filter_menu_treelist %})).
2246
+ * Represents a service to set the filter descriptor for the TreeList. ([See example]({% slug filter_menu_treelist %})).
2239
2247
  */
2240
2248
  class FilterService {
2241
2249
  /**
@@ -2248,8 +2256,7 @@ class FilterService {
2248
2256
  changes = new Subject();
2249
2257
  /**
2250
2258
  * Sets the filter descriptor.
2251
- *
2252
- * @param {CompositeFilterDescriptor} value - The filter descriptor that will be set.
2259
+ * @param {CompositeFilterDescriptor} value The filter descriptor to set.
2253
2260
  */
2254
2261
  filter(value) {
2255
2262
  this.changes.next(value);
@@ -2305,7 +2312,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
2305
2312
  }] });
2306
2313
 
2307
2314
  /**
2308
- * Arguments for the `pdfExport` event.
2315
+ * Provides the arguments for the `pdfExport` event.
2316
+ *
2317
+ * Use this event to customize or prevent the PDF export process.
2309
2318
  */
2310
2319
  class PDFExportEvent extends PreventableEvent {
2311
2320
  /**
@@ -2479,15 +2488,13 @@ class ColumnList {
2479
2488
  * Represents the toolbar template of the TreeList ([see example](slug:toolbartemplate_treelist)).
2480
2489
  *
2481
2490
  * The template context has the following field:
2482
- * - `position`&mdash;The position at which the toolbar template is rendered. The possible values are `top`, `bottom` and `both`.
2491
+ * - `position`&mdash;The position at which the toolbar template is rendered. The possible values are `top`, `bottom`, and `both`.
2483
2492
  *
2484
2493
  * @example
2485
2494
  * ```html
2486
2495
  * <kendo-treelist ...>
2487
2496
  * <ng-template kendoTreeListToolbarTemplate>
2488
- * <button kendoTreeListExcelCommand >
2489
- * Export to Excel
2490
- * </button>
2497
+ * <button kendoTreeListExcelCommand>Export to Excel</button>
2491
2498
  * </ng-template>
2492
2499
  * </kendo-treelist>
2493
2500
  * ```
@@ -2497,8 +2504,8 @@ class ToolbarTemplateDirective {
2497
2504
  optionChanges;
2498
2505
  _position = "top";
2499
2506
  /**
2500
- * The position of the toolbar ([see example](slug:toolbartemplate_treelist#toc-setting-the-toolbar-position)).
2501
- * The group panel or header and the second one below the pager.
2507
+ * Sets the position of the toolbar. The value can be `top`, `bottom`, or `both`.
2508
+ * Controls whether the toolbar appears above, below, or on both sides of the TreeList. [See example.](slug:toolbartemplate_treelist#toc-setting-the-toolbar-position)
2502
2509
  * @default 'top'
2503
2510
  */
2504
2511
  set position(position) {
@@ -2955,11 +2962,11 @@ const contains$1 = (node, predicate) => {
2955
2962
  return false;
2956
2963
  };
2957
2964
  /**
2958
- * Arguments for the `close` event of the filter and column-menu popup.
2965
+ * Provides arguments for the `close` event of the filter and column-menu popup. Use this event to access the original DOM event that triggers the popup to close and to prevent the default closing behavior if needed.
2959
2966
  */
2960
2967
  class PopupCloseEvent extends PreventableEvent {
2961
2968
  /**
2962
- * The original DOM event that causes the popup to close.
2969
+ * Stores the original DOM event that causes the popup to close.
2963
2970
  */
2964
2971
  originalEvent;
2965
2972
  /**
@@ -2972,8 +2979,9 @@ class PopupCloseEvent extends PreventableEvent {
2972
2979
  }
2973
2980
  const DEFAULT_POPUP_CLASS = 'k-grid-filter-popup';
2974
2981
  /**
2975
- * The service that is used for the popups of the filter and column menus
2976
- * ([see example]({% slug filter_menu_treelist %}#toc-filter-menu-with-popup)).
2982
+ * Represents the service used for the popups of the filter and column menus.
2983
+ * Use this service to manage popup opening, closing, and event handling.
2984
+ * ([See example]({% slug filter_menu_treelist %}#toc-filter-menu-with-popup)).
2977
2985
  */
2978
2986
  class SinglePopupService {
2979
2987
  popupService;
@@ -2981,8 +2989,8 @@ class SinglePopupService {
2981
2989
  ngZone;
2982
2990
  localization;
2983
2991
  /**
2984
- * Fires when the filter or column menus are about to close because the user clicked outside their popups.
2985
- * Used to prevent the popup from closing.
2992
+ * Emits when the filter or column menus are about to close because the user clicked outside their popups.
2993
+ * Use this event to prevent the popup from closing.
2986
2994
  */
2987
2995
  onClose = new Subject();
2988
2996
  removeClick;
@@ -3359,21 +3367,19 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3359
3367
  }] });
3360
3368
 
3361
3369
  /**
3362
- * Arguments for the `columnReorder` event.
3370
+ * Provides arguments for the `columnReorder` event. Use this event to access the reordered column and its new and old indexes.
3363
3371
  */
3364
3372
  class ColumnReorderEvent extends PreventableEvent {
3365
3373
  /**
3366
- * The reordered column.
3374
+ * Specifies the reordered column.
3367
3375
  */
3368
3376
  column;
3369
3377
  /**
3370
- * The new index of the column.
3371
- * Relative to the collection of columns.
3378
+ * The new index of the column, relative to the collection of columns.
3372
3379
  */
3373
3380
  newIndex;
3374
3381
  /**
3375
- * The original index of the column before reordering.
3376
- * Relative to the collection of columns.
3382
+ * The original index of the column before reordering, relative to the collection of columns.
3377
3383
  */
3378
3384
  oldIndex;
3379
3385
  /**
@@ -3574,11 +3580,11 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3574
3580
  }], ctorParameters: function () { return [{ type: FocusRoot }]; } });
3575
3581
 
3576
3582
  /**
3577
- * A directive that controls the way focusable cell elements receive
3578
- * [focus in a navigable TreeList]({% slug keyboard_navigation_treelist %}).
3583
+ * Represents a directive that controls how focusable cell elements receive focus in a [navigable TreeList]({% slug keyboard_navigation_treelist %}).
3579
3584
  *
3580
- * The directive takes as input the `cellContext` from the cell template.
3585
+ * Use this directive to manage focus behavior for cell elements. Pass the `cellContext` from the cell template as input.
3581
3586
  *
3587
+ * @example
3582
3588
  * ```html
3583
3589
  * <kendo-treelist-column>
3584
3590
  * <ng-template kendoTreeListCellTemplate let-cellContext="cellContext">
@@ -3592,7 +3598,7 @@ class FocusableDirective {
3592
3598
  renderer;
3593
3599
  group;
3594
3600
  /**
3595
- * The cell context provided by the template.
3601
+ * Provides the cell context from the template.
3596
3602
  */
3597
3603
  cellContext;
3598
3604
  /**
@@ -4148,15 +4154,15 @@ class TreeListFocusableElement {
4148
4154
  }
4149
4155
 
4150
4156
  /**
4151
- * Arguments for the TreeList expand and collapse events ([see examples]({% slug treelist_expanded_state %})).
4157
+ * Arguments for the TreeList expand and collapse events. [See example]({% slug treelist_expanded_state %}).
4152
4158
  */
4153
4159
  class ExpandEvent extends PreventableEvent {
4154
4160
  /**
4155
- * The expanded/collapsed data item.
4161
+ * The expanded or collapsed data item.
4156
4162
  */
4157
4163
  dataItem;
4158
4164
  /**
4159
- * The TreeList component that triggered the event.
4165
+ * The TreeList component that triggers the event.
4160
4166
  */
4161
4167
  sender;
4162
4168
  /**
@@ -4224,7 +4230,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4224
4230
  */
4225
4231
  class SelectionChangeEvent {
4226
4232
  /**
4227
- * Specifies how was the selection changed
4233
+ * Specifies how the selection was changed.
4228
4234
  */
4229
4235
  action;
4230
4236
  /**
@@ -5218,11 +5224,11 @@ class SortService {
5218
5224
  }
5219
5225
 
5220
5226
  /**
5221
- * Arguments for the `columnVisibilityChange` event.
5227
+ * Represents the arguments for the `columnVisibilityChange` event.
5222
5228
  */
5223
5229
  class ColumnVisibilityChangeEvent {
5224
5230
  /**
5225
- * The columns whose visibility is changed.
5231
+ * Contains the columns whose visibility changes.
5226
5232
  */
5227
5233
  columns;
5228
5234
  /**
@@ -5234,11 +5240,13 @@ class ColumnVisibilityChangeEvent {
5234
5240
  }
5235
5241
 
5236
5242
  /**
5237
- * Arguments for the `columnLockedChange` event.
5243
+ * Represents the event arguments for the `columnLockedChange` event in the Kendo UI for Angular TreeList.
5244
+ * Use this event to access the columns whose locked state has changed.
5245
+ *
5238
5246
  */
5239
5247
  class ColumnLockedChangeEvent {
5240
5248
  /**
5241
- * The columns whose locked state is changed.
5249
+ * The array of columns whose locked state has changed.
5242
5250
  */
5243
5251
  columns;
5244
5252
  /**
@@ -8883,7 +8891,7 @@ class FilterOperatorBase {
8883
8891
  operator;
8884
8892
  localization;
8885
8893
  /**
8886
- * The text that will be displayed in the drop-down list.
8894
+ * The text displayed in the drop-down list for the filter operator.
8887
8895
  * @readonly
8888
8896
  * @type {string}
8889
8897
  * @memberOf FilterOperatorBase
@@ -9012,7 +9020,9 @@ const localizeOperators = operators => localization => Object.keys(operators).ma
9012
9020
  value: operators[key]
9013
9021
  }));
9014
9022
  /**
9015
- * An abstract base class for the filter-cell component ([see example](slug:filter_row_treelist#toc-custom-filter-row-components).
9023
+ * An abstract base class for the filter-cell component in the TreeList.
9024
+ * Use this class to implement custom filter cell components.
9025
+ * [See example](slug:filter_row_treelist#toc-custom-filter-row-components).
9016
9026
  */
9017
9027
  class BaseFilterCellComponent {
9018
9028
  filterService;
@@ -9110,7 +9120,7 @@ const stringOperators$1 = localizeOperators({
9110
9120
  "filterIsNotEmptyOperator": "isnotempty"
9111
9121
  });
9112
9122
  /**
9113
- * Represents a base string filter component.
9123
+ * Represents a base string filter component for the TreeList.
9114
9124
  */
9115
9125
  class StringFilterComponent extends BaseFilterCellComponent {
9116
9126
  localization;
@@ -9386,7 +9396,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
9386
9396
  }] } });
9387
9397
 
9388
9398
  /**
9389
- * Represents a component which accommodates the filter operators.
9399
+ * Represents a component that displays filter operators for the TreeList filter row.
9400
+ * Use this component to let users select filter operators for a column.
9390
9401
  *
9391
9402
  * @example
9392
9403
  * ```html
@@ -9668,9 +9679,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
9668
9679
 
9669
9680
  /**
9670
9681
  * Represents a string-filter cell component.
9682
+ * Use this component to filter string values in the TreeList.
9671
9683
  * See the article about the [built-in filter components](slug:filter_row_treelist#toc-built-in-filter-row-components).
9672
- * @example
9673
9684
  *
9685
+ * @example
9674
9686
  * ```html
9675
9687
  * <kendo-treelist-column field="ProductName">
9676
9688
  * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
@@ -9681,19 +9693,18 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
9681
9693
  * </ng-template>
9682
9694
  * </kendo-treelist-column>
9683
9695
  * ```
9696
+ * @remarks
9697
+ * Supported children components are: {@link EqualFilterOperatorComponent}, {@link NotEqualFilterOperatorComponent}, {@link ContainsFilterOperatorComponent}, {@link DoesNotContainFilterOperatorComponent}, {@link StartsWithFilterOperatorComponent}, {@link EndsWithFilterOperatorComponent}, {@link IsNullFilterOperatorComponent}, {@link IsNotNullFilterOperatorComponent}, {@link IsEmptyFilterOperatorComponent}, {@link IsNotEmptyFilterOperatorComponent}.
9684
9698
  */
9685
9699
  class StringFilterCellComponent extends StringFilterComponent {
9686
9700
  /**
9687
- * Determines the delay time (in milliseconds) before the filter value is submitted.
9688
- * A value of `0` indicates no delay. The default value is `500`.
9689
- * @type {boolean}
9701
+ * Sets the delay time (in milliseconds) before the filter value is submitted.
9702
+ * A value of `0` means no delay.
9690
9703
  * @default 500
9691
9704
  */
9692
9705
  filterDelay = 500;
9693
9706
  /**
9694
- * Determines if the drop-down filter operators will be displayed.
9695
- * The default value is `true`.
9696
- * @type {boolean}
9707
+ * Shows or hides the drop-down filter operators.
9697
9708
  * @default true
9698
9709
  */
9699
9710
  showOperators = true;
@@ -9775,7 +9786,7 @@ const numericOperators = localizeOperators({
9775
9786
  "filterIsNotNullOperator": "isnotnull"
9776
9787
  });
9777
9788
  /**
9778
- * Represents a base numeric filter component.
9789
+ * Represents a base numeric filter component for the TreeList.
9779
9790
  */
9780
9791
  class NumericFilterComponent extends BaseFilterCellComponent {
9781
9792
  localization;
@@ -9792,7 +9803,7 @@ class NumericFilterComponent extends BaseFilterCellComponent {
9792
9803
  operator = "eq";
9793
9804
  /**
9794
9805
  * Specifies the value that is used to increment or decrement the component value.
9795
- * @type {numeric}
9806
+ * @type {number}
9796
9807
  * @default 1
9797
9808
  */
9798
9809
  step = 1;
@@ -9815,13 +9826,13 @@ class NumericFilterComponent extends BaseFilterCellComponent {
9815
9826
  /**
9816
9827
  * Specifies the number precision applied to the component value when it is focused.
9817
9828
  * If the user enters a number with a greater precision than is currently configured, the component value is rounded.
9818
- *
9819
9829
  * @type {number}
9820
9830
  */
9821
9831
  decimals;
9822
9832
  /**
9823
9833
  * Specifies the number format used when the component is not focused.
9824
9834
  * By default, the `column.format` value is used (if set).
9835
+ * @type {string}
9825
9836
  */
9826
9837
  get format() {
9827
9838
  return !isNullOrEmptyString(this._format) ? this._format : this.columnFormat;
@@ -9897,7 +9908,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
9897
9908
 
9898
9909
  /**
9899
9910
  * Represents a numeric filter cell.
9911
+ * Use this component to filter numeric values in the TreeList.
9900
9912
  * See the article about the [built-in filter components](slug:filter_row_treelist#toc-built-in-filter-row-components).
9913
+ *
9901
9914
  * @example
9902
9915
  * ```html
9903
9916
  * <kendo-treelist-column field="ProductName" title="Product Name">
@@ -9909,19 +9922,19 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
9909
9922
  * </ng-template>
9910
9923
  * </kendo-treelist-column>
9911
9924
  * ```
9925
+ * @remarks
9926
+ * Supported children components are: {@link EqualFilterOperatorComponent}, {@link NotEqualFilterOperatorComponent}, {@link GreaterFilterOperatorComponent}, {@link GreaterOrEqualToFilterOperatorComponent}, {@link LessFilterOperatorComponent}, {@link LessOrEqualToFilterOperatorComponent}, {@link IsNullFilterOperatorComponent}, {@link IsNotNullFilterOperatorComponent}.
9912
9927
  */
9913
9928
  class NumericFilterCellComponent extends NumericFilterComponent {
9914
9929
  localization;
9915
9930
  /**
9916
- * Determines the delay time (in milliseconds) before the filter value is submitted.
9917
- * A value of `0` indicates no delay.
9918
- * @type {boolean}
9931
+ * Sets the delay time (in milliseconds) before the filter value is submitted.
9932
+ * A value of `0` means no delay.
9919
9933
  * @default 500
9920
9934
  */
9921
9935
  filterDelay = 500;
9922
9936
  /**
9923
- * Determines if the drop-down filter operators will be displayed.
9924
- * @type {boolean}
9937
+ * Shows or hides the drop-down filter operators.
9925
9938
  * @default true
9926
9939
  */
9927
9940
  showOperators = true;
@@ -10103,6 +10116,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
10103
10116
 
10104
10117
  /**
10105
10118
  * Represents a Boolean filter-cell component.
10119
+ * Use this component to filter Boolean values in the TreeList.
10106
10120
  * See the article about the [built-in filter components](slug:filter_row_treelist#toc-built-in-filter-row-components).
10107
10121
  *
10108
10122
  * @example
@@ -10214,7 +10228,7 @@ class DateFilterComponent extends BaseFilterCellComponent {
10214
10228
  */
10215
10229
  column;
10216
10230
  /**
10217
- * The default filter operator. Defaults to `contains`.
10231
+ * The default filter operator.
10218
10232
  * @type {string}
10219
10233
  * @default 'gte'
10220
10234
  */
@@ -10230,6 +10244,7 @@ class DateFilterComponent extends BaseFilterCellComponent {
10230
10244
  /**
10231
10245
  * Specifies the date format that is used when the component is not focused.
10232
10246
  * By default, the `column.format` value is used (if set).
10247
+ * @type {string}
10233
10248
  */
10234
10249
  set format(value) {
10235
10250
  this._format = value;
@@ -10237,7 +10252,6 @@ class DateFilterComponent extends BaseFilterCellComponent {
10237
10252
  /**
10238
10253
  * Specifies the date format that is used when the component is not focused.
10239
10254
  * By default, the `column.format` value is used (if set).
10240
- *
10241
10255
  * @readonly
10242
10256
  * @type {string}
10243
10257
  */
@@ -10257,32 +10271,37 @@ class DateFilterComponent extends BaseFilterCellComponent {
10257
10271
  /**
10258
10272
  * Defines the descriptions of the format sections in the input field.
10259
10273
  * [See possible format options](slug:placeholders_dateinput#toc-format-sections-description).
10274
+ * @type {DateInputFormatPlaceholder}
10260
10275
  */
10261
10276
  formatPlaceholder;
10262
10277
  /**
10263
10278
  * Specifies the hint that the component displays when its value is `null`.
10279
+ * @type {string}
10264
10280
  */
10265
10281
  placeholder;
10266
10282
  /**
10267
10283
  * Defines the active view that the calendar initially renders.
10268
10284
  * By default, the active view is `month`.
10269
- *
10270
10285
  * You have to set `activeView` within the `topView`-`bottomView` range.
10286
+ * @type {CalendarView}
10271
10287
  * @default 'month'
10272
10288
  */
10273
10289
  activeView = "month";
10274
10290
  /**
10275
10291
  * Defines the bottommost calendar view, to which the user can navigate.
10292
+ * @type {CalendarView}
10276
10293
  * @default 'month'
10277
10294
  */
10278
10295
  bottomView = "month";
10279
10296
  /**
10280
10297
  * Defines the topmost calendar view, to which the user can navigate.
10298
+ * @type {CalendarView}
10281
10299
  * @default 'century'
10282
10300
  */
10283
10301
  topView = "century";
10284
10302
  /**
10285
10303
  * Determines whether to display a week number column in the `month` view of the Calendar.
10304
+ * @type {boolean}
10286
10305
  * @default false
10287
10306
  */
10288
10307
  weekNumber = false;
@@ -10352,9 +10371,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
10352
10371
 
10353
10372
  /**
10354
10373
  * Represents a date-filter cell component.
10374
+ * Use this component to filter date values in the TreeList.
10355
10375
  * See the article about the [built-in filter components](slug:filter_row_treelist#toc-built-in-filter-row-components).
10356
- * @example
10357
10376
  *
10377
+ * @example
10358
10378
  * ```html
10359
10379
  * <kendo-treelist-column field="OrderDate">
10360
10380
  * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
@@ -10365,12 +10385,13 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
10365
10385
  * </ng-template>
10366
10386
  * </kendo-treelist-column>
10367
10387
  * ```
10388
+ * @remarks
10389
+ * Supported children components are: {@link EqualFilterOperatorComponent}, {@link NotEqualFilterOperatorComponent}, {@link AfterEqFilterOperatorComponent}, {@link AfterFilterOperatorComponent}, {@link BeforeEqFilterOperatorComponent}, {@link BeforeFilterOperatorComponent}, {@link IsNullFilterOperatorComponent}, {@link IsNotNullFilterOperatorComponent}.
10368
10390
  */
10369
10391
  class DateFilterCellComponent extends DateFilterComponent {
10370
10392
  localization;
10371
10393
  /**
10372
- * Determines if the drop-down filter operators will be displayed. The default value is `true`.
10373
- * @type {boolean}
10394
+ * Shows or hides the drop-down filter operators.
10374
10395
  * @default true
10375
10396
  */
10376
10397
  showOperators = true;
@@ -10855,8 +10876,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
10855
10876
  }] } });
10856
10877
 
10857
10878
  /**
10858
- * Represents the service that is passed to the
10859
- * [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
10879
+ * Represents the service passed to the [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
10860
10880
  *
10861
10881
  * @example
10862
10882
  * ```html
@@ -10935,7 +10955,7 @@ const ColumnMenuErrorMessages = {
10935
10955
  */
10936
10956
  class ColumnMenuItemBase {
10937
10957
  /**
10938
- * Represents the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %}) class.
10958
+ * Represents the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %}) instance.
10939
10959
  * Requires a mandatory input.
10940
10960
  */
10941
10961
  service;
@@ -11213,7 +11233,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
11213
11233
  }] } });
11214
11234
 
11215
11235
  /**
11216
- * Represents a string-filter menu component.
11236
+ * Represents the Kendo UI string-filter menu component for the TreeList. Use this component to filter string values using a filter menu popup.
11217
11237
  * [See example](slug:filter_menu_treelist#toc-built-in-filter-menu-components).
11218
11238
  *
11219
11239
  * @example
@@ -11228,7 +11248,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
11228
11248
  * </ng-template>
11229
11249
  * </kendo-treelist-column>
11230
11250
  * ```
11231
- *
11251
+ * @remarks
11252
+ * Supported children components are: {@link EqualFilterOperatorComponent}, {@link NotEqualFilterOperatorComponent}, {@link ContainsFilterOperatorComponent}, {@link DoesNotContainFilterOperatorComponent}, {@link StartsWithFilterOperatorComponent}, {@link EndsWithFilterOperatorComponent}, {@link IsNullFilterOperatorComponent}, {@link IsNotNullFilterOperatorComponent}, {@link IsEmptyFilterOperatorComponent}, {@link IsNotEmptyFilterOperatorComponent}.
11232
11253
  */
11233
11254
  class StringFilterMenuComponent extends StringFilterComponent {
11234
11255
  logicOperators = logicOperators(this.localization);
@@ -11244,12 +11265,13 @@ class StringFilterMenuComponent extends StringFilterComponent {
11244
11265
  */
11245
11266
  filter = { filters: [], logic: "and" };
11246
11267
  /**
11247
- * Determines if the inputs of second criteria will displayed.
11268
+ * Determines if the inputs for a second criteria are displayed.
11269
+ * @type {boolean}
11248
11270
  * @default true
11249
11271
  */
11250
11272
  extra = true;
11251
11273
  /**
11252
- * The `FilterService` instance which is responsible for handling the changes in the filter descriptor.
11274
+ * The `FilterService` instance responsible for handling changes in the filter descriptor.
11253
11275
  */
11254
11276
  filterService;
11255
11277
  /**
@@ -11514,10 +11536,11 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
11514
11536
  }] } });
11515
11537
 
11516
11538
  /**
11517
- * Represents a numeric-filter menu component. [See example](slug:filter_menu_treelist#toc-built-in-filter-menu-components).
11539
+ * Represents the Kendo UI numeric-filter menu component for the TreeList. Use this component to filter numeric values using a filter menu popup.
11540
+ * [See example](slug:filter_menu_treelist#toc-built-in-filter-menu-components).
11518
11541
  *
11519
11542
  * @example
11520
- * ```html
11543
+ * ```html
11521
11544
  * <kendo-treelist-column field="UnitPrice">
11522
11545
  * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
11523
11546
  * <kendo-treelist-numeric-filter-menu
@@ -11528,6 +11551,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
11528
11551
  * </ng-template>
11529
11552
  * </kendo-treelist-column>
11530
11553
  * ```
11554
+ * @remarks
11555
+ * Supported children components are: {@link EqualFilterOperatorComponent}, {@link NotEqualFilterOperatorComponent}, {@link GreaterFilterOperatorComponent}, {@link GreaterOrEqualToFilterOperatorComponent}, {@link LessFilterOperatorComponent}, {@link LessOrEqualToFilterOperatorComponent}, {@link IsNullFilterOperatorComponent}, {@link IsNotNullFilterOperatorComponent}.
11531
11556
  */
11532
11557
  class NumericFilterMenuComponent extends NumericFilterComponent {
11533
11558
  logicOperators = logicOperators(this.localization);
@@ -11543,7 +11568,7 @@ class NumericFilterMenuComponent extends NumericFilterComponent {
11543
11568
  */
11544
11569
  filter = { filters: [], logic: "and" };
11545
11570
  /**
11546
- * Determines if the inputs of second criteria will displayed.
11571
+ * Determines if the inputs of second criteria are displayed.
11547
11572
  * @default true
11548
11573
  */
11549
11574
  extra = true;
@@ -11552,19 +11577,20 @@ class NumericFilterMenuComponent extends NumericFilterComponent {
11552
11577
  */
11553
11578
  filterService;
11554
11579
  /**
11555
- * 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.
11556
- *
11580
+ * Determines the delay (in milliseconds) before creating a filter descriptor based on the value. A value of 0 indicates no delay.
11557
11581
  * @default 500
11558
11582
  */
11559
11583
  filterDelay = 500;
11560
11584
  /**
11561
11585
  * The placeholder text for the filter input.
11562
11586
  * @type {string}
11587
+ * @default ''
11563
11588
  */
11564
11589
  placeholder = '';
11565
11590
  /**
11566
11591
  * The placeholder text for the extra filter input. Applies when `extra` is set to `true`.
11567
11592
  * @type {string}
11593
+ * @default ''
11568
11594
  */
11569
11595
  extraPlaceholder = '';
11570
11596
  /**
@@ -11872,7 +11898,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
11872
11898
  }] } });
11873
11899
 
11874
11900
  /**
11875
- * Represents a date-filter menu component. [See example](slug:filter_menu_treelist#toc-built-in-filter-menu-components).
11901
+ * Represents the Kendo UI date-filter menu component for Angular TreeList. Use this component to filter date fields in the TreeList. [See example](slug:filter_menu_treelist#toc-built-in-filter-menu-components).
11876
11902
  *
11877
11903
  * @example
11878
11904
  * ```html
@@ -11886,6 +11912,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
11886
11912
  * </ng-template>
11887
11913
  * </kendo-treelist-column>
11888
11914
  * ```
11915
+ * @remarks
11916
+ * Supported children components are: {@link EqualFilterOperatorComponent}, {@link NotEqualFilterOperatorComponent}, {@link AfterEqFilterOperatorComponent}, {@link AfterFilterOperatorComponent}, {@link BeforeEqFilterOperatorComponent}, {@link BeforeFilterOperatorComponent}, {@link IsNullFilterOperatorComponent}, {@link IsNotNullFilterOperatorComponent}.
11889
11917
  */
11890
11918
  class DateFilterMenuComponent extends DateFilterComponent {
11891
11919
  logicOperators = logicOperators(this.localization);
@@ -11901,12 +11929,13 @@ class DateFilterMenuComponent extends DateFilterComponent {
11901
11929
  */
11902
11930
  filter = { filters: [], logic: "and" };
11903
11931
  /**
11904
- * Determines if the inputs of second criteria will be displayed.
11932
+ * Determines if the inputs of second criteria are displayed.
11933
+ * @type {boolean}
11905
11934
  * @default true
11906
11935
  */
11907
11936
  extra = true;
11908
11937
  /**
11909
- * The `FilterService` instance which is responsible for handling the changes in the filter descriptor.
11938
+ * The `FilterService` instance that handles changes in the filter descriptor.
11910
11939
  */
11911
11940
  filterService;
11912
11941
  /**
@@ -12086,7 +12115,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
12086
12115
  }] } });
12087
12116
 
12088
12117
  /**
12089
- * Represents a Boolean-filter menu component. [See example](slug:filter_menu_treelist#toc-built-in-filter-menu-components).
12118
+ * Represents the Kendo UI Boolean-filter menu component for Angular TreeList. Use this component to filter boolean fields in the TreeList. [See example](slug:filter_menu_treelist#toc-built-in-filter-menu-components).
12090
12119
  *
12091
12120
  * @example
12092
12121
  * ```html
@@ -12099,7 +12128,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
12099
12128
  * </kendo-treelist-boolean-filter-menu>
12100
12129
  * </ng-template>
12101
12130
  * </kendo-treelist-column>
12102
- * ```
12131
+ * ```
12103
12132
  */
12104
12133
  class BooleanFilterMenuComponent extends BooleanFilterComponent {
12105
12134
  /**
@@ -12115,7 +12144,7 @@ class BooleanFilterMenuComponent extends BooleanFilterComponent {
12115
12144
  */
12116
12145
  filter = { filters: [], logic: "and" };
12117
12146
  /**
12118
- * The `FilterService` instance which is responsible for handling the changes in the filter descriptor.
12147
+ * The `FilterService` instance that handles changes in the filter descriptor.
12119
12148
  */
12120
12149
  filterService;
12121
12150
  /**
@@ -12557,11 +12586,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
12557
12586
  }] } });
12558
12587
 
12559
12588
  /**
12560
- * Represents the content template of the
12561
- * [`kendo-treelist-columnmenu-item`]({% slug api_treelist_columnmenuitemcomponent %}) component.
12562
- * Provides an option for specifying the content of a column item.
12563
- * To define the content template, nest an `<ng-template>` tag with the
12564
- * `kendoTreeListColumnMenuItemContentTemplate` directive inside a `<kendo-treelist-columnmenu-item>`.
12589
+ * Represents the content template for the [`kendo-treelist-columnmenu-item`]({% slug api_treelist_columnmenuitemcomponent %}) component.
12590
+ * Use this directive to specify the content of a column menu item.
12591
+ * To define the content template, nest an `<ng-template>` tag with the `kendoTreeListColumnMenuItemContentTemplate` directive inside a `<kendo-treelist-columnmenu-item>`.
12565
12592
  *
12566
12593
  * @example
12567
12594
  * ```html
@@ -12597,8 +12624,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
12597
12624
  }] }]; } });
12598
12625
 
12599
12626
  /**
12600
- * Represents an item that can be placed inside a
12601
- * [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
12627
+ * Represents an item you can place inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
12602
12628
  *
12603
12629
  * @example
12604
12630
  * ```html
@@ -12615,25 +12641,23 @@ class ColumnMenuItemComponent {
12615
12641
  */
12616
12642
  itemClick = new EventEmitter();
12617
12643
  /**
12618
- * Fires when the content is expanded.
12644
+ * Fires when the content expands.
12619
12645
  */
12620
12646
  expand = new EventEmitter();
12621
12647
  /**
12622
- * Fires when the content is collapsed.
12648
+ * Fires when the content collapses.
12623
12649
  */
12624
12650
  collapse = new EventEmitter();
12625
12651
  /**
12626
- * Specifies the name of the [font icon](slug:icons#icons-list)
12627
- * that will be rendered for the item.
12652
+ * Sets the name of the [font icon](slug:icons#icons-list) rendered for the item.
12628
12653
  */
12629
12654
  icon;
12630
12655
  /**
12631
- * Specifies the name of the [SVG icon]({% slug svgicon_list %})
12632
- * that will be rendered for the item.
12656
+ * Sets the name of the [SVG icon]({% slug svgicon_list %}) rendered for the item.
12633
12657
  */
12634
12658
  svgIcon;
12635
12659
  /**
12636
- * Specifies the item text.
12660
+ * Sets the item text.
12637
12661
  */
12638
12662
  text;
12639
12663
  /**
@@ -12649,7 +12673,7 @@ class ColumnMenuItemComponent {
12649
12673
  */
12650
12674
  expanded;
12651
12675
  /**
12652
- * Represents the [ColumnMenuService]({% slug api_treelist_columnmenuservice %}) class.
12676
+ * Provides the [ColumnMenuService]({% slug api_treelist_columnmenuservice %}) instance.
12653
12677
  * Required to include the item in the column menu keyboard navigation sequence.
12654
12678
  */
12655
12679
  service;
@@ -12839,21 +12863,31 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
12839
12863
  /**
12840
12864
  * Represents the column-menu item for editing column filters in the TreeList.
12841
12865
  *
12842
- * The component can be placed inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
12866
+ * Render this component inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
12843
12867
  *
12844
12868
  * To register the component as a known column menu item, set the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %})
12845
- * that is passed by the template to the service input of the `kendo-treelist-columnmenu-filter` component.
12869
+ * that the template passes to the `service` input of the `kendo-treelist-columnmenu-filter` component.
12846
12870
  *
12871
+ * @example
12872
+ * ```html
12873
+ * <kendo-treelist ...>
12874
+ * <kendo-treelist-column field="ProductName">
12875
+ * <ng-template kendoTreeListColumnMenuTemplate>
12876
+ * <kendo-treelist-columnmenu-filter></kendo-treelist-columnmenu-filter>
12877
+ * </ng-template>
12878
+ * </kendo-treelist-column>
12879
+ * </kendo-treelist>
12880
+ * ```
12847
12881
  */
12848
12882
  class ColumnMenuFilterComponent extends ColumnMenuItemBase {
12849
12883
  localization;
12850
12884
  hostElement;
12851
12885
  /**
12852
- * Fires when the content is expanded.
12886
+ * Fires when the content expands.
12853
12887
  */
12854
12888
  expand = new EventEmitter();
12855
12889
  /**
12856
- * Fires when the content is collapsed.
12890
+ * Fires when the content collapses.
12857
12891
  */
12858
12892
  collapse = new EventEmitter();
12859
12893
  /**
@@ -13387,12 +13421,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
13387
13421
  }] } });
13388
13422
 
13389
13423
  /**
13390
- * Represents the column-menu item for selecting columns in the TreeList. [See example](slug:columnmenu_treelist#toc-column-chooser-item).
13391
13424
  *
13392
- * The component can be placed inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
13425
+ * Represents the Kendo UI for Angular TreeList column-menu item for chaging the visibility of the columns. [See example](slug:columnmenu_treelist#toc-column-chooser-item).
13393
13426
  *
13394
- * To register the component as a known column menu item, set the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %})
13395
- * that is passed by the template to the service input of the `kendo-treelist-columnmenu-chooser` component.
13427
+ * Place this component inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive to enable the feature.
13428
+ * Set the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %}) and `column` inputs using the values passed by the template.
13429
+ *
13430
+ * @example
13431
+ * ```html
13432
+ * <kendo-treelist [columnMenu]="true" ...>
13433
+ * <ng-template kendoTreeListColumnMenuTemplate let-service="service" let-column="column">
13434
+ * <kendo-treelist-columnmenu-chooser [column]="column" [service]="service">
13435
+ * </kendo-treelist-columnmenu-chooser>
13436
+ * </ng-template>
13437
+ * </kendo-treelist>
13438
+ * ```
13396
13439
  */
13397
13440
  class ColumnMenuChooserComponent extends ColumnMenuItemBase {
13398
13441
  localization;
@@ -13400,11 +13443,11 @@ class ColumnMenuChooserComponent extends ColumnMenuItemBase {
13400
13443
  changeDetector;
13401
13444
  hostElement;
13402
13445
  /**
13403
- * Fires when the content is expanded.
13446
+ * Fires when the content expands.
13404
13447
  */
13405
13448
  expand = new EventEmitter();
13406
13449
  /**
13407
- * Fires when the content is collapsed.
13450
+ * Fires when the content collapses.
13408
13451
  */
13409
13452
  collapse = new EventEmitter();
13410
13453
  /**
@@ -13528,13 +13571,23 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
13528
13571
  }] } });
13529
13572
 
13530
13573
  /**
13531
- * Represents the column-menu item that allows the user to lock or unlock columns.
13574
+ * Represents the column-menu item that lets you lock or unlock columns.
13532
13575
  *
13533
- * The componnt can be placed inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
13576
+ * Render this component inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
13534
13577
  *
13535
- * To register the component as a known column menu item, set the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %})
13536
- * that is passed by the template to the service input of the `kendo-treelist-columnmenu-lock` component.
13578
+ * To register the component as a known column menu item, set the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %})
13579
+ * that the template passes to the `service` input of the `kendo-treelist-columnmenu-lock` component.
13537
13580
  *
13581
+ * @example
13582
+ * ```html
13583
+ * <kendo-treelist ...>
13584
+ * <kendo-treelist-column field="ProductName">
13585
+ * <ng-template kendoTreeListColumnMenuTemplate>
13586
+ * <kendo-treelist-columnmenu-lock></kendo-treelist-columnmenu-lock>
13587
+ * </ng-template>
13588
+ * </kendo-treelist-column>
13589
+ * </kendo-treelist>
13590
+ * ```
13538
13591
  */
13539
13592
  class ColumnMenuLockComponent extends ColumnMenuItemBase {
13540
13593
  localization;
@@ -13620,11 +13673,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
13620
13673
  /**
13621
13674
  * Represents the column-menu item for sorting TreeList columns.
13622
13675
  *
13623
- * The component can be placed inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
13676
+ * Render this component inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
13624
13677
  *
13625
13678
  * To register the component as a known column menu item, set the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %})
13626
- * that is passed by the template to the service input of the `kendo-treelist-columnmenu-sort` component.
13679
+ * that the template passes to the `service` input of the `kendo-treelist-columnmenu-sort` component.
13627
13680
  *
13681
+ * @example
13682
+ * ```html
13683
+ * <kendo-treelist ...>
13684
+ * <kendo-treelist-column field="ProductName">
13685
+ * <ng-template kendoTreeListColumnMenuTemplate>
13686
+ * <kendo-treelist-columnmenu-sort></kendo-treelist-columnmenu-sort>
13687
+ * </ng-template>
13688
+ * </kendo-treelist-column>
13689
+ * </kendo-treelist>
13690
+ * ```
13628
13691
  */
13629
13692
  class ColumnMenuSortComponent extends ColumnMenuItemBase {
13630
13693
  localization;
@@ -13709,12 +13772,34 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
13709
13772
  }]
13710
13773
  }], ctorParameters: function () { return [{ type: i1$1.LocalizationService }, { type: SortService }]; } });
13711
13774
 
13775
+ /**
13776
+ * Provides keyboard navigation support for TreeList column menu items.
13777
+ * Use this directive to manage focus and tab order for custom column menu items. [See example](slug:columnmenu_treelist#customizing-the-content).
13778
+ *
13779
+ * @example
13780
+ * ```html
13781
+ * <ng-template kendoTreelistColumnMenuTemplate let-service="service" let-column="column">
13782
+ * <kendo-treelist-columnmenu-sort #sortItem [kendoTreeListColumnMenuItem]="sortItem" [service]="service">
13783
+ * </kendo-treelist-columnmenu-sort>
13784
+ * </ng-template>
13785
+ * ```
13786
+ * @remarks
13787
+ * Applied to:
13788
+ * {@link ColumnMenuChooserComponent},
13789
+ * {@link ColumnMenuFilterComponent},
13790
+ * {@link ColumnMenuSortComponent},
13791
+ * {@link ColumnMenuLockComponent},
13792
+ * {@link ColumnMenuComponent},
13793
+ * {@link ColumnMenuItemComponent},
13794
+ * {@link ColumnMenuAutoSizeAllColumnsComponent},
13795
+ * {@link ColumnMenuAutoSizeColumnComponent}.
13796
+ */
13712
13797
  class ColumnMenuItemDirective {
13713
13798
  hostElement;
13714
13799
  renderer;
13715
13800
  ngZone;
13716
13801
  /**
13717
- * The reference to the TreeList column menu item. Required to include the item in the built-in keyboard navigation.
13802
+ * Provides a reference to the TreeList column menu item. Required for built-in keyboard navigation.
13718
13803
  */
13719
13804
  menuItemComponent;
13720
13805
  firstFocusableElement;
@@ -13875,12 +13960,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
13875
13960
  }] } });
13876
13961
 
13877
13962
  /**
13878
- * Represents the column-menu item for resizing all columns to the minimum possible width so that they fit the widest header or cell content without wrapping.
13879
- * [See example](slug:columnmenu_treelist#toc-autosize-all-columns-item).
13963
+ * Represents the Kendo UI TreeList column-menu item for resizing all columns to fit the widest header or cell content without wrapping. [See example](slug:columnmenu_treelist#toc-autosize-all-columns-item).
13880
13964
  *
13881
- * The component can be placed inside a [ColumnMenuTemplate]({% slug api_treelist_columnmenutemplatedirective %}) directive.
13882
- * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_treelist_columnmenuservice %}) that is passed by
13883
- * the template to the `service` input of the `kendo-treelist-columnmenu-autosize-all-columns` component. [See example](slug:columnmenu_treelist#toc-customizing-the-content).
13965
+ * Place this component inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive to enable the feature.
13966
+ * Register the component as a known column menu item by setting the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %}) to the `service` input. [See example](slug:columnmenu_treelist#toc-customizing-the-content).
13884
13967
  *
13885
13968
  * @example
13886
13969
  * ```html
@@ -13941,12 +14024,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
13941
14024
  }], ctorParameters: function () { return [{ type: ContextService }]; } });
13942
14025
 
13943
14026
  /**
13944
- * Represents the column-menu item for resizing the specified column to the minimum possible width so that it fits the header or cell content without wrapping.
13945
- * The component can be placed inside a [ColumnMenuTemplate]({% slug api_treelist_columnmenutemplatedirective %}) directive.
13946
- * [See example](slug:columnmenu_treelist#toc-customizing-the-content).
14027
+ * Represents the Kendo UI for Angular TreeList column-menu item for resizing a specified column to fit the header or cell content without wrapping. [See example](slug:columnmenu_treelist#toc-customizing-the-content).
13947
14028
  *
13948
- * You have to set the [ColumnMenuService]({% slug api_treelist_columnmenuservice %}) and `column` that are passed by
13949
- * the template to the `service` and `column` input of the `kendo-treelist-columnmenu-autosize-column` component.
14029
+ * Place this component inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive to enable the feature.
14030
+ * Set the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %}) and `column` inputs using the values passed by the template.
13950
14031
  *
13951
14032
  * @example
13952
14033
  * ```html
@@ -13961,7 +14042,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
13961
14042
  class ColumnMenuAutoSizeColumnComponent extends ColumnMenuItemBase {
13962
14043
  ctx;
13963
14044
  /**
13964
- * The TreeList column instance which will be resized through the auto size column option.
14045
+ * The TreeList column instance to resize with the auto size column option.
13965
14046
  */
13966
14047
  column;
13967
14048
  maxWidthIcon = maxWidthIcon;
@@ -13976,7 +14057,7 @@ class ColumnMenuAutoSizeColumnComponent extends ColumnMenuItemBase {
13976
14057
  }
13977
14058
  }
13978
14059
  /**
13979
- * Resizes a specified column to the minimum possible width so that it fits the widest header or cell content without wrapping.
14060
+ * Resizes the specified column to the minimum possible width so that it fits the widest header or cell content without wrapping.
13980
14061
  */
13981
14062
  autoSizeColumn() {
13982
14063
  autoSizeColumn(this.ctx.treelist, this.service, this.column);
@@ -14019,6 +14100,18 @@ let id$1 = 0;
14019
14100
  const getId$1 = (gridId) => `${gridId}-column-menu-${id$1++}`;
14020
14101
  /**
14021
14102
  * Represents the [column menu]({% slug columnmenu_treelist %}) component of the TreeList.
14103
+ * Use this component to display and manage column menu options for a TreeList column.
14104
+ *
14105
+ * @example
14106
+ * ```html
14107
+ * <kendo-treelist ...>
14108
+ * <kendo-treelist-column field="ProductName">
14109
+ * <ng-template kendoTreeListColumnMenuTemplate let-service="service" let-column="column">
14110
+ * <kendo-treelist-column-menu [column]="column"></kendo-treelist-column-menu>
14111
+ * </ng-template>
14112
+ * </kendo-treelist-column>
14113
+ * </kendo-treelist>
14114
+ * ```
14022
14115
  */
14023
14116
  class ColumnMenuComponent {
14024
14117
  navigationService;
@@ -14044,12 +14137,12 @@ class ColumnMenuComponent {
14044
14137
  */
14045
14138
  settings = {};
14046
14139
  /**
14047
- * The descriptors by which the data will be sorted.
14140
+ * The descriptors by which the data is sorted.
14048
14141
  * Typically bound to the same value as [TreeListComponent.sort]({% slug api_treelist_treelistcomponent %}#toc-sort).
14049
14142
  */
14050
14143
  sort;
14051
14144
  /**
14052
- * The descriptor by which the data will be filtered.
14145
+ * The descriptor by which the data is filtered.
14053
14146
  * Typically bound to the same value as [TreeListComponent.filter]({% slug api_treelist_treelistcomponent %}#toc-filter).
14054
14147
  */
14055
14148
  filter;
@@ -16223,12 +16316,39 @@ const isInEditedCell = (element, treelistElement) => closest(element, matchesCla
16223
16316
  closest(element, matchesNodeName('kendo-treelist')) === treelistElement;
16224
16317
  /**
16225
16318
  * Represents the Kendo UI TreeList component for Angular.
16319
+ * Use this component to display and manage hierarchical data in a tabular format.
16226
16320
  *
16227
16321
  * @example
16228
16322
  * ```html
16229
- * <kendo-treelist [kendoTreeListFlatBinding]="data" ...></kendo-treelist>
16323
+ * <kendo-treelist
16324
+ * [kendoTreeListFlatBinding]="data"
16325
+ * [pageSize]="10"
16326
+ * [pageable]="true">
16327
+ * </kendo-treelist>
16230
16328
  * ```
16231
16329
  *
16330
+ * @remarks
16331
+ * Supported children components are:
16332
+ * {@link CheckboxColumnComponent},
16333
+ * {@link ColumnChooserComponent},
16334
+ * {@link ColumnComponent},
16335
+ * {@link ColumnGroupComponent},
16336
+ * {@link ColumnMenuAutoSizeAllColumnsComponent},
16337
+ * {@link ColumnMenuAutoSizeColumnComponent},
16338
+ * {@link ColumnMenuChooserComponent},
16339
+ * {@link ColumnMenuComponent},
16340
+ * {@link ColumnMenuFilterComponent},
16341
+ * {@link ColumnMenuItemComponent},
16342
+ * {@link ColumnMenuLockComponent},
16343
+ * {@link ColumnMenuSortComponent},
16344
+ * {@link CommandColumnComponent},
16345
+ * {@link CustomMessagesComponent},
16346
+ * {@link ExcelComponent},
16347
+ * {@link TreeListSpacerComponent},
16348
+ * {@link PDFComponent},
16349
+ * {@link RowReorderColumnComponent},
16350
+ * {@link SpanColumnComponent},
16351
+ * {@link ToolBarComponent}.
16232
16352
  */
16233
16353
  class TreeListComponent {
16234
16354
  supportService;
@@ -16257,11 +16377,11 @@ class TreeListComponent {
16257
16377
  ctx;
16258
16378
  rowReorderService;
16259
16379
  /**
16260
- * An optional accessible description of the component.
16380
+ * Provides an accessible description of the component.
16261
16381
  */
16262
16382
  ariaLabel;
16263
16383
  /**
16264
- * Sets the data of the TreeList. If an array is provided, the TreeList automatically gets the total count
16384
+ * Sets the data for the TreeList. When you provide an array, the TreeList gets the total count automatically
16265
16385
  * ([more information and example]({% slug databinding_treelist %})).
16266
16386
  */
16267
16387
  set data(value) {
@@ -16280,26 +16400,26 @@ class TreeListComponent {
16280
16400
  return this.loadedData;
16281
16401
  }
16282
16402
  /**
16283
- * Defines the page size used by the TreeList when [paging]({% slug paging_treelist %}) is enabled.
16403
+ * Sets the page size for the TreeList when [paging]({% slug paging_treelist %}) is enabled.
16284
16404
  *
16285
16405
  * @default 10
16286
16406
  */
16287
16407
  pageSize = 10;
16288
16408
  /**
16289
- * Defines the height (in pixels) that is used when the `scrollable` option of the TreeList is set.
16290
- * To set the height of the TreeList, you can also use `style.height`. The `style.height`
16409
+ * Sets the height in pixels for the TreeList when you set the `scrollable` option.
16410
+ * You can also use `style.height` to set the height. The `style.height`
16291
16411
  * option supports units such as `px`, `%`, `em`, `rem`, and others.
16292
16412
  */
16293
16413
  height;
16294
16414
  /**
16295
- * Represent the actual height of each TreeList row (`tr`) element in the DOM.
16296
- * Required by the [virtual scrolling functionality]({% slug scrollmmodes_treelist %}).
16297
- * Set the `rowHeight` option to the exact pixels as the height of the `tr` element appears in the DOM.
16415
+ * Sets the actual height of each TreeList row (`tr`) element in the DOM.
16416
+ * The [virtual scrolling functionality]({% slug scrollmmodes_treelist %}) requires this setting.
16417
+ * Set the `rowHeight` option to match the exact pixel height of the `tr` element in the DOM.
16298
16418
  */
16299
16419
  rowHeight;
16300
16420
  /**
16301
- * Defines the number of records to be skipped by the pager.
16302
- * Required by the [paging]({% slug paging_treelist %}) functionality.
16421
+ * Sets the number of records that the pager skips.
16422
+ * The [paging]({% slug paging_treelist %}) functionality requires this setting.
16303
16423
  */
16304
16424
  get skip() {
16305
16425
  return this._skip;
@@ -16311,12 +16431,13 @@ class TreeListComponent {
16311
16431
  }
16312
16432
  }
16313
16433
  /**
16314
- * Defines the scroll mode used by the TreeList.
16434
+ * Sets the scroll mode for the TreeList.
16435
+ *
16315
16436
  * @default 'scrollable'
16316
16437
  */
16317
16438
  scrollable = 'scrollable';
16318
16439
  /**
16319
- * The descriptors by which the data will be sorted ([see example]({% slug sorting_treelist %})).
16440
+ * Sets the descriptors for sorting the data ([see example]({% slug sorting_treelist %})).
16320
16441
  */
16321
16442
  set sort(value) {
16322
16443
  if (isArray(value)) {
@@ -16327,19 +16448,19 @@ class TreeListComponent {
16327
16448
  return this._sort;
16328
16449
  }
16329
16450
  /**
16330
- * A function that defines how to track changes for the data rows.
16451
+ * Sets a function that defines how to track changes for the data rows.
16331
16452
  *
16332
16453
  * By default, the TreeList tracks changes by the index of the data item.
16333
- * Edited rows are tracked by reference.
16334
- *
16454
+ * The TreeList tracks edited rows by reference.
16335
16455
  */
16336
16456
  trackBy = defaultTrackBy;
16337
16457
  /**
16338
- * The descriptor by which the data will be filtered ([see examples]({% slug filtering_treelist %})).
16458
+ * Sets the descriptor for filtering the data ([see examples]({% slug filtering_treelist %})).
16339
16459
  */
16340
16460
  filter;
16341
16461
  /**
16342
- * If set to `true`, the treelist will render only the columns in the current viewport.
16462
+ * When set to `true`, the TreeList renders only the columns in the current viewport.
16463
+ *
16343
16464
  * @default false
16344
16465
  */
16345
16466
  virtualColumns = false;
@@ -16404,40 +16525,44 @@ class TreeListComponent {
16404
16525
  return this.selectionService.enableMarquee;
16405
16526
  }
16406
16527
  /**
16407
- * Enables the [filtering]({% slug filtering_treelist %}) of the TreeList columns that have their `field` option set.
16528
+ * Enables the [filtering]({% slug filtering_treelist %}) of TreeList columns that have their `field` option set.
16529
+ *
16530
+ * @default false
16408
16531
  */
16409
16532
  filterable = false;
16410
16533
  /**
16411
- * Enables the [sorting]({% slug sorting_treelist %}) of the TreeList columns that have their `field` option set.
16534
+ * Enables the [sorting]({% slug sorting_treelist %}) of TreeList columns that have their `field` option set.
16535
+ *
16536
+ * @default false
16412
16537
  */
16413
16538
  sortable = false;
16414
16539
  /**
16415
- * Configures the pager of the TreeList ([see example]({% slug paging_treelist %})).
16540
+ * Configures the pager for the TreeList ([see example]({% slug paging_treelist %})).
16416
16541
  *
16542
+ * @default false
16417
16543
  */
16418
16544
  pageable = false;
16419
16545
  get normalizedPageableSettings() {
16420
16546
  return normalize(this.pageable);
16421
16547
  }
16422
16548
  /**
16423
- * When the keyboard navigation is enabled, the user can use dedicated shortcuts to interact with the Grid.
16424
- * By default, navigation is enabled. To disable it altogether, and include the TreeList content in the normal tab sequence, set the property to `false`.
16549
+ * When keyboard navigation is enabled, you can use dedicated shortcuts to interact with the TreeList.
16550
+ * By default, navigation is enabled. To disable it and include the TreeList content in the normal tab sequence, set this property to `false`.
16551
+ *
16425
16552
  * @default true
16426
16553
  */
16427
16554
  navigable = true;
16428
16555
  /**
16429
- * Indicates whether the TreeList columns will be resized during initialization so that
16430
- * they fit their headers and row content. Defaults to `false`.
16556
+ * Determines whether TreeList columns resize during initialization to fit their headers and row content.
16431
16557
  * Columns with `autoSize` set to `false` are excluded.
16432
- * To dynamically update the column width to match the new content,
16558
+ * To dynamically update the column width to match new content,
16433
16559
  * refer to [this example]({% slug resizing_columns_treelist %}).
16434
16560
  *
16435
16561
  * @default false
16436
16562
  */
16437
16563
  autoSize = false;
16438
16564
  /**
16439
- * Defines a function that is executed for every data row in the component.
16440
- *
16565
+ * A function executed for every data row in the component. It should return a string that will be used as a CSS class for the row.
16441
16566
  */
16442
16567
  set rowClass(fn) {
16443
16568
  if (typeof fn !== 'function') {
@@ -16455,39 +16580,39 @@ class TreeListComponent {
16455
16580
  return this.navigationService.activeCell;
16456
16581
  }
16457
16582
  /**
16458
- * Returns the currently focused row (if any).
16583
+ * Gets the currently focused row (if any).
16459
16584
  */
16460
16585
  get activeRow() {
16461
16586
  return this.navigationService.activeRow;
16462
16587
  }
16463
16588
  /**
16464
- * If set to `true`, the user can resize columns by dragging the edges (resize handles) of their header cells
16589
+ * When set to `true`, you can resize columns by dragging the edges (resize handles) of their header cells
16465
16590
  * ([see example]({% slug resizing_columns_treelist %})).
16466
16591
  *
16467
16592
  * @default false
16468
16593
  */
16469
16594
  resizable = false;
16470
16595
  /**
16471
- * If set to `true`, the user can reorder columns by dragging their header cells
16596
+ * When set to `true`, you can reorder columns by dragging their header cells
16472
16597
  * ([see example]({% slug reordering_columns_treelist %})).
16473
16598
  *
16474
16599
  * @default false
16475
16600
  */
16476
16601
  reorderable = false;
16477
16602
  /**
16478
- * Specifies if the loading indicator of the TreeList will be displayed ([see example]({% slug databinding_treelist %})).
16603
+ * Determines whether the TreeList displays the loading indicator ([see example]({% slug databinding_treelist %})).
16479
16604
  *
16480
16605
  * @default false
16481
16606
  */
16482
16607
  loading = false;
16483
16608
  /**
16484
- * Specifies if the column menu of the columns will be displayed ([see example]({% slug columnmenu_treelist %})).
16609
+ * Determines whether the column menu of the columns displays ([see example]({% slug columnmenu_treelist %})).
16485
16610
  *
16486
16611
  * @default false
16487
16612
  */
16488
16613
  columnMenu = false;
16489
16614
  /**
16490
- * Specifies if the header of the treelist will be hidden. The header is visible by default.
16615
+ * Determines whether the TreeList hides the header. The header is visible by default.
16491
16616
  *
16492
16617
  * The header includes column headers and the [filter row](slug:filter_row_treelist).
16493
16618
  *
@@ -16495,7 +16620,7 @@ class TreeListComponent {
16495
16620
  */
16496
16621
  hideHeader = false;
16497
16622
  /**
16498
- * The name of the field which contains the unique identifier of the node.
16623
+ * Sets the name of the field that contains the unique identifier of the node.
16499
16624
  *
16500
16625
  * @default "id"
16501
16626
  */
@@ -16509,13 +16634,13 @@ class TreeListComponent {
16509
16634
  this.editService.idGetter = this.idGetter;
16510
16635
  }
16511
16636
  /**
16512
- * Specified the treelist selection settings
16637
+ * Sets the TreeList selection settings.
16513
16638
  */
16514
16639
  set selectable(value) {
16515
16640
  this.selectionService.settings = value;
16516
16641
  }
16517
16642
  /**
16518
- * Provides a callback that determines if the given row or cell is selected.
16643
+ * Sets a callback that determines if the given row or cell is selected.
16519
16644
  */
16520
16645
  set isSelected(value) {
16521
16646
  if (typeof value !== 'function' && isDevMode()) {
@@ -16525,6 +16650,7 @@ class TreeListComponent {
16525
16650
  }
16526
16651
  /**
16527
16652
  * Enables the [row reordering]({% slug treelist_row_reordering %}) of the TreeList.
16653
+ *
16528
16654
  * @default false
16529
16655
  */
16530
16656
  set rowReorderable(value) {
@@ -16545,102 +16671,102 @@ class TreeListComponent {
16545
16671
  return this._rowReorderable;
16546
16672
  }
16547
16673
  /**
16548
- * Fires when the TreeList selection is changed.
16674
+ * Fires when the TreeList selection changes.
16549
16675
  */
16550
16676
  selectionChange = new EventEmitter();
16551
16677
  /**
16552
- * Fires when the TreeList filter is modified through the UI.
16553
- * You have to handle the event yourself and filter the data.
16678
+ * Fires when you modify the TreeList filter through the UI.
16679
+ * You have to handle the event and filter the data.
16554
16680
  */
16555
16681
  filterChange = new EventEmitter();
16556
16682
  /**
16557
- * Fires when the page of the TreeList is changed ([see example]({% slug paging_treelist %})).
16558
- * You have to handle the event yourself and page the data.
16683
+ * Fires when the page of the TreeList changes ([see example]({% slug paging_treelist %})).
16684
+ * You have to handle the event and page the data.
16559
16685
  */
16560
16686
  pageChange = new EventEmitter();
16561
16687
  /**
16562
- * Fires when the sorting of the TreeList is changed ([see example]({% slug sorting_treelist %})).
16563
- * You have to handle the event yourself and sort the data.
16688
+ * Fires when the sorting of the TreeList changes ([see example]({% slug sorting_treelist %})).
16689
+ * You have to handle the event and sort the data.
16564
16690
  */
16565
16691
  sortChange = new EventEmitter();
16566
16692
  /**
16567
- * Fires when the data state of the TreeList is changed.
16693
+ * Fires when the data state of the TreeList changes.
16568
16694
  */
16569
16695
  dataStateChange = new EventEmitter();
16570
16696
  /**
16571
- * Fires when the user clicks the **Edit** command button to edit a row
16697
+ * Fires when you click the **Edit** command button to edit a row
16572
16698
  * ([see example]({% slug editing_template_forms_treelist %}#toc-editing-records)).
16573
16699
  */
16574
16700
  edit = new EventEmitter();
16575
16701
  /**
16576
- * Fires when the user clicks the **Cancel** command button to close a row
16702
+ * Fires when you click the **Cancel** command button to close a row
16577
16703
  * ([see example]({% slug editing_template_forms_treelist %}#toc-cancelling-editing)).
16578
16704
  */
16579
16705
  cancel = new EventEmitter();
16580
16706
  /**
16581
- * Fires when the user clicks the **Save** command button to save changes in a row
16707
+ * Fires when you click the **Save** command button to save changes in a row
16582
16708
  * ([see example]({% slug editing_template_forms_treelist %}#toc-saving-records)).
16583
16709
  */
16584
16710
  save = new EventEmitter();
16585
16711
  /**
16586
- * Fires when the user clicks the **Remove** command button to remove a row
16712
+ * Fires when you click the **Remove** command button to remove a row
16587
16713
  * ([see example]({% slug editing_template_forms_treelist %}#toc-removing-records)).
16588
16714
  */
16589
16715
  remove = new EventEmitter();
16590
16716
  /**
16591
- * Fires when the user clicks the **Add** command button to add a new row
16717
+ * Fires when you click the **Add** command button to add a new row
16592
16718
  * ([see example]({% slug editing_template_forms_treelist %}#toc-adding-records)).
16593
16719
  */
16594
16720
  add = new EventEmitter();
16595
16721
  /**
16596
- * Fires when the user leaves an edited cell ([see example]({% slug editing_incell_treelist %}#toc-basic-concepts)).
16722
+ * Fires when you leave an edited cell ([see example]({% slug editing_incell_treelist %}#toc-basic-concepts)).
16597
16723
  */
16598
16724
  cellClose = new EventEmitter();
16599
16725
  /**
16600
- * Fires when the user clicks a cell ([see example]({% slug editing_incell_treelist %}#toc-basic-concepts)).
16726
+ * Fires when you click a cell ([see example]({% slug editing_incell_treelist %}#toc-basic-concepts)).
16601
16727
  */
16602
16728
  cellClick = new EventEmitter();
16603
16729
  /**
16604
- * Fires when the user clicks the **Export to PDF** command button.
16730
+ * Fires when you click the **Export to PDF** command button.
16605
16731
  */
16606
16732
  pdfExport = new EventEmitter();
16607
16733
  /**
16608
- * Fires when the user clicks the **Export to Excel** command button.
16734
+ * Fires when you click the **Export to Excel** command button.
16609
16735
  */
16610
16736
  excelExport = new EventEmitter();
16611
16737
  /**
16612
- * Fires when the user completes the resizing of the column.
16738
+ * Fires when you complete the resizing of the column.
16613
16739
  */
16614
16740
  columnResize = new EventEmitter();
16615
16741
  /**
16616
- * Fires when the user completes the reordering of the column.
16742
+ * Fires when you complete the reordering of the column.
16617
16743
  */
16618
16744
  columnReorder = new EventEmitter();
16619
16745
  /**
16620
- * Fires when the user changes the visibility of the columns from the column menu or column chooser.
16746
+ * Fires when you change the visibility of the columns from the column menu or column chooser.
16621
16747
  */
16622
16748
  columnVisibilityChange = new EventEmitter();
16623
16749
  /**
16624
- * Fires when the user changes the locked state of the columns from the column menu or by reordering the columns.
16750
+ * Fires when you change the locked state of the columns from the column menu or by reordering the columns.
16625
16751
  */
16626
16752
  columnLockedChange = new EventEmitter();
16627
16753
  /**
16628
- * Fires when the user scrolls to the last record on the page and enables endless scrolling
16754
+ * Fires when you scroll to the last record on the page and enables endless scrolling
16629
16755
  * ([see example]({% slug scrollmmodes_treelist %}#toc-endless-scrolling)).
16630
- * You have to handle the event yourself and page the data.
16756
+ * You have to handle the event and page the data.
16631
16757
  */
16632
16758
  scrollBottom = new EventEmitter();
16633
16759
  /**
16634
- * Fires when the treelist content is scrolled.
16635
- * For performance reasons, the event is triggered outside the Angular zone. Enter the Angular zone if you make any changes that require change detection.
16760
+ * Fires when the TreeList content scrolls.
16761
+ * For performance reasons, the event triggers outside the Angular zone. Enter the Angular zone if you make any changes that require change detection.
16636
16762
  */
16637
16763
  contentScroll = new EventEmitter();
16638
16764
  /**
16639
- * Fires when an item is expanded.
16765
+ * Fires when an item expands.
16640
16766
  */
16641
16767
  expandEvent = new EventEmitter();
16642
16768
  /**
16643
- * Fires when an item is collapsed.
16769
+ * Fires when an item collapses.
16644
16770
  */
16645
16771
  collapseEvent = new EventEmitter();
16646
16772
  /**
@@ -16651,7 +16777,7 @@ class TreeListComponent {
16651
16777
  */
16652
16778
  expandStateChange = new EventEmitter();
16653
16779
  /**
16654
- * Fires when the user drops the dragged row and reordering is performed.
16780
+ * Fires when you drop the dragged row and reordering occurs.
16655
16781
  * Emits the [RowReorderEvent]({% slug api_treelist_rowreorderevent %}).
16656
16782
  */
16657
16783
  rowReorder = new EventEmitter();
@@ -16823,7 +16949,7 @@ class TreeListComponent {
16823
16949
  return this.view.totalRows;
16824
16950
  }
16825
16951
  /**
16826
- * Gets or sets the callback function that retrieves the child nodes for a particular node.
16952
+ * Sets or gets the callback function that retrieves the child nodes for a particular node.
16827
16953
  */
16828
16954
  set fetchChildren(value) {
16829
16955
  this._fetchChildren = value;
@@ -16832,7 +16958,7 @@ class TreeListComponent {
16832
16958
  return this._fetchChildren;
16833
16959
  }
16834
16960
  /**
16835
- * Gets or sets the callback function that indicates if a particular node has child nodes.
16961
+ * Sets or gets the callback function that determines if a particular node has child nodes.
16836
16962
  */
16837
16963
  set hasChildren(value) {
16838
16964
  this._hasChildren = value;
@@ -16841,7 +16967,7 @@ class TreeListComponent {
16841
16967
  return this._hasChildren;
16842
16968
  }
16843
16969
  /**
16844
- * Sets the callback function that indicates if a particular item is expanded.
16970
+ * Sets the callback function that determines if a particular item is expanded.
16845
16971
  */
16846
16972
  set isExpanded(value) {
16847
16973
  this.expandStateService.isExpanded = value || defaultExpanded;
@@ -17138,12 +17264,14 @@ class TreeListComponent {
17138
17264
  }
17139
17265
  }
17140
17266
  /**
17141
- * Switches the specified table row in the edit mode ([see example]({% slug editing_template_forms_treelist %}#toc-editing-records)).
17267
+ * Switches the specified table row to edit mode ([see example]({% slug editing_template_forms_treelist %}#toc-editing-records)).
17142
17268
  *
17143
- * @param dataItem - The data item that will be edited.
17269
+ * @param dataItem The data item that you will edit.
17144
17270
  * @param group - The [`FormGroup`](link:site.data.urls.angular['formgroupapi'])
17145
17271
  * that describes the edit form.
17146
- * @param options - Additional options. Use `skipFocus` to determine if the row's edit element should be focused. Defaults to `false`.
17272
+ * @param options Additional options. Use `skipFocus` to determine if the edit element of the row should receive focus.
17273
+ *
17274
+ * @default false
17147
17275
  */
17148
17276
  editRow(dataItem, group, options) {
17149
17277
  this.editService.editRow(dataItem, group);
@@ -17159,8 +17287,8 @@ class TreeListComponent {
17159
17287
  /**
17160
17288
  * Closes the editor for a given row ([see example]({% slug editing_template_forms_treelist %}#toc-cancelling-editing)).
17161
17289
  *
17162
- * @param {any} dataItem - The dataItem that will be switched out of the edit mode.
17163
- * @param {boolean} isNew - Indicates whether the dataItem is new.
17290
+ * @param dataItem The data item that you will switch out of edit mode.
17291
+ * @param isNew Determines whether the data item is new.
17164
17292
  */
17165
17293
  closeRow(dataItem, isNew) {
17166
17294
  this.editService.close(dataItem, isNew);
@@ -17175,8 +17303,8 @@ class TreeListComponent {
17175
17303
  /**
17176
17304
  * Creates a new row editor ([see example]({% slug editing_template_forms_treelist %}#toc-adding-records)).
17177
17305
  *
17178
- * @param {FormGroup} group - The [`FormGroup`](link:site.data.urls.angular['formgroupapi']) that describes
17179
- * the edit form. If called with a data item, it will build the `FormGroup` from the data item fields.
17306
+ * @param group The [`FormGroup`](link:site.data.urls.angular['formgroupapi']) that describes
17307
+ * the edit form. If called with a data item, it builds the `FormGroup` from the data item fields.
17180
17308
  */
17181
17309
  addRow(group, parent) {
17182
17310
  const isFormGroup = group instanceof FormGroup;
@@ -17202,11 +17330,11 @@ class TreeListComponent {
17202
17330
  });
17203
17331
  }
17204
17332
  /**
17205
- * Puts the cell that is specified by the table row and column in edit mode.
17333
+ * Puts the cell that you specify by the table row and column in edit mode.
17206
17334
  *
17207
- * @param {any} dataItem - The data item that will be edited.
17208
- * @param {number|string|any} column - The leaf column index, or the field name or the column instance that should be edited.
17209
- * @param {FormGroup} group - The [`FormGroup`](link:site.data.urls.angular['formgroupapi'])
17335
+ * @param dataItem The data item that you will edit.
17336
+ * @param column The leaf column index, or the field name or the column instance that should be edited.
17337
+ * @param group The [`FormGroup`](link:site.data.urls.angular['formgroupapi'])
17210
17338
  * that describes the edit form.
17211
17339
  */
17212
17340
  editCell(dataItem, column, group) {
@@ -17220,9 +17348,8 @@ class TreeListComponent {
17220
17348
  * Closes the current cell in edit mode and fires
17221
17349
  * the [`cellClose`]({% slug api_treelist_treelistcomponent %}#toc-cellclose) event.
17222
17350
  *
17223
- * @return {boolean} Indicates whether the edited cell was closed.
17224
- * A `false` value indicates that the
17225
- * [`cellClose`]({% slug api_treelist_treelistcomponent %}#toc-cellclose) event was prevented.
17351
+ * @return {boolean} A Boolean value that indicates whether the edited cell closed.
17352
+ * A `false` value indicates that the [`cellClose`]({% slug api_treelist_treelistcomponent %}#toc-cellclose) event was prevented.
17226
17353
  */
17227
17354
  closeCell() {
17228
17355
  return !this.editService.closeCell();
@@ -17235,23 +17362,23 @@ class TreeListComponent {
17235
17362
  this.view.updateEditedState();
17236
17363
  }
17237
17364
  /**
17238
- * Returns a flag which indicates if a row or a cell is currently edited.
17365
+ * Gets a flag that indicates if a row or a cell is currently edited.
17239
17366
  *
17240
- * @return {boolean} A flag which indicates if a row or a cell is currently edited.
17367
+ * @return {boolean} A Boolean flag that indicates if a row or a cell is currently edited.
17241
17368
  */
17242
17369
  isEditing() {
17243
17370
  return this.editService.isEditing();
17244
17371
  }
17245
17372
  /**
17246
- * Returns a flag which indicates if a cell is currently edited.
17373
+ * Gets a flag that indicates if a cell is currently edited.
17247
17374
  *
17248
- * @return {boolean} A flag which indicates if a cell is currently being edited.
17375
+ * @return {boolean} A Boolean flag that indicates if a cell is currently being edited.
17249
17376
  */
17250
17377
  isEditingCell() {
17251
17378
  return this.editService.isEditing() && this.editService.isEditingCell();
17252
17379
  }
17253
17380
  /**
17254
- * Initiates the PDF export ([see example]({% slug pdfexport_treelist %})).
17381
+ * Starts the PDF export ([see example]({% slug pdfexport_treelist %})).
17255
17382
  */
17256
17383
  saveAsPDF() {
17257
17384
  this.pdfService.save(this);
@@ -17260,7 +17387,7 @@ class TreeListComponent {
17260
17387
  * Exports the TreeList element to a Drawing [`Group`]({% slug api_kendo-drawing_group %}) by using the `kendo-treelist-pdf` component options.
17261
17388
  * ([see example]({% slug pdfexport_treelist %}#toc-exporting-multiple-treelists-to-the-same-pdf)).
17262
17389
  *
17263
- * @return {Promise} A promise that will be resolved with the Drawing `Group`.
17390
+ * @return {Promise} A promise that resolves with the Drawing `Group`.
17264
17391
  */
17265
17392
  drawPDF() {
17266
17393
  const promise = createPromise();
@@ -17268,7 +17395,7 @@ class TreeListComponent {
17268
17395
  return promise;
17269
17396
  }
17270
17397
  /**
17271
- * Initiates the Excel export ([see example]({% slug excelexport_treelist %})).
17398
+ * Starts the Excel export ([see example]({% slug excelexport_treelist %})).
17272
17399
  */
17273
17400
  saveAsExcel() {
17274
17401
  this.excelService.save(this);
@@ -17277,16 +17404,15 @@ class TreeListComponent {
17277
17404
  * Applies the minimum possible width for the specified column,
17278
17405
  * so that the whole text fits without wrapping. This method expects the TreeList
17279
17406
  * to be resizable (set `resizable` to `true`).
17280
- * Makes sense to execute this method only
17407
+ * Execute this method only
17281
17408
  * after the TreeList is already populated with data. [See example](slug:resizing_columns_treelist#toc-auto-fitting-the-content).
17282
- *
17283
17409
  */
17284
17410
  autoFitColumn(column) {
17285
17411
  this.columnResizingService.autoFit(column);
17286
17412
  }
17287
17413
  /**
17288
17414
  * Adjusts the width of the specified columns to fit the entire content, including headers, without wrapping.
17289
- * If no columns are specified, `autoFitColumns` is applied to all columns.
17415
+ * If you do not specify columns, `autoFitColumns` applies to all columns.
17290
17416
  *
17291
17417
  * This method requires the TreeList to be resizable (set `resizable` to `true`).
17292
17418
  * [See example](slug:resizing_columns_treelist#toc-auto-fitting-the-content).
@@ -17372,8 +17498,8 @@ class TreeListComponent {
17372
17498
  * The row indexing is absolute and does not change with paging.
17373
17499
  * Header rows are included, starting at index 0.
17374
17500
  *
17375
- * If the TreeList is configured for scrolling, including virtual scrolling, the scroll position will be updated.
17376
- * If the row is not present on the current page, the method will have no effect.
17501
+ * If the TreeList is configured for scrolling, including virtual scrolling, the scroll position updates.
17502
+ * If the row is not present on the current page, the method has no effect.
17377
17503
  *
17378
17504
  * @param rowIndex - The logical row index to focus. The top header row has an index 0.
17379
17505
  * @param colIndex - The column index to focus.
@@ -17387,8 +17513,10 @@ class TreeListComponent {
17387
17513
  /**
17388
17514
  * Focuses the next cell, optionally wrapping to the next row.
17389
17515
  *
17390
- * @param wrap - A Boolean value which indicates if the focus will move to the next row. Defaults to `true`.
17391
- * @returns {NavigationCell} The focused cell. If the focus is already on the last cell, returns `null`.
17516
+ * @param wrap A Boolean value that indicates if the focus moves to the next row.
17517
+ * @return {NavigationCell} The focused cell. If the focus is already on the last cell, returns `null`.
17518
+ *
17519
+ * @default true
17392
17520
  */
17393
17521
  focusNextCell(wrap = true) {
17394
17522
  this.assertNavigable();
@@ -17397,15 +17525,17 @@ class TreeListComponent {
17397
17525
  /**
17398
17526
  * Focuses the previous cell. Optionally wraps to the previous row.
17399
17527
  *
17400
- * @param wrap - A Boolean value which indicates if the focus will move to the next row. Defaults to `true`.
17401
- * @returns {NavigationCell} The focused cell. If the focus is already on the first cell, returns `null`.
17528
+ * @param wrap A Boolean value that indicates if the focus moves to the next row.
17529
+ * @return {NavigationCell} The focused cell. If the focus is already on the first cell, returns `null`.
17530
+ *
17531
+ * @default true
17402
17532
  */
17403
17533
  focusPrevCell(wrap = true) {
17404
17534
  this.assertNavigable();
17405
17535
  return this.navigationService.focusPrevCell(wrap);
17406
17536
  }
17407
17537
  /**
17408
- * Scrolls to the specified row and column
17538
+ * Scrolls to the specified row and column.
17409
17539
  */
17410
17540
  scrollTo(request) {
17411
17541
  this.scrollRequestService.scrollTo(request);
@@ -17413,14 +17543,13 @@ class TreeListComponent {
17413
17543
  /**
17414
17544
  * Changes the position of the specified column.
17415
17545
  * The reordering of columns operates only on the level
17416
- * which is inferred by the source column.
17546
+ * that the source column infers.
17417
17547
  * For the `reorderColumn` method to work properly,
17418
17548
  * the `source` column has to be visible.
17419
17549
  *
17420
- * @param {ColumnBase} source - The column whose position will be changed.
17421
- * @param {number} destIndex - The new position of the column.
17422
- * @param {ColumnReorderConfig} options - Additional options.
17423
- *
17550
+ * @param source The column whose position you will change.
17551
+ * @param destIndex The new position of the column.
17552
+ * @param options Additional options.
17424
17553
  */
17425
17554
  reorderColumn(source, destIndex, options = { before: false }) {
17426
17555
  const columnsForLevel = sortColumns(this.allColumnsForLevel(source.level));
@@ -17444,7 +17573,7 @@ class TreeListComponent {
17444
17573
  });
17445
17574
  }
17446
17575
  /**
17447
- * Clears the already loaded children for the dataItem so that the TreeList will fetch them again the next time it is rendered.
17576
+ * Clears the already loaded children for the data item so that the TreeList fetches them again the next time it renders.
17448
17577
  */
17449
17578
  reload(dataItem, reloadChildren) {
17450
17579
  if (dataItem) {
@@ -17469,14 +17598,14 @@ class TreeListComponent {
17469
17598
  this.changeDetectorRef.markForCheck();
17470
17599
  }
17471
17600
  /**
17472
- * Expands the row for the specified dataItem.
17601
+ * Expands the row for the specified data item.
17473
17602
  */
17474
17603
  expand(dataItem) {
17475
17604
  this.expandStateService.expand(dataItem);
17476
17605
  this.changeDetectorRef.markForCheck();
17477
17606
  }
17478
17607
  /**
17479
- * Collapses the row for the specified dataItem.
17608
+ * Collapses the row for the specified data item.
17480
17609
  */
17481
17610
  collapse(dataItem) {
17482
17611
  this.expandStateService.collapse(dataItem);
@@ -18360,7 +18489,7 @@ class TreeListComponent {
18360
18489
  (pageTextVisibilityChange)="handlePagerVisibilityChange('showPagerPageText', $event)"
18361
18490
  (itemsTextVisibilityChange)="handlePagerVisibilityChange('showPagerItemsText', $event)">
18362
18491
  <ng-template kendoPagerTemplate>
18363
- <ng-container
18492
+ <ng-container
18364
18493
  [ngTemplateOutlet]="pagerTemplate ? pagerTemplate?.templateRef : defaultPager"
18365
18494
  [ngTemplateOutletContext]="pager.templateContext"></ng-container>
18366
18495
  </ng-template>
@@ -18881,7 +19010,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
18881
19010
  (pageTextVisibilityChange)="handlePagerVisibilityChange('showPagerPageText', $event)"
18882
19011
  (itemsTextVisibilityChange)="handlePagerVisibilityChange('showPagerItemsText', $event)">
18883
19012
  <ng-template kendoPagerTemplate>
18884
- <ng-container
19013
+ <ng-container
18885
19014
  [ngTemplateOutlet]="pagerTemplate ? pagerTemplate?.templateRef : defaultPager"
18886
19015
  [ngTemplateOutletContext]="pager.templateContext"></ng-container>
18887
19016
  </ng-template>
@@ -19124,8 +19253,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
19124
19253
  }] } });
19125
19254
 
19126
19255
  /**
19127
- * Custom component messages override default component messages
19128
- * ([see example](slug:globalization_treelist#toc-custom-messages)).
19256
+ * Overrides the default component messages with custom messages.
19257
+ * [See example](slug:globalization_treelist#toc-custom-messages).
19258
+ *
19259
+ * @example
19260
+ * ```html
19261
+ * <kendo-treelist>
19262
+ * <kendo-treelist-messages
19263
+ * noRecords="No records available">
19264
+ * </kendo-treelist-messages>
19265
+ * </kendo-treelist>
19266
+ * ```
19129
19267
  */
19130
19268
  class CustomMessagesComponent extends Messages {
19131
19269
  service;
@@ -19160,8 +19298,19 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
19160
19298
  }], ctorParameters: function () { return [{ type: i1$1.LocalizationService }]; } });
19161
19299
 
19162
19300
  /**
19163
- * A directive applied to all toolbar elements that need to be a part of the TreeList
19164
- * keyboard navigation.
19301
+ * A directive for toolbar elements that need to be part of TreeList keyboard navigation.
19302
+ * Use this directive to make toolbar elements focusable and accessible with the keyboard.
19303
+ *
19304
+ * @example
19305
+ * ```html
19306
+ * <kendo-treelist>
19307
+ * <kendo-toolbar>
19308
+ * <button kendoTreeListToolbarFocusable>Custom Button</button>
19309
+ * <button kendoTreeListCancelCommand>Cancel</button>
19310
+ * <button kendoTreeListEditCommand>Edit</button>
19311
+ * </kendo-toolbar>
19312
+ * </kendo-treelist>
19313
+ * ```
19165
19314
  */
19166
19315
  class TreeListToolbarFocusableDirective {
19167
19316
  host;
@@ -19223,7 +19372,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
19223
19372
  class EditingDirectiveBase {
19224
19373
  treelist;
19225
19374
  /**
19226
- * The edit service that will handle the operations.
19375
+ * The edit service that handles the operations.
19227
19376
  */
19228
19377
  set editService(value) {
19229
19378
  this.userEditService = value;
@@ -19232,7 +19381,7 @@ class EditingDirectiveBase {
19232
19381
  return this.userEditService || this.defaultEditService;
19233
19382
  }
19234
19383
  /**
19235
- * Gets or sets a function that will be called to determine the unique identifier
19384
+ * Gets or sets a function that determines the unique identifier
19236
19385
  * for new items. The function receives the `item` and its `parent` as parameters
19237
19386
  * and must return an ID.
19238
19387
  */
@@ -19243,7 +19392,7 @@ class EditingDirectiveBase {
19243
19392
  return this.idCallback;
19244
19393
  }
19245
19394
  /**
19246
- * A function that is called to confirm if the `dataItem` will be removed.
19395
+ * A function that confirms if the `dataItem` will be removed.
19247
19396
  */
19248
19397
  removeConfirmation;
19249
19398
  subscriptions = new Subscription();
@@ -19379,13 +19528,23 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
19379
19528
  }] });
19380
19529
 
19381
19530
  /**
19382
- * A directive which encapsulates the editing operations of the TreeList when using
19383
- * the Template-Driven Angular Forms ([see example](slug:editing_directives_treelist#toc-template-editing-directive)).
19531
+ * A directive that encapsulates the editing operations of the TreeList when using
19532
+ * Template-Driven Angular Forms. [See example](slug:editing_directives_treelist#toc-template-editing-directive).
19533
+ *
19534
+ * @example
19535
+ * ```html
19536
+ * <kendo-treelist [kendoTreeListTemplateEditing]="createNewItem">
19537
+ * <kendo-treelist-column field="name" title="Name"></kendo-treelist-column>
19538
+ * <kendo-treelist-column field="age" title="Age"></kendo-treelist-column>
19539
+ * </kendo-treelist>
19540
+ * ```
19541
+ * @remarks
19542
+ * Applied to: {@link TreeListComponent}.
19384
19543
  */
19385
19544
  class TemplateEditingDirective extends RowEditingDirectiveBase {
19386
19545
  treelist;
19387
19546
  /**
19388
- * The function that creates the `dataItem` for the new rows.
19547
+ * The function that creates the `dataItem` for new rows.
19389
19548
  */
19390
19549
  createNewItem;
19391
19550
  originalValues;
@@ -19467,8 +19626,18 @@ const insertNewItem = (newItem, originalData, treelist, parent) => {
19467
19626
  };
19468
19627
 
19469
19628
  /**
19470
- * A directive which encapsulates the editing operations of the TreeList when using the
19471
- * Reactive Forms ([see example](slug:editing_directives_treelist#toc-reactive-editing-directive)).
19629
+ * A directive that encapsulates the editing operations of the TreeList when using the
19630
+ * Reactive Forms. [See example](slug:editing_directives_treelist#toc-reactive-editing-directive).
19631
+ *
19632
+ * @example
19633
+ * ```html
19634
+ * <kendo-treelist [kendoTreeListReactiveEditing]="createFormGroup">
19635
+ * <kendo-treelist-column field="name" title="Name"></kendo-treelist-column>
19636
+ * <kendo-treelist-column field="age" title="Age"></kendo-treelist-column>
19637
+ * </kendo-treelist>
19638
+ * ```
19639
+ * @remarks
19640
+ * Applied to: {@link TreeListComponent}.
19472
19641
  */
19473
19642
  class ReactiveEditingDirective extends RowEditingDirectiveBase {
19474
19643
  treelist;
@@ -19509,8 +19678,18 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
19509
19678
  }] } });
19510
19679
 
19511
19680
  /**
19512
- * A directive which encapsulates the editing operations of the TreeList when using the in-cell
19513
- * editing with Reactive Forms ([see example](slug:editing_directives_treelist#toc-in-cell-editing-directive)).
19681
+ * A directive that encapsulates the editing operations of the TreeList when using the in-cell
19682
+ * editing with Reactive Forms. [See example](slug:editing_directives_treelist#toc-in-cell-editing-directive).
19683
+ *
19684
+ * @example
19685
+ * ```html
19686
+ * <kendo-treelist [kendoTreeListInCellEditing]="createFormGroup">
19687
+ * <kendo-treelist-column field="name" title="Name"></kendo-treelist-column>
19688
+ * <kendo-treelist-column field="age" title="Age"></kendo-treelist-column>
19689
+ * </kendo-treelist>
19690
+ * ```
19691
+ * @remarks
19692
+ * Applied to: {@link TreeListComponent}.
19514
19693
  */
19515
19694
  class InCellEditingDirective extends EditingDirectiveBase {
19516
19695
  treelist;
@@ -19578,23 +19757,26 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
19578
19757
  args: ['kendoTreeListInCellEditing']
19579
19758
  }] } });
19580
19759
 
19760
+ /**
19761
+ * @hidden
19762
+ */
19581
19763
  class BaseBindingDirective {
19582
19764
  component;
19583
19765
  rowReorderService;
19584
19766
  /**
19585
- * Defines the descriptors by which the data will be sorted.
19767
+ * Sets the descriptors that sort the data.
19586
19768
  */
19587
19769
  set sort(value) {
19588
19770
  this.component.sort = this.state.sort = value;
19589
19771
  }
19590
19772
  /**
19591
- * Defines the descriptor by which the data will be filtered.
19773
+ * Sets the descriptor that filters the data.
19592
19774
  */
19593
19775
  set filter(value) {
19594
19776
  this.component.filter = this.state.filter = value;
19595
19777
  }
19596
19778
  /**
19597
- * Defines the descriptor by which the data will be aggregated.
19779
+ * Sets the descriptor that aggregates the data.
19598
19780
  */
19599
19781
  set aggregate(value) {
19600
19782
  this._aggregate = value;
@@ -19833,17 +20015,24 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
19833
20015
  }] });
19834
20016
 
19835
20017
  /**
19836
- * A directive which binds the TreeList to a tree of objects.
20018
+ * Represents the Kendo UI for Angular TreeList hierarchy binding directive.
20019
+ * Use this directive to bind the TreeList to a tree of objects using a field that holds child data items.
20020
+ * Handles in-memory data operations [sorting]({% slug sorting_treelist %}), [aggregation]({% slug treelist_with_aggregates %})
20021
+ * and [filtering]({% slug filtering_treelist %}). [More information and examples.](slug:local_databinding_treelist#toc-binding-to-hierarchical-data-1)
19837
20022
  *
19838
- * The directive encapsulates the in-memory handling of data operations such as
19839
- * [sorting]({% slug sorting_treelist %}), [aggregation]({% slug treelist_with_aggregates %})
19840
- * and [filtering]({% slug filtering_treelist %}) ([more information and examples](slug:local_databinding_treelist#toc-binding-to-hierarchical-data-1)).
20023
+ * @example
20024
+ * ```html
20025
+ * <kendo-treelist [kendoTreeListHierarchyBinding]="data" [children]="childrenField"></kendo-treelist>
20026
+ * ```
20027
+ *
20028
+ * @remarks
20029
+ * Applied to: {@link TreeListComponent}.
19841
20030
  */
19842
20031
  class HierarchyBindingDirective extends BaseBindingDirective {
19843
20032
  component;
19844
20033
  rowReorderService;
19845
20034
  /**
19846
- * The name of the field which holds the child data items of the node.
20035
+ * Sets the name of the field that holds the child data items of the node.
19847
20036
  */
19848
20037
  set childrenField(value) {
19849
20038
  this.childrenGetter = getter(value);
@@ -19854,7 +20043,7 @@ class HierarchyBindingDirective extends BaseBindingDirective {
19854
20043
  return this._childrenField;
19855
20044
  }
19856
20045
  /**
19857
- * The array of data which will be used to populate the TreeList.
20046
+ * Sets the array of data that populates the TreeList.
19858
20047
  */
19859
20048
  data;
19860
20049
  childrenGetter = getter('items');
@@ -20009,18 +20198,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
20009
20198
 
20010
20199
  const ROOT_ID = null;
20011
20200
  /**
20012
- * A directive which binds the TreeList to an array of objects by using
20013
- * an `idField` and `parentIDField` field to define the hierarchy.
20201
+ * Represents the Kendo for Angular UI TreeList flat binding directive.
20202
+ * Use this directive to bind the TreeList to a flat array of objects using `idField` and `parentIdField` to define the hierarchy.
20203
+ * Handles in-memory data operations [sorting]({% slug sorting_treelist %}), [aggregation]({% slug treelist_with_aggregates %})
20204
+ * and [filtering]({% slug filtering_treelist %}). [More information and examples]({% slug databinding_treelist %}).
20014
20205
  *
20015
- * The directive encapsulates the in-memory handling of data operations such as
20016
- * [sorting]({% slug sorting_treelist %}), [aggregation]({% slug treelist_with_aggregates %})
20017
- * and [filtering]({% slug filtering_treelist %}) ([more information and examples]({% slug databinding_treelist %})).
20018
20206
  */
20019
20207
  class FlatBindingDirective extends BaseBindingDirective {
20020
20208
  component;
20021
20209
  rowReorderService;
20022
20210
  /**
20023
- * The name of the field which contains the identifier of the parent node.
20211
+ * Sets the name of the field that contains the identifier of the parent node.
20024
20212
  */
20025
20213
  set parentIdField(value) {
20026
20214
  this.parentIdGetter = getter(value);
@@ -20031,7 +20219,7 @@ class FlatBindingDirective extends BaseBindingDirective {
20031
20219
  return this._parentIdField;
20032
20220
  }
20033
20221
  /**
20034
- * The name of the field which contains the unique identifier of the node.
20222
+ * Sets the name of the field that contains the unique identifier of the node.
20035
20223
  */
20036
20224
  set idField(value) {
20037
20225
  this.idGetter = getter(value);
@@ -20042,7 +20230,7 @@ class FlatBindingDirective extends BaseBindingDirective {
20042
20230
  return this._idField;
20043
20231
  }
20044
20232
  /**
20045
- * The array of data which will be used to populate the TreeList.
20233
+ * Sets the array of data that populates the TreeList.
20046
20234
  */
20047
20235
  data;
20048
20236
  idGetter = getter('id');
@@ -20125,7 +20313,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
20125
20313
  }] } });
20126
20314
 
20127
20315
  /**
20128
- * A directive which controls the expanded state of the items. [See example](slug:treelist_expanded_state#toc-built-in-directive).
20316
+ * A directive which controls the expanded state of items in the TreeList. [See example](slug:treelist_expanded_state#toc-built-in-directive).
20129
20317
  *
20130
20318
  * @example
20131
20319
  * ```html
@@ -20134,15 +20322,18 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
20134
20322
  * kendoTreeListExpandable> ...
20135
20323
  * </kendo-treelist>
20136
20324
  * ```
20325
+ * @remarks
20326
+ * Applied to: {@link TreeListComponent},
20137
20327
  */
20138
20328
  class ExpandableDirective {
20139
20329
  component;
20140
20330
  /**
20141
- * Fires when the expandedKeys are changed.
20331
+ * Emits when the `expandedKeys` change.
20142
20332
  */
20143
20333
  expandedKeysChange = new EventEmitter();
20144
20334
  /**
20145
20335
  * Sets the expanded item keys.
20336
+ * Use this property to control which items are expanded.
20146
20337
  */
20147
20338
  set expandedKeys(value) {
20148
20339
  if (value !== this._expandedKeys) {
@@ -20154,13 +20345,13 @@ class ExpandableDirective {
20154
20345
  return Array.from(this.state.keys());
20155
20346
  }
20156
20347
  /**
20157
- * Specifies if the items should be initially expanded.
20348
+ * Specifies if items are initially expanded.
20158
20349
  * @default false
20159
20350
  */
20160
20351
  initiallyExpanded = false;
20161
20352
  /**
20162
- * Defines the item key that will be stored in the expandedKeys collection.
20163
- * Defaults to the component idField.
20353
+ * Defines the item key stored in the `expandedKeys` collection.
20354
+ * Uses the component `idField` by default.
20164
20355
  */
20165
20356
  set expandBy(key) {
20166
20357
  if (isString(key)) {
@@ -20234,6 +20425,18 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
20234
20425
  const defaultColumnKeyGetter = (_column, columnIndex) => columnIndex;
20235
20426
  /**
20236
20427
  * A directive which controls the selection state. [See example](slug:selection_treelist).
20428
+ *
20429
+ * @example
20430
+ * ```html
20431
+ * <kendo-treelist
20432
+ * [kendoTreeListSelectable]="{ mode: 'row' }"
20433
+ * [selectedItems]="selectedItems">
20434
+ * <kendo-treelist-column field="name" title="Name"></kendo-treelist-column>
20435
+ * <kendo-treelist-column field="age" title="Age"></kendo-treelist-column>
20436
+ * </kendo-treelist>
20437
+ * ```
20438
+ * @remarks
20439
+ * Applied to: {@link TreeListComponent}.
20237
20440
  */
20238
20441
  class SelectableDirective {
20239
20442
  treelist;
@@ -20432,9 +20635,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
20432
20635
 
20433
20636
  /**
20434
20637
  * Represents the Kendo UI TreeListSpacer component for Angular.
20435
- * Used to give additional white space between the Pager inner elements,
20436
- * and provides a way for customizing the spacer width.
20437
- * It can also be used in any flex container within the TreeList. [See example](slug:toolbartemplate_treelist#toc-defining-the-spacing-between-toolbar-elements).
20638
+ * Use this component to add extra white space between Pager inner elements or to customize the spacer width.
20639
+ * You can also use it in any flex container within the TreeList. [See example](slug:toolbartemplate_treelist#toc-defining-the-spacing-between-toolbar-elements).
20640
+ *
20641
+ * @example
20642
+ * ```html
20643
+ * <kendo-treelist [data]="data" [fetchChildren]="fetchChildren" [hasChildren]="hasChildren">
20644
+ * <ng-template kendoTreeListToolbarTemplate>
20645
+ * <kendo-treelist-spacer></kendo-treelist-spacer>
20646
+ * <button type="button" kendoTreeListExcelCommand [svgIcon]="fileExcelIcon"> Export to Excel </button>
20647
+ * <kendo-treelist-spacer></kendo-treelist-spacer>
20648
+ * </ng-template>
20649
+ * <kendo-treelist-column field="ProductName" title="Product Name"></kendo-treelist-column>
20650
+ * </kendo-treelist>
20651
+ * ```
20438
20652
  */
20439
20653
  class TreeListSpacerComponent {
20440
20654
  hostClass = true;
@@ -20446,9 +20660,9 @@ class TreeListSpacerComponent {
20446
20660
  }
20447
20661
  /**
20448
20662
  * Specifies the width of the TreeListSpacer.
20449
- * Accepts the [string values of the CSS `flex-basis` property](https://developer.mozilla.org/en-US/docs/Web/CSS/flex-basis).
20663
+ * Accepts string values for the [CSS `flex-basis` property](https://developer.mozilla.org/en-US/docs/Web/CSS/flex-basis).
20450
20664
  *
20451
- * If not set, the TreeListSpacer will take all the available space.
20665
+ * If not set, the TreeListSpacer takes all available space.
20452
20666
  */
20453
20667
  width;
20454
20668
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: TreeListSpacerComponent, deps: [], target: i0.ɵɵFactoryTarget.Component });
@@ -20475,20 +20689,32 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
20475
20689
  }] } });
20476
20690
 
20477
20691
  /**
20478
- * Represents the checkbox for selecting rows in the TreeList. [See example](slug:treelist_row_selection#toc-select-all-checkbox).
20692
+ * Represents the checkbox column for selecting rows in the TreeList. [See example](slug:treelist_row_selection#toc-select-all-checkbox).
20693
+ *
20694
+ * @example
20695
+ * ```html
20696
+ * <kendo-treelist ...>
20697
+ * <kendo-treelist-checkbox-column
20698
+ * [showSelectAll]="true"
20699
+ * [checkChildren]="true"
20700
+ * [expandable]="true">
20701
+ * </kendo-treelist-checkbox-column>
20702
+ * <kendo-treelist-column field="ProductName" title="Product Name"></kendo-treelist-column>
20703
+ * </kendo-treelist>
20704
+ * ```
20479
20705
  */
20480
20706
  class CheckboxColumnComponent extends ColumnBase {
20481
20707
  parent;
20482
20708
  /**
20483
- * Determines whether a select-all checkbox will be displayed in the header.
20709
+ * Specifies if a select-all checkbox appears in the header.
20484
20710
  */
20485
20711
  showSelectAll;
20486
20712
  /**
20487
- * Determines whether checkbox click should select / unselect all children
20713
+ * Specifies if clicking the checkbox selects or deselects all children.
20488
20714
  */
20489
20715
  checkChildren;
20490
20716
  /**
20491
- * Defines whether the expanded indicator should be rendered in the column.
20717
+ * Specifies if the expanded indicator appears in the column.
20492
20718
  * @default false
20493
20719
  */
20494
20720
  expandable;
@@ -20543,7 +20769,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
20543
20769
  }] } });
20544
20770
 
20545
20771
  /**
20546
- * Represents the drag handle for reordering rows in the TreeList.
20772
+ * Represents the drag handle column for reordering rows in the TreeList.
20773
+ *
20774
+ * @example
20775
+ * ```html
20776
+ * <kendo-treelist [data]="data" [fetchChildren]="fetchChildren" [hasChildren]="hasChildren">
20777
+ * <kendo-treelist-rowreorder-column></kendo-treelist-rowreorder-column>
20778
+ * <kendo-treelist-column field="ProductName" title="Product Name"></kendo-treelist-column>
20779
+ * </kendo-treelist>
20780
+ * ```
20547
20781
  */
20548
20782
  class RowReorderColumnComponent extends ColumnBase {
20549
20783
  parent;
@@ -20585,9 +20819,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
20585
20819
  }] }]; } });
20586
20820
 
20587
20821
  /**
20588
- * Represents the command columns of the TreeList. You have to define the content of the
20589
- * column inside an `<ng-template>` tag. For more information and examples on using the passed fields
20590
- * and the command directives, refer to the article on
20822
+ * Represents the command column of the TreeList. Define the content of the column inside an `<ng-template>` tag.
20823
+ * For more information and examples on using the passed fields and command directives, see
20591
20824
  * [editing the TreeList in Angular Reactive Forms]({% slug editing_reactive_forms_treelist %}).
20592
20825
  *
20593
20826
  * Usually, the template contains CRUD command directives such as:
@@ -20600,7 +20833,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
20600
20833
  * ```html
20601
20834
  * <kendo-treelist ...>
20602
20835
  * <kendo-treelist-column field="ProductID"></kendo-treelist-column>
20603
- * <kendo-treelist-command-column title="command" >
20836
+ * <kendo-treelist-command-column title="command">
20604
20837
  * <ng-template kendoTreeListCellTemplate>
20605
20838
  * <button kendoTreeListEditCommand class="k-primary">Edit</button>
20606
20839
  * <button kendoTreeListRemoveCommand>Remove</button>
@@ -20726,14 +20959,11 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
20726
20959
  }] } });
20727
20960
 
20728
20961
  /**
20729
- * Represents the `edit` command of the TreeList. You can apply this directive to any `button`
20730
- * element inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
20731
- * When an associated button with the directive is clicked, the
20732
- * [`edit`]({% slug api_treelist_treelistcomponent %}#toc-edit) event
20733
- * is triggered ([see example](slug:custom_editors_editing_treelist)).
20962
+ * Represents the `edit` command of the TreeList. Apply this directive to any `button` element inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
20734
20963
  *
20735
- * When the row is in the `edit` mode, the button with `kendoTreeListEditCommand` is automatically hidden.
20736
- * The directive takes as input the `cellContext` from the cell template.
20964
+ * When the user clicks a button with this directive, the [`edit`]({% slug api_treelist_treelistcomponent %}#toc-edit) event is triggered ([see example](slug:custom_editors_editing_treelist)).
20965
+ *
20966
+ * The button with `kendoTreeListEditCommand` is automatically hidden when the row is in edit mode. The directive takes the `cellContext` from the cell template as input.
20737
20967
  *
20738
20968
  * @example
20739
20969
  * ```html
@@ -20745,11 +20975,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
20745
20975
  * </kendo-treelist-command-column>
20746
20976
  * </kendo-treelist>
20747
20977
  * ```
20748
- *
20749
20978
  */
20750
20979
  class EditCommandDirective extends BaseCommandDirective {
20751
20980
  /**
20752
- * The `cellContext` provided to the template.
20981
+ * Provides the `cellContext` to the template.
20753
20982
  */
20754
20983
  cellContext;
20755
20984
  commandClass = true;
@@ -20804,14 +21033,11 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
20804
21033
  }] } });
20805
21034
 
20806
21035
  /**
20807
- * Represents the `cancel` command of the TreeList. You can apply this directive to any `button`
20808
- * element inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
20809
- * When an associated button with the directive is clicked, the
20810
- * [`cancel`]({% slug api_treelist_treelistcomponent %}#toc-cancel) event
20811
- * is triggered ([see example](slug:custom_editors_editing_treelist)).
21036
+ * Represents the `cancel` command of the TreeList. Apply this directive to any `button` element inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
20812
21037
  *
20813
- * When the row is not in the `edit` mode, the button with the `kendoTreeListCancelCommand` is automatically hidden.
20814
- * The directive takes as input the `cellContext` from the cell template.
21038
+ * When the user clicks a button with this directive, the [`cancel`]({% slug api_treelist_treelistcomponent %}#toc-cancel) event is triggered ([see example](slug:custom_editors_editing_treelist)).
21039
+ *
21040
+ * The button with `kendoTreeListCancelCommand` is automatically hidden when the row is not in edit mode. The directive takes the `cellContext` from the cell template as input.
20815
21041
  *
20816
21042
  * @example
20817
21043
  * ```html
@@ -20826,7 +21052,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
20826
21052
  */
20827
21053
  class CancelCommandDirective extends BaseCommandDirective {
20828
21054
  /**
20829
- * The `cellContext` provided to the template.
21055
+ * Provides the `cellContext` to the template.
20830
21056
  */
20831
21057
  cellContext;
20832
21058
  commandClass = true;
@@ -20882,14 +21108,11 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
20882
21108
  }] } });
20883
21109
 
20884
21110
  /**
20885
- * Represents the `save` command of the TreeList. You can apply this directive to any `button`
20886
- * element inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
20887
- * When an associated button with the directive is clicked, the
20888
- * [`save`]({% slug api_treelist_treelistcomponent %}#toc-save) event
20889
- * is triggered ([see example]({% slug editing_treelist %})).
21111
+ * Represents the `save` command of the TreeList. Apply this directive to any `button` element inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
21112
+ *
21113
+ * 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 %})).
20890
21114
  *
20891
- * When the row is not in the `edit` mode, the button with `kendoTreeListSaveCommand` is automatically hidden.
20892
- * The directive takes as input the `cellContext` from the cell template.
21115
+ * 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.
20893
21116
  *
20894
21117
  * @example
20895
21118
  * ```html
@@ -20904,7 +21127,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
20904
21127
  */
20905
21128
  class SaveCommandDirective extends BaseCommandDirective {
20906
21129
  /**
20907
- * The `cellContext` provided to the template.
21130
+ * Provides the `cellContext` to the template.
20908
21131
  */
20909
21132
  cellContext;
20910
21133
  commandClass = true;
@@ -20959,14 +21182,11 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
20959
21182
  }] } });
20960
21183
 
20961
21184
  /**
20962
- * Represents the `remove` command of the TreeList. You can apply this directive to any `button` element
20963
- * inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
20964
- * When an associated button with the directive is clicked, the
20965
- * [`remove` event]({% slug api_treelist_treelistcomponent %}#toc-remove)
20966
- * is triggered ([see example]({% slug editing_reactive_forms_treelist %})).
21185
+ * Represents the `remove` command of the TreeList. Apply this directive to any `button` element inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
20967
21186
  *
20968
- * When the row is in the `edit` mode, the button with the `kendoTreeListRemoveCommand` is automatically hidden.
20969
- * The directive takes as input the `cellContext` from the cell template.
21187
+ * 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 %})).
21188
+ *
21189
+ * 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.
20970
21190
  *
20971
21191
  * @example
20972
21192
  * ```html
@@ -20981,7 +21201,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
20981
21201
  */
20982
21202
  class RemoveCommandDirective extends BaseCommandDirective {
20983
21203
  /**
20984
- * The `cellContext` provided to the template.
21204
+ * Provides the `cellContext` to the template.
20985
21205
  */
20986
21206
  cellContext;
20987
21207
  commandClass = true;
@@ -21036,17 +21256,13 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
21036
21256
  }] } });
21037
21257
 
21038
21258
  /**
21039
- * Represents the command for adding a new item to the TreeList. You can apply this directive to any
21040
- * `button` element inside a [`ToolbarTemplate`](slug:toolbartemplate_treelist) or
21041
- * inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
21259
+ * Represents the command for adding a new item to the TreeList. Apply this directive to any `button` element inside a [`ToolbarTemplate`](slug:toolbartemplate_treelist) or inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
21042
21260
  *
21043
- * When an associated button with the directive is clicked, the
21044
- * [`add`]({% slug api_treelist_treelistcomponent %}#toc-add) event is triggered
21045
- * ([see example](slug:custom_editors_editing_treelist)).
21261
+ * When the user clicks a button with this directive, the [`add`]({% slug api_treelist_treelistcomponent %}#toc-add) event is triggered ([see example](slug:custom_editors_editing_treelist)).
21046
21262
  *
21047
- * When the row is in the `edit mode`, the button with `kendoTreeListAddCommand` is automatically hidden.
21263
+ * The button with `kendoTreeListAddCommand` is automatically hidden when the row is in edit mode.
21048
21264
  *
21049
- * When added to the command column, the directive takes as input the `cellContext` from the cell template.
21265
+ * When used in the command column, the directive takes the `cellContext` from the cell template as input.
21050
21266
  *
21051
21267
  * @example
21052
21268
  * ```html
@@ -21061,7 +21277,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
21061
21277
  */
21062
21278
  class AddCommandDirective extends BaseCommandDirective {
21063
21279
  /**
21064
- * The `cellContext` provided to the template.
21280
+ * Provides the `cellContext` to the template.
21065
21281
  */
21066
21282
  cellContext;
21067
21283
  commandClass = true;
@@ -21211,8 +21427,35 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
21211
21427
  }] } });
21212
21428
 
21213
21429
  /**
21214
- * Represents the `Contains` (**Contains**) filter operator. [See example](slug:filtering_treelist#toc-using-the-built-in-directives).
21430
+ * Represents the `Contains` (**Contains**) filter operator for the TreeList.
21431
+ * Use this operator to filter values that contain a specific substring.
21432
+ * [See example](slug:filtering_treelist#toc-using-the-built-in-directives).
21215
21433
  * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row_treelist#toc-setting-the-default-filter-operator).
21434
+ *
21435
+ * @example
21436
+ * ```html Filter Cell
21437
+ * <kendo-treelist-column field="name" title="Name">
21438
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
21439
+ * <kendo-treelist-string-filter-cell
21440
+ * [column]="column"
21441
+ * [filter]="filter">
21442
+ * <kendo-treelist-filter-contains-operator></kendo-treelist-filter-contains-operator>
21443
+ * </kendo-treelist-string-filter-cell>
21444
+ * </ng-template>
21445
+ * </kendo-treelist-column>
21446
+ * ```
21447
+ * ```html Filter Menu
21448
+ * <kendo-treelist-column field="name" title="Name">
21449
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
21450
+ * <kendo-treelist-string-filter-menu
21451
+ * [column]="column"
21452
+ * [filter]="filter"
21453
+ * [filterService]="filterService">
21454
+ * <kendo-treelist-filter-contains-operator></kendo-treelist-filter-contains-operator>
21455
+ * </kendo-treelist-string-filter-menu>
21456
+ * </ng-template>
21457
+ * </kendo-treelist-column>
21458
+ * ```
21216
21459
  */
21217
21460
  class ContainsFilterOperatorComponent extends FilterOperatorBase {
21218
21461
  constructor(localization) { super('contains', localization); }
@@ -21240,8 +21483,35 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
21240
21483
  }], ctorParameters: function () { return [{ type: i1$1.LocalizationService }]; } });
21241
21484
 
21242
21485
  /**
21243
- * Represents the `DoesNotContain` (**Does not contain**) filter operator. [See example](slug:filtering_treelist#toc-using-the-built-in-directives).
21486
+ * Represents the `DoesNotContain` (**Does not contain**) filter operator for the TreeList.
21487
+ * Use this operator to filter values that do not contain a specific substring.
21488
+ * [See example](slug:filtering_treelist#toc-using-the-built-in-directives).
21244
21489
  * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row_treelist#toc-setting-the-default-filter-operator).
21490
+ *
21491
+ * @example
21492
+ * ```html Filter Cell
21493
+ * <kendo-treelist-column field="name" title="Name">
21494
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
21495
+ * <kendo-treelist-string-filter-cell
21496
+ * [column]="column"
21497
+ * [filter]="filter">
21498
+ * <kendo-treelist-filter-not-contains-operator></kendo-treelist-filter-not-contains-operator>
21499
+ * </kendo-treelist-string-filter-cell>
21500
+ * </ng-template>
21501
+ * </kendo-treelist-column>
21502
+ * ```
21503
+ * ```html Filter Menu
21504
+ * <kendo-treelist-column field="name" title="Name">
21505
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
21506
+ * <kendo-treelist-string-filter-menu
21507
+ * [column]="column"
21508
+ * [filter]="filter"
21509
+ * [filterService]="filterService">
21510
+ * <kendo-treelist-filter-not-contains-operator></kendo-treelist-filter-not-contains-operator>
21511
+ * </kendo-treelist-string-filter-menu>
21512
+ * </ng-template>
21513
+ * </kendo-treelist-column>
21514
+ * ```
21245
21515
  */
21246
21516
  class DoesNotContainFilterOperatorComponent extends FilterOperatorBase {
21247
21517
  constructor(localization) { super('doesnotcontain', localization); }
@@ -21269,25 +21539,52 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
21269
21539
  }], ctorParameters: function () { return [{ type: i1$1.LocalizationService }]; } });
21270
21540
 
21271
21541
  /**
21272
- * Represents the `EndsWith` (**Ends with**) string filter operator. [See example](slug:filtering_treelist#toc-using-the-built-in-directives).
21542
+ * Represents the `EndsWith` (**Ends with**) string filter operator for the TreeList.
21543
+ * Use this operator to filter values that end with a specific substring.
21544
+ * [See example](slug:filtering_treelist#toc-using-the-built-in-directives).
21273
21545
  * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row_treelist#toc-setting-the-default-filter-operator).
21274
- */
21275
- class EndsWithFilterOperatorComponent extends FilterOperatorBase {
21276
- constructor(localization) { super('endswith', localization); }
21277
- static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: EndsWithFilterOperatorComponent, deps: [{ token: i1$1.LocalizationService }], target: i0.ɵɵFactoryTarget.Component });
21278
- static ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "16.2.12", type: EndsWithFilterOperatorComponent, isStandalone: true, selector: "kendo-treelist-filter-endswith-operator", providers: [
21279
- {
21280
- provide: FilterOperatorBase,
21281
- useExisting: forwardRef(() => EndsWithFilterOperatorComponent)
21282
- }
21283
- ], usesInheritance: true, ngImport: i0, template: ``, isInline: true });
21284
- }
21285
- i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: EndsWithFilterOperatorComponent, decorators: [{
21286
- type: Component,
21287
- args: [{
21288
- providers: [
21289
- {
21290
- provide: FilterOperatorBase,
21546
+ *
21547
+ * @example
21548
+ * ```html Filter Cell
21549
+ * <kendo-treelist-column field="name" title="Name">
21550
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
21551
+ * <kendo-treelist-string-filter-cell
21552
+ * [column]="column"
21553
+ * [filter]="filter">
21554
+ * <kendo-treelist-filter-endswith-operator></kendo-treelist-filter-endswith-operator>
21555
+ * </kendo-treelist-string-filter-cell>
21556
+ * </ng-template>
21557
+ * </kendo-treelist-column>
21558
+ * ```
21559
+ * ```html Filter Menu
21560
+ * <kendo-treelist-column field="name" title="Name">
21561
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
21562
+ * <kendo-treelist-string-filter-menu
21563
+ * [column]="column"
21564
+ * [filter]="filter"
21565
+ * [filterService]="filterService">
21566
+ * <kendo-treelist-filter-endswith-operator></kendo-treelist-filter-endswith-operator>
21567
+ * </kendo-treelist-string-filter-menu>
21568
+ * </ng-template>
21569
+ * </kendo-treelist-column>
21570
+ * ```
21571
+ */
21572
+ class EndsWithFilterOperatorComponent extends FilterOperatorBase {
21573
+ constructor(localization) { super('endswith', localization); }
21574
+ static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: EndsWithFilterOperatorComponent, deps: [{ token: i1$1.LocalizationService }], target: i0.ɵɵFactoryTarget.Component });
21575
+ static ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "16.2.12", type: EndsWithFilterOperatorComponent, isStandalone: true, selector: "kendo-treelist-filter-endswith-operator", providers: [
21576
+ {
21577
+ provide: FilterOperatorBase,
21578
+ useExisting: forwardRef(() => EndsWithFilterOperatorComponent)
21579
+ }
21580
+ ], usesInheritance: true, ngImport: i0, template: ``, isInline: true });
21581
+ }
21582
+ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: EndsWithFilterOperatorComponent, decorators: [{
21583
+ type: Component,
21584
+ args: [{
21585
+ providers: [
21586
+ {
21587
+ provide: FilterOperatorBase,
21291
21588
  useExisting: forwardRef(() => EndsWithFilterOperatorComponent)
21292
21589
  }
21293
21590
  ],
@@ -21298,8 +21595,83 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
21298
21595
  }], ctorParameters: function () { return [{ type: i1$1.LocalizationService }]; } });
21299
21596
 
21300
21597
  /**
21301
- * Represents the `Equal` (**Is equal to**) filter operator. [See example](slug:filtering_treelist#toc-using-the-built-in-directives).
21598
+ * Represents the `Equal` (**Is equal to**) filter operator for the TreeList.
21599
+ * Use this operator to filter values that are equal to a specific value.
21600
+ * [See example](slug:filtering_treelist#toc-using-the-built-in-directives).
21302
21601
  * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row_treelist#toc-setting-the-default-filter-operator).
21602
+ *
21603
+ * @example
21604
+ * ```html String Filter Cell
21605
+ * <kendo-treelist-column field="name" title="Name">
21606
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
21607
+ * <kendo-treelist-string-filter-cell
21608
+ * [column]="column"
21609
+ * [filter]="filter">
21610
+ * <kendo-treelist-filter-eq-operator></kendo-treelist-filter-eq-operator>
21611
+ * </kendo-treelist-string-filter-cell>
21612
+ * </ng-template>
21613
+ * </kendo-treelist-column>
21614
+ * ```
21615
+ * ```html Numeric Filter Cell
21616
+ * <kendo-treelist-column field="yearsService" title="Years Service">
21617
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
21618
+ * <kendo-treelist-numeric-filter-cell
21619
+ * [column]="column"
21620
+ * [filter]="filter">
21621
+ * <kendo-treelist-filter-eq-operator></kendo-treelist-filter-eq-operator>
21622
+ * </kendo-treelist-numeric-filter-cell>
21623
+ * </ng-template>
21624
+ * </kendo-treelist-column>
21625
+ * ```
21626
+ * ```html Date Filter Cell
21627
+ * <kendo-treelist-column field="hireDate">
21628
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
21629
+ * <kendo-treelist-date-filter-cell
21630
+ * [column]="column"
21631
+ * [filter]="filter">
21632
+ * <kendo-treelist-filter-eq-operator></kendo-treelist-filter-eq-operator>
21633
+ * </kendo-treelist-date-filter-cell>
21634
+ * </ng-template>
21635
+ * </kendo-treelist-column>
21636
+ * ```
21637
+ *
21638
+ * @example
21639
+ * ```html String Filter Menu
21640
+ * <kendo-treelist-column field="name" title="Name">
21641
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
21642
+ * <kendo-treelist-string-filter-menu
21643
+ * [column]="column"
21644
+ * [filter]="filter"
21645
+ * [filterService]="filterService">
21646
+ * <kendo-treelist-filter-eq-operator></kendo-treelist-filter-eq-operator>
21647
+ * </kendo-treelist-string-filter-menu>
21648
+ * </ng-template>
21649
+ * </kendo-treelist-column>
21650
+ * ```
21651
+ * ```html Numeric Filter Menu
21652
+ * <kendo-treelist-column field="yearsService" title="Years Service">
21653
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
21654
+ * <kendo-treelist-numeric-filter-menu
21655
+ * [column]="column"
21656
+ * [filter]="filter"
21657
+ * [filterService]="filterService">
21658
+ * <kendo-treelist-filter-eq-operator></kendo-treelist-filter-eq-operator>
21659
+ * </kendo-treelist-numeric-filter-menu>
21660
+ * </ng-template>
21661
+ * </kendo-treelist-column>
21662
+ * ```
21663
+ * ```html Date Filter Menu
21664
+ * <kendo-treelist-column field="hireDate">
21665
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
21666
+ * <kendo-treelist-date-filter-menu
21667
+ * [column]="column"
21668
+ * [filter]="filter"
21669
+ * [filterService]="filterService">
21670
+ * <kendo-treelist-filter-eq-operator></kendo-treelist-filter-eq-operator>
21671
+ * </kendo-treelist-date-filter-menu>
21672
+ * </ng-template>
21673
+ * </kendo-treelist-column>
21674
+ * ```
21303
21675
  */
21304
21676
  class EqualFilterOperatorComponent extends FilterOperatorBase {
21305
21677
  constructor(localization) { super('eq', localization); }
@@ -21327,8 +21699,35 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
21327
21699
  }], ctorParameters: function () { return [{ type: i1$1.LocalizationService }]; } });
21328
21700
 
21329
21701
  /**
21330
- * Represents the `IsEmpty` (**Is empty**) filter operator. [See example](slug:filtering_treelist#toc-using-the-built-in-directives).
21702
+ * Represents the `IsEmpty` (**Is empty**) filter operator for the TreeList.
21703
+ * Use this operator to filter values that are empty.
21704
+ * [See example](slug:filtering_treelist#toc-using-the-built-in-directives).
21331
21705
  * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row_treelist#toc-setting-the-default-filter-operator).
21706
+ *
21707
+ * @example
21708
+ * ```html Filter Cell
21709
+ * <kendo-treelist-column field="name" title="Name">
21710
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
21711
+ * <kendo-treelist-string-filter-cell
21712
+ * [column]="column"
21713
+ * [filter]="filter">
21714
+ * <kendo-treelist-filter-isempty-operator></kendo-treelist-filter-isempty-operator>
21715
+ * </kendo-treelist-string-filter-cell>
21716
+ * </ng-template>
21717
+ * </kendo-treelist-column>
21718
+ * ```
21719
+ * ```html Filter Menu
21720
+ * <kendo-treelist-column field="name" title="Name">
21721
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
21722
+ * <kendo-treelist-string-filter-menu
21723
+ * [column]="column"
21724
+ * [filter]="filter"
21725
+ * [filterService]="filterService">
21726
+ * <kendo-treelist-filter-isempty-operator></kendo-treelist-filter-isempty-operator>
21727
+ * </kendo-treelist-string-filter-menu>
21728
+ * </ng-template>
21729
+ * </kendo-treelist-column>
21730
+ * ```
21332
21731
  */
21333
21732
  class IsEmptyFilterOperatorComponent extends FilterOperatorBase {
21334
21733
  constructor(localization) { super('isempty', localization); }
@@ -21356,8 +21755,35 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
21356
21755
  }], ctorParameters: function () { return [{ type: i1$1.LocalizationService }]; } });
21357
21756
 
21358
21757
  /**
21359
- * Represents the `IsNotEmpty` (**Is not empty**) filter operator. [See example](slug:filtering_treelist#toc-using-the-built-in-directives).
21758
+ * Represents the `IsNotEmpty` (**Is not empty**) filter operator for the TreeList.
21759
+ * Use this operator to filter values that are not empty.
21760
+ * [See example](slug:filtering_treelist#toc-using-the-built-in-directives).
21360
21761
  * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row_treelist#toc-setting-the-default-filter-operator).
21762
+ *
21763
+ * * @example
21764
+ * ```html Filter Cell
21765
+ * <kendo-treelist-column field="name" title="Name">
21766
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
21767
+ * <kendo-treelist-string-filter-cell
21768
+ * [column]="column"
21769
+ * [filter]="filter">
21770
+ * <kendo-treelist-filter-isnotempty-operator></kendo-treelist-filter-isnotempty-operator>
21771
+ * </kendo-treelist-string-filter-cell>
21772
+ * </ng-template>
21773
+ * </kendo-treelist-column>
21774
+ * ```
21775
+ * ```html Filter Menu
21776
+ * <kendo-treelist-column field="name" title="Name">
21777
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
21778
+ * <kendo-treelist-string-filter-menu
21779
+ * [column]="column"
21780
+ * [filter]="filter"
21781
+ * [filterService]="filterService">
21782
+ * <kendo-treelist-filter-isnotempty-operator></kendo-treelist-filter-isnotempty-operator>
21783
+ * </kendo-treelist-string-filter-menu>
21784
+ * </ng-template>
21785
+ * </kendo-treelist-column>
21786
+ * ```
21361
21787
  */
21362
21788
  class IsNotEmptyFilterOperatorComponent extends FilterOperatorBase {
21363
21789
  constructor(localization) { super('isnotempty', localization); }
@@ -21385,8 +21811,83 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
21385
21811
  }], ctorParameters: function () { return [{ type: i1$1.LocalizationService }]; } });
21386
21812
 
21387
21813
  /**
21388
- * Represents the `IsNotNull` (**Is not null**) filter operator. [See example](slug:filtering_treelist#toc-using-the-built-in-directives).
21814
+ * Represents the `IsNotNull` (**Is not null**) filter operator for the TreeList.
21815
+ * Use this operator to filter values that are not null.
21816
+ * [See example](slug:filtering_treelist#toc-using-the-built-in-directives).
21389
21817
  * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row_treelist#toc-setting-the-default-filter-operator).
21818
+ *
21819
+ * @example
21820
+ * ```html String Filter Cell
21821
+ * <kendo-treelist-column field="name" title="Name">
21822
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
21823
+ * <kendo-treelist-string-filter-cell
21824
+ * [column]="column"
21825
+ * [filter]="filter">
21826
+ * <kendo-treelist-filter-isnotnull-operator></kendo-treelist-filter-isnotnull-operator>
21827
+ * </kendo-treelist-string-filter-cell>
21828
+ * </ng-template>
21829
+ * </kendo-treelist-column>
21830
+ * ```
21831
+ * ```html Numeric Filter Cell
21832
+ * <kendo-treelist-column field="yearsService" title="Years Service">
21833
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
21834
+ * <kendo-treelist-numeric-filter-cell
21835
+ * [column]="column"
21836
+ * [filter]="filter">
21837
+ * <kendo-treelist-filter-isnotnull-operator></kendo-treelist-filter-isnotnull-operator>
21838
+ * </kendo-treelist-numeric-filter-cell>
21839
+ * </ng-template>
21840
+ * </kendo-treelist-column>
21841
+ * ```
21842
+ * ```html Date Filter Cell
21843
+ * <kendo-treelist-column field="hireDate">
21844
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
21845
+ * <kendo-treelist-date-filter-cell
21846
+ * [column]="column"
21847
+ * [filter]="filter">
21848
+ * <kendo-treelist-filter-isnotnull-operator></kendo-treelist-filter-isnotnull-operator>
21849
+ * </kendo-treelist-date-filter-cell>
21850
+ * </ng-template>
21851
+ * </kendo-treelist-column>
21852
+ * ```
21853
+ *
21854
+ * @example
21855
+ * ```html String Filter Menu
21856
+ * <kendo-treelist-column field="name" title="Name">
21857
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
21858
+ * <kendo-treelist-string-filter-menu
21859
+ * [column]="column"
21860
+ * [filter]="filter"
21861
+ * [filterService]="filterService">
21862
+ * <kendo-treelist-filter-isnotnull-operator></kendo-treelist-filter-isnotnull-operator>
21863
+ * </kendo-treelist-string-filter-menu>
21864
+ * </ng-template>
21865
+ * </kendo-treelist-column>
21866
+ * ```
21867
+ * ```html Numeric Filter Menu
21868
+ * <kendo-treelist-column field="yearsService" title="Years Service">
21869
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
21870
+ * <kendo-treelist-numeric-filter-menu
21871
+ * [column]="column"
21872
+ * [filter]="filter"
21873
+ * [filterService]="filterService">
21874
+ * <kendo-treelist-filter-isnotnull-operator></kendo-treelist-filter-isnotnull-operator>
21875
+ * </kendo-treelist-numeric-filter-menu>
21876
+ * </ng-template>
21877
+ * </kendo-treelist-column>
21878
+ * ```
21879
+ * ```html Date Filter Menu
21880
+ * <kendo-treelist-column field="hireDate">
21881
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
21882
+ * <kendo-treelist-date-filter-menu
21883
+ * [column]="column"
21884
+ * [filter]="filter"
21885
+ * [filterService]="filterService">
21886
+ * <kendo-treelist-filter-isnotnull-operator></kendo-treelist-filter-isnotnull-operator>
21887
+ * </kendo-treelist-date-filter-menu>
21888
+ * </ng-template>
21889
+ * </kendo-treelist-column>
21890
+ * ```
21390
21891
  */
21391
21892
  class IsNotNullFilterOperatorComponent extends FilterOperatorBase {
21392
21893
  constructor(localization) { super('isnotnull', localization); }
@@ -21414,8 +21915,83 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
21414
21915
  }], ctorParameters: function () { return [{ type: i1$1.LocalizationService }]; } });
21415
21916
 
21416
21917
  /**
21417
- * Represents the `IsNull` (**Is null**) filter operator. [See example](slug:filtering_treelist#toc-using-the-built-in-directives).
21918
+ * Represents the `IsNull` (**Is null**) filter operator for the TreeList.
21919
+ * Use this operator to filter values that are null.
21920
+ * [See example](slug:filtering_treelist#toc-using-the-built-in-directives).
21418
21921
  * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row_treelist#toc-setting-the-default-filter-operator).
21922
+ *
21923
+ * @example
21924
+ * ```html String Filter Cell
21925
+ * <kendo-treelist-column field="name" title="Name">
21926
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
21927
+ * <kendo-treelist-string-filter-cell
21928
+ * [column]="column"
21929
+ * [filter]="filter">
21930
+ * <kendo-treelist-filter-isnull-operator></kendo-treelist-filter-isnull-operator>
21931
+ * </kendo-treelist-string-filter-cell>
21932
+ * </ng-template>
21933
+ * </kendo-treelist-column>
21934
+ * ```
21935
+ * ```html Numeric Filter Cell
21936
+ * <kendo-treelist-column field="yearsService" title="Years Service">
21937
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
21938
+ * <kendo-treelist-numeric-filter-cell
21939
+ * [column]="column"
21940
+ * [filter]="filter">
21941
+ * <kendo-treelist-filter-isnull-operator></kendo-treelist-filter-isnull-operator>
21942
+ * </kendo-treelist-numeric-filter-cell>
21943
+ * </ng-template>
21944
+ * </kendo-treelist-column>
21945
+ * ```
21946
+ * ```html Date Filter Cell
21947
+ * <kendo-treelist-column field="hireDate">
21948
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
21949
+ * <kendo-treelist-date-filter-cell
21950
+ * [column]="column"
21951
+ * [filter]="filter">
21952
+ * <kendo-treelist-filter-isnull-operator></kendo-treelist-filter-isnull-operator>
21953
+ * </kendo-treelist-date-filter-cell>
21954
+ * </ng-template>
21955
+ * </kendo-treelist-column>
21956
+ * ```
21957
+ *
21958
+ * @example
21959
+ * ```html String Filter Menu
21960
+ * <kendo-treelist-column field="name" title="Name">
21961
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
21962
+ * <kendo-treelist-string-filter-menu
21963
+ * [column]="column"
21964
+ * [filter]="filter"
21965
+ * [filterService]="filterService">
21966
+ * <kendo-treelist-filter-isnull-operator></kendo-treelist-filter-isnull-operator>
21967
+ * </kendo-treelist-string-filter-menu>
21968
+ * </ng-template>
21969
+ * </kendo-treelist-column>
21970
+ * ```
21971
+ * ```html Numeric Filter Menu
21972
+ * <kendo-treelist-column field="yearsService" title="Years Service">
21973
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
21974
+ * <kendo-treelist-numeric-filter-menu
21975
+ * [column]="column"
21976
+ * [filter]="filter"
21977
+ * [filterService]="filterService">
21978
+ * <kendo-treelist-filter-isnull-operator></kendo-treelist-filter-isnull-operator>
21979
+ * </kendo-treelist-numeric-filter-menu>
21980
+ * </ng-template>
21981
+ * </kendo-treelist-column>
21982
+ * ```
21983
+ * ```html Date Filter Menu
21984
+ * <kendo-treelist-column field="hireDate">
21985
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
21986
+ * <kendo-treelist-date-filter-menu
21987
+ * [column]="column"
21988
+ * [filter]="filter"
21989
+ * [filterService]="filterService">
21990
+ * <kendo-treelist-filter-isnull-operator></kendo-treelist-filter-isnull-operator>
21991
+ * </kendo-treelist-date-filter-menu>
21992
+ * </ng-template>
21993
+ * </kendo-treelist-column>
21994
+ * ```
21419
21995
  */
21420
21996
  class IsNullFilterOperatorComponent extends FilterOperatorBase {
21421
21997
  constructor(localization) { super('isnull', localization); }
@@ -21443,8 +22019,83 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
21443
22019
  }], ctorParameters: function () { return [{ type: i1$1.LocalizationService }]; } });
21444
22020
 
21445
22021
  /**
21446
- * Represents the `NotEqual` (**Is not equal to**) filter operator. [See example](slug:filtering_treelist#toc-using-the-built-in-directives).
22022
+ * Represents the `NotEqual` (**Is not equal to**) filter operator for the TreeList.
22023
+ * Use this operator to filter values that are not equal to a specific value.
22024
+ * [See example](slug:filtering_treelist#toc-using-the-built-in-directives).
21447
22025
  * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row_treelist#toc-setting-the-default-filter-operator).
22026
+ *
22027
+ * @example
22028
+ * ```html String Filter Cell
22029
+ * <kendo-treelist-column field="name" title="Name">
22030
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
22031
+ * <kendo-treelist-string-filter-cell
22032
+ * [column]="column"
22033
+ * [filter]="filter">
22034
+ * <kendo-treelist-filter-neq-operator></kendo-treelist-filter-neq-operator>
22035
+ * </kendo-treelist-string-filter-cell>
22036
+ * </ng-template>
22037
+ * </kendo-treelist-column>
22038
+ * ```
22039
+ * ```html Numeric Filter Cell
22040
+ * <kendo-treelist-column field="yearsService" title="Years Service">
22041
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
22042
+ * <kendo-treelist-numeric-filter-cell
22043
+ * [column]="column"
22044
+ * [filter]="filter">
22045
+ * <kendo-treelist-filter-neq-operator></kendo-treelist-filter-neq-operator>
22046
+ * </kendo-treelist-numeric-filter-cell>
22047
+ * </ng-template>
22048
+ * </kendo-treelist-column>
22049
+ * ```
22050
+ * ```html Date Filter Cell
22051
+ * <kendo-treelist-column field="hireDate">
22052
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
22053
+ * <kendo-treelist-date-filter-cell
22054
+ * [column]="column"
22055
+ * [filter]="filter">
22056
+ * <kendo-treelist-filter-neq-operator></kendo-treelist-filter-neq-operator>
22057
+ * </kendo-treelist-date-filter-cell>
22058
+ * </ng-template>
22059
+ * </kendo-treelist-column>
22060
+ * ```
22061
+ *
22062
+ * @example
22063
+ * ```html String Filter Menu
22064
+ * <kendo-treelist-column field="name" title="Name">
22065
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
22066
+ * <kendo-treelist-string-filter-menu
22067
+ * [column]="column"
22068
+ * [filter]="filter"
22069
+ * [filterService]="filterService">
22070
+ * <kendo-treelist-filter-neq-operator></kendo-treelist-filter-neq-operator>
22071
+ * </kendo-treelist-string-filter-menu>
22072
+ * </ng-template>
22073
+ * </kendo-treelist-column>
22074
+ * ```
22075
+ * ```html Numeric Filter Menu
22076
+ * <kendo-treelist-column field="yearsService" title="Years Service">
22077
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
22078
+ * <kendo-treelist-numeric-filter-menu
22079
+ * [column]="column"
22080
+ * [filter]="filter"
22081
+ * [filterService]="filterService">
22082
+ * <kendo-treelist-filter-neq-operator></kendo-treelist-filter-neq-operator>
22083
+ * </kendo-treelist-numeric-filter-menu>
22084
+ * </ng-template>
22085
+ * </kendo-treelist-column>
22086
+ * ```
22087
+ * ```html Date Filter Menu
22088
+ * <kendo-treelist-column field="hireDate">
22089
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
22090
+ * <kendo-treelist-date-filter-menu
22091
+ * [column]="column"
22092
+ * [filter]="filter"
22093
+ * [filterService]="filterService">
22094
+ * <kendo-treelist-filter-neq-operator></kendo-treelist-filter-neq-operator>
22095
+ * </kendo-treelist-date-filter-menu>
22096
+ * </ng-template>
22097
+ * </kendo-treelist-column>
22098
+ * ```
21448
22099
  */
21449
22100
  class NotEqualFilterOperatorComponent extends FilterOperatorBase {
21450
22101
  constructor(localization) { super('neq', localization); }
@@ -21472,8 +22123,35 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
21472
22123
  }], ctorParameters: function () { return [{ type: i1$1.LocalizationService }]; } });
21473
22124
 
21474
22125
  /**
21475
- * Represents the `StartsWith` (**Starts with**) filter operator. [See example](slug:filtering_treelist#toc-using-the-built-in-directives).
22126
+ * Represents the `StartsWith` (**Starts with**) filter operator for the TreeList.
22127
+ * Use this operator to filter values that start with a specific substring.
22128
+ * [See example](slug:filtering_treelist#toc-using-the-built-in-directives).
21476
22129
  * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row_treelist#toc-setting-the-default-filter-operator).
22130
+ *
22131
+ * @example
22132
+ * ```html Filter Cell
22133
+ * <kendo-treelist-column field="name" title="Name">
22134
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
22135
+ * <kendo-treelist-string-filter-cell
22136
+ * [column]="column"
22137
+ * [filter]="filter">
22138
+ * <kendo-treelist-filter-startswith-operator></kendo-treelist-filter-startswith-operator>
22139
+ * </kendo-treelist-string-filter-cell>
22140
+ * </ng-template>
22141
+ * </kendo-treelist-column>
22142
+ * ```
22143
+ * ```html Filter Menu
22144
+ * <kendo-treelist-column field="name" title="Name">
22145
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
22146
+ * <kendo-treelist-string-filter-menu
22147
+ * [column]="column"
22148
+ * [filter]="filter"
22149
+ * [filterService]="filterService">
22150
+ * <kendo-treelist-filter-startswith-operator></kendo-treelist-filter-startswith-operator>
22151
+ * </kendo-treelist-string-filter-menu>
22152
+ * </ng-template>
22153
+ * </kendo-treelist-column>
22154
+ * ```
21477
22155
  */
21478
22156
  class StartsWithFilterOperatorComponent extends FilterOperatorBase {
21479
22157
  constructor(localization) { super('startswith', localization); }
@@ -21500,9 +22178,35 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
21500
22178
  }]
21501
22179
  }], ctorParameters: function () { return [{ type: i1$1.LocalizationService }]; } });
21502
22180
 
21503
- /*
21504
- * Represents the `Greater` (**Is greater than**) [numeric filter](slug:filtering_treelist#toc-numeric-filter) operator.
22181
+ /**
22182
+ * Represents the `Greater` (**Is greater than**) [numeric filter operator](slug:filtering_treelist#toc-numeric-filter) for the TreeList.
22183
+ * Use this operator to filter values that are greater than a specific value.
21505
22184
  * [See example](slug:filter_row_treelist#toc-setting-the-default-filter-operator).
22185
+ *
22186
+ * @example
22187
+ * ```html Filter Cell
22188
+ * <kendo-treelist-column field="yearsService" title="Years Service">
22189
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
22190
+ * <kendo-treelist-numeric-filter-cell
22191
+ * [column]="column"
22192
+ * [filter]="filter">
22193
+ * <kendo-treelist-filter-gt-operator></kendo-treelist-filter-gt-operator>
22194
+ * </kendo-treelist-numeric-filter-cell>
22195
+ * </ng-template>
22196
+ * </kendo-treelist-column>
22197
+ * ```
22198
+ * ```html Filter Menu
22199
+ * <kendo-treelist-column field="yearsService" title="Years Service">
22200
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
22201
+ * <kendo-treelist-numeric-filter-menu
22202
+ * [column]="column"
22203
+ * [filter]="filter"
22204
+ * [filterService]="filterService">
22205
+ * <kendo-treelist-filter-gt-operator></kendo-treelist-filter-gt-operator>
22206
+ * </kendo-treelist-numeric-filter-menu>
22207
+ * </ng-template>
22208
+ * </kendo-treelist-column>
22209
+ * ```
21506
22210
  */
21507
22211
  class GreaterFilterOperatorComponent extends FilterOperatorBase {
21508
22212
  constructor(localization) { super('gt', localization); }
@@ -21530,8 +22234,34 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
21530
22234
  }], ctorParameters: function () { return [{ type: i1$1.LocalizationService }]; } });
21531
22235
 
21532
22236
  /**
21533
- * Represents the `GreaterOrEqualTo` (**Is greater than or equal to**) [numeric filter](slug:filtering_treelist#toc-numeric-filter) operator.
22237
+ * Represents the `GreaterOrEqualTo` (**Is greater than or equal to**) [numeric filter operator](slug:filtering_treelist#toc-numeric-filter) for the TreeList.
22238
+ * Use this operator to filter values that are greater than or equal to a specific value.
21534
22239
  * [See example](slug:filter_row_treelist#toc-setting-the-default-filter-operator).
22240
+ *
22241
+ * @example
22242
+ * ```html Filter Cell
22243
+ * <kendo-treelist-column field="yearsService" title="Years Service">
22244
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
22245
+ * <kendo-treelist-numeric-filter-cell
22246
+ * [column]="column"
22247
+ * [filter]="filter">
22248
+ * <kendo-treelist-filter-gte-operator></kendo-treelist-filter-gte-operator>
22249
+ * </kendo-treelist-numeric-filter-cell>
22250
+ * </ng-template>
22251
+ * </kendo-treelist-column>
22252
+ * ```
22253
+ * ```html Filter Menu
22254
+ * <kendo-treelist-column field="yearsService" title="Years Service">
22255
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
22256
+ * <kendo-treelist-numeric-filter-menu
22257
+ * [column]="column"
22258
+ * [filter]="filter"
22259
+ * [filterService]="filterService">
22260
+ * <kendo-treelist-filter-gte-operator></kendo-treelist-filter-gte-operator>
22261
+ * </kendo-treelist-numeric-filter-menu>
22262
+ * </ng-template>
22263
+ * </kendo-treelist-column>
22264
+ * ```
21535
22265
  */
21536
22266
  class GreaterOrEqualToFilterOperatorComponent extends FilterOperatorBase {
21537
22267
  constructor(localization) { super('gte', localization); }
@@ -21559,8 +22289,34 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
21559
22289
  }], ctorParameters: function () { return [{ type: i1$1.LocalizationService }]; } });
21560
22290
 
21561
22291
  /**
21562
- * Represents the `Less` (**Is less than**) [numeric filter](slug:filtering_treelist#toc-numeric-filter) operator.
22292
+ * Represents the `Less` (**Is less than**) [numeric filter operator](slug:filtering_treelist#toc-numeric-filter) for the TreeList.
22293
+ * Use this operator to filter values that are less than a specific value.
21563
22294
  * [See example](slug:filter_row_treelist#toc-setting-the-default-filter-operator).
22295
+ *
22296
+ * @example
22297
+ * ```html Filter Cell
22298
+ * <kendo-treelist-column field="yearsService" title="Years Service">
22299
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
22300
+ * <kendo-treelist-numeric-filter-cell
22301
+ * [column]="column"
22302
+ * [filter]="filter">
22303
+ * <kendo-treelist-filter-lt-operator></kendo-treelist-filter-lt-operator>
22304
+ * </kendo-treelist-numeric-filter-cell>
22305
+ * </ng-template>
22306
+ * </kendo-treelist-column>
22307
+ * ```
22308
+ * ```html Filter Menu
22309
+ * <kendo-treelist-column field="yearsService" title="Years Service">
22310
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
22311
+ * <kendo-treelist-numeric-filter-menu
22312
+ * [column]="column"
22313
+ * [filter]="filter"
22314
+ * [filterService]="filterService">
22315
+ * <kendo-treelist-filter-lt-operator></kendo-treelist-filter-lt-operator>
22316
+ * </kendo-treelist-numeric-filter-menu>
22317
+ * </ng-template>
22318
+ * </kendo-treelist-column>
22319
+ * ```
21564
22320
  */
21565
22321
  class LessFilterOperatorComponent extends FilterOperatorBase {
21566
22322
  constructor(localization) { super('lt', localization); }
@@ -21587,9 +22343,35 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
21587
22343
  }]
21588
22344
  }], ctorParameters: function () { return [{ type: i1$1.LocalizationService }]; } });
21589
22345
 
21590
- /*
21591
- * Represents the `LessOrEqualTo` (**Is less than or equal to**) [numeric filter](slug:filtering_treelist#toc-numeric-filter) operator.
22346
+ /**
22347
+ * Represents the `LessOrEqualTo` (**Is less than or equal to**) [numeric filter operator](slug:filtering_treelist#toc-numeric-filter) for the TreeList.
22348
+ * Use this operator to filter values that are less than or equal to a specific value.
21592
22349
  * [See example](slug:filter_row_treelist#toc-setting-the-default-filter-operator).
22350
+ *
22351
+ * @example
22352
+ * ```html Filter Cell
22353
+ * <kendo-treelist-column field="yearsService" title="Years Service">
22354
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
22355
+ * <kendo-treelist-numeric-filter-cell
22356
+ * [column]="column"
22357
+ * [filter]="filter">
22358
+ * <kendo-treelist-filter-lte-operator></kendo-treelist-filter-lte-operator>
22359
+ * </kendo-treelist-numeric-filter-cell>
22360
+ * </ng-template>
22361
+ * </kendo-treelist-column>
22362
+ * ```
22363
+ * ```html Filter Menu
22364
+ * <kendo-treelist-column field="yearsService" title="Years Service">
22365
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
22366
+ * <kendo-treelist-numeric-filter-menu
22367
+ * [column]="column"
22368
+ * [filter]="filter"
22369
+ * [filterService]="filterService">
22370
+ * <kendo-treelist-filter-lte-operator></kendo-treelist-filter-lte-operator>
22371
+ * </kendo-treelist-numeric-filter-menu>
22372
+ * </ng-template>
22373
+ * </kendo-treelist-column>
22374
+ * ```
21593
22375
  */
21594
22376
  class LessOrEqualToFilterOperatorComponent extends FilterOperatorBase {
21595
22377
  constructor(localization) { super('lte', localization); }
@@ -21617,8 +22399,34 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
21617
22399
  }], ctorParameters: function () { return [{ type: i1$1.LocalizationService }]; } });
21618
22400
 
21619
22401
  /**
21620
- * Represents the `Greater` (**Is after**) [date filter](slug:filtering_treelist#toc-date-filter) operator.
22402
+ * Represents the `Greater` (**Is after**) [date filter operator](slug:filtering_treelist#toc-date-filter) for the TreeList.
22403
+ * Use this operator to filter dates that are after a specific value.
21621
22404
  * [See example](slug:filter_row_treelist#toc-setting-the-default-filter-operator).
22405
+ *
22406
+ * @example
22407
+ * ```html Filter Cell
22408
+ * <kendo-treelist-column field="hireDate">
22409
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
22410
+ * <kendo-treelist-date-filter-cell
22411
+ * [column]="column"
22412
+ * [filter]="filter">
22413
+ * <kendo-treelist-filter-after-operator></kendo-treelist-filter-after-operator>
22414
+ * </kendo-treelist-date-filter-cell>
22415
+ * </ng-template>
22416
+ * </kendo-treelist-column>
22417
+ * ```
22418
+ * ```html Filter Menu
22419
+ * <kendo-treelist-column field="hireDate">
22420
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
22421
+ * <kendo-treelist-date-filter-menu
22422
+ * [column]="column"
22423
+ * [filter]="filter"
22424
+ * [filterService]="filterService">
22425
+ * <kendo-treelist-filter-after-operator></kendo-treelist-filter-after-operator>
22426
+ * </kendo-treelist-date-filter-menu>
22427
+ * </ng-template>
22428
+ * </kendo-treelist-column>
22429
+ * ```
21622
22430
  */
21623
22431
  class AfterFilterOperatorComponent extends FilterOperatorBase {
21624
22432
  constructor(localization) { super('after', localization); }
@@ -21655,8 +22463,34 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
21655
22463
  }], ctorParameters: function () { return [{ type: i1$1.LocalizationService }]; } });
21656
22464
 
21657
22465
  /**
21658
- * Represents the `GreaterOrEqualTo` (**Is after or equal to**) [date filter](slug:filtering_treelist#toc-date-filter) operator.
22466
+ * Represents the `GreaterOrEqualTo` (**Is after or equal to**) [date filter operator](slug:filtering_treelist#toc-date-filter) for the TreeList.
22467
+ * Use this operator to filter dates that are after or equal to a specific value.
21659
22468
  * [See example](slug:filter_row_treelist#toc-setting-the-default-filter-operator).
22469
+ *
22470
+ * @example
22471
+ * ```html Filter Cell
22472
+ * <kendo-treelist-column field="hireDate">
22473
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
22474
+ * <kendo-treelist-date-filter-cell
22475
+ * [column]="column"
22476
+ * [filter]="filter">
22477
+ * <kendo-treelist-filter-after-eq-operator></kendo-treelist-filter-after-eq-operator>
22478
+ * </kendo-treelist-date-filter-cell>
22479
+ * </ng-template>
22480
+ * </kendo-treelist-column>
22481
+ * ```
22482
+ * ```html Filter Menu
22483
+ * <kendo-treelist-column field="hireDate">
22484
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
22485
+ * <kendo-treelist-date-filter-menu
22486
+ * [column]="column"
22487
+ * [filter]="filter"
22488
+ * [filterService]="filterService">
22489
+ * <kendo-treelist-filter-after-eq-operator></kendo-treelist-filter-after-eq-operator>
22490
+ * </kendo-treelist-date-filter-menu>
22491
+ * </ng-template>
22492
+ * </kendo-treelist-column>
22493
+ * ```
21660
22494
  */
21661
22495
  class AfterEqFilterOperatorComponent extends FilterOperatorBase {
21662
22496
  constructor(localization) { super('after-eq', localization); }
@@ -21693,8 +22527,34 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
21693
22527
  }], ctorParameters: function () { return [{ type: i1$1.LocalizationService }]; } });
21694
22528
 
21695
22529
  /**
21696
- * Represents the `LessOrEqualTo` (**Is before or equal to**) [date filter](slug:filtering_treelist#toc-date-filter) operator.
22530
+ * Represents the `LessOrEqualTo` (**Is before or equal to**) [date filter operator](slug:filtering_treelist#toc-date-filter) for the TreeList.
22531
+ * Use this operator to filter dates that are before or equal to a specific value.
21697
22532
  * [See example](slug:filter_row_treelist#toc-setting-the-default-filter-operator).
22533
+ *
22534
+ * @example
22535
+ * ```html Filter Cell
22536
+ * <kendo-treelist-column field="hireDate">
22537
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
22538
+ * <kendo-treelist-date-filter-cell
22539
+ * [column]="column"
22540
+ * [filter]="filter">
22541
+ * <kendo-treelist-filter-before-eq-operator></kendo-treelist-filter-before-eq-operator>
22542
+ * </kendo-treelist-date-filter-cell>
22543
+ * </ng-template>
22544
+ * </kendo-treelist-column>
22545
+ * ```
22546
+ * ```html Filter Menu
22547
+ * <kendo-treelist-column field="hireDate">
22548
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
22549
+ * <kendo-treelist-date-filter-menu
22550
+ * [column]="column"
22551
+ * [filter]="filter"
22552
+ * [filterService]="filterService">
22553
+ * <kendo-treelist-filter-before-eq-operator></kendo-treelist-filter-before-eq-operator>
22554
+ * </kendo-treelist-date-filter-menu>
22555
+ * </ng-template>
22556
+ * </kendo-treelist-column>
22557
+ * ```
21698
22558
  */
21699
22559
  class BeforeEqFilterOperatorComponent extends FilterOperatorBase {
21700
22560
  constructor(localization) { super('before-eq', localization); }
@@ -21731,8 +22591,34 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
21731
22591
  }], ctorParameters: function () { return [{ type: i1$1.LocalizationService }]; } });
21732
22592
 
21733
22593
  /**
21734
- * Represents the `Less than` (**Is before**) [date filter](slug:filtering_treelist#toc-date-filter) operator.
22594
+ * Represents the `Less than` (**Is before**) [date filter operator](slug:filtering_treelist#toc-date-filter) for the TreeList.
22595
+ * Use this operator to filter dates that are before a specific value.
21735
22596
  * [See example](slug:filter_row_treelist#toc-setting-the-default-filter-operator).
22597
+ *
22598
+ * @example
22599
+ * ```html Filer Cell
22600
+ * <kendo-treelist-column field="hireDate">
22601
+ * <ng-template kendoTreeListFilterCellTemplate let-filter let-column="column">
22602
+ * <kendo-treelist-date-filter-cell
22603
+ * [column]="column"
22604
+ * [filter]="filter">
22605
+ * <kendo-treelist-filter-before-operator></kendo-treelist-filter-before-operator>
22606
+ * </kendo-treelist-date-filter-cell>
22607
+ * </ng-template>
22608
+ * </kendo-treelist-column>
22609
+ * ```
22610
+ * ```html Filter Menu
22611
+ * <kendo-treelist-column field="hireDate">
22612
+ * <ng-template kendoTreeListFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
22613
+ * <kendo-treelist-date-filter-menu
22614
+ * [column]="column"
22615
+ * [filter]="filter"
22616
+ * [filterService]="filterService">
22617
+ * <kendo-treelist-filter-before-operator></kendo-treelist-filter-before-operator>
22618
+ * </kendo-treelist-date-filter-menu>
22619
+ * </ng-template>
22620
+ * </kendo-treelist-column>
22621
+ * ```
21736
22622
  */
21737
22623
  class BeforeFilterOperatorComponent extends FilterOperatorBase {
21738
22624
  constructor(localization) { super('before', localization); }
@@ -21769,15 +22655,14 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
21769
22655
  }], ctorParameters: function () { return [{ type: i1$1.LocalizationService }]; } });
21770
22656
 
21771
22657
  /**
21772
- * Represents the component for selecting columns in the TreeList.
21773
- * To show and hide the columns without including the column chooser item in the [Column Menu](slug:columnmenu_treelist),
21774
- * add the component inside the [`ToolbarTemplate`]({% slug api_treelist_toolbartemplatedirective %}) directive.
22658
+ * Represents the Kendo UI for Angular TreeList column chooser component.
22659
+ * Use this component to let users show or hide columns in the TreeList. To display the column chooser outside the Column Menu, add it inside the [`ToolbarTemplate`]({% slug api_treelist_toolbartemplatedirective %}) directive.
21775
22660
  *
21776
22661
  * @example
21777
22662
  * ```html
21778
22663
  * <kendo-treelist ...>
21779
- * <ng-template kendoTreeListToolbarTemplate>
21780
- * <kendo-treelist-column-chooser> </kendo-treelist-column-chooser>
22664
+ * <ng-template kendoTreeListColumnMenuTemplate>
22665
+ * <kendo-treelist-column-chooser></kendo-treelist-column-chooser>
21781
22666
  * </ng-template>
21782
22667
  * </kendo-treelist>
21783
22668
  * ```
@@ -21790,14 +22675,12 @@ class ColumnChooserComponent {
21790
22675
  renderer;
21791
22676
  changeDetector;
21792
22677
  /**
21793
- * Specifies if the changes in the visibility of the column will be immediately applied.
21794
- *
22678
+ * Specifies if changes in column visibility are applied immediately.
21795
22679
  * @default false
21796
22680
  */
21797
22681
  autoSync = false;
21798
22682
  /**
21799
22683
  * Specifies if all columns can be hidden.
21800
- *
21801
22684
  * @default true
21802
22685
  */
21803
22686
  allowHideAll = true;
@@ -22046,7 +22929,14 @@ const componentColumns = (component) => {
22046
22929
  return orderBy(columns, [{ field: 'locked', dir: 'desc' }]);
22047
22930
  };
22048
22931
  /**
22049
- * Configures the settings for the export of TreeList in Excel ([see example]({% slug excelexport_treelist %})).
22932
+ * Configures the settings for exporting the TreeList to Excel. [See example]({% slug excelexport_treelist %}).
22933
+ *
22934
+ * @example
22935
+ * ```html
22936
+ * <kendo-treelist [data]="data" [height]="500">
22937
+ * <kendo-treelist-excel fileName="Employees.xlsx"></kendo-treelist-excel>
22938
+ * </kendo-treelist>
22939
+ * ```
22050
22940
  */
22051
22941
  class ExcelComponent {
22052
22942
  excelService;
@@ -22058,57 +22948,56 @@ class ExcelComponent {
22058
22948
  */
22059
22949
  fileName = 'Export.xlsx';
22060
22950
  /**
22061
- * Enables or disables column filtering in the Excel file. This behavior is different from the filtering feature of the TreeList.
22951
+ * Enables or disables column filtering in the Excel file. This is different from the TreeList filtering feature.
22062
22952
  */
22063
22953
  filterable;
22064
22954
  /**
22065
- * The author of the workbook.
22955
+ * Sets the author of the workbook.
22066
22956
  */
22067
22957
  creator;
22068
22958
  /**
22069
- * The date on which the workbook was created. Defaults to `new Date()`.
22959
+ * Sets the date the workbook was created. Defaults to `new Date()`.
22070
22960
  */
22071
22961
  date;
22072
22962
  /**
22073
- * If set to `true`, the content is forwarded to `proxyURL` even if the browser supports the saving of files locally.
22963
+ * If set to `true`, forwards the content to `proxyURL` even if the browser supports saving files locally.
22074
22964
  */
22075
22965
  forceProxy;
22076
22966
  /**
22077
- * The URL of the server-side proxy which streams the file to the end user.
22078
- * Using a proxy is required if the browser is not capable of saving files locally.
22967
+ * The URL of the server-side proxy that streams the file to the user.
22968
+ * Use a proxy if the browser cannot save files locally.
22079
22969
  *
22080
22970
  * Optionally, set up a proxy to reduce memory usage. This avoids copying the file contents into memory,
22081
22971
  * but transmits it over the network instead. For this use case, set [forceProxy](#toc-forceproxy) to `true`
22082
22972
  * to skip client-side saving even in browsers that support it.
22083
22973
  *
22084
- * In the request body, the proxy receives a POST request with the specific parameters. [See example](slug:server_proxy#toc-implementations).
22974
+ * The proxy receives a POST request with specific parameters in the request body. [See example](slug:server_proxy#toc-implementations).
22085
22975
  * The proxy returns the decoded file with the `"Content-Disposition"` header set to `attachment; filename="<fileName.xslx>"`.
22086
22976
  *
22087
- * For details on the server-side proxy usage and implementation, see the [File Saver]({% slug overview_filesaver %}) documentation.
22088
- *
22977
+ * For details on server-side proxy usage and implementation, see the [File Saver]({% slug overview_filesaver %}) documentation.
22089
22978
  */
22090
22979
  proxyURL;
22091
22980
  /**
22092
- * The function that is used to get the exported data options. By default, uses the current data of the TreeList.
22093
- * To export data that is different from the current TreeList data, provide a custom function.
22981
+ * The function used to get the exported data options. By default, uses the current TreeList data.
22982
+ * To export data different from the current TreeList data, provide a custom function.
22094
22983
  */
22095
22984
  fetchData;
22096
22985
  /**
22097
- * Specifies if the item levels in the Excel file are collapsible. Applicable only if the treelist has footers.
22986
+ * Specifies if item levels in the Excel file are collapsible. Applies only if the TreeList has footers.
22098
22987
  */
22099
22988
  collapsible;
22100
22989
  /**
22101
- * Specifies if export should include all pages
22990
+ * Specifies if export should include all pages.
22102
22991
  * @default true
22103
22992
  */
22104
22993
  allPages = true;
22105
22994
  /**
22106
- * Specifies if the export should expand all items or should use the current TreeList state.
22995
+ * Specifies if the export should expand all items or use the current TreeList state.
22107
22996
  * @default true
22108
22997
  */
22109
22998
  expandAll = true;
22110
22999
  /**
22111
- * The options of the cells that are inserted before the data to indicate the hierarchy.
23000
+ * The options for the cells inserted before the data to indicate the hierarchy.
22112
23001
  */
22113
23002
  paddingCellOptions;
22114
23003
  /**
@@ -22241,18 +23130,14 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
22241
23130
  }] } });
22242
23131
 
22243
23132
  /**
22244
- * Represents the `export-to-Excel` command of the TreeList. You can apply this
22245
- * directive to any `button` element inside a
22246
- * [`ToolbarTemplate`](slug:toolbartemplate_treelist).
22247
- * When the user clicks a button associated with the directive, the
22248
- * [`excelExport`]({% slug api_treelist_treelistcomponent %}#toc-excelexport) event
22249
- * fires ([see example]({% slug excelexport_treelist %})).
23133
+ * Represents the `export-to-Excel` command of the TreeList. Apply this directive to any `button` element inside a [`ToolbarTemplate`](slug:toolbartemplate_treelist).
23134
+ * When the user clicks a button with this directive, the [`excelExport`]({% slug api_treelist_treelistcomponent %}#toc-excelexport) event fires ([see example]({% slug excelexport_treelist %})).
22250
23135
  *
22251
23136
  * @example
22252
23137
  * ```html
22253
23138
  * <kendo-treelist ...>
22254
23139
  * <ng-template kendoTreeListToolbarTemplate>
22255
- * <button kendoTreeListExcelCommand>Export to PDF</button>
23140
+ * <button kendoTreeListExcelCommand>Export to Excel</button>
22256
23141
  * </ng-template>
22257
23142
  * <kendo-treelist-excel fileName="TreeList.xlsx"> </kendo-treelist-excel>
22258
23143
  * </kendo-treelist>
@@ -22320,24 +23205,22 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
22320
23205
  }] } });
22321
23206
 
22322
23207
  /**
22323
- * Represents the `export-to-Excel` toolbar tool of the TreeList.
22324
- * You can apply this directive to any `kendo-toolbar-button` element inside a
22325
- * ToolbarComponent used in the TreeList.
23208
+ * 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.
22326
23209
  *
22327
- * When the user clicks a button associated with the directive, the
22328
- * [excelExport]({% slug api_treelist_treelistcomponent %}#toc-excelexport) event
22329
- * fires ([see example]({% slug excelexport_treelist %})).
23210
+ * When the user clicks a button with this directive, the [excelExport]({% slug api_treelist_treelistcomponent %}#toc-excelexport) event fires ([see example]({% slug excelexport_treelist %})).
22330
23211
  *
22331
23212
  * @example
22332
- * ```html-no-run
23213
+ * ```html
22333
23214
  * <kendo-treelist>
22334
- * <kendo-toolbar>
23215
+ * <kendo-toolbar>
22335
23216
  * <kendo-toolbar-button text="Excel Export" kendoTreeListExcelTool></kendo-toolbar-button>
22336
- * </kendo-toolbar>
22337
- * <kendo-treelist-excel fileName="TreeList.xlsx">
22338
- * </kendo-treelist-excel>
23217
+ * </kendo-toolbar>
23218
+ * <kendo-treelist-excel fileName="TreeList.xlsx">
23219
+ * </kendo-treelist-excel>
22339
23220
  * </kendo-treelist>
22340
23221
  * ```
23222
+ * @remarks
23223
+ * Applied to: {@link ToolBarButtonComponent}
22341
23224
  */
22342
23225
  class ExcelCommandToolbarDirective {
22343
23226
  excelService;
@@ -22376,12 +23259,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
22376
23259
 
22377
23260
  /**
22378
23261
  * Represents the Kendo UI PDFMargin component for Angular.
22379
- * The supported units are:
22380
- * `"mm"`
22381
- * `"cm"`
22382
- * `"in"`
22383
- * `"pt"` (default).
23262
+ * The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"` (default).
22384
23263
  * Numbers are considered to be points (`"pt"`).
23264
+ *
23265
+ * @example
23266
+ * ```html
23267
+ * <kendo-treelist>
23268
+ * <kendo-treelist-pdf [allPages]="true" [delay]="100">
23269
+ * <kendo-treelist-pdf-margin top="1cm" bottom="1cm" left="1cm" right="1cm"></kendo-treelist-pdf-margin>
23270
+ * </kendo-treelist-pdf>
23271
+ * </kendo-treelist>
23272
+ * ```
22385
23273
  */
22386
23274
  class PDFMarginComponent extends PDFExportMarginComponent {
22387
23275
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: PDFMarginComponent, deps: null, target: i0.ɵɵFactoryTarget.Component });
@@ -22397,8 +23285,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
22397
23285
  }] });
22398
23286
 
22399
23287
  /**
22400
- * Represents the PDF page template of the TreeList that helps to customize the PDF pages. To define a page template,
22401
- * nest an `<ng-template>` tag with the `kendoTreeListPDFTemplate` directive inside `<kendo-treelist-pdf>`.
23288
+ * Represents the PDF page template of the TreeList. Use this directive to customize the PDF pages.
23289
+ * To define a page template, nest an `<ng-template>` tag with the `kendoTreeListPDFTemplate` directive inside `<kendo-treelist-pdf>`.
22402
23290
  *
22403
23291
  * The template context provides the following fields:
22404
23292
  * - `pageNumber`&mdash;Defines PDF page number.
@@ -22603,14 +23491,24 @@ const createDiv = (className) => {
22603
23491
  return createElement('div', className);
22604
23492
  };
22605
23493
  /**
22606
- * Configures the settings for the export of TreeList in PDF ([see example]({% slug pdfexport_treelist %})).
23494
+ * Configures the settings for exporting TreeList to PDF ([see example]({% slug pdfexport_treelist %})).
23495
+ *
23496
+ * @example
23497
+ * ```html
23498
+ * <kendo-treelist>
23499
+ * <kendo-treelist-pdf [allPages]="true" [fileName]="'export.pdf'"></kendo-treelist-pdf>
23500
+ * </kendo-treelist>
23501
+ * ```
23502
+ *
23503
+ * @remarks
23504
+ * Supported children components are: {@link PDFMarginComponent}.
22607
23505
  */
22608
23506
  class PDFComponent extends PDFExportComponent {
22609
23507
  pdfService;
22610
23508
  suspendService;
22611
23509
  ngZone;
22612
23510
  /**
22613
- * Exports all TreeList pages, starting from the first one.
23511
+ * Specifies if the export includes all TreeList pages, starting from the first one.
22614
23512
  */
22615
23513
  allPages;
22616
23514
  columns = new QueryList();
@@ -22828,9 +23726,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
22828
23726
 
22829
23727
  /**
22830
23728
  * Represents the `export-to-PDF` command of the TreeList.
22831
- * You can apply this directive to any `button` element inside a
23729
+ * Apply this directive to any `button` element inside a
22832
23730
  * [`ToolbarTemplate`](slug:toolbartemplate_treelist).
22833
- * When the user clicks a button that is associated with the directive, the
23731
+ * When you click a button that contains the directive, the
22834
23732
  * [`pdfExport`]({% slug api_treelist_treelistcomponent %}#toc-pdfexport) event
22835
23733
  * fires ([see example]({% slug pdfexport_treelist %})).
22836
23734
  *
@@ -22906,21 +23804,18 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
22906
23804
  }] } });
22907
23805
 
22908
23806
  /**
22909
- * Represents the command for adding a new item to the TreeList.
22910
- * You can apply this directive to any `kendo-toolbar-button` element inside a
22911
- * ToolbarComponent used in the TreeList.
22912
- *
22913
- * When the user clicks the toolbar button that is associated with the directive, the
22914
- * [add]({% slug api_treelist_treelistcomponent %}#toc-add) event is triggered.
23807
+ * Represents the command for adding a new item to the TreeList. Apply this directive to any `kendo-toolbar-button` element inside a ToolbarComponent. When the user clicks the toolbar button associated with the directive, the [`add`]({% slug api_treelist_treelistcomponent %}#toc-add) event is triggered.
22915
23808
  *
22916
23809
  * @example
22917
- * ```html-no-run
22918
- * <kendo-grid>
22919
- * <kendo-toolbar>
22920
- * <kendo-toolbar-button text="Add new" kendoTreeListAddTool></kendo-toolbar-button>
22921
- * </kendo-toolbar>
22922
- * </kendo-grid>
23810
+ * ```html
23811
+ * <kendo-treelist>
23812
+ * <kendo-toolbar>
23813
+ * <kendo-toolbar-button text="Add new" kendoTreeListAddTool></kendo-toolbar-button>
23814
+ * </kendo-toolbar>
23815
+ * </kendo-treelist>
22923
23816
  * ```
23817
+ * @remarks
23818
+ * Applied to: {@link ToolBarButtonComponent}
22924
23819
  */
22925
23820
  class AddCommandToolbarDirective {
22926
23821
  editService;
@@ -22959,23 +23854,25 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
22959
23854
 
22960
23855
  /**
22961
23856
  * Represents the `export-to-PDF` toolbar tool of the TreeList.
22962
- * You can apply this directive to any `kendo-toolbar-button` element inside a
22963
- * ToolbarComponent used in the TreeList.
23857
+ * Apply this directive to any `kendo-toolbar-button` element inside a
23858
+ * ToolbarComponent.
22964
23859
  *
22965
- * When the user clicks the toolbar button that is associated with the directive, the
22966
- * [pdfExport]({% slug api_treelist_treelistcomponent %}#toc-pdfexport) event
23860
+ * When you click the toolbar button that contains the directive, the
23861
+ * [`pdfExport`]({% slug api_treelist_treelistcomponent %}#toc-pdfexport) event
22967
23862
  * fires ([see example]({% slug pdfexport_treelist %})).
22968
23863
  *
22969
23864
  * @example
22970
- * ```html-no-run
23865
+ * ```html
22971
23866
  * <kendo-treelist>
22972
- * <kendo-toolbar>
23867
+ * <kendo-toolbar>
22973
23868
  * <kendo-toolbar-button text="PDF Export" kendoTreeListPDFTool></kendo-toolbar-button>
22974
- * </kendo-toolbar>
22975
- * <kendo-treelist-pdf fileName="TreeList.pdf">
22976
- * </kendo-treelist-pdf>
23869
+ * </kendo-toolbar>
23870
+ * <kendo-treelist-pdf fileName="TreeList.pdf">
23871
+ * </kendo-treelist-pdf>
22977
23872
  * </kendo-treelist>
22978
23873
  * ```
23874
+ * @remarks
23875
+ * Applied to: {@link ToolBarButtonComponent}
22979
23876
  */
22980
23877
  class PDFCommandToolbarDirective {
22981
23878
  pdfService;
@@ -23014,7 +23911,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
23014
23911
 
23015
23912
  /**
23016
23913
  * @hidden
23017
- * Utility array that contains the former Shared module exports
23914
+ * Utility array that contains the former Shared module exports.
23018
23915
  */
23019
23916
  const SHARED_EXPORTS = [
23020
23917
  ColumnComponent,
@@ -23034,7 +23931,7 @@ const SHARED_EXPORTS = [
23034
23931
  ];
23035
23932
  /**
23036
23933
  * @hidden
23037
- * Utility array that contains the Body module exports
23934
+ * Utility array that contains the Body module exports.
23038
23935
  */
23039
23936
  const BODY_EXPORTS = [
23040
23937
  CommandColumnComponent,
@@ -23052,7 +23949,7 @@ const BODY_EXPORTS = [
23052
23949
  ];
23053
23950
  /**
23054
23951
  * @hidden
23055
- * Utility array that contains the Header module exports
23952
+ * Utility array that contains the Header module exports.
23056
23953
  */
23057
23954
  const HEADER_EXPORTS = [
23058
23955
  HeaderComponent,
@@ -23061,7 +23958,7 @@ const HEADER_EXPORTS = [
23061
23958
  ];
23062
23959
  /**
23063
23960
  * @hidden
23064
- * Utility array that contains the former SharedFilter module exports
23961
+ * Utility array that contains the former SharedFilter module exports.
23065
23962
  */
23066
23963
  const SHARED_FILTER_EXPORTS = [
23067
23964
  FilterCellOperatorsComponent,
@@ -23088,7 +23985,7 @@ const SHARED_FILTER_EXPORTS = [
23088
23985
  ];
23089
23986
  /**
23090
23987
  * @hidden
23091
- * Utility array that contains the former ColumnMenu module exports
23988
+ * Utility array that contains the former ColumnMenu module exports.
23092
23989
  */
23093
23990
  const ROW_FILTER_EXPORTS = [
23094
23991
  FilterRowComponent,
@@ -23124,7 +24021,7 @@ const FILTER_MENU_EXPORTS = [
23124
24021
  ];
23125
24022
  /**
23126
24023
  * @hidden
23127
- * Utility array that contains the former ColumnMenu module exports
24024
+ * Utility array that contains the former ColumnMenu module exports.
23128
24025
  */
23129
24026
  const COLUMN_MENU_EXPORTS = [
23130
24027
  ColumnChooserComponent,
@@ -23140,7 +24037,7 @@ const COLUMN_MENU_EXPORTS = [
23140
24037
  ];
23141
24038
  /**
23142
24039
  * @hidden
23143
- * Utility array that contains the Excel module exports
24040
+ * Utility array that contains the Excel module exports.
23144
24041
  */
23145
24042
  const KENDO_TREELIST_EXCEL_EXPORT = [
23146
24043
  ExcelComponent,
@@ -23155,7 +24052,7 @@ const KENDO_TREELIST_EXCEL_EXPORT = [
23155
24052
  ];
23156
24053
  /**
23157
24054
  * @hidden
23158
- * Utility array that contains the PDF module exports
24055
+ * Utility array that contains the PDF module exports.
23159
24056
  */
23160
24057
  const KENDO_TREELIST_PDF_EXPORT = [
23161
24058
  PDFComponent,
@@ -23165,7 +24062,8 @@ const KENDO_TREELIST_PDF_EXPORT = [
23165
24062
  PDFCommandToolbarDirective
23166
24063
  ];
23167
24064
  /**
23168
- * Utility array that contains all `@progress/kendo-angular-treelist` related components and directives
24065
+ * Utility array that contains all `@progress/kendo-angular-treelist`-related components and directives.
24066
+ * Use it to import all TreeList components and directives into a standalone Angular application.
23169
24067
  */
23170
24068
  const KENDO_TREELIST = [
23171
24069
  TreeListComponent,
@@ -23193,22 +24091,20 @@ const KENDO_TREELIST = [
23193
24091
 
23194
24092
  // IMPORTANT: NgModule export kept for backwards compatibility
23195
24093
  /**
23196
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
23197
- * definition for the TreeList component.
24094
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) definition for the TreeList component.
24095
+ * Use this module to enable TreeList features in your application.
23198
24096
  *
23199
24097
  * @example
23200
- *
23201
24098
  * ```ts
23202
24099
  * import { NgModule } from '@angular/core';
23203
24100
  * import { BrowserModule } from "@angular/platform-browser";
23204
24101
  * import { TreeListModule } from '@progress/kendo-angular-treelist';
23205
- *
23206
24102
  * import { AppComponent } from './app.component';
23207
24103
  *
23208
- * _@NgModule({
23209
- * declarations: [AppComponent],
23210
- * imports: [BrowserModule, TreeListModule],
23211
- * bootstrap: [AppComponent]
24104
+ * @NgModule({
24105
+ * declarations: [AppComponent],
24106
+ * imports: [BrowserModule, TreeListModule],
24107
+ * bootstrap: [AppComponent]
23212
24108
  * })
23213
24109
  * export class AppModule {}
23214
24110
  * ```
@@ -23257,8 +24153,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
23257
24153
 
23258
24154
  // IMPORTANT: NgModule export kept for backwards compatibility
23259
24155
  /**
23260
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
23261
- * definition for the TreeList PDF component.
24156
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) definition for the TreeList PDF component.
24157
+ * Use this module to enable PDF export features of the TreeList inside NgModule-based Angular application.
23262
24158
  *
23263
24159
  * @example
23264
24160
  *
@@ -23268,10 +24164,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
23268
24164
  * import { TreeListModule, PDFModule } from '@progress/kendo-angular-treelist';
23269
24165
  * import { AppComponent } from './app.component';
23270
24166
  *
23271
- * _@NgModule({
23272
- * declarations: [AppComponent],
23273
- * imports: [BrowserModule, TreeListModule, PDFModule],
23274
- * bootstrap: [AppComponent]
24167
+ * @NgModule({
24168
+ * declarations: [AppComponent],
24169
+ * imports: [BrowserModule, TreeListModule, PDFModule],
24170
+ * bootstrap: [AppComponent]
23275
24171
  * })
23276
24172
  * export class AppModule {}
23277
24173
  * ```
@@ -23292,7 +24188,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
23292
24188
 
23293
24189
  // IMPORTANT: NgModule export kept for backwards compatibility
23294
24190
  /**
23295
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
24191
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi'])
23296
24192
  * definition for the Excel component of the TreeList.
23297
24193
  *
23298
24194
  * @example
@@ -23302,7 +24198,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
23302
24198
  * import { TreeListModule, ExcelModule } from '@progress/kendo-angular-treelist';
23303
24199
  * import { AppComponent } from './app.component';
23304
24200
  *
23305
- * _@NgModule({
24201
+ * @NgModule({
23306
24202
  * declarations: [AppComponent],
23307
24203
  * imports: [BrowserModule, TreeListModule, ExcelModule],
23308
24204
  * bootstrap: [AppComponent]