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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (244) hide show
  1. package/binding-directives/base-binding.directive.d.ts +6 -3
  2. package/binding-directives/flat-binding.directive.d.ts +7 -8
  3. package/binding-directives/hierarchy-binding.directive.d.ts +13 -6
  4. package/column-menu/column-chooser.component.d.ts +5 -8
  5. package/column-menu/column-locked-change-event.d.ts +4 -2
  6. package/column-menu/column-menu-autosize-all.component.d.ts +3 -5
  7. package/column-menu/column-menu-autosize.component.d.ts +5 -7
  8. package/column-menu/column-menu-chooser.component.d.ts +15 -6
  9. package/column-menu/column-menu-expandable-item.interface.d.ts +4 -3
  10. package/column-menu/column-menu-filter.component.d.ts +14 -4
  11. package/column-menu/column-menu-item-base.d.ts +1 -1
  12. package/column-menu/column-menu-item-content-template.directive.d.ts +3 -5
  13. package/column-menu/column-menu-item.component.d.ts +7 -10
  14. package/column-menu/column-menu-item.directive.d.ts +23 -1
  15. package/column-menu/column-menu-lock.component.d.ts +14 -4
  16. package/column-menu/column-menu-settings.interface.d.ts +5 -5
  17. package/column-menu/column-menu-sort.component.d.ts +12 -2
  18. package/column-menu/column-menu-template.directive.d.ts +3 -5
  19. package/column-menu/column-menu.component.d.ts +14 -2
  20. package/column-menu/column-menu.service.d.ts +1 -2
  21. package/column-menu/column-visibility-change-event.d.ts +2 -2
  22. package/column-resizing/column-resize.interface.d.ts +3 -2
  23. package/columns/checkbox-column.component.d.ts +16 -4
  24. package/columns/column-base.d.ts +15 -28
  25. package/columns/column-group.component.d.ts +1 -2
  26. package/columns/column.component.d.ts +22 -18
  27. package/columns/command-column.component.d.ts +3 -4
  28. package/columns/rowreorder-column.component.d.ts +9 -1
  29. package/columns/sort-settings.d.ts +5 -23
  30. package/columns/span-column.component.d.ts +11 -16
  31. package/common/cell-click-event-args.interface.d.ts +4 -3
  32. package/common/create-form-group.d.ts +2 -1
  33. package/common/pager-settings.d.ts +7 -8
  34. package/common/remove-confirmation.d.ts +1 -1
  35. package/common/single-popup.service.d.ts +7 -6
  36. package/data/change-event-args.interface.d.ts +6 -7
  37. package/data/data-item.interface.d.ts +5 -5
  38. package/data/data.collection.d.ts +4 -3
  39. package/data/treelist-item.interface.d.ts +2 -2
  40. package/directives.d.ts +10 -9
  41. package/dragdrop/column-reorder-config.d.ts +3 -2
  42. package/dragdrop/column-reorder-event.d.ts +4 -6
  43. package/editing/add-command-tool.directive.d.ts +9 -12
  44. package/editing/add-command.directive.d.ts +5 -9
  45. package/editing/add-event-args.interface.d.ts +3 -2
  46. package/editing/cancel-command.directive.d.ts +5 -8
  47. package/editing/cancel-event-args.interface.d.ts +1 -1
  48. package/editing/cell-close-event.d.ts +5 -5
  49. package/editing/edit-command.directive.d.ts +5 -9
  50. package/editing/edit-event-args.interface.d.ts +4 -3
  51. package/editing/edit-template.directive.d.ts +2 -4
  52. package/editing/remove-command.directive.d.ts +5 -8
  53. package/editing/remove-event-args.interface.d.ts +3 -2
  54. package/editing/save-command.directive.d.ts +5 -8
  55. package/editing/save-event-args.interface.d.ts +4 -3
  56. package/editing-directives/create-form-group-args.interface.d.ts +1 -1
  57. package/editing-directives/edit-service.interface.d.ts +13 -5
  58. package/editing-directives/editing-directive-base.d.ts +3 -3
  59. package/editing-directives/in-cell-editing.directive.d.ts +12 -2
  60. package/editing-directives/reactive-editing.directive.d.ts +12 -2
  61. package/editing-directives/template-editing.directive.d.ts +13 -3
  62. package/esm2022/binding-directives/base-binding.directive.mjs +6 -3
  63. package/esm2022/binding-directives/flat-binding.directive.mjs +7 -8
  64. package/esm2022/binding-directives/hierarchy-binding.directive.mjs +13 -6
  65. package/esm2022/column-menu/column-chooser.component.mjs +5 -8
  66. package/esm2022/column-menu/column-locked-change-event.mjs +4 -2
  67. package/esm2022/column-menu/column-menu-autosize-all.component.mjs +3 -5
  68. package/esm2022/column-menu/column-menu-autosize.component.mjs +5 -7
  69. package/esm2022/column-menu/column-menu-chooser.component.mjs +15 -6
  70. package/esm2022/column-menu/column-menu-filter.component.mjs +14 -4
  71. package/esm2022/column-menu/column-menu-item-base.mjs +1 -1
  72. package/esm2022/column-menu/column-menu-item-content-template.directive.mjs +3 -5
  73. package/esm2022/column-menu/column-menu-item.component.mjs +7 -10
  74. package/esm2022/column-menu/column-menu-item.directive.mjs +23 -1
  75. package/esm2022/column-menu/column-menu-lock.component.mjs +14 -4
  76. package/esm2022/column-menu/column-menu-sort.component.mjs +12 -2
  77. package/esm2022/column-menu/column-menu-template.directive.mjs +3 -5
  78. package/esm2022/column-menu/column-menu.component.mjs +14 -2
  79. package/esm2022/column-menu/column-menu.service.mjs +1 -2
  80. package/esm2022/column-menu/column-visibility-change-event.mjs +2 -2
  81. package/esm2022/columns/checkbox-column.component.mjs +16 -4
  82. package/esm2022/columns/column-base.mjs +15 -28
  83. package/esm2022/columns/column-group.component.mjs +1 -2
  84. package/esm2022/columns/column.component.mjs +22 -18
  85. package/esm2022/columns/command-column.component.mjs +3 -4
  86. package/esm2022/columns/rowreorder-column.component.mjs +9 -1
  87. package/esm2022/columns/span-column.component.mjs +11 -16
  88. package/esm2022/common/single-popup.service.mjs +7 -6
  89. package/esm2022/directives.mjs +10 -9
  90. package/esm2022/dragdrop/column-reorder-event.mjs +4 -6
  91. package/esm2022/editing/add-command-tool.directive.mjs +9 -12
  92. package/esm2022/editing/add-command.directive.mjs +5 -9
  93. package/esm2022/editing/cancel-command.directive.mjs +5 -8
  94. package/esm2022/editing/cell-close-event.mjs +5 -5
  95. package/esm2022/editing/edit-command.directive.mjs +5 -9
  96. package/esm2022/editing/edit-template.directive.mjs +2 -4
  97. package/esm2022/editing/remove-command.directive.mjs +5 -8
  98. package/esm2022/editing/save-command.directive.mjs +5 -8
  99. package/esm2022/editing-directives/editing-directive-base.mjs +3 -3
  100. package/esm2022/editing-directives/in-cell-editing.directive.mjs +12 -2
  101. package/esm2022/editing-directives/reactive-editing.directive.mjs +12 -2
  102. package/esm2022/editing-directives/template-editing.directive.mjs +13 -3
  103. package/esm2022/excel/excel-command-tool.directive.mjs +9 -11
  104. package/esm2022/excel/excel-command.directive.mjs +3 -7
  105. package/esm2022/excel/excel.component.mjs +22 -16
  106. package/esm2022/excel/excel.module.mjs +2 -2
  107. package/esm2022/expand-state/expand-event.mjs +3 -3
  108. package/esm2022/expand-state/expandable.directive.mjs +8 -5
  109. package/esm2022/filtering/base-filter-cell.component.mjs +3 -1
  110. package/esm2022/filtering/cell/boolean-filter-cell.component.mjs +1 -0
  111. package/esm2022/filtering/cell/date-filter-cell.component.mjs +5 -3
  112. package/esm2022/filtering/cell/filter-cell-operators.component.mjs +2 -1
  113. package/esm2022/filtering/cell/filter-cell-template.directive.mjs +18 -3
  114. package/esm2022/filtering/cell/numeric-filter-cell.component.mjs +7 -5
  115. package/esm2022/filtering/cell/string-filter-cell.component.mjs +7 -7
  116. package/esm2022/filtering/date-filter.component.mjs +8 -3
  117. package/esm2022/filtering/filter.service.mjs +2 -4
  118. package/esm2022/filtering/menu/boolean-filter-menu.component.mjs +3 -3
  119. package/esm2022/filtering/menu/date-filter-menu.component.mjs +6 -3
  120. package/esm2022/filtering/menu/filter-menu-template.directive.mjs +18 -2
  121. package/esm2022/filtering/menu/numeric-filter-menu.component.mjs +9 -5
  122. package/esm2022/filtering/menu/string-filter-menu.component.mjs +6 -4
  123. package/esm2022/filtering/numeric-filter.component.mjs +3 -3
  124. package/esm2022/filtering/operators/after-eq-filter-operator.component.mjs +27 -1
  125. package/esm2022/filtering/operators/after-filter-operator.component.mjs +27 -1
  126. package/esm2022/filtering/operators/before-eq-filter-operator.component.mjs +27 -1
  127. package/esm2022/filtering/operators/before-filter-operator.component.mjs +27 -1
  128. package/esm2022/filtering/operators/contains-filter-operator.component.mjs +28 -1
  129. package/esm2022/filtering/operators/ends-with-filter-operator.component.mjs +28 -1
  130. package/esm2022/filtering/operators/eq-filter-operator.component.mjs +76 -1
  131. package/esm2022/filtering/operators/filter-operator.base.mjs +1 -1
  132. package/esm2022/filtering/operators/gt-filter-operator.component.mjs +28 -2
  133. package/esm2022/filtering/operators/gte-filter-operator.component.mjs +27 -1
  134. package/esm2022/filtering/operators/is-empty-filter-operator.component.mjs +28 -1
  135. package/esm2022/filtering/operators/is-not-empty-filter-operator.component.mjs +28 -1
  136. package/esm2022/filtering/operators/is-not-null-filter-operator.component.mjs +76 -1
  137. package/esm2022/filtering/operators/isnull-filter-operator.component.mjs +76 -1
  138. package/esm2022/filtering/operators/lt-filter-operator.component.mjs +27 -1
  139. package/esm2022/filtering/operators/lte-filter-operator.component.mjs +28 -2
  140. package/esm2022/filtering/operators/neq-filter-operator.component.mjs +76 -1
  141. package/esm2022/filtering/operators/not-contains-filter-operator.component.mjs +28 -1
  142. package/esm2022/filtering/operators/starts-with-filter-operator.component.mjs +28 -1
  143. package/esm2022/filtering/string-filter.component.mjs +1 -1
  144. package/esm2022/localization/custom-messages.component.mjs +11 -2
  145. package/esm2022/navigation/focusable.directive.mjs +4 -4
  146. package/esm2022/package-metadata.mjs +2 -2
  147. package/esm2022/pdf/pdf-command-tool.directive.mjs +11 -9
  148. package/esm2022/pdf/pdf-command.directive.mjs +2 -2
  149. package/esm2022/pdf/pdf-export-event.mjs +3 -1
  150. package/esm2022/pdf/pdf-margin.component.mjs +10 -5
  151. package/esm2022/pdf/pdf-template.directive.mjs +2 -2
  152. package/esm2022/pdf/pdf.component.mjs +12 -2
  153. package/esm2022/pdf/pdf.module.mjs +6 -6
  154. package/esm2022/rendering/cell-template.directive.mjs +8 -9
  155. package/esm2022/rendering/common/spacer.component.mjs +16 -5
  156. package/esm2022/rendering/footer-template.directive.mjs +10 -12
  157. package/esm2022/rendering/header/header-template.directive.mjs +4 -4
  158. package/esm2022/rendering/no-records-template.directive.mjs +2 -2
  159. package/esm2022/rendering/toolbar/toolbar-focusable.directive.mjs +13 -2
  160. package/esm2022/rendering/toolbar/toolbar-template.directive.mjs +4 -6
  161. package/esm2022/selection/selectable.directive.mjs +12 -0
  162. package/esm2022/selection/selection-change-event.mjs +1 -1
  163. package/esm2022/treelist.component.mjs +145 -109
  164. package/esm2022/treelist.module.mjs +6 -8
  165. package/esm2022/utils.mjs +1 -1
  166. package/excel/excel-command-tool.directive.d.ts +9 -11
  167. package/excel/excel-command.directive.d.ts +3 -7
  168. package/excel/excel-export-data.interface.d.ts +4 -4
  169. package/excel/excel.component.d.ts +22 -16
  170. package/excel/excel.module.d.ts +2 -2
  171. package/expand-state/expand-event.d.ts +3 -3
  172. package/expand-state/expandable-tree-component.d.ts +4 -6
  173. package/expand-state/expandable.directive.d.ts +8 -5
  174. package/fesm2022/progress-kendo-angular-treelist.mjs +1470 -574
  175. package/filtering/base-filter-cell.component.d.ts +3 -1
  176. package/filtering/cell/boolean-filter-cell.component.d.ts +1 -0
  177. package/filtering/cell/date-filter-cell.component.d.ts +5 -3
  178. package/filtering/cell/filter-cell-operators.component.d.ts +2 -1
  179. package/filtering/cell/filter-cell-template.directive.d.ts +18 -3
  180. package/filtering/cell/numeric-filter-cell.component.d.ts +7 -5
  181. package/filtering/cell/string-filter-cell.component.d.ts +7 -7
  182. package/filtering/date-filter.component.d.ts +8 -3
  183. package/filtering/filter.service.d.ts +2 -4
  184. package/filtering/filterable.d.ts +3 -2
  185. package/filtering/menu/boolean-filter-menu.component.d.ts +3 -3
  186. package/filtering/menu/date-filter-menu.component.d.ts +6 -3
  187. package/filtering/menu/filter-menu-template.directive.d.ts +18 -2
  188. package/filtering/menu/numeric-filter-menu.component.d.ts +9 -5
  189. package/filtering/menu/string-filter-menu.component.d.ts +6 -4
  190. package/filtering/numeric-filter.component.d.ts +3 -3
  191. package/filtering/operators/after-eq-filter-operator.component.d.ts +27 -1
  192. package/filtering/operators/after-filter-operator.component.d.ts +27 -1
  193. package/filtering/operators/before-eq-filter-operator.component.d.ts +27 -1
  194. package/filtering/operators/before-filter-operator.component.d.ts +27 -1
  195. package/filtering/operators/contains-filter-operator.component.d.ts +28 -1
  196. package/filtering/operators/ends-with-filter-operator.component.d.ts +28 -1
  197. package/filtering/operators/eq-filter-operator.component.d.ts +76 -1
  198. package/filtering/operators/filter-operator.base.d.ts +1 -1
  199. package/filtering/operators/gt-filter-operator.component.d.ts +30 -0
  200. package/filtering/operators/gte-filter-operator.component.d.ts +27 -1
  201. package/filtering/operators/is-empty-filter-operator.component.d.ts +28 -1
  202. package/filtering/operators/is-not-empty-filter-operator.component.d.ts +28 -1
  203. package/filtering/operators/is-not-null-filter-operator.component.d.ts +76 -1
  204. package/filtering/operators/isnull-filter-operator.component.d.ts +76 -1
  205. package/filtering/operators/lt-filter-operator.component.d.ts +27 -1
  206. package/filtering/operators/lte-filter-operator.component.d.ts +30 -0
  207. package/filtering/operators/neq-filter-operator.component.d.ts +76 -1
  208. package/filtering/operators/not-contains-filter-operator.component.d.ts +28 -1
  209. package/filtering/operators/starts-with-filter-operator.component.d.ts +28 -1
  210. package/filtering/string-filter.component.d.ts +1 -1
  211. package/localization/custom-messages.component.d.ts +11 -2
  212. package/navigation/focusable-element.interface.d.ts +7 -11
  213. package/navigation/focusable.directive.d.ts +4 -4
  214. package/navigation/navigation-cell.interface.d.ts +5 -5
  215. package/navigation/navigation-row.interface.d.ts +4 -5
  216. package/package.json +18 -18
  217. package/pdf/pdf-command-tool.directive.d.ts +11 -9
  218. package/pdf/pdf-command.directive.d.ts +2 -2
  219. package/pdf/pdf-export-event.d.ts +3 -1
  220. package/pdf/pdf-margin.component.d.ts +10 -5
  221. package/pdf/pdf-margin.interface.d.ts +1 -1
  222. package/pdf/pdf-template.directive.d.ts +2 -2
  223. package/pdf/pdf.component.d.ts +12 -2
  224. package/pdf/pdf.module.d.ts +6 -6
  225. package/rendering/cell-template.directive.d.ts +8 -9
  226. package/rendering/common/row-class.d.ts +4 -7
  227. package/rendering/common/spacer.component.d.ts +16 -5
  228. package/rendering/footer-template.directive.d.ts +10 -12
  229. package/rendering/header/header-template.directive.d.ts +4 -4
  230. package/rendering/no-records-template.directive.d.ts +2 -2
  231. package/rendering/toolbar/toolbar-focusable.directive.d.ts +13 -2
  232. package/rendering/toolbar/toolbar-template.directive.d.ts +4 -6
  233. package/row-reordering/types.d.ts +4 -1
  234. package/schematics/ngAdd/index.js +3 -3
  235. package/scrolling/content-scroll-event.d.ts +2 -0
  236. package/scrolling/scroll-bottom-event.d.ts +2 -0
  237. package/scrolling/scroll-request.service.d.ts +3 -3
  238. package/scrolling/scrollmode.d.ts +3 -3
  239. package/selection/is-selected.d.ts +5 -4
  240. package/selection/selectable-settings.d.ts +6 -6
  241. package/selection/selectable.directive.d.ts +12 -0
  242. package/selection/selection-change-event.d.ts +2 -2
  243. package/treelist.component.d.ts +143 -107
  244. package/treelist.module.d.ts +6 -8
