@progress/kendo-angular-grid 12.0.0-develop.9 → 12.0.1-develop.1

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 (172) hide show
  1. package/column-menu/column-chooser.component.d.ts +14 -19
  2. package/column-menu/column-menu-autosize-all.component.d.ts +12 -27
  3. package/column-menu/column-menu-autosize.component.d.ts +12 -26
  4. package/column-menu/column-menu-chooser.component.d.ts +11 -24
  5. package/column-menu/column-menu-expandable-item.interface.d.ts +0 -1
  6. package/column-menu/column-menu-filter.component.d.ts +12 -24
  7. package/column-menu/column-menu-item.component.d.ts +6 -21
  8. package/column-menu/column-menu-lock.component.d.ts +11 -25
  9. package/column-menu/column-menu-position.component.d.ts +12 -24
  10. package/column-menu/column-menu-settings.interface.d.ts +3 -24
  11. package/column-menu/column-menu-sort.component.d.ts +12 -25
  12. package/column-menu/column-menu-stick.component.d.ts +12 -24
  13. package/column-menu/column-menu.component.d.ts +9 -1
  14. package/column-menu/column-menu.service.d.ts +9 -21
  15. package/column-resizing/column-resize.interface.d.ts +1 -1
  16. package/columns/checkbox-column.component.d.ts +6 -57
  17. package/columns/column-base.d.ts +16 -369
  18. package/columns/column-group.component.d.ts +9 -48
  19. package/columns/column.component.d.ts +23 -109
  20. package/columns/command-column.component.d.ts +12 -60
  21. package/columns/reorder-column.component.d.ts +1 -1
  22. package/columns/sort-settings.d.ts +24 -12
  23. package/columns/span-column.component.d.ts +12 -123
  24. package/common/cell-click-event-args.interface.d.ts +1 -1
  25. package/common/fetch-data-callback.d.ts +1 -1
  26. package/common/preventable-event.d.ts +1 -1
  27. package/common/single-popup.service.d.ts +1 -1
  28. package/common/size-options.d.ts +1 -2
  29. package/data/change-event-args.interface.d.ts +2 -2
  30. package/data/data.collection.d.ts +1 -1
  31. package/data/grid-item.interface.d.ts +6 -3
  32. package/dragdrop/column-reorder-config.d.ts +1 -1
  33. package/editing/add-event-args.interface.d.ts +1 -1
  34. package/editing/cancel-event-args.interface.d.ts +1 -1
  35. package/editing/edit-event-args.interface.d.ts +1 -1
  36. package/editing/remove-event-args.interface.d.ts +1 -1
  37. package/editing/save-event-args.interface.d.ts +1 -1
  38. package/editing-directives/edit-service.interface.d.ts +1 -1
  39. package/esm2020/column-menu/column-chooser.component.mjs +14 -19
  40. package/esm2020/column-menu/column-menu-autosize-all.component.mjs +12 -27
  41. package/esm2020/column-menu/column-menu-autosize.component.mjs +12 -26
  42. package/esm2020/column-menu/column-menu-chooser.component.mjs +11 -24
  43. package/esm2020/column-menu/column-menu-filter.component.mjs +12 -24
  44. package/esm2020/column-menu/column-menu-item.component.mjs +6 -21
  45. package/esm2020/column-menu/column-menu-lock.component.mjs +11 -25
  46. package/esm2020/column-menu/column-menu-position.component.mjs +12 -24
  47. package/esm2020/column-menu/column-menu-sort.component.mjs +12 -25
  48. package/esm2020/column-menu/column-menu-stick.component.mjs +12 -24
  49. package/esm2020/column-menu/column-menu.component.mjs +9 -1
  50. package/esm2020/column-menu/column-menu.service.mjs +9 -21
  51. package/esm2020/columns/checkbox-column.component.mjs +6 -57
  52. package/esm2020/columns/column-base.mjs +7 -40
  53. package/esm2020/columns/column-group.component.mjs +9 -48
  54. package/esm2020/columns/column.component.mjs +22 -79
  55. package/esm2020/columns/command-column.component.mjs +12 -60
  56. package/esm2020/columns/reorder-column.component.mjs +1 -1
  57. package/esm2020/columns/span-column.component.mjs +12 -123
  58. package/esm2020/common/preventable-event.mjs +1 -1
  59. package/esm2020/common/single-popup.service.mjs +1 -1
  60. package/esm2020/excel/excel.module.mjs +5 -15
  61. package/esm2020/filtering/cell/boolean-filter-cell.component.mjs +11 -10
  62. package/esm2020/filtering/cell/date-filter-cell.component.mjs +26 -13
  63. package/esm2020/filtering/cell/filter-cell-operators.component.mjs +15 -0
  64. package/esm2020/filtering/cell/numeric-filter-cell.component.mjs +14 -11
  65. package/esm2020/filtering/cell/string-filter-cell.component.mjs +14 -15
  66. package/esm2020/filtering/date-filter.component.mjs +6 -2
  67. package/esm2020/filtering/menu/boolean-filter-menu.component.mjs +13 -13
  68. package/esm2020/filtering/menu/date-filter-menu.component.mjs +13 -13
  69. package/esm2020/filtering/menu/numeric-filter-menu.component.mjs +13 -13
  70. package/esm2020/filtering/menu/string-filter-menu.component.mjs +15 -2
  71. package/esm2020/filtering/numeric-filter.component.mjs +4 -1
  72. package/esm2020/filtering/operators/after-eq-filter-operator.component.mjs +3 -6
  73. package/esm2020/filtering/operators/after-filter-operator.component.mjs +3 -6
  74. package/esm2020/filtering/operators/before-eq-filter-operator.component.mjs +3 -6
  75. package/esm2020/filtering/operators/before-filter-operator.component.mjs +3 -6
  76. package/esm2020/filtering/operators/contains-filter-operator.component.mjs +2 -5
  77. package/esm2020/filtering/operators/ends-with-filter-operator.component.mjs +2 -4
  78. package/esm2020/filtering/operators/eq-filter-operator.component.mjs +2 -4
  79. package/esm2020/filtering/operators/gt-filter-operator.component.mjs +3 -6
  80. package/esm2020/filtering/operators/gte-filter-operator.component.mjs +2 -5
  81. package/esm2020/filtering/operators/is-empty-filter-operator.component.mjs +2 -4
  82. package/esm2020/filtering/operators/is-not-empty-filter-operator.component.mjs +2 -4
  83. package/esm2020/filtering/operators/is-not-null-filter-operator.component.mjs +2 -4
  84. package/esm2020/filtering/operators/isnull-filter-operator.component.mjs +2 -4
  85. package/esm2020/filtering/operators/lt-filter-operator.component.mjs +3 -5
  86. package/esm2020/filtering/operators/lte-filter-operator.component.mjs +3 -5
  87. package/esm2020/filtering/operators/neq-filter-operator.component.mjs +2 -4
  88. package/esm2020/filtering/operators/not-contains-filter-operator.component.mjs +2 -4
  89. package/esm2020/filtering/operators/starts-with-filter-operator.component.mjs +2 -4
  90. package/esm2020/filtering/string-filter.component.mjs +2 -1
  91. package/esm2020/grid.component.mjs +39 -325
  92. package/esm2020/grid.module.mjs +6 -16
  93. package/esm2020/layout/sizing-options.service.mjs +3 -0
  94. package/esm2020/localization/custom-messages.component.mjs +1 -1
  95. package/esm2020/package-metadata.mjs +2 -2
  96. package/esm2020/pager/pager-info.component.mjs +1 -1
  97. package/esm2020/pager/pager-input.component.mjs +1 -48
  98. package/esm2020/pager/pager-next-buttons.component.mjs +1 -1
  99. package/esm2020/pager/pager-numeric-buttons.component.mjs +1 -1
  100. package/esm2020/pager/pager-page-sizes.component.mjs +3 -92
  101. package/esm2020/pager/pager-prev-buttons.component.mjs +1 -1
  102. package/esm2020/pdf/pdf-margin.component.mjs +9 -0
  103. package/esm2020/pdf/pdf.module.mjs +7 -16
  104. package/esm2020/rendering/common/spacer.component.mjs +2 -1
  105. package/esm2020/rendering/toolbar/toolbar-position.mjs +17 -0
  106. package/esm2020/row-reordering/row-reorder.service.mjs +2 -1
  107. package/excel/excel.component.d.ts +2 -7
  108. package/excel/excel.module.d.ts +5 -15
  109. package/fesm2015/progress-kendo-angular-grid.mjs +476 -1372
  110. package/fesm2020/progress-kendo-angular-grid.mjs +476 -1372
  111. package/filtering/cell/boolean-filter-cell.component.d.ts +11 -10
  112. package/filtering/cell/date-filter-cell.component.d.ts +26 -13
  113. package/filtering/cell/filter-cell-operators.component.d.ts +15 -0
  114. package/filtering/cell/numeric-filter-cell.component.d.ts +14 -11
  115. package/filtering/cell/string-filter-cell.component.d.ts +14 -15
  116. package/filtering/date-filter.component.d.ts +8 -12
  117. package/filtering/filterable.d.ts +10 -0
  118. package/filtering/menu/boolean-filter-menu.component.d.ts +13 -13
  119. package/filtering/menu/date-filter-menu.component.d.ts +13 -13
  120. package/filtering/menu/numeric-filter-menu.component.d.ts +13 -13
  121. package/filtering/menu/string-filter-menu.component.d.ts +15 -2
  122. package/filtering/numeric-filter.component.d.ts +4 -1
  123. package/filtering/operators/after-eq-filter-operator.component.d.ts +4 -0
  124. package/filtering/operators/after-filter-operator.component.d.ts +4 -0
  125. package/filtering/operators/before-eq-filter-operator.component.d.ts +4 -0
  126. package/filtering/operators/before-filter-operator.component.d.ts +4 -0
  127. package/filtering/operators/contains-filter-operator.component.d.ts +2 -5
  128. package/filtering/operators/ends-with-filter-operator.component.d.ts +2 -4
  129. package/filtering/operators/eq-filter-operator.component.d.ts +2 -4
  130. package/filtering/operators/gt-filter-operator.component.d.ts +4 -0
  131. package/filtering/operators/gte-filter-operator.component.d.ts +2 -5
  132. package/filtering/operators/is-empty-filter-operator.component.d.ts +2 -4
  133. package/filtering/operators/is-not-empty-filter-operator.component.d.ts +2 -4
  134. package/filtering/operators/is-not-null-filter-operator.component.d.ts +2 -4
  135. package/filtering/operators/isnull-filter-operator.component.d.ts +2 -4
  136. package/filtering/operators/lt-filter-operator.component.d.ts +5 -0
  137. package/filtering/operators/lte-filter-operator.component.d.ts +5 -0
  138. package/filtering/operators/neq-filter-operator.component.d.ts +2 -4
  139. package/filtering/operators/not-contains-filter-operator.component.d.ts +2 -4
  140. package/filtering/operators/starts-with-filter-operator.component.d.ts +2 -4
  141. package/filtering/string-filter.component.d.ts +2 -1
  142. package/grid.component.d.ts +43 -327
  143. package/grid.module.d.ts +6 -16
  144. package/grouping/group-key.interface.d.ts +1 -13
  145. package/grouping/group-rows-args.interface.d.ts +1 -1
  146. package/layout/sizing-options.service.d.ts +3 -0
  147. package/localization/custom-messages.component.d.ts +1 -1
  148. package/localization/messages.d.ts +35 -98
  149. package/navigation/navigable-settings.d.ts +15 -1
  150. package/navigation/navigation-cell.interface.d.ts +2 -5
  151. package/navigation/navigation-row.interface.d.ts +2 -5
  152. package/package.json +19 -19
  153. package/pager/pager-info.component.d.ts +1 -1
  154. package/pager/pager-input.component.d.ts +1 -48
  155. package/pager/pager-next-buttons.component.d.ts +1 -1
  156. package/pager/pager-numeric-buttons.component.d.ts +1 -1
  157. package/pager/pager-page-sizes.component.d.ts +3 -92
  158. package/pager/pager-prev-buttons.component.d.ts +1 -1
  159. package/pager/pager-settings.d.ts +9 -38
  160. package/pdf/pdf-margin.component.d.ts +9 -0
  161. package/pdf/pdf-margin.interface.d.ts +0 -5
  162. package/pdf/pdf.module.d.ts +7 -16
  163. package/rendering/common/row-class.d.ts +4 -4
  164. package/rendering/common/spacer.component.d.ts +2 -1
  165. package/rendering/toolbar/toolbar-position.d.ts +18 -1
  166. package/row-reordering/row-reorder.service.d.ts +1 -0
  167. package/row-reordering/types.d.ts +1 -1
  168. package/schematics/ngAdd/index.js +2 -2
  169. package/scrolling/content-scroll-event.d.ts +1 -1
  170. package/scrolling/scroll-request.service.d.ts +2 -1
  171. package/scrolling/scrollmode.d.ts +4 -4
  172. package/selection/types.d.ts +31 -48