@@ -7,20 +7,32 @@ import { ColumnBase } from './column-base';
7
7
  import { CellTemplateDirective } from '../rendering/cell-template.directive';
8
8
  import * as i0 from "@angular/core";
9
9
  /**
10
- * Represents the checkbox for selecting rows in the TreeList. [See example](slug:treelist_row_selection#toc-select-all-checkbox).
10
+ * Represents the checkbox column for selecting rows in the TreeList. [See example](slug:treelist_row_selection#toc-select-all-checkbox).
11
+ *
12
+ * @example
13
+ * ```html
14
+ * <kendo-treelist ...>
15
+ * <kendo-treelist-checkbox-column
16
+ * [showSelectAll]="true"
17
+ * [checkChildren]="true"
18
+ * [expandable]="true">
19
+ * </kendo-treelist-checkbox-column>
20
+ * <kendo-treelist-column field="ProductName" title="Product Name"></kendo-treelist-column>
21
+ * </kendo-treelist>
22
+ * ```
11
23
  */
12
24
  export declare class CheckboxColumnComponent extends ColumnBase {
13
25
  parent?: ColumnBase;
14
26
  /**
15
- * Determines whether a select-all checkbox will be displayed in the header.
27
+ * Specifies if a select-all checkbox appears in the header.
16
28
  */
17
29
  showSelectAll: boolean;
18
30
  /**
19
- * Determines whether checkbox click should select / unselect all children
31
+ * Specifies if clicking the checkbox selects or deselects all children.
20
32
  */
21
33
  checkChildren: boolean;
22
34
  /**
23
- * Defines whether the expanded indicator should be rendered in the column.
35
+ * Specifies if the expanded indicator appears in the column.
24
36
  * @default false
25
37
  */
26
38
  expandable: boolean;
@@ -21,7 +21,7 @@ export declare const isCheckboxColumn: (column: any) => any;
21
21
  */
22
22
  export declare const isRowReorderColumn: (column: any) => any;
23
23
  /**
24
- * The base class for the column components of the TreeList.
24
+ * Serves as the base class for column components in the TreeList.
25
25
  */
26
26
  export declare class ColumnBase implements OnChanges {
27
27
  parent?: ColumnBase;
@@ -64,26 +64,25 @@ export declare class ColumnBase implements OnChanges {
64
64
  */
65
65
  reorderable: boolean;
66
66
  /**
67
- * The width (in pixels) below which the user is not able to resize the column by using the UI.
67
+ * Sets the minimum width (in pixels) for resizing the column using the UI.
68
68
  * @default 10
69
69
  */
70
70
  minResizableWidth: number;
71
71
  /**
72
- * The title of the column.
72
+ * Sets the title of the column.
73
73
  */
74
74
  title: string;
75
75
  /**
76
- * The width of the column (in pixels).
76
+ * Sets the width of the column (in pixels).
77
77
  */
78
78
  set width(value: number);
79
79
  get width(): number;
80
80
  /**
81
- * Indicates whether the column will be resized during initialization so that it fits its header and row content.
81
+ * Indicates whether the column is automatically resized during initialization to fit its header and row content.
82
82
  */
83
83
  autoSize: boolean;
84
84
  /**
85
85
  * Toggles the locked (frozen) state of the columns ([more information and example](slug:locked_columns_treelist)).
86
- *
87
86
  * @default false
88
87
  */
89
88
  set locked(value: boolean);
@@ -91,12 +90,11 @@ export declare class ColumnBase implements OnChanges {
91
90
  protected _locked: boolean;
92
91
  /**
93
92
  * Sets the visibility of the column ([see example](slug:hidden_columns_treelist#toc-using-the-built-in-options)).
94
- *
95
93
  * @default false
96
94
  */
97
95
  hidden: boolean;
98
96
  /**
99
- * Sets the condition that needs to be satisfied for a column to remain visible ([see example](slug:responsive_treelist#toc-columns)).
97
+ * Sets the condition that must be satisfied for a column to remain visible ([see example](slug:responsive_treelist#toc-columns)).
100
98
  * If you set the `hidden` property, the behavior of `media` is overridden.
101
99
  */
102
100
  media: string;
@@ -106,57 +104,46 @@ export declare class ColumnBase implements OnChanges {
106
104
  */
107
105
  lockable: boolean;
108
106
  /**
109
- * Specifies if the column menu will be shown for the column.
107
+ * Specifies if the column menu is shown for the column.
110
108
  * @default true
111
109
  */
112
110
  columnMenu: boolean;
113
111
  /**
114
- * Specifies if the column will be included in the column-chooser list.
112
+ * Specifies if the column is included in the column-chooser list.
115
113
  * @default true
116
114
  */
117
115
  includeInChooser: boolean;
118
116
  /**
119
- * Allows setting the `role` attribute for the table cells (excluding the footer and header ones) of the column.
117
+ * Sets the `role` attribute for the table cells (excluding the footer and header) of the column.
120
118
  * @default "gridcell"
121
119
  */
122
120
  tableCellsRole: string;
123
121
  /**
124
- * Sets the custom styles for the table cells (excluding the footer and header ones) of the column. Under the hood,
125
- * to apply the property, the `style` option uses the
126
- * [NgStyle](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_treelist_columns).
122
+ * 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).
127
123
  */
128
124
  style: {
129
125
  [key: string]: string;
130
126
  };
131
127
  /**
132
- * Sets the custom styles for the header cell of the column. Under the hood, to apply the property,
133
- * the `headerStyle` option uses the
134
- * [NgStyle](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_treelist_columns).
128
+ * 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)
135
129
  */
136
130
  headerStyle: {
137
131
  [key: string]: string;
138
132
  };
139
133
  /**
140
- * Sets the custom styles for the footer cell of the column. Under the hood, to apply the property,
141
- * the `footerStyle` option uses the
142
- * [NgStyle](link:site.data.urls.angular['ngstyleapi']) directive. [See example](slug:styling_treelist_columns).
134
+ * 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)
143
135
  */
144
136
  footerStyle: {
145
137
  [key: string]: string;
146
138
  };
147
139
  /**
148
- * Sets the custom CSS classes to the column cells. Under the hood, to apply the property, the `class` option uses the
149
- * [NgClass](link:site.data.urls.angular['ngclassapi']) directive.
150
- * To customize header and footer column cells, use the [`headerClass`]({% slug api_treelist_columncomponent %}#toc-headerclass)
151
- * and [`footerClass`]({% slug api_treelist_columncomponent %}#toc-footerclass) inputs.
140
+ * 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.
152
141
  */
153
142
  cssClass: string | string[] | Set<string> | {
154
143
  [key: string]: any;
155
144
  };
156
145
  /**
157
- * Sets the custom CSS classes to the column header cell. Under the hood, to apply the property,
158
- * the `headerClass` option uses the
159
- * [NgClass](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_treelist_columns).
146
+ * 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).
160
147
  */
161
148
  headerClass: string | string[] | Set<string> | {
162
149
  [key: string]: any;
@@ -164,7 +151,7 @@ export declare class ColumnBase implements OnChanges {
164
151
  /**
165
152
  * Sets the custom CSS classes to the column footer cell. Under the hood, to apply the property,
166
153
  * the `footerClass` option uses the
167
- * [NgClass](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_treelist_columns).
154
+ * [`NgClass`](link:site.data.urls.angular['ngclassapi']) directive. [See example](slug:styling_treelist_columns).
168
155
  */
169
156
  footerClass: string | string[] | Set<string> | {
170
157
  [key: string]: any;
@@ -11,8 +11,7 @@ import * as i0 from "@angular/core";
11
11
  */
12
12
  export declare function isColumnGroupComponent(column: any): column is ColumnGroupComponent;
13
13
  /**
14
- * Represents the column group header of the TreeList
15
- * ([more information and examples]({% slug multicolumnheaders_columns_treelist %})).
14
+ * Represents the column group header of the TreeList. ([More information and examples]({% slug multicolumnheaders_columns_treelist %})).
16
15
  *
17
16
  * @example
18
17
  * ```html
@@ -16,58 +16,62 @@ import * as i0 from "@angular/core";
16
16
  */
17
17
  export declare function isColumnComponent(column: any): column is ColumnComponent;
18
18
  /**
19
- * Represents the columns of the TreeList.
19
+ * Represents a column in the TreeList. Use this component to define a data-bound column.
20
20
  *
21
21
  * @example
22
22
  * ```html
23
23
  * <kendo-treelist [kendoTreeListFlatBinding]="data" ...>
24
24
  * <kendo-treelist-column field="name" title="Name"></kendo-treelist-column>
25
- * <kendo-treelist-column field="title"title="Title"></kendo-treelist-column>
25
+ * <kendo-treelist-column field="title" title="Title"></kendo-treelist-column>
26
26
  * </kendo-treelist>
27
27
  * ```
28
+ * @remarks
29
+ * Supported children components are:
30
+ * {@link StringFilterCellComponent},
31
+ * {@link NumericFilterCellComponent},
32
+ * {@link BooleanFilterCellComponent},
33
+ * {@link DateFilterCellComponent},
34
+ * {@link StringFilterMenuComponent},
35
+ * {@link NumericFilterMenuComponent},
36
+ * {@link BooleanFilterMenuComponent},
37
+ * {@link DateFilterMenuComponent},
38
+ * {@link FilterCellOperatorsComponent}.
28
39
  */
29
40
  export declare class ColumnComponent extends ColumnBase {
30
41
  /**
31
- * Defines whether the expanded indicator should be rendered in the column.
32
- * @default false
42
+ * Specifies if the expanded indicator appears in the column.
33
43
  */
34
44
  expandable: boolean;
35
45
  /**
36
- * The field to which the column is bound.
46
+ * Sets the field to which the column is bound.
37
47
  */
38
48
  field: string;
39
49
  /**
40
- * The format that is applied to the value before it is displayed. For more information on the supported date and number formats,
41
- * refer to the [Column Formats](slug:formats_columns_treelist) documentation article.
50
+ * Sets the format applied to the value before display. For supported date and number formats, see the [Column Formats](slug:formats_columns_treelist) article.
42
51
  */
43
52
  format: any;
44
53
  /**
45
- * Allows the column headers to be clicked and the `sortChange` event emitted.
46
- * You have to handle the `sortChange` event yourself and sort the data.
54
+ * Allows the column headers to be clicked and the `sortChange` event emitted. You must handle the `sortChange` event and sort the data.
55
+ * @default true
47
56
  */
48
57
  sortable: boolean | ColumnSortSettings;
49
58
  /**
50
- * Defines the editor type ([see example]({% slug editing_reactive_forms_treelist %}#toc-setup)).
51
- * Used when the column enters the edit mode. [See example](slug:editing_reactive_forms_treelist).
52
- *
59
+ * 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).
53
60
  * @default 'text'
54
61
  */
55
62
  editor: 'text' | 'numeric' | 'date' | 'boolean';
56
63
  /**
57
- * Defines the filter type that is displayed inside the filter row.
58
- *
64
+ * Sets the filter type displayed inside the filter row.
59
65
  * @default 'text'
60
66
  */
61
67
  filter: 'text' | 'numeric' | 'boolean' | 'date';
62
68
  /**
63
- * Defines if a filter UI will be displayed for this column.
64
- *
69
+ * Specifies if a filter UI appears for this column.
65
70
  * @default true
66
71
  */
67
72
  filterable: boolean;
68
73
  /**
69
- * Defines whether the column is editable.
70
- *
74
+ * Specifies if the column is editable.
71
75
  * @default true
72
76
  */
73
77
  editable: boolean;
@@ -8,9 +8,8 @@ import { CellTemplateDirective } from '../rendering/cell-template.directive';
8
8
  import { OptionChangesService } from '../common/option-changes.service';
9
9
  import * as i0 from "@angular/core";
10
10
  /**
11
- * Represents the command columns of the TreeList. You have to define the content of the
12
- * column inside an `<ng-template>` tag. For more information and examples on using the passed fields
13
- * and the command directives, refer to the article on
11
+ * Represents the command column of the TreeList. Define the content of the column inside an `<ng-template>` tag.
12
+ * For more information and examples on using the passed fields and command directives, see
14
13
  * [editing the TreeList in Angular Reactive Forms]({% slug editing_reactive_forms_treelist %}).
15
14
  *
16
15
  * Usually, the template contains CRUD command directives such as:
@@ -23,7 +22,7 @@ import * as i0 from "@angular/core";
23
22
  * ```html
24
23
  * <kendo-treelist ...>
25
24
  * <kendo-treelist-column field="ProductID"></kendo-treelist-column>
26
- * <kendo-treelist-command-column title="command" >
25
+ * <kendo-treelist-command-column title="command">
27
26
  * <ng-template kendoTreeListCellTemplate>
28
27
  * <button kendoTreeListEditCommand class="k-primary">Edit</button>
29
28
  * <button kendoTreeListRemoveCommand>Remove</button>
@@ -5,7 +5,15 @@
5
5
  import { ColumnBase } from './column-base';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents the drag handle for reordering rows in the TreeList.
8
+ * Represents the drag handle column for reordering rows in the TreeList.
9
+ *
10
+ * @example
11
+ * ```html
12
+ * <kendo-treelist [data]="data" [fetchChildren]="fetchChildren" [hasChildren]="hasChildren">
13
+ * <kendo-treelist-rowreorder-column></kendo-treelist-rowreorder-column>
14
+ * <kendo-treelist-column field="ProductName" title="Product Name"></kendo-treelist-column>
15
+ * </kendo-treelist>
16
+ * ```
9
17
  */
10
18
  export declare class RowReorderColumnComponent extends ColumnBase {
11
19
  parent?: ColumnBase;
@@ -3,7 +3,8 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Defines the settings for sorting the TreeList column.
6
+ * Defines the settings for sorting a TreeList column.
7
+ * Use this type to configure sorting options such as allowing unsort and setting the initial direction.
7
8
  *
8
9
  * @example
9
10
  * ```html
@@ -19,41 +20,22 @@ export type ColumnSortSettings = boolean | {
19
20
  */
20
21
  allowUnsort?: boolean;
21
22
  /**
22
- * Determines the initial (from the unsorted to the sorted state) sort direction.
23
- *
24
- * The available values for setting the initial sort direction are:
25
- * - `asc` (default)
26
- * - `desc`
23
+ * Sets the initial sort direction when changing from unsorted to sorted state.
27
24
  */
28
25
  initialDirection?: 'asc' | 'desc';
29
26
  };
30
27
  /**
31
- * Specifies a modifier key when multiple sort.
28
+ * Specifies a modifier key for multiple column sorting.
32
29
  *
33
- * @example
34
- * ```html
35
- * <kendo-treelist [sortable]="{ mode: 'multiple', multiSortKey: 'shift' }">
36
- * <kendo-treelist-column field="ProductID"></kendo-treelist-column>
37
- * ...
38
- * </kendo-treelist>
39
- * ```
40
30
  */
41
31
  export type ModifierKey = 'none' | 'ctrl' | 'shift' | 'alt';
42
32
  /**
43
33
  * Defines the settings for sorting the TreeList.
44
- *
45
- * @example
46
- * ```html
47
- * <kendo-treelist [sortable]="{ mode: 'multiple', allowUnsort: false}"></kendo-treelist>
48
- * ```
49
34
  */
50
35
  export type SortSettings = boolean | ColumnSortSettings & {
51
36
  /**
52
- * The sort mode of the TreeList.
37
+ * Sets the sort mode of the TreeList.
53
38
  *
54
- * The available values for setting the sort modes are:
55
- * - `single`
56
- * - `multiple`
57
39
  */
58
40
  mode?: 'single' | 'multiple';
59
41
  /**
@@ -14,16 +14,15 @@ import * as i0 from "@angular/core";
14
14
  */
15
15
  export declare function isSpanColumnComponent(column: any): column is SpanColumnComponent;
16
16
  /**
17
- * Represents a column which can be spanned over multiple data cells while the individual
18
- * header and footer cells are retained ([see example]({% slug spanned_columns_treelist %})).
19
- * Enables you to achieve more flexible layout while keeping the built-in UI element for
20
- * [sorting]({% slug sorting_treelist %}) and [filtering]({% slug filtering_treelist %}). Wrap the columns that will be
21
- * merged inside the `<kendo-treelist-span-column>` tag.
17
+ * Represents a column that spans multiple data cells while keeping individual header and footer cells.
18
+ * Use this component to create flexible layouts and retain built-in UI for [sorting]({% slug sorting_treelist %}) and [filtering]({% slug filtering_treelist %}).
19
+ * Wrap the columns to merge inside the `<kendo-treelist-span-column>` tag.
22
20
  *
21
+ * @example
23
22
  * ```html
24
23
  * <kendo-treelist-span-column>
25
- * <kendo-treelist-column field="field1" ></kendo-treelist-column>
26
- * <kendo-treelist-column field="field2" ></kendo-treelist-column>
24
+ * <kendo-treelist-column field="field1"></kendo-treelist-column>
25
+ * <kendo-treelist-column field="field2"></kendo-treelist-column>
27
26
  * <ng-template kendoTreeListCellTemplate let-dataItem>
28
27
  * <h5>{{ dataItem.field1 }}</h5>
29
28
  * <p>{{ dataItem.field2 }}</p>
@@ -33,8 +32,7 @@ export declare function isSpanColumnComponent(column: any): column is SpanColumn
33
32
  */
34
33
  export declare class SpanColumnComponent extends ColumnBase {
35
34
  /**
36
- * Defines whether the expanded indicator should be rendered in the column.
37
- * @default false
35
+ * Specifies if the expanded indicator appears in the column.
38
36
  */
39
37
  expandable: boolean;
40
38
  readonly isSpanColumn: boolean;
@@ -77,10 +75,9 @@ export declare class SpanColumnComponent extends ColumnBase {
77
75
  */
78
76
  includeInChooser: boolean;
79
77
  /**
80
- * Defines whether the edit template of the column will be rendered. The default value is `false`.
81
- *
82
- * To enable the editing functionality for a spanned column, set an edit template for it.
83
- *
78
+ * Defines whether the edit template of the column is rendered.
79
+ * To enable editing for a spanned column, set an edit template for it.
80
+ * @default false
84
81
  */
85
82
  set editable(value: boolean);
86
83
  get editable(): boolean;
@@ -109,9 +106,7 @@ export declare class SpanColumnComponent extends ColumnBase {
109
106
  */
110
107
  get colspan(): number;
111
108
  /**
112
- * Toggles the locked (frozen) state of the columns. Locked columns are visible
113
- * at all times during the horizontal scrolling of the TreeList. [See example](slug:locked_columns_treelist).
114
- *
109
+ * Toggles the locked (frozen) state of the columns. Locked columns are visible at all times during horizontal scrolling. [See example](slug:locked_columns_treelist).
115
110
  * @default false
116
111
  */
117
112
  set locked(value: boolean);
@@ -4,7 +4,8 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { TreeListComponent } from "../treelist.component";
6
6
  /**
7
- * Arguments for the `cellClick` event.
7
+ * Provides the arguments for the `cellClick` event.
8
+ * Use this interface to access information about the clicked cell, including its column, row, data item, and event type.
8
9
  */
9
10
  export interface CellClickEvent {
10
11
  /**
@@ -16,11 +17,11 @@ export interface CellClickEvent {
16
17
  */
17
18
  columnIndex: number;
18
19
  /**
19
- * The data item that is associated with the row in which the clicked cell is located.
20
+ * The data item associated with the row containing the clicked cell.
20
21
  */
21
22
  dataItem: any;
22
23
  /**
23
- * Indicates if the cell is being edited.
24
+ * Specifies if the cell is being edited.
24
25
  */
25
26
  isEdited: boolean;
26
27
  /**
@@ -5,6 +5,7 @@
5
5
  import { FormGroup } from "@angular/forms";
6
6
  import { CreateFormGroupArgs } from "../editing-directives/create-form-group-args.interface";
7
7
  /**
8
- * The function that creates the `FormGroup` for the edited model.
8
+ * Creates a `FormGroup` for the edited model. Use this function to generate a reactive form group for editing data in the TreeList.
9
+ *
9
10
  */
10
11
  export type CreateFormGroup = (args: CreateFormGroupArgs) => FormGroup;
@@ -3,7 +3,7 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * The type of the TreeList pager.
6
+ * Represents the type of the TreeList pager. Use this type to specify the pager style.
7
7
  *
8
8
  * The available values are:
9
9
  * * `numeric`&mdash;Buttons with numbers.
@@ -11,16 +11,15 @@
11
11
  *
12
12
  * @example
13
13
  * ```html
14
- * <kendo-treelist [pageable]="{ type: 'numeric'}"></kendo-treelist>
14
+ * <kendo-treelist [pageable]="{ type: 'numeric' }"></kendo-treelist>
15
15
  * ```
16
16
  */
17
17
  export type PagerType = 'numeric' | 'input';
18
18
  /**
19
- * The pager settings of the TreeList.
19
+ * Represents the pager settings of the TreeList. Use this interface to configure the pager options.
20
20
  *
21
21
  * @example
22
- * ```html-no-run
23
- *
22
+ * ```html
24
23
  * <kendo-treelist
25
24
  * [pageable]="{
26
25
  * buttonCount: 2,
@@ -31,15 +30,15 @@ export type PagerType = 'numeric' | 'input';
31
30
  */
32
31
  export interface PagerSettings {
33
32
  /**
34
- * Sets the maximum numeric buttons count before the buttons are collapsed.
33
+ * Sets the maximum numeric buttons count before the buttons collapse.
35
34
  */
36
35
  buttonCount?: number;
37
36
  /**
38
- * A flag that indicates if child nodes should be fetched and counted for the pager total.
37
+ * Indicates if child nodes are fetched and counted for the pager total.
39
38
  */
40
39
  countChildren?: boolean;
41
40
  /**
42
- * Toggles the information about the current page and the total number of records.
41
+ * Shows information about the current page and the total number of records.
43
42
  */
44
43
  info?: boolean;
45
44
  /**
@@ -4,6 +4,6 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { Observable } from "rxjs";
6
6
  /**
7
- * A function that is called to confirm if the `dataItem` will be removed.
7
+ * Represents a callback function that confirms if the `dataItem` will be removed. Use this function to prompt the user or perform custom logic before removing an item from the TreeList.
8
8
  */
9
9
  export type RemoveConfirmationCallback = (dataItem: any, parent: any) => Promise<boolean> | Observable<boolean> | boolean;
@@ -10,11 +10,11 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
10
10
  import { ScrollSyncService } from '../scrolling/scroll-sync.service';
11
11
  import * as i0 from "@angular/core";
12
12
  /**
13
- * Arguments for the `close` event of the filter and column-menu popup.
13
+ * 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.
14
14
  */
15
15
  export declare class PopupCloseEvent extends PreventableEvent {
16
16
  /**
17
- * The original DOM event that causes the popup to close.
17
+ * Stores the original DOM event that causes the popup to close.
18
18
  */
19
19
  originalEvent: any;
20
20
  /**
@@ -23,8 +23,9 @@ export declare class PopupCloseEvent extends PreventableEvent {
23
23
  constructor(e: any);
24
24
  }
25
25
  /**
26
- * The service that is used for the popups of the filter and column menus
27
- * ([see example]({% slug filter_menu_treelist %}#toc-filter-menu-with-popup)).
26
+ * Represents the service used for the popups of the filter and column menus.
27
+ * Use this service to manage popup opening, closing, and event handling.
28
+ * ([See example]({% slug filter_menu_treelist %}#toc-filter-menu-with-popup)).
28
29
  */
29
30
  export declare class SinglePopupService implements OnDestroy {
30
31
  private popupService;
@@ -32,8 +33,8 @@ export declare class SinglePopupService implements OnDestroy {
32
33
  private ngZone;
33
34
  private localization;
34
35
  /**
35
- * Fires when the filter or column menus are about to close because the user clicked outside their popups.
36
- * Used to prevent the popup from closing.
36
+ * Emits when the filter or column menus are about to close because the user clicked outside their popups.
37
+ * Use this event to prevent the popup from closing.
37
38
  */
38
39
  readonly onClose: Subject<PopupCloseEvent>;
39
40
  private removeClick;
@@ -4,29 +4,28 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { SortDescriptor, CompositeFilterDescriptor } from '@progress/kendo-data-query';
6
6
  /**
7
- * Arguments for the [`pageChange`](slug:api_treelist_treelistcomponent#toc-pagechange) event.
7
+ * Provides arguments for the [`pageChange`](slug:api_treelist_treelistcomponent#toc-pagechange) event.
8
8
  */
9
9
  export interface PageChangeEvent {
10
10
  /**
11
- * The number of records to skip.
11
+ * Specifies the number of records to skip.
12
12
  */
13
13
  skip: number;
14
14
  /**
15
- * The number of records to take.
15
+ * Specifies the number of records to take.
16
16
  */
17
17
  take: number;
18
18
  }
19
19
  /**
20
- * Arguments for the [`dataStateChange`](slug:api_treelist_treelistcomponent#toc-datastatechange) event
21
- * ([more information and examples]({% slug databinding_treelist %})).
20
+ * Provides arguments for the [`dataStateChange`](slug:api_treelist_treelistcomponent#toc-datastatechange) event ([more information and examples]({% slug databinding_treelist %})).
22
21
  */
23
22
  export interface DataStateChangeEvent {
24
23
  /**
25
- * The sort descriptors by which the data is sorted.
24
+ * Specifies the sort descriptors by which the data is sorted.
26
25
  */
27
26
  sort?: Array<SortDescriptor>;
28
27
  /**
29
- * The filter descriptor by which the data is filtered.
28
+ * Specifies the filter descriptor by which the data is filtered.
30
29
  */
31
30
  filter?: CompositeFilterDescriptor;
32
31
  }
@@ -3,23 +3,23 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Represents a treelist item for a data row.
6
+ * Represents a TreeList item for a data row. Use this interface to access information about a data row in the TreeList.
7
7
  */
8
8
  export interface DataItem {
9
9
  /**
10
- * The type of the treelist item.
10
+ * Specifies the type of the TreeList item.
11
11
  */
12
12
  type: 'data';
13
13
  /**
14
- * A reference to the data item.
14
+ * Provides a reference to the data item.
15
15
  */
16
16
  data: Object;
17
17
  /**
18
- * The index of the treelist item. Note that this could be different than the index of the data item in the source data set.
18
+ * Specifies the index of the TreeList item. This value may differ from the index of the data item in the source data set.
19
19
  */
20
20
  index: number;
21
21
  /**
22
- * A flag indicating if the item is currently being edited
22
+ * Indicates if the item is currently being edited.
23
23
  */
24
24
  isEditing: boolean;
25
25
  }
@@ -5,15 +5,16 @@
5
5
  import { Observable } from 'rxjs';
6
6
  import { EventEmitter } from '@angular/core';
7
7
  /**
8
- * The data type that is expected by the TreeList.
8
+ * Represents the data type expected by the TreeList. Use this interface to provide the data and aggregates for the TreeList.
9
+ *
9
10
  */
10
11
  export interface TreeListDataResult {
11
12
  /**
12
- * The data that will be rendered by the TreeList as an array.
13
+ * Represents the data rendered by the TreeList as an array.
13
14
  */
14
15
  data: any[];
15
16
  /**
16
- * The aggregated values for the group. An [`AggregateResult`](slug:treelist_with_aggregates) instance.
17
+ * Represents the aggregated values for the group. An [`AggregateResult`](slug:treelist_with_aggregates) instance.
17
18
  */
18
19
  aggregates?: any;
19
20
  }
@@ -4,7 +4,7 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { DataItem } from './data-item.interface';
6
6
  /**
7
- * Represents an item that will be rendered by the TreeList.
8
- * Can be a [`DataItem`]({% slug api_treelist_dataitem %}). ([See example]({% slug api_treelist_treelistcomponent %}#toc-trackby))
7
+ * Represents an item rendered by the TreeList. Use this type for items such as [`DataItem`]({% slug api_treelist_dataitem %}). ([See example]({% slug api_treelist_treelistcomponent %}#toc-trackby)).
8
+ *
9
9
  */
10
10
  export type TreeListItem = DataItem;