@@ -6,11 +6,9 @@ import { FilterOperatorBase } from './filter-operator.base';
6
6
  import { LocalizationService } from '@progress/kendo-angular-l10n';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * Represents the `IsNull` (**Is null**) filter operator.
9
+ * Represents the `IsNull` (**Is null**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
10
10
  *
11
- * For more information and examples, refer to:
12
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
13
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
11
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
14
12
  */
15
13
  export declare class IsNullFilterOperatorComponent extends FilterOperatorBase {
16
14
  constructor(localization: LocalizationService);
@@ -5,6 +5,11 @@
5
5
  import { FilterOperatorBase } from './filter-operator.base';
6
6
  import { LocalizationService } from '@progress/kendo-angular-l10n';
7
7
  import * as i0 from "@angular/core";
8
+ /**
9
+ * Represents the `Less` (**Is less than**) [numeric filter](slug:filtering_grid#toc-numeric-filter) operator.
10
+ *
11
+ * [See example](slug:filter_row#toc-default-filter-operator).
12
+ */
8
13
  export declare class LessFilterOperatorComponent extends FilterOperatorBase {
9
14
  constructor(localization: LocalizationService);
10
15
  static ɵfac: i0.ɵɵFactoryDeclaration<LessFilterOperatorComponent, never>;
@@ -5,6 +5,11 @@
5
5
  import { FilterOperatorBase } from './filter-operator.base';
6
6
  import { LocalizationService } from '@progress/kendo-angular-l10n';
7
7
  import * as i0 from "@angular/core";
8
+ /**
9
+ * Represents the `LessOrEqualTo` (**Is less than or equal to**) [numeric filter](slug:filtering_grid#toc-numeric-filter) operator.
10
+ *
11
+ * [See example](slug:filter_row#toc-default-filter-operator).
12
+ */
8
13
  export declare class LessOrEqualToFilterOperatorComponent extends FilterOperatorBase {
9
14
  constructor(localization: LocalizationService);
10
15
  static ɵfac: i0.ɵɵFactoryDeclaration<LessOrEqualToFilterOperatorComponent, never>;
@@ -6,11 +6,9 @@ import { FilterOperatorBase } from './filter-operator.base';
6
6
  import { LocalizationService } from '@progress/kendo-angular-l10n';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * Represents the `NotEqual` (**Is not equal to**) filter operator.
9
+ * Represents the `NotEqual` (**Is not equal to**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
10
10
  *
11
- * For more information and examples, refer to:
12
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
13
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
11
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
14
12
  */
15
13
  export declare class NotEqualFilterOperatorComponent extends FilterOperatorBase {
16
14
  constructor(localization: LocalizationService);
@@ -6,11 +6,9 @@ import { FilterOperatorBase } from './filter-operator.base';
6
6
  import { LocalizationService } from '@progress/kendo-angular-l10n';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * Represents the `DoesNotContain` (**Does not contain**) filter operator.
9
+ * Represents the `DoesNotContain` (**Does not contain**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
10
10
  *
11
- * For more information and examples, refer to:
12
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
13
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
11
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
14
12
  */
15
13
  export declare class DoesNotContainFilterOperatorComponent extends FilterOperatorBase {
16
14
  constructor(localization: LocalizationService);
@@ -6,11 +6,9 @@ import { FilterOperatorBase } from './filter-operator.base';
6
6
  import { LocalizationService } from '@progress/kendo-angular-l10n';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * Represents the `StartsWith` (**Starts with**) filter operator.
9
+ * Represents the `StartsWith` (**Starts with**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
10
10
  *
11
- * For more information and examples, refer to:
12
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
13
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
11
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
14
12
  */
15
13
  export declare class StartsWithFilterOperatorComponent extends FilterOperatorBase {
16
14
  constructor(localization: LocalizationService);
@@ -25,8 +25,9 @@ export declare abstract class StringFilterComponent extends BaseFilterCellCompon
25
25
  */
26
26
  filter: CompositeFilterDescriptor;
27
27
  /**
28
- * The default filter operator. Defaults to `contains`.
28
+ * The default filter operator.
29
29
  * @type {string}
30
+ * @default 'contains'
30
31
  */
31
32
  operator: string;
32
33
  /**
@@ -81,33 +81,11 @@ import { DragTargetContainerDirective, DragTargetDataFn, DropTargetContainerDire
81
81
  import { RowReorderService } from './row-reordering/row-reorder.service';
82
82
  import * as i0 from "@angular/core";
83
83
  /**
84
- * Represents the Kendo UI Grid component for Angular.
84
+ * Represents the Kendo UI for Angular Data Grid component.
85
85
  *
86
86
  * @example
87
- * ```ts-preview
88
- * _@Component({
89
- * selector: 'my-app',
90
- * template: `
91
- * <kendo-grid [data]="gridData">
92
- * </kendo-grid>
93
- * `
94
- * })
95
- * class AppComponent {
96
- * public gridData: any[] = products;
97
- * }
98
- *
99
- * const products = [{
100
- * "ProductID": 1,
101
- * "ProductName": "Chai",
102
- * "UnitPrice": 18.0000,
103
- * "Discontinued": true
104
- * }, {
105
- * "ProductID": 2,
106
- * "ProductName": "Chang",
107
- * "UnitPrice": 19.0000,
108
- * "Discontinued": false
109
- * }
110
- * ];
87
+ * ```html
88
+ * <kendo-grid [data]="gridData"></kendo-grid>
111
89
  * ```
112
90
  */
113
91
  export declare class GridComponent implements AfterContentInit, AfterViewInit, OnDestroy, OnChanges, OnInit {
@@ -158,13 +136,15 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
158
136
  */
159
137
  height: number;
160
138
  /**
161
- * Defines the row height that is used when the `scrollable` option of the Grid is set to `virtual`.
139
+ * Represent the actual height of each Grid row (`tr`) element in the DOM.
162
140
  * Required by the [virtual scrolling functionality]({% slug scrollmmodes_grid %}).
141
+ * Set the `rowHeight` option to the exact pixels as the height of the `tr` element appears in the DOM.
163
142
  */
164
143
  rowHeight: number;
165
144
  /**
166
- * Defines the detail row height that is used when the `scrollable` option of the Grid is set to `virtual`.
145
+ * Represent the actual height of each Grid detail row (`tr`) element in the DOM.
167
146
  * Required by the [virtual scrolling functionality]({% slug scrollmmodes_grid %}).
147
+ * Set the `detailRowHeight` option to the exact pixels as the height of the detail Grid `tr` element appears in the DOM.
168
148
  */
169
149
  detailRowHeight: number;
170
150
  /**
@@ -176,14 +156,13 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
176
156
  /**
177
157
  * Defines the scroll mode used by the Grid.
178
158
  *
179
- * The available options are:
180
- * - `none`&mdash;Renders no scrollbar.
181
- * - `scrollable`&mdash;The default scroll mode. It requires the setting of the `height` option.
182
- * - `virtual`&mdash;Displays no pager and renders a portion of the data (optimized rendering) while the user is scrolling the content.
159
+ * @default 'scrollable'
183
160
  */
184
161
  scrollable: ScrollMode;
185
162
  /**
186
- * Enables the single-row [selection]({% slug selection_grid %}) of the Grid.
163
+ * Enables the [single-row selection](slug:grid_row_selection) of the Grid.
164
+ *
165
+ * @default false
187
166
  */
188
167
  selectable: SelectableSettings | boolean;
189
168
  /**
@@ -199,48 +178,9 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
199
178
  get size(): GridSize;
200
179
  /**
201
180
  * A function that defines how to track changes for the data rows.
202
- *
203
181
  * By default, the Grid tracks changes by the index of the data item.
204
182
  * Edited rows are tracked by reference.
205
- * In some cases, you might need to override the default behavior,
206
- * for example, when you implement editing with immutable data items.
207
- *
208
- * The following example demonstrates how to track items only by index.
209
- *
210
- * @example
211
- * ```ts
212
- * import { Component } from '@angular/core';
213
- * import { GridItem } from '@progress/kendo-angular-grid';
214
- *
215
- * _@Component({
216
- * selector: 'my-app',
217
- * template: `
218
- * <kendo-grid [data]="gridData" [trackBy]="trackBy">
219
- * </kendo-grid>
220
- * `
221
- * })
222
- * class AppComponent {
223
- * public gridData: any[] = products;
224
- *
225
- * public trackBy(index: number, item: GridItem): any {
226
- * console.log(item);
227
- * return index;
228
- * }
229
- * }
230
- *
231
- * const products = [{
232
- * "ProductID": 1,
233
- * "ProductName": "Chai",
234
- * "UnitPrice": 18.0000,
235
- * "Discontinued": true
236
- * }, {
237
- * "ProductID": 2,
238
- * "ProductName": "Chang",
239
- * "UnitPrice": 19.0000,
240
- * "Discontinued": false
241
- * }
242
- * ];
243
- * ```
183
+ * [See exmpale](slug:track_changes_grid)
244
184
  */
245
185
  trackBy: TrackByFunction<GridItem>;
246
186
  /**
@@ -256,6 +196,7 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
256
196
  get group(): Array<GroupDescriptor> | null | undefined;
257
197
  /**
258
198
  * If set to `true`, the grid will render only the columns in the current viewport.
199
+ * @default false
259
200
  */
260
201
  virtualColumns: boolean;
261
202
  /**
@@ -300,31 +241,26 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
300
241
  gridData: DragTargetDataFn;
301
242
  /**
302
243
  * Enables the [filtering]({% slug filtering_grid %}) of the Grid columns that have their `field` option set.
244
+ * @default false
303
245
  */
304
246
  filterable: FilterableSettings;
305
247
  /**
306
248
  * Enables the [sorting]({% slug sorting_grid %}) of the Grid columns that have their `field` option set.
249
+ * @default false
307
250
  */
308
251
  sortable: SortSettings;
309
252
  /**
310
- * Configures the pager of the Grid ([see example]({% slug paging_grid %})).
311
- *
312
- * The available options are:
313
- * - `buttonCount: Number`&mdash;Sets the maximum numeric buttons count before the buttons are collapsed. Defaults to `10`.
314
- * - `info: Boolean`&mdash;Toggles the information about the current page and the total number of records. Defaults to `true`.
315
- * - `type: PagerType`&mdash;Accepts the `numeric` (buttons with numbers) and `input` (input for typing the page number) values. Defaults to `'numeric'`.
316
- * - `pageSizes: Boolean` or `Array<number>`&mdash;Shows a menu for selecting the page size. Defaults to `false`.
317
- * - `previousNext: Boolean`&mdash;Toggles the **Previous** and **Next** buttons. Defaults to `true`.
318
- * - `responsive: Boolean`&mdash;Toggles the built-in responsive behavior of the Pager. Defaults to `true`.
253
+ * Configures the pager of the Grid ([see example](slug:paging_grid_settings)).
254
+ * @default false
319
255
  */
320
256
  pageable: PagerSettings | boolean;
321
257
  /**
322
- * If set to `true`, the user can group the Grid by dragging the column header cells.
323
- * By default, grouping is disabled ([see example]({% slug grouping_grid %})).
258
+ * If set to `true`, the user can group the Grid by dragging the column header cells ([see example]({% slug grouping_grid %})).
259
+ * @default false
324
260
  */
325
261
  groupable: GroupableSettings | boolean;
326
262
  /**
327
- * Enables the [row reordering]({% slug ToDo %}) of the Grid.
263
+ * Enables the [row reordering]({% slug reordering_rows_grid %}) of the Grid.
328
264
  * @default false
329
265
  */
330
266
  set rowReorderable(value: boolean);
@@ -348,56 +284,16 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
348
284
  get navigatable(): GridNavigableSettings;
349
285
  /**
350
286
  * Indicates whether the Grid columns will be resized during initialization so that
351
- * they fit their headers and row content. Defaults to `false`.
287
+ * they fit their headers and row content.
352
288
  * Columns with `autoSize` set to `false` are excluded.
353
289
  * To dynamically update the column width to match the new content,
354
290
  * refer to [this example]({% slug resizing_columns_grid %}).
291
+ * @default false
355
292
  */
356
293
  autoSize: boolean;
357
294
  /**
358
- * Defines a function that is executed for every data row in the component.
359
- *
360
- * @example
361
- * ```ts
362
- * import { Component, ViewEncapsulation } from '@angular/core';
363
- * import { RowClassArgs } from '@progress/kendo-angular-grid';
364
- *
365
- * _@Component({
366
- * selector: 'my-app',
367
- * encapsulation: ViewEncapsulation.None,
368
- * styles: [`
369
- * .k-grid tr.even { background-color: #f45c42; }
370
- * .k-grid tr.odd { background-color: #41f4df; }
371
- * `],
372
- * template: `
373
- * <kendo-grid [data]="gridData" [rowClass]="rowCallback">
374
- * </kendo-grid>
375
- * `
376
- * })
377
- * class AppComponent {
378
- * public gridData: any[] = products;
379
- *
380
- * public rowCallback(context: RowClassArgs) {
381
- * const isEven = context.index % 2 === 0;
382
- * return {
383
- * even: isEven,
384
- * odd: !isEven
385
- * };
386
- * }
387
- * }
388
- *
389
- * const products = [{
390
- * "ProductID": 1,
391
- * "ProductName": "Chai",
392
- * "UnitPrice": 18.0000,
393
- * "Discontinued": true
394
- * }, {
395
- * "ProductID": 2,
396
- * "ProductName": "Chang",
397
- * "UnitPrice": 19.0000,
398
- * "Discontinued": false
399
- * }
400
- * ];
295
+ * Defines a function that is executed for every data row in the component
296
+ * ([see example](slug:styling_grid_rows)).
401
297
  * ```
402
298
  */
403
299
  set rowClass(fn: RowClassFn);
@@ -462,8 +358,8 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
462
358
  columnMenu: boolean | ColumnMenuSettings;
463
359
  /**
464
360
  * Specifies if the header of the grid will be hidden. The header is visible by default.
465
- *
466
- * > The header includes column headers and the [filter row]({% slug filtering_grid %}#toc-filter-row).
361
+ * The header includes column headers and the [filter row](slug:filter_row).
362
+ * @default false
467
363
  */
468
364
  hideHeader: boolean;
469
365
  /**
@@ -744,9 +640,9 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
744
640
  * This method is provided only for backwards-compatibility with legacy versions.
745
641
  * These versions tracked the expanded group state internally using the hierarchical group index.
746
642
  *
747
- * > * When you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive,
748
- * > the `expandGroup` method is not supported.
749
- * > * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
643
+ * The `expandGroup` method is not supported when you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive.
644
+ *
645
+ * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
750
646
  *
751
647
  * @param {string} index - The underscore separated hierarchical index of the group.
752
648
  */
@@ -758,9 +654,9 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
758
654
  * This method is provided only for backwards-compatibility with legacy versions.
759
655
  * These versions tracked the expanded group state internally using the hierarchical group index.
760
656
  *
761
- * > * When you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive,
762
- * > the `collapseGroup` method is not supported.
763
- * > * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
657
+ * The `collapseGroup` method is not supported when you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive.
658
+ *
659
+ * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
764
660
  *
765
661
  * @param {string} index - The underscore separated hierarchical index of the group.
766
662
  */
@@ -821,7 +717,7 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
821
717
  */
822
718
  addRow(group: any): void;
823
719
  /**
824
- * Puts the cell that is specified by the table row and column in edit mode.
720
+ * Puts the cell that is specified by the table row and column in edit mode ([see example](slug:editing_incell_grid)).
825
721
  *
826
722
  * @param {number} rowIndex - The data row index that will be switched in the edit mode.
827
723
  * @param {number|string|any} column - The leaf column index, or the field name or the column instance that should be edited.
@@ -862,7 +758,7 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
862
758
  * Exports the Grid element to a Drawing [Group]({% slug api_kendo-drawing_group %}) by using the `kendo-grid-pdf` component options.
863
759
  * ([see example]({% slug pdfexport_grid %}#toc-exporting-multiple-grids-to-the-same-pdf)).
864
760
  *
865
- * @return {Promise} - A promise that will be resolved with the Drawing `Group`.
761
+ * @return {Promise} A promise that will be resolved with the Drawing `Group`.
866
762
  */
867
763
  drawPDF(): Promise<any>;
868
764
  /**
@@ -872,136 +768,17 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
872
768
  /**
873
769
  * Applies the minimum possible width for the specified column,
874
770
  * so that the whole text fits without wrapping. This method expects the Grid
875
- * to be resizable (set `resizable` to `true`).
876
- * Makes sense to execute this method only
771
+ * to be [resizable](slug:resizing_columns_grid). The method must be executed
877
772
  * after the Grid is already populated with data.
878
- *
879
- * @example
880
- * ```ts
881
- * _@Component({
882
- * selector: 'my-app',
883
- * template: `
884
- * <kendo-grid
885
- * #grid
886
- * [data]="gridData"
887
- * [resizable]="true"
888
- * style="height: 300px">
889
- * <ng-template kendoGridToolbarTemplate>
890
- * <button kendoButton (click)="grid.autoFitColumn(groupColumn)">
891
- * Auto-fit the group column
892
- * </button>
893
- * </ng-template>
894
- * <kendo-grid-column-group #groupColumn title="Product Info">
895
- * <kendo-grid-column
896
- * field="ProductID"
897
- * [width]="50"
898
- * [minResizableWidth]="30"
899
- * title="ID">
900
- * </kendo-grid-column>
901
- *
902
- * <kendo-grid-column
903
- * field="ProductName"
904
- * title="Product Name">
905
- * </kendo-grid-column>
906
- * </kendo-grid-column-group>
907
- *
908
- * <kendo-grid-column
909
- * field="UnitPrice"
910
- * title="Unit Price"
911
- * [width]="180"
912
- * filter="numeric"
913
- * format="{0:c}">
914
- * </kendo-grid-column>
915
- * </kendo-grid>
916
- * `
917
- * })
918
- * class AppComponent {
919
- * public gridData: any[] = products;
920
- * }
921
- *
922
- * const products = [{
923
- * "ProductID": 1,
924
- * "ProductName": "Chai",
925
- * "UnitPrice": 18.0000,
926
- * "Discontinued": true
927
- * }, {
928
- * "ProductID": 2,
929
- * "ProductName": "Chang",
930
- * "UnitPrice": 19.0000,
931
- * "Discontinued": false
932
- * }
933
- * ];
934
- * ```
773
+ * [See example](slug:resizing_columns_grid#toc-auto-fitting-the-content)
935
774
  */
936
775
  autoFitColumn(column: ColumnBase): void;
937
776
  /**
938
777
  * Adjusts the width of the specified columns to fit the entire content, including headers, without wrapping.
939
- * If no columns are specified, `autoFitColumns` is applied to all columns.
940
- *
941
- * This method requires the Grid to be resizable (set `resizable` to `true`).
942
- *
943
- * @example
944
- * ```ts
945
- * _@Component({
946
- * selector: 'my-app',
947
- * template: `
948
- * <kendo-grid
949
- * #grid
950
- * [data]="gridData"
951
- * [resizable]="true"
952
- * style="height: 300px">
953
- * <ng-template kendoGridToolbarTemplate>
954
- * <button kendoButton (click)="grid.autoFitColumns([firstColumn, lastColumn])">
955
- * Auto-fit the first and last column
956
- * </button>
957
- * <button kendoButton (click)="grid.autoFitColumns()">
958
- * Auto-fit all columns
959
- * </button>
960
- * </ng-template>
961
- * <kendo-grid-column-group title="Product Info">
962
- * <kendo-grid-column
963
- * #firstColumn
964
- * field="ProductID"
965
- * [width]="50"
966
- * [minResizableWidth]="30"
967
- * title="ID">
968
- * </kendo-grid-column>
969
- *
970
- * <kendo-grid-column
971
- * field="ProductName"
972
- * title="Product Name"
973
- * >
974
- * </kendo-grid-column>
975
- * </kendo-grid-column-group>
976
- *
977
- * <kendo-grid-column
978
- * #lastColumn
979
- * field="UnitPrice"
980
- * title="Unit Price"
981
- * [width]="180"
982
- * filter="numeric"
983
- * format="{0:c}">
984
- * </kendo-grid-column>
985
- * </kendo-grid>
986
- * `
987
- * })
988
- * class AppComponent {
989
- * public gridData: any[] = products;
990
- * }
778
+ * If no columns are specified, `autoFitColumns` is applied to all columns.The method must be executed
779
+ * after the Grid is already populated with data.
780
+ * [See example](slug:resizing_columns_grid#toc-auto-fitting-the-content)
991
781
  *
992
- * const products = [{
993
- * "ProductID": 1,
994
- * "ProductName": "Chai",
995
- * "UnitPrice": 18.0000,
996
- * "Discontinued": true
997
- * }, {
998
- * "ProductID": 2,
999
- * "ProductName": "Chang",
1000
- * "UnitPrice": 19.0000,
1001
- * "Discontinued": false
1002
- * }
1003
- * ];
1004
- * ```
1005
782
  */
1006
783
  autoFitColumns(columns?: Array<ColumnBase> | QueryList<ColumnBase>): void;
1007
784
  /**
@@ -1025,10 +802,10 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
1025
802
  /**
1026
803
  * Focuses the cell with the specified row and column index.
1027
804
  *
1028
- * The row index is based on the logical structure of the Grid and does not correspond to the data item index:
1029
- * * Header rows are included, starting at index 0.
1030
- * * Group headers and footers are included.
1031
- * * The row indexing is absolute and does not change with paging.
805
+ * The row index is based on the logical structure of the Grid and does not correspond to the data item index.
806
+ * Header rows are included, starting at index 0.
807
+ * Group headers and footers are included.
808
+ * The row indexing is absolute and does not change with paging.
1032
809
  *
1033
810
  * If the Grid is configured for scrolling, including virtual scrolling, the scroll position will be updated.
1034
811
  * If the row is not present on the current page, the method will have no effect.
@@ -1068,67 +845,6 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
1068
845
  * @param {number} destIndex - The new position of the column.
1069
846
  * @param {ColumnReorderConfig} options - Additional options.
1070
847
  *
1071
- * @example
1072
- * ```ts
1073
- * _@Component({
1074
- * selector: 'my-app',
1075
- * template: `
1076
- * <kendo-grid
1077
- * #grid
1078
- * [data]="gridData"
1079
- * [reorderable]="true"
1080
- * style="height: 300px">
1081
- * <ng-template kendoGridToolbarTemplate>
1082
- * <button kendoButton
1083
- * (click)="grid.reorderColumn(groupColumn, 2, { before: true })">
1084
- * Move the group column before the last one.
1085
- * </button>
1086
- * </ng-template>
1087
- * <kendo-grid-column-group #groupColumn title="Product Info">
1088
- * <kendo-grid-column
1089
- * field="ProductID"
1090
- * [width]="50"
1091
- * title="ID">
1092
- * </kendo-grid-column>
1093
- *
1094
- * <kendo-grid-column
1095
- * field="ProductName"
1096
- * title="Product Name">
1097
- * </kendo-grid-column>
1098
- * </kendo-grid-column-group>
1099
- *
1100
- * <kendo-grid-column
1101
- * field="UnitPrice"
1102
- * title="Unit Price"
1103
- * [width]="180"
1104
- * format="{0:c}">
1105
- * </kendo-grid-column>
1106
- *
1107
- * <kendo-grid-column
1108
- * field="Discontinued"
1109
- * title="Discontinued"
1110
- * [width]="100">
1111
- * </kendo-grid-column>
1112
- * </kendo-grid>
1113
- * `
1114
- * })
1115
- * class AppComponent {
1116
- * public gridData: any[] = products;
1117
- * }
1118
- *
1119
- * const products = [{
1120
- * "ProductID": 1,
1121
- * "ProductName": "Chai",
1122
- * "UnitPrice": 18.0000,
1123
- * "Discontinued": true
1124
- * }, {
1125
- * "ProductID": 2,
1126
- * "ProductName": "Chang",
1127
- * "UnitPrice": 19.0000,
1128
- * "Discontinued": false
1129
- * }
1130
- * ];
1131
- * ```
1132
848
  */
1133
849
  reorderColumn(source: ColumnBase, destIndex: number, options?: ColumnReorderConfig): void;
1134
850
  /**
package/grid.module.d.ts CHANGED
@@ -123,29 +123,19 @@ import * as i114 from "./column-menu/column-menu-autosize-all.component";
123
123
  *
124
124
  * @example
125
125
  *
126
- * ```ts-no-run
127
- * // Import the Grid module
128
- * import { GridModule } from '@progress/kendo-angular-grid';
129
- *
130
- * // The browser platform with a compiler
131
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
132
- *
126
+ * ```ts
133
127
  * import { NgModule } from '@angular/core';
134
- *
135
- * // Import the app component
128
+ * import { GridModule } from '@progress/kendo-angular-grid';
129
+ * import { BrowserModule } from "@angular/platform-browser";
136
130
  * import { AppComponent } from './app.component';
137
131
  *
138
- * // Define the app module
139
- * _@NgModule({
140
- * declarations: [AppComponent], // declare app component
141
- * imports: [BrowserModule, GridModule], // import Grid module
132
+ * @NgModule({
133
+ * declarations: [AppComponent],
134
+ * imports: [BrowserModule, GridModule],
142
135
  * bootstrap: [AppComponent]
143
136
  * })
144
137
  * export class AppModule {}
145
138
  *
146
- * // Compile and launch the module
147
- * platformBrowserDynamic().bootstrapModule(AppModule);
148
- *
149
139
  * ```
150
140
  */
151
141
  export declare class GridModule {
@@ -19,20 +19,8 @@ export interface GroupKey {
19
19
  value: any;
20
20
  /**
21
21
  * An array of `{ field: string, value: any }` items indicating all parent groups of the current one,
22
- * staring from the direct parent group all the way to the root level one.
22
+ * staring from the direct parent group all the way to the root level one. [See example](slug:groups_expanded_state_grid#toc-default-configuration).
23
23
  *
24
- * The following example demonstrates how to provide [expandedGroupKeys]({% slug api_grid_expandgroupdirective %}#toc-expandedgroupkeys).
25
- * The `productCategory` group provides as `parentGroupKeys` first the group descriptor for its direct parent group,
26
- * and then the group descriptors for the ancestor groups.
27
- *
28
- * @example
29
- * ```ts-no-run
30
- * public expandedGroupKeys: Array<GroupKey> = [
31
- * { field: 'location', value: 'Sofia' },
32
- * { field: 'inStock', value: true, parentGroupKeys: [{ field: 'location', value: 'Sofia' }] },
33
- * { field: 'productCategory', value: 'Bevarages', parentGroupKeys: [{ field: 'inStock', value: true }, { field: 'location', value: 'Sofia' }] }
34
- * ];
35
- * ```
36
24
  */
37
25
  parentGroupKeys?: Array<{
38
26
  field: string;