@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
@@ -169,7 +169,8 @@ const replaceMessagePlaceholder = (message, name, value) => message.replace(new
169
169
  * Represents the Kendo UI GridSpacer component for Angular.
170
170
  * Used to give additional white space between the Pager inner elements,
171
171
  * and provides a way for customizing the spacer width.
172
- * It can also be used in any flex container within the Grid.
172
+ * It can also be used in any flex container within the Grid
173
+ * ([see example](slug:toolbartemplate_grid#toc-defining-the-spacing-between-toolbar-elements)).
173
174
  */
174
175
  class GridSpacerComponent {
175
176
  constructor() {
@@ -1035,7 +1036,7 @@ class PreventableEvent {
1035
1036
  this.prevented = true;
1036
1037
  }
1037
1038
  /**
1038
- * Returns `true` if the event was prevented
1039
+ * Returns a respective boolean if the event was prevented
1039
1040
  * by any of its subscribers.
1040
1041
  *
1041
1042
  * @returns `true` if the default action was prevented.
@@ -2826,8 +2827,8 @@ const packageMetadata = {
2826
2827
  name: '@progress/kendo-angular-grid',
2827
2828
  productName: 'Kendo UI for Angular',
2828
2829
  productCodes: ['KENDOUIANGULAR', 'KENDOUICOMPLETE'],
2829
- publishDate: 1681884669,
2830
- version: '12.0.0-develop.9',
2830
+ publishDate: 1683028339,
2831
+ version: '12.0.1-develop.1',
2831
2832
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
2832
2833
  };
2833
2834
 
@@ -3190,9 +3191,9 @@ class ColumnBase {
3190
3191
  */
3191
3192
  this.matchesMedia = true;
3192
3193
  /**
3193
- * The column index after reordering.
3194
+ * The column index after reordering. The `orderIndex` is a read-only property. Setting this field does not affect column order.
3194
3195
  *
3195
- * > `orderIndex` is a read-only property. Setting this field does not affect column order.
3196
+ * @default 0
3196
3197
  */
3197
3198
  this.orderIndex = 0;
3198
3199
  /**
@@ -3215,6 +3216,7 @@ class ColumnBase {
3215
3216
  this.reorderable = true;
3216
3217
  /**
3217
3218
  * The width (in pixels) below which the user is not able to resize the column by using the UI ([see example]({% slug resizing_columns_grid %}#toc-limiting-the-resizing)).
3219
+ * The `autoFitColumn` and `autoFitColumns` methods have higher priority.
3218
3220
  * @default 10
3219
3221
  */
3220
3222
  this.minResizableWidth = 10;
@@ -3227,18 +3229,22 @@ class ColumnBase {
3227
3229
  this.sticky = false;
3228
3230
  /**
3229
3231
  * Specifies if the column can be locked or unlocked from the column menu or by reordering the columns.
3232
+ * @default true
3230
3233
  */
3231
3234
  this.lockable = true;
3232
3235
  /**
3233
3236
  * Specifies if the column can be stuck or unstuck from the column menu.
3237
+ * @default true
3234
3238
  */
3235
3239
  this.stickable = true;
3236
3240
  /**
3237
3241
  * Specifies if the column menu will be shown for the column.
3242
+ * @default true
3238
3243
  */
3239
3244
  this.columnMenu = true;
3240
3245
  /**
3241
3246
  * Specifies if the column will be included in the column-chooser list.
3247
+ * @default true
3242
3248
  */
3243
3249
  this.includeInChooser = true;
3244
3250
  /**
@@ -3286,44 +3292,6 @@ class ColumnBase {
3286
3292
  *
3287
3293
  * @default false
3288
3294
  *
3289
- * @example
3290
- * ```ts
3291
- * _@Component({
3292
- * selector: 'my-app',
3293
- * template: `
3294
- * <kendo-grid [data]="gridData" [scrollable]="scrollable" style="height: 200px">
3295
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120" [locked]="true">
3296
- * </kendo-grid-column>
3297
- * <kendo-grid-column field="ProductName" title="Product Name" [width]="200">
3298
- * </kendo-grid-column>
3299
- * <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
3300
- * </kendo-grid-column>
3301
- * </kendo-grid>
3302
- * `
3303
- * })
3304
- *
3305
- * class AppComponent {
3306
- * public gridData: any[];
3307
- *
3308
- * constructor() {
3309
- * this.gridData = products;
3310
- * }
3311
- * }
3312
- *
3313
- * const products = [{
3314
- * "ProductID": 1,
3315
- * "ProductName": "Chai",
3316
- * "UnitPrice": 18.0000,
3317
- * "Discontinued": true
3318
- * }, {
3319
- * "ProductID": 2,
3320
- * "ProductName": "Chang",
3321
- * "UnitPrice": 19.0000,
3322
- * "Discontinued": false
3323
- * }
3324
- * ];
3325
- *
3326
- * ```
3327
3295
  */
3328
3296
  set locked(value) {
3329
3297
  this._locked = value;
@@ -3503,113 +3471,56 @@ function isColumnComponent(column) {
3503
3471
  return isPresent(column.field);
3504
3472
  }
3505
3473
  /**
3506
- * Represents the columns of the [Angular Data Grid]({% slug overview_grid %}).
3474
+ * Represents the column of the Grid. [See example](slug:columns_config#toc-using-the-column-component)
3507
3475
  *
3508
3476
  * @example
3509
- * ```ts-preview
3510
- *
3511
- * _@Component({
3512
- * selector: 'my-app',
3513
- * template: `
3514
- * <kendo-grid [data]="gridData">
3515
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
3516
- * </kendo-grid-column>
3517
- * <kendo-grid-column field="ProductName" title="Product Name">
3518
- * </kendo-grid-column>
3519
- * <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
3520
- * </kendo-grid-column>
3521
- * <kendo-grid-column field="Discontinued" [width]="120">
3522
- * <ng-template kendoGridCellTemplate let-dataItem>
3523
- * <input type="checkbox" [checked]="dataItem.Discontinued" disabled/>
3524
- * </ng-template>
3525
- * </kendo-grid-column>
3526
- * </kendo-grid>
3527
- * `
3528
- * })
3529
- *
3530
- * class AppComponent {
3531
- * public gridData: any[];
3532
- *
3533
- * constructor() {
3534
- * this.gridData = products;
3535
- * }
3536
- * }
3537
- *
3538
- * const products = [{
3539
- * "ProductID": 1,
3540
- * "ProductName": "Chai",
3541
- * "UnitPrice": 18.0000,
3542
- * "Discontinued": true
3543
- * }, {
3544
- * "ProductID": 2,
3545
- * "ProductName": "Chang",
3546
- * "UnitPrice": 19.0000,
3547
- * "Discontinued": false
3548
- * }
3549
- * ];
3550
- *
3477
+ * ```html
3478
+ * <kendo-grid [data]="gridData">
3479
+ * <kendo-grid-column field="ProductID" title="Product ID"></kendo-grid-column>
3480
+ * <kendo-grid-column field="ProductName" title="Product Name"></kendo-grid-column>
3481
+ * <kendo-grid-column field="UnitPrice" title="Unit Price"></kendo-grid-column>
3482
+ * </kendo-grid>
3551
3483
  * ```
3552
3484
  */
3553
3485
  class ColumnComponent extends ColumnBase {
3554
3486
  constructor(parent, idService) {
3555
3487
  super(parent, idService);
3556
3488
  /**
3557
- * Allows the column headers to be clicked and the `sortChange` event emitted.
3558
- * You have to handle the `sortChange` event yourself and sort the data.
3489
+ * Allows the user to click the column headers and emits the `sortChange` event. [See example](slug:sorting_grid).
3490
+ *
3491
+ * @default true
3559
3492
  */
3560
3493
  this.sortable = true;
3561
3494
  /**
3562
- * Determines if the column can be dragged to the group panel. The default value is `true`.
3495
+ * Determines if the column can be dragged to the group panel.
3563
3496
  * If set to `false`, you can group the columns by the column field by using the API of the Grid.
3497
+ *
3498
+ * @default true
3564
3499
  */
3565
3500
  this.groupable = true;
3566
3501
  /**
3567
- * Defines the editor type ([see example]({% slug inline_editing_grid %}#toc-using-reactive-forms)).
3568
- * Used when the column enters the edit mode. The default value is `text`.
3502
+ * Defines the editor type. [See example](slug:inline_editing_grid#toc-using-reactive-forms).
3503
+ * Used when the column enters the edit mode.
3569
3504
  *
3570
- * @example
3571
- * ```html-no-run
3572
- * <kendo-grid>
3573
- * <kendo-grid-column field="UnitPrice" editor="numeric">
3574
- * </kendo-grid-column>
3575
- * </kendo-grid>
3576
- * ```
3505
+ * @default 'text'
3577
3506
  */
3578
3507
  this.editor = 'text';
3579
3508
  /**
3580
- * Defines the filter type that is displayed inside the filter row. The default value is `text`.
3509
+ * Defines the filter type that is displayed inside the filter row. [See example](slug:filtering_grid#toc-filter-data-types).
3581
3510
  *
3582
- * @example
3583
- * ```html-no-run
3584
- * <kendo-grid>
3585
- * <kendo-grid-column field="UnitPrice" filter="numeric">
3586
- * </kendo-grid-column>
3587
- * </kendo-grid>
3588
- * ```
3511
+ * @default 'text'
3589
3512
  */
3590
3513
  this.filter = 'text';
3591
3514
  /**
3592
- * Defines if a filter UI will be displayed for this column. The default value is `true`.
3515
+ * Defines if a filter UI will be displayed for this column. [See example](slug:filtering_grid).
3593
3516
  *
3594
- * @example
3595
- * ```html-no-run
3596
- * <kendo-grid>
3597
- * <kendo-grid-column field="UnitPrice" [filterable]="false">
3598
- * </kendo-grid-column>
3599
- * </kendo-grid>
3600
- * ```
3517
+ * @default true
3601
3518
  */
3602
3519
  this.filterable = true;
3603
3520
  /**
3604
- * Defines whether the column is editable. The default value is `true`.
3521
+ * Defines whether the column is editable. [See example](slug:make_fields_uneditable_grid).
3605
3522
  *
3606
- * @example
3607
- * ```html-no-run
3608
- * <kendo-grid>
3609
- * <kendo-grid-column field="UnitPrice" [editable]="false">
3610
- * </kendo-grid-column>
3611
- * </kendo-grid>
3612
- * ```
3523
+ * @default true
3613
3524
  */
3614
3525
  this.editable = true;
3615
3526
  }
@@ -3718,62 +3629,15 @@ function isSpanColumnComponent(column) {
3718
3629
  * [grouping]({% slug grouping_grid %}). Wrap the columns that will be
3719
3630
  * merged inside the `<kendo-grid-span-column>` tag.
3720
3631
  *
3721
- * @example
3722
- * ```ts-preview
3723
- *
3724
- * _@Component({
3725
- * selector: 'my-app',
3726
- * template: `
3727
- * <kendo-grid
3728
- * [sortable]="true"
3729
- * [filterable]="true"
3730
- * [kendoGridBinding]="products">
3731
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
3732
- * </kendo-grid-column>
3733
- * <kendo-grid-span-column>
3734
- * <kendo-grid-column field="ProductName" title="Product Name">
3735
- * </kendo-grid-column>
3736
- * <kendo-grid-column field="UnitPrice" title="Unit Price" filter="numeric" [width]="180" format="{0:c}">
3737
- * </kendo-grid-column>
3738
- * </kendo-grid-span-column>
3739
- * <kendo-grid-column field="Discontinued" [width]="120" filter="boolean">
3740
- * <ng-template kendoGridCellTemplate let-dataItem>
3741
- * <input type="checkbox" [checked]="dataItem.Discontinued" disabled/>
3742
- * </ng-template>
3743
- * </kendo-grid-column>
3744
- * </kendo-grid>
3745
- * `
3746
- * })
3747
- *
3748
- * class AppComponent {
3749
- * public products = [{
3750
- * "ProductID": 1,
3751
- * "ProductName": "Chai",
3752
- * "UnitPrice": 18.0000,
3753
- * "Discontinued": true
3754
- * }, {
3755
- * "ProductID": 2,
3756
- * "ProductName": "Chang",
3757
- * "UnitPrice": 19.0000,
3758
- * "Discontinued": false
3759
- * }
3760
- * ];
3761
- * }
3762
- *
3763
- * ```
3764
- *
3765
- * By default, the data cell displays the data for the specified fields. To further customize
3766
- * the span-column functionality, use a [cell template]({% slug api_grid_celltemplatedirective %}).
3767
- *
3768
- * ```html-no-run
3632
+ * ```html
3769
3633
  * <kendo-grid-span-column>
3770
- * <kendo-grid-column field="field1" title="Field 1"></kendo-grid-column>
3771
- * <kendo-grid-column field="field2" title="Field 2"></kendo-grid-column>
3772
- * <ng-template kendoGridCellTemplate let-dataItem>
3773
- * <h5>{{ dataItem.field1 }}</h5>
3774
- * <p>{{ dataItem.field2 }}</p>
3775
- * </ng-template>
3776
- * </kendo-grid-span-column>
3634
+ * <kendo-grid-column field="field1"></kendo-grid-column>
3635
+ * <kendo-grid-column field="field2"></kendo-grid-column>
3636
+ * <ng-template kendoGridCellTemplate let-dataItem>
3637
+ * <h5>{{ dataItem.field1 }}</h5>
3638
+ * <p>{{ dataItem.field2 }}</p>
3639
+ * </ng-template>
3640
+ * </kendo-grid-span-column>
3777
3641
  * ```
3778
3642
  */
3779
3643
  class SpanColumnComponent extends ColumnBase {
@@ -3799,24 +3663,9 @@ class SpanColumnComponent extends ColumnBase {
3799
3663
  }
3800
3664
  }
3801
3665
  /**
3802
- * Defines whether the edit template of the column will be rendered. The default value is `false`.
3803
- *
3804
- * > To enable the editing functionality for a spanned column, set an edit template for it.
3805
- *
3806
- * @example
3807
- * ```html-no-run
3808
- * <kendo-grid>
3809
- * <kendo-grid-span-column [editable]="false">
3810
- * <kendo-grid-column field="UnitPrice">
3811
- * </kendo-grid-column>
3812
- * <kendo-grid-column field="ProductName">
3813
- * </kendo-grid-column>
3814
- * <ng-template kendoGridEditTemplate>
3815
- * .....
3816
- * </ng-template>
3817
- * </kendo-grid-span-column>
3818
- * </kendo-grid>
3819
- * ```
3666
+ * Defines whether the edit template of the column will be rendered.
3667
+ * To enable the editing functionality for a spanned column, set an edit template for it ([see exmaple](slug:custom_reactive_editing_grid)).
3668
+ * @default false
3820
3669
  */
3821
3670
  set editable(value) {
3822
3671
  this._editable = value;
@@ -3860,57 +3709,8 @@ class SpanColumnComponent extends ColumnBase {
3860
3709
  return this.childColumns.filter(c => c.isVisible).length;
3861
3710
  }
3862
3711
  /**
3863
- * Toggles the locked (frozen) state of the columns. Locked columns are visible
3864
- * at all times during the horizontal scrolling of the Grid.
3865
- *
3866
- * For the option to work properly, make sure that:
3867
- * - Scrolling is enabled.
3868
- * - The `height` option of the Grid is set.
3869
- * - The widths of all Grid columns are explicitly set in pixels. In this way,
3870
- * the Grid adjusts the layout of the locked and unlocked columns.
3871
- *
3712
+ * Toggles the locked (frozen) state of the columns ([see example](slug:locked_columns_grid)).
3872
3713
  * @default false
3873
- *
3874
- * @example
3875
- * ```ts
3876
- * _@Component({
3877
- * selector: 'my-app',
3878
- * template: `
3879
- * <kendo-grid [data]="gridData" [scrollable]="scrollable" style="height: 200px">
3880
- * <kendo-grid-span-column [locked]="true">
3881
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
3882
- * </kendo-grid-column>
3883
- * <kendo-grid-column field="ProductName" title="Product Name" [width]="200">
3884
- * </kendo-grid-column>
3885
- * </kendo-grid-span-column>
3886
- * <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
3887
- * </kendo-grid-column>
3888
- * </kendo-grid>
3889
- * `
3890
- * })
3891
- *
3892
- * class AppComponent {
3893
- * public gridData: any[];
3894
- *
3895
- * constructor() {
3896
- * this.gridData = products;
3897
- * }
3898
- * }
3899
- *
3900
- * const products = [{
3901
- * "ProductID": 1,
3902
- * "ProductName": "Chai",
3903
- * "UnitPrice": 18.0000,
3904
- * "Discontinued": true
3905
- * }, {
3906
- * "ProductID": 2,
3907
- * "ProductName": "Chang",
3908
- * "UnitPrice": 19.0000,
3909
- * "Discontinued": false
3910
- * }
3911
- * ];
3912
- *
3913
- * ```
3914
3714
  */
3915
3715
  set locked(value) {
3916
3716
  this._locked = value;
@@ -4042,56 +3842,17 @@ function isColumnGroupComponent(column) {
4042
3842
  }
4043
3843
  /**
4044
3844
  * Represents the column group header of the Grid
4045
- * ([more information and examples]({% slug multicolumnheaders_columns_grid %})).
3845
+ * ([more information and examples](slug:multicolumnheaders_columns_grid)).
4046
3846
  *
4047
3847
  * @example
4048
- * ```ts-preview
4049
- *
4050
- * _@Component({
4051
- * selector: 'my-app',
4052
- * template: `
4053
- * <kendo-grid [data]="gridData">
4054
- * <kendo-grid-column-group title="Product Info">
4055
- * <ng-template kendoGridHeaderTemplate let-columnIndex="columnIndex" let-column="column">
4056
- * Column index: {{columnIndex}} / column title: {{column.title}}
4057
- * </ng-template>
4058
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
4059
- * </kendo-grid-column>
4060
- * <kendo-grid-column field="ProductName" title="Product Name">
4061
- * </kendo-grid-column>
4062
- * </kendo-grid-column-group>
4063
- * <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
4064
- * </kendo-grid-column>
4065
- * <kendo-grid-column field="Discontinued" [width]="120">
4066
- * <ng-template kendoGridCellTemplate let-dataItem>
4067
- * <input type="checkbox" [checked]="dataItem.Discontinued" disabled/>
4068
- * </ng-template>
4069
- * </kendo-grid-column>
4070
- * </kendo-grid>
4071
- * `
4072
- * })
4073
- *
4074
- * class AppComponent {
4075
- * public gridData: any[];
4076
- *
4077
- * constructor() {
4078
- * this.gridData = products;
4079
- * }
4080
- * }
4081
- *
4082
- * const products = [{
4083
- * "ProductID": 1,
4084
- * "ProductName": "Chai",
4085
- * "UnitPrice": 18.0000,
4086
- * "Discontinued": true
4087
- * }, {
4088
- * "ProductID": 2,
4089
- * "ProductName": "Chang",
4090
- * "UnitPrice": 19.0000,
4091
- * "Discontinued": false
4092
- * }
4093
- * ];
4094
- *
3848
+ * ```html
3849
+ * <kendo-grid [data]="gridData">
3850
+ * <kendo-grid-column-group title="Product Info">
3851
+ * <kendo-grid-column field="ProductID"></kendo-grid-column>
3852
+ * <kendo-grid-column field="ProductName"></kendo-grid-column>
3853
+ * </kendo-grid-column-group>
3854
+ * <kendo-grid-column field="UnitPrice"></kendo-grid-column>
3855
+ * </kendo-grid>
4095
3856
  * ```
4096
3857
  */
4097
3858
  class ColumnGroupComponent extends ColumnBase {
@@ -5730,7 +5491,7 @@ class PopupCloseEvent extends PreventableEvent {
5730
5491
  const DEFAULT_POPUP_CLASS = 'k-grid-filter-popup';
5731
5492
  /**
5732
5493
  * The service that is used for the popups of the filter and column menus
5733
- * ([see example]({% slug filter_menu %}#toc-custom-filter-row-components)#toc-filter-menu-with-popup).
5494
+ * ([see example]({% slug filter_menu %}#toc-filter-menu-with-popup)).
5734
5495
  */
5735
5496
  class SinglePopupService {
5736
5497
  constructor(popupService, renderer, ngZone, scrollSyncService, localization) {
@@ -6323,6 +6084,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
6323
6084
  }]
6324
6085
  }], ctorParameters: function () { return [{ type: i0.TemplateRef }]; } });
6325
6086
 
6087
+ /**
6088
+ * @hidden
6089
+ */
6326
6090
  class SizingOptionsService {
6327
6091
  constructor() {
6328
6092
  this.changes = new Subject();
@@ -6433,6 +6197,7 @@ class RowReorderService {
6433
6197
  }
6434
6198
  press(ev) {
6435
6199
  this.dragTarget = ev.dragTarget;
6200
+ this.offsetY = ev.dragEvent.offsetY;
6436
6201
  }
6437
6202
  dragStart() {
6438
6203
  this.createDropIndicator();
@@ -6444,7 +6209,7 @@ class RowReorderService {
6444
6209
  }
6445
6210
  const position = {
6446
6211
  x: ev.dragEvent.clientX,
6447
- y: ev.dragEvent.clientY
6212
+ y: ev.dragEvent.clientY - this.offsetY
6448
6213
  };
6449
6214
  if (isPresent$1(this.hintElement)) {
6450
6215
  this.renderer.setStyle(this.hintElement, 'left', `${position.x}px`);
@@ -6939,7 +6704,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
6939
6704
  }] } });
6940
6705
 
6941
6706
  /**
6942
- * Displays buttons for navigating to the first and to the previous page ([see example]({% slug paging_grid %}#toc-pager-templates)).
6707
+ * Displays buttons for navigating to the first and to the previous page ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
6943
6708
  */
6944
6709
  class PagerPrevButtonsComponent extends PagerElementComponent {
6945
6710
  constructor(localization, pagerContext, cd, navigationService) {
@@ -7041,7 +6806,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
7041
6806
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }, { type: PagerContextService }, { type: i0.ChangeDetectorRef }, { type: NavigationService }]; } });
7042
6807
 
7043
6808
  /**
7044
- * Displays numeric buttons to enable navigation between the pages.
6809
+ * Displays numeric buttons to enable navigation between the pages ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
7045
6810
  */
7046
6811
  class PagerNumericButtonsComponent extends PagerElementComponent {
7047
6812
  constructor(localization, cd, pagerContext) {
@@ -7297,54 +7062,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
7297
7062
  }], ctorParameters: function () { return [{ type: i3.NumericTextBoxComponent }, { type: i0.Renderer2 }]; } });
7298
7063
 
7299
7064
  /**
7300
- * Displays an input element which allows the typing and rendering of page numbers.
7301
- *
7302
- * @example
7303
- * ```ts-preview
7304
- *
7305
- * _@Component({
7306
- * selector: 'my-app',
7307
- * template: `
7308
- * <kendo-grid
7309
- * [kendoGridBinding]="gridData"
7310
- * [pageSize]="1"
7311
- * [pageable]="true"
7312
- * >
7313
- * <kendo-grid-column field="ProductID" title="ID" [width]="40">
7314
- * </kendo-grid-column>
7315
- * <kendo-grid-column field="ProductName" title="Name" [width]="250">
7316
- * </kendo-grid-column>
7317
- * <kendo-grid-column field="UnitPrice" title="Price" [width]="80" format="{0:c}">
7318
- * </kendo-grid-column>
7319
- *
7320
- * <ng-template kendoPagerTemplate let-totalPages="totalPages" let-currentPage="currentPage">
7321
- * <kendo-pager-prev-buttons></kendo-pager-prev-buttons>
7322
- * <kendo-pager-numeric-buttons [buttonCount]="10"></kendo-pager-numeric-buttons>
7323
- * <kendo-pager-next-buttons></kendo-pager-next-buttons>
7324
- * <kendo-pager-input></kendo-pager-input>
7325
- * <kendo-pager-info></kendo-pager-info>
7326
- * </ng-template>
7327
- *
7328
- * </kendo-grid>
7329
- * `
7330
- * })
7331
- *
7332
- * class AppComponent {
7333
- * public gridData = [{
7334
- * "ProductID": 1,
7335
- * "ProductName": "Chai",
7336
- * "UnitPrice": 18.0000,
7337
- * "Discontinued": false
7338
- * }, {
7339
- * "ProductID": 2,
7340
- * "ProductName": "Chang",
7341
- * "UnitPrice": 19.0000,
7342
- * "Discontinued": true
7343
- * }
7344
- * ];
7345
- * }
7346
- *
7347
- * ```
7065
+ * Displays an input element which allows the typing and rendering of page numbers ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
7348
7066
  */
7349
7067
  class PagerInputComponent extends PagerElementComponent {
7350
7068
  constructor(localization, pagerContext, zone, navigationService, cd) {
@@ -7468,7 +7186,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
7468
7186
  }] } });
7469
7187
 
7470
7188
  /**
7471
- * Displays buttons for navigating to the next and to the last page ([see example]({% slug paging_grid %}#toc-pager-template)).
7189
+ * Displays buttons for navigating to the next and to the last page ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
7472
7190
  */
7473
7191
  class PagerNextButtonsComponent extends PagerElementComponent {
7474
7192
  constructor(localization, pagerContext, cd, navigationService) {
@@ -7569,7 +7287,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
7569
7287
 
7570
7288
  // eslint-disable no-access-missing-member
7571
7289
  /**
7572
- * Displays information about the current page and the total number of records ([see example]({% slug paging_grid %}#toc-pager-templates)).
7290
+ * Displays information about the current page and the total number of records ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
7573
7291
  */
7574
7292
  class PagerInfoComponent extends PagerElementComponent {
7575
7293
  constructor(localization, cd, pagerContext) {
@@ -7661,7 +7379,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
7661
7379
  }], ctorParameters: function () { return [{ type: i1$4.DropDownListComponent }]; } });
7662
7380
 
7663
7381
  /**
7664
- * Displays a drop-down list for the page size selection ([see example]({% slug paging_grid %}#toc-pager-templates)).
7382
+ * Displays a drop-down list for the page size selection ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
7665
7383
  */
7666
7384
  class PagerPageSizesComponent extends PagerElementComponent {
7667
7385
  constructor(localization, cd, pagerContext, navigationService) {
@@ -7671,97 +7389,8 @@ class PagerPageSizesComponent extends PagerElementComponent {
7671
7389
  this._pageSizes = [];
7672
7390
  }
7673
7391
  /**
7674
- * The page sizes collection. Can be an Array of numbers and/or PageSizeItem objects.
7675
- *
7676
- * @example
7677
- * ```ts-preview
7678
- * _@Component({
7679
- * selector: 'my-app',
7680
- * template: `
7681
- * <kendo-grid [kendoGridBinding]="gridData" [height]="200"
7682
- * [pageable]="true"
7683
- * [pageSize]="pageSize">
7684
- * <ng-template kendoPagerTemplate let-totalPages="totalPages" let-currentPage="currentPage">
7685
- * <kendo-pager-page-sizes [pageSizes]="pagesizes"></kendo-pager-page-sizes>
7686
- * </ng-template>
7687
- * </kendo-grid>
7688
- * `
7689
- * })
7690
- * class AppComponent {
7691
- * public gridData: any[] = products;
7692
- * public pageSize = 2;
7693
- * public pagesizes = [{text: 'One', value: 1}, {text: 'Two', value: 2}, {text: 'All', value : 'all'}];
7694
- * }
7695
- *
7696
- * const products = [{
7697
- * 'ProductID' : 1,
7698
- * 'ProductName' : "Chai",
7699
- * 'SupplierID' : 1,
7700
- * 'CategoryID' : 1,
7701
- * 'QuantityPerUnit' : "10 boxes x 20 bags",
7702
- * 'UnitPrice' : 18.0000,
7703
- * 'UnitsInStock' : 39,
7704
- * 'UnitsOnOrder' : 0,
7705
- * 'ReorderLevel' : 10,
7706
- * 'Discontinued' : false
7707
- *
7708
- * }, {
7709
- * 'ProductID' : 2,
7710
- * 'ProductName' : "Chang",
7711
- * 'SupplierID' : 1,
7712
- * 'CategoryID' : 1,
7713
- * 'QuantityPerUnit' : "24 - 12 oz bottles",
7714
- * 'UnitPrice' : 19.0000,
7715
- * 'UnitsInStock' : 17,
7716
- * 'UnitsOnOrder' : 40,
7717
- * 'ReorderLevel' : 25,
7718
- * 'Discontinued' : false
7719
- * }, {
7720
- * 'ProductID' : 3,
7721
- * 'ProductName' : "Aniseed Syrup",
7722
- * 'SupplierID' : 1,
7723
- * 'CategoryID' : 2,
7724
- * 'QuantityPerUnit' : "12 - 550 ml bottles",
7725
- * 'UnitPrice' : 10.0000,
7726
- * 'UnitsInStock' : 13,
7727
- * 'UnitsOnOrder' : 70,
7728
- * 'ReorderLevel' : 25,
7729
- * 'Discontinued' : false
7730
- * }, {
7731
- * 'ProductID' : 4,
7732
- * 'ProductName' : "Chef Anton\'s Cajun Seasoning",
7733
- * 'SupplierID' : 2,
7734
- * 'CategoryID' : 2,
7735
- * 'QuantityPerUnit' : "48 - 6 oz jars",
7736
- * 'UnitPrice' : 22.0000,
7737
- * 'UnitsInStock' : 53,
7738
- * 'UnitsOnOrder' : 0,
7739
- * 'ReorderLevel' : 0,
7740
- * 'Discontinued' : false
7741
- * }, {
7742
- * 'ProductID' : 5,
7743
- * 'ProductName' : "Chef Anton\'s Gumbo Mix",
7744
- * 'SupplierID' : 2,
7745
- * 'CategoryID' : 2,
7746
- * 'QuantityPerUnit' : "36 boxes",
7747
- * 'UnitPrice' : 21.3500,
7748
- * 'UnitsInStock' : 0,
7749
- * 'UnitsOnOrder' : 0,
7750
- * 'ReorderLevel' : 0,
7751
- * 'Discontinued' : true
7752
- * }, {
7753
- * 'ProductID' : 6,
7754
- * 'ProductName' : "Grandma\'s Boysenberry Spread",
7755
- * 'SupplierID' : 3,
7756
- * 'CategoryID' : 2,
7757
- * 'QuantityPerUnit' : "12 - 8 oz jars",
7758
- * 'UnitPrice' : 25.0000,
7759
- * 'UnitsInStock' : 120,
7760
- * 'UnitsOnOrder' : 0,
7761
- * 'ReorderLevel' : 25,
7762
- * 'Discontinued' : false
7763
- * }];
7764
- * ```
7392
+ * The page sizes collection. Can be an Array of numbers and/or [`PageSizeItem`](slug:api_grid_pagesizeitem) objects
7393
+ * ([see example]({% slug paging_grid %}#toc-pager-templates))
7765
7394
  */
7766
7395
  set pageSizes(pageSizes) {
7767
7396
  let normalizedItems = [];
@@ -9185,8 +8814,9 @@ class StringFilterComponent extends BaseFilterCellComponent {
9185
8814
  super(filterService);
9186
8815
  this.localization = localization;
9187
8816
  /**
9188
- * The default filter operator. Defaults to `contains`.
8817
+ * The default filter operator.
9189
8818
  * @type {string}
8819
+ * @default 'contains'
9190
8820
  */
9191
8821
  this.operator = "contains";
9192
8822
  }
@@ -9650,8 +9280,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
9650
9280
  }] } });
9651
9281
 
9652
9282
  /**
9653
- * Represents a string-filter menu component.
9654
- * ([see example]({% slug filter_menu %}#toc-built-in-filter-menu-components)).
9283
+ * Represents a string-filter menu component
9284
+ * ([see example](slug:filter_menu#toc-built-in-filter-menu-components)).
9285
+ *
9286
+ * ```html
9287
+ * <kendo-grid-column field="ProductName">
9288
+ * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
9289
+ * <kendo-grid-string-filter-menu
9290
+ * [column]="column"
9291
+ * [filter]="filter"
9292
+ * [filterService]="filterService">
9293
+ * </kendo-grid-string-filter-menu>
9294
+ * </ng-template>
9295
+ * </kendo-grid-column>
9296
+ * ```
9655
9297
  */
9656
9298
  class StringFilterMenuComponent extends StringFilterComponent {
9657
9299
  constructor(localization) {
@@ -9664,6 +9306,7 @@ class StringFilterMenuComponent extends StringFilterComponent {
9664
9306
  this.filter = { filters: [], logic: "and" };
9665
9307
  /**
9666
9308
  * Determines if the inputs of second criteria will displayed.
9309
+ * @default true
9667
9310
  */
9668
9311
  this.extra = true;
9669
9312
  }
@@ -9794,18 +9437,21 @@ class NumericFilterComponent extends BaseFilterCellComponent {
9794
9437
  super(filterService);
9795
9438
  this.localization = localization;
9796
9439
  /**
9797
- * The default filter operator. Defaults to `eq`.
9440
+ * The default filter operator.
9798
9441
  * @type {string}
9442
+ * @default 'eq'
9799
9443
  */
9800
9444
  this.operator = "eq";
9801
9445
  /**
9802
9446
  * Specifies the value that is used to increment or decrement the component value.
9803
9447
  * @type {numeric}
9448
+ * @default 1
9804
9449
  */
9805
9450
  this.step = 1;
9806
9451
  /**
9807
9452
  * Specifies whether the **Up** and **Down** spin buttons will be rendered.
9808
9453
  * @type {boolean}
9454
+ * @default true
9809
9455
  */
9810
9456
  this.spinners = true;
9811
9457
  this.defaultOperators = numericOperators(this.localization);
@@ -10018,21 +9664,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
10018
9664
  }] } });
10019
9665
 
10020
9666
  /**
10021
- * Represents a numeric-filter menu component.
9667
+ * Represents a numeric filter-menu component.
10022
9668
  *
10023
9669
  * @example
10024
- * ```html-no-run
10025
- * <kendo-grid-column field="UnitPrice" title="Unit Price">
10026
- * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
10027
- * <kendo-grid-numeric-filter-menu
10028
- * [column]="column"
10029
- * [filter]="filter"
10030
- * [filterService]="filterService"
10031
- * >
10032
- * </kendo-grid-numeric-filter-menu>
10033
- * </ng-template>
10034
- * </kendo-grid-column>
10035
- * ```
9670
+ * ```html
9671
+ * <kendo-grid-column field="UnitPrice">
9672
+ * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
9673
+ * <kendo-grid-numeric-filter-menu
9674
+ * [column]="column"
9675
+ * [filter]="filter"
9676
+ * [filterService]="filterService">
9677
+ * </kendo-grid-numeric-filter-menu>
9678
+ * </ng-template>
9679
+ * </kendo-grid-column>
9680
+ * ```
10036
9681
  */
10037
9682
  class NumericFilterMenuComponent extends NumericFilterComponent {
10038
9683
  constructor(localization) {
@@ -10045,6 +9690,7 @@ class NumericFilterMenuComponent extends NumericFilterComponent {
10045
9690
  this.filter = { filters: [], logic: "and" };
10046
9691
  /**
10047
9692
  * Determines if the inputs of second criteria will displayed.
9693
+ * @default true
10048
9694
  */
10049
9695
  this.extra = true;
10050
9696
  /**
@@ -10217,25 +9863,29 @@ class DateFilterComponent extends BaseFilterCellComponent {
10217
9863
  /**
10218
9864
  * The default filter operator. Defaults to `contains`.
10219
9865
  * @type {string}
9866
+ * @default 'gte'
10220
9867
  */
10221
9868
  this.operator = "gte";
10222
9869
  /**
10223
9870
  * Defines the active view that the calendar initially renders.
10224
9871
  * By default, the active view is `month`.
10225
- *
10226
- * > You have to set `activeView` within the `topView`-`bottomView` range.
9872
+ * You have to set `activeView` within the `topView`-`bottomView` range.
9873
+ * @default 'month'
10227
9874
  */
10228
9875
  this.activeView = "month";
10229
9876
  /**
10230
9877
  * Defines the bottommost calendar view, to which the user can navigate.
9878
+ * @default 'month'
10231
9879
  */
10232
9880
  this.bottomView = "month";
10233
9881
  /**
10234
9882
  * Defines the topmost calendar view, to which the user can navigate.
9883
+ * @default 'century'
10235
9884
  */
10236
9885
  this.topView = "century";
10237
9886
  /**
10238
9887
  * Determines whether to display a week number column in the `month` view of the Calendar.
9888
+ * @default false
10239
9889
  */
10240
9890
  this.weekNumber = false;
10241
9891
  this.defaultOperators = dateOperators(this.localization);
@@ -10470,21 +10120,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
10470
10120
  }] } });
10471
10121
 
10472
10122
  /**
10473
- * Represents a date-filter menu component.
10123
+ * Represents a date filter-menu component.
10474
10124
  *
10475
10125
  * @example
10476
- * ```html-no-run
10477
- * <kendo-grid-column field="OrderDate" title="Order Date">
10478
- * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
10479
- * <kendo-grid-date-filter-menu
10480
- * [column]="column"
10481
- * [filter]="filter"
10482
- * [filterService]="filterService"
10483
- * >
10484
- * </kendo-grid-date-filter-menu>
10485
- * </ng-template>
10486
- * </kendo-grid-column>
10487
- * ```
10126
+ * ```html
10127
+ * <kendo-grid-column field="FirstOrderedOn">
10128
+ * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
10129
+ * <kendo-grid-date-filter-menu
10130
+ * [column]="column"
10131
+ * [filter]="filter"
10132
+ * [filterService]="filterService">
10133
+ * </kendo-grid-date-filter-menu>
10134
+ * </ng-template>
10135
+ * </kendo-grid-column>
10136
+ * ```
10488
10137
  */
10489
10138
  class DateFilterMenuComponent extends DateFilterComponent {
10490
10139
  constructor(localization) {
@@ -10497,6 +10146,7 @@ class DateFilterMenuComponent extends DateFilterComponent {
10497
10146
  this.filter = { filters: [], logic: "and" };
10498
10147
  /**
10499
10148
  * Determines if the inputs of second criteria will be displayed.
10149
+ * @default true
10500
10150
  */
10501
10151
  this.extra = true;
10502
10152
  }
@@ -10753,21 +10403,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
10753
10403
  }] } });
10754
10404
 
10755
10405
  /**
10756
- * Represents a Boolean-filter menu component.
10406
+ * Represents a Boolean-filter menu component. [See example](slug:filter_menu#toc-built-in-filter-menu-components)
10757
10407
  *
10758
10408
  * @example
10759
- * ```html-no-run
10760
- * <kendo-grid-column field="Discontinued" title="Discontinued">
10761
- * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
10762
- * <kendo-grid-boolean-filter-menu
10763
- * [column]="column"
10764
- * [filter]="filter"
10765
- * [filterService]="filterService"
10766
- * >
10767
- * </kendo-grid-boolean-filter-menu>
10768
- * </ng-template>
10769
- * </kendo-grid-column>
10770
- * ```
10409
+ *
10410
+ * ```html
10411
+ * <kendo-grid-column field="Discontinued" title="Discontinued">
10412
+ * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
10413
+ * <kendo-grid-boolean-filter-menu
10414
+ * [column]="column"
10415
+ * [filter]="filter"
10416
+ * [filterService]="filterService">
10417
+ * </kendo-grid-boolean-filter-menu>
10418
+ * </ng-template>
10419
+ * </kendo-grid-column>
10420
+ * ```
10771
10421
  */
10772
10422
  class BooleanFilterMenuComponent extends BooleanFilterComponent {
10773
10423
  constructor(localization) {
@@ -11295,27 +10945,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
11295
10945
  * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11296
10946
  *
11297
10947
  * @example
11298
- * ```ts-preview
11299
- *
11300
- * _@Component({
11301
- * selector: 'my-app',
11302
- * template: `
11303
- * <kendo-grid [data]="data" [columnMenu]="true">
11304
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
11305
- * <span class="k-icon k-i-x" (click)="service.close()"
11306
- * style="position: absolute; right: 5px; top: 5px;cursor: pointer;"></span>
11307
- * <kendo-grid-columnmenu-sort [service]="service">
11308
- * </kendo-grid-columnmenu-sort>
11309
- * </ng-template>
11310
- * <kendo-grid-column field="Field1"></kendo-grid-column>
11311
- * <kendo-grid-column field="Field2"></kendo-grid-column>
11312
- * </kendo-grid>
11313
- * `
11314
- * })
11315
- *
11316
- * class AppComponent {
11317
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
11318
- * }
10948
+ * ```html
10949
+ * <kendo-grid [data]="data" [columnMenu]="true">
10950
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
10951
+ * <span class="k-icon k-i-x" (click)="service.close()" </span>
10952
+ * <kendo-grid-columnmenu-sort [service]="service">
10953
+ * </kendo-grid-columnmenu-sort>
10954
+ * </ng-template>
10955
+ * <kendo-grid-column field="Field1"></kendo-grid-column>
10956
+ * </kendo-grid>
11319
10957
  *
11320
10958
  * ```
11321
10959
  */
@@ -11428,27 +11066,12 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
11428
11066
  * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11429
11067
  *
11430
11068
  * @example
11431
- * ```ts-preview
11432
- *
11433
- * _@Component({
11434
- * selector: 'my-app',
11435
- * template: `
11436
- * <kendo-grid [data]="data" [columnMenu]="true" [resizable]="true" #grid>
11437
- * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
11438
- * <kendo-grid-columnmenu-item icon="arrows-resizing" text="Fit column"
11439
- * (itemClick)="grid.autoFitColumn(column); service.close()">
11440
- * </kendo-grid-columnmenu-item>
11441
- * </ng-template>
11442
- * <kendo-grid-column field="Field1"></kendo-grid-column>
11443
- * <kendo-grid-column field="Field2"></kendo-grid-column>
11444
- * </kendo-grid>
11445
- * `
11446
- * })
11447
- *
11448
- * class AppComponent {
11449
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
11450
- * }
11451
- *
11069
+ * ```html
11070
+ * <kendo-grid [columnMenu]="true" ...>
11071
+ * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
11072
+ * <kendo-grid-columnmenu-item text="Fit column"></kendo-grid-columnmenu-item>
11073
+ * </ng-template>
11074
+ * </kendo-grid>
11452
11075
  * ```
11453
11076
  */
11454
11077
  class ColumnMenuItemComponent {
@@ -11605,34 +11228,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
11605
11228
  }] } });
11606
11229
 
11607
11230
  /**
11608
- * Represents a column-menu item that can be placed inside a
11609
- * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11610
- * Allows the user to lock or unlock the columns.
11231
+ * Represents the column-menu item for locking and unlocking columns in the Grid. [See example](slug:columnmenu_grid#toc-lock-and-unlock-items).
11611
11232
  *
11612
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11613
- * > the template to the service input of the `kendo-grid-columnmenu-lock` component.
11233
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11234
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11235
+ * the template to the service input of the `kendo-grid-columnmenu-lock` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
11614
11236
  *
11615
11237
  * @example
11616
- * ```ts-preview
11617
- *
11618
- * _@Component({
11619
- * selector: 'my-app',
11620
- * template: `
11621
- * <kendo-grid [data]="data" [columnMenu]="true">
11622
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
11623
- * <kendo-grid-columnmenu-lock [service]="service">
11624
- * </kendo-grid-columnmenu-lock>
11625
- * </ng-template>
11626
- * <kendo-grid-column field="Field1" [width]="100"></kendo-grid-column>
11627
- * <kendo-grid-column field="Field2" [width]="100"></kendo-grid-column>
11628
- * </kendo-grid>
11629
- * `
11630
- * })
11631
- *
11632
- * class AppComponent {
11633
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
11634
- * }
11635
- *
11238
+ * ```html
11239
+ * <kendo-grid [data]="data" [columnMenu]="true" ...>
11240
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
11241
+ * <kendo-grid-columnmenu-lock [service]="service">
11242
+ * </kendo-grid-columnmenu-lock>
11243
+ * </ng-template>
11244
+ * </kendo-grid>
11636
11245
  * ```
11637
11246
  */
11638
11247
  class ColumnMenuLockComponent extends ColumnMenuItemBase {
@@ -11712,33 +11321,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
11712
11321
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }, { type: ColumnInfoService }, { type: i0.ChangeDetectorRef }]; } });
11713
11322
 
11714
11323
  /**
11715
- * Represents a column-menu item that can be placed inside a
11716
- * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11717
- * Allows the user to stick or unstick the columns.
11324
+ * Represents the column-menu item that sticks or unsticks columns in the Grid.
11325
+ * [See example](slug:columnmenu_grid#toc-stick-and-unstick-items).
11718
11326
  *
11719
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11720
- * > the template to the service input of the `kendo-grid-columnmenu-stick` component.
11327
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11328
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11329
+ * the template to the service input of the `kendo-grid-columnmenu-lock` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
11721
11330
  *
11722
11331
  * @example
11723
- * ```ts-preview
11724
- *
11725
- * _@Component({
11726
- * selector: 'my-app',
11727
- * template: `
11728
- * <kendo-grid [data]="data" [columnMenu]="true">
11729
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
11730
- * <kendo-grid-columnmenu-stick [service]="service">
11731
- * </kendo-grid-columnmenu-stick>
11732
- * </ng-template>
11733
- * <kendo-grid-column field="Field1" [width]="100"></kendo-grid-column>
11734
- * <kendo-grid-column field="Field2" [width]="100"></kendo-grid-column>
11735
- * </kendo-grid>
11736
- * `
11737
- * })
11738
- *
11739
- * class AppComponent {
11740
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
11741
- * }
11332
+ * ```html
11333
+ * <kendo-grid [data]="data" [columnMenu]="true">
11334
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
11335
+ * <kendo-grid-columnmenu-stick [service]="service">
11336
+ * </kendo-grid-columnmenu-stick>
11337
+ * </ng-template>
11338
+ * </kendo-grid>
11742
11339
  *
11743
11340
  * ```
11744
11341
  */
@@ -11819,33 +11416,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
11819
11416
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }, { type: ColumnInfoService }, { type: i0.ChangeDetectorRef }]; } });
11820
11417
 
11821
11418
  /**
11822
- * Represents the component for editing column filters in the Grid that can be placed
11823
- * inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11419
+ * Represents the column-menu item which combines the lock and sticky column functionalities.
11824
11420
  *
11825
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11826
- * > the template to the service input of the `kendo-grid-columnmenu-filter` component.
11421
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11422
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11423
+ * the template to the service input of the `kendo-grid-columnmenu-filter` component. [See example](slug:columnmenu_grid#toc-set-column-position-item).
11827
11424
  *
11828
11425
  * @example
11829
- * ```ts-preview
11830
- *
11831
- * _@Component({
11832
- * selector: 'my-app',
11833
- * template: `
11834
- * <kendo-grid [kendoGridBinding]="data" [columnMenu]="true">
11835
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
11836
- * <kendo-grid-columnmenu-filter [service]="service">
11837
- * </kendo-grid-columnmenu-filter>
11838
- * </ng-template>
11839
- * <kendo-grid-column field="Field1"></kendo-grid-column>
11840
- * <kendo-grid-column field="Field2"></kendo-grid-column>
11841
- * </kendo-grid>
11842
- * `
11843
- * })
11844
- *
11845
- * class AppComponent {
11846
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
11847
- * }
11848
- *
11426
+ * ```html
11427
+ * <kendo-grid [data]="data" [columnMenu]="true" ...>
11428
+ * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
11429
+ * <kendo-grid-columnmenu-position [service]="service" [showLock]="true" [showStick]="true">
11430
+ * </kendo-grid-columnmenu-position>
11431
+ * </ng-template>
11432
+ * </kendo-grid>
11849
11433
  * ```
11850
11434
  */
11851
11435
  class ColumnMenuPositionComponent extends ColumnMenuItemBase {
@@ -11863,6 +11447,7 @@ class ColumnMenuPositionComponent extends ColumnMenuItemBase {
11863
11447
  this.collapse = new EventEmitter();
11864
11448
  /**
11865
11449
  * Specifies if the content is expanded.
11450
+ * @default false
11866
11451
  */
11867
11452
  this.expanded = false;
11868
11453
  /**
@@ -12194,33 +11779,19 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12194
11779
  }] } });
12195
11780
 
12196
11781
  /**
12197
- * Represents the component for selecting columns in the Grid that can be placed
12198
- * inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11782
+ * Represents the column-menu item for selecting columns in the Grid. [See example](slug:columnmenu_grid#toc-column-chooser-item).
12199
11783
  *
12200
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12201
- * > the template to the service input of the `kendo-grid-columnmenu-chooser` component.
11784
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11785
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11786
+ * the template to the service input of the `kendo-grid-columnmenu-chooser` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
12202
11787
  *
12203
11788
  * @example
12204
- * ```ts-preview
12205
- *
12206
- * _@Component({
12207
- * selector: 'my-app',
12208
- * template: `
12209
- * <kendo-grid [data]="data" [columnMenu]="true">
12210
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
12211
- * <kendo-grid-columnmenu-chooser [service]="service">
12212
- * </kendo-grid-columnmenu-chooser>
12213
- * </ng-template>
12214
- * <kendo-grid-column field="Field1"></kendo-grid-column>
12215
- * <kendo-grid-column field="Field2" [hidden]="true"></kendo-grid-column>
12216
- * </kendo-grid>
12217
- * `
12218
- * })
12219
- *
12220
- * class AppComponent {
12221
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
12222
- * }
12223
- *
11789
+ * ```html
11790
+ * <kendo-grid [columnMenu]="true" ...>
11791
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
11792
+ * <kendo-grid-columnmenu-chooser [service]="service"> </kendo-grid-columnmenu-chooser>
11793
+ * </ng-template>
11794
+ * </kendo-grid>
12224
11795
  * ```
12225
11796
  */
12226
11797
  class ColumnMenuChooserComponent extends ColumnMenuItemBase {
@@ -12240,6 +11811,7 @@ class ColumnMenuChooserComponent extends ColumnMenuItemBase {
12240
11811
  this.collapse = new EventEmitter();
12241
11812
  /**
12242
11813
  * Specifies if the content is expanded.
11814
+ * @default false
12243
11815
  */
12244
11816
  this.expanded = false;
12245
11817
  /**
@@ -12348,33 +11920,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12348
11920
  }] } });
12349
11921
 
12350
11922
  /**
12351
- * Represents the component for editing column filters in the Grid that can be placed
12352
- * inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11923
+ * Represents the column-menu item for editing column filters in the Grid. [See example](slug:columnmenu_grid#toc-filter-item).
12353
11924
  *
12354
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12355
- * > the template to the service input of the `kendo-grid-columnmenu-filter` component.
11925
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11926
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11927
+ * the template to the service input of the `kendo-grid-columnmenu-filter` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
12356
11928
  *
12357
11929
  * @example
12358
- * ```ts-preview
12359
- *
12360
- * _@Component({
12361
- * selector: 'my-app',
12362
- * template: `
12363
- * <kendo-grid [kendoGridBinding]="data" [columnMenu]="true">
12364
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
12365
- * <kendo-grid-columnmenu-filter [service]="service">
12366
- * </kendo-grid-columnmenu-filter>
12367
- * </ng-template>
12368
- * <kendo-grid-column field="Field1"></kendo-grid-column>
12369
- * <kendo-grid-column field="Field2"></kendo-grid-column>
12370
- * </kendo-grid>
12371
- * `
12372
- * })
12373
- *
12374
- * class AppComponent {
12375
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
12376
- * }
12377
- *
11930
+ * ```html
11931
+ * <kendo-grid [columnMenu]="true" ...>
11932
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
11933
+ * <kendo-grid-columnmenu-filter [service]="service">
11934
+ * </kendo-grid-columnmenu-filter>
11935
+ * </ng-template>
11936
+ * </kendo-grid>
12378
11937
  * ```
12379
11938
  */
12380
11939
  class ColumnMenuFilterComponent extends ColumnMenuItemBase {
@@ -12392,6 +11951,7 @@ class ColumnMenuFilterComponent extends ColumnMenuItemBase {
12392
11951
  this.collapse = new EventEmitter();
12393
11952
  /**
12394
11953
  * Specifies if the content is expanded.
11954
+ * @default false
12395
11955
  */
12396
11956
  this.expanded = false;
12397
11957
  /**
@@ -12611,34 +12171,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12611
12171
  }] } });
12612
12172
 
12613
12173
  /**
12614
- * Represents a column-menu item for sorting Grid columns that can be placed inside a
12615
- * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
12616
- * Allows the user to sort the column.
12174
+ * Represents the column-menu item for sorting Grid columns.
12175
+ * [See example](slug:columnmenu_grid#toc-sort-item).
12617
12176
  *
12618
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12619
- * > the template to the service input of the `kendo-grid-columnmenu-sort` component.
12177
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
12178
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12179
+ * the template to the service input of the `kendo-grid-columnmenu-sort` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
12620
12180
  *
12621
12181
  * @example
12622
- * ```ts-preview
12623
- *
12624
- * _@Component({
12625
- * selector: 'my-app',
12626
- * template: `
12627
- * <kendo-grid [kendoGridBinding]="data" [sortable]="true" [columnMenu]="true">
12628
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
12629
- * <kendo-grid-columnmenu-sort [service]="service">
12630
- * </kendo-grid-columnmenu-sort>
12631
- * </ng-template>
12632
- * <kendo-grid-column field="Field1" [width]="100"></kendo-grid-column>
12633
- * <kendo-grid-column field="Field2" [width]="100"></kendo-grid-column>
12634
- * </kendo-grid>
12635
- * `
12636
- * })
12637
- *
12638
- * class AppComponent {
12639
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }, { Field1: 'Foo1', Field2: 'Bar1' }];
12640
- * }
12641
- *
12182
+ * ```html
12183
+ * <kendo-grid [kendoGridBinding]="data" [sortable]="true" [columnMenu]="true">
12184
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
12185
+ * <kendo-grid-columnmenu-sort [service]="service">
12186
+ * </kendo-grid-columnmenu-sort>
12187
+ * </ng-template>
12188
+ * </kendo-grid>
12642
12189
  * ```
12643
12190
  */
12644
12191
  class ColumnMenuSortComponent extends ColumnMenuItemBase {
@@ -12722,36 +12269,22 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12722
12269
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }, { type: SortService }, { type: i0.Renderer2 }]; } });
12723
12270
 
12724
12271
  /**
12725
- * Represents the component for resizing the specified column to the minimum possible width so that it fits the header or cell content without wrapping.
12272
+ * 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.
12273
+ * [See example](slug:slug:columnmenu_grid#toc-autosize-column-item).
12726
12274
  * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
12275
+ * [See example](slug:columnmenu_grid#toc-customizing-the-content).
12727
12276
  *
12728
- * > To enable the autosize-column option, set the [`resizable`]({% slug api_grid_gridcomponent %}#toc-resizable)
12729
- * > property of the Grid to `true`.
12730
- *
12731
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) and `column` that are passed by
12732
- * > the template to the `service` and `column` input of the `kendo-grid-columnmenu-autosize-column` component.
12277
+ * You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) and `column` that are passed by
12278
+ * the template to the `service` and `column` input of the `kendo-grid-columnmenu-autosize-column` component.
12733
12279
  *
12734
12280
  * @example
12735
- * ```ts-preview
12736
- *
12737
- * _@Component({
12738
- * selector: 'my-app',
12739
- * template: `
12740
- * <kendo-grid [data]="data" [columnMenu]="true">
12741
- * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
12742
- * <kendo-grid-columnmenu-autosize-column [column]="column" [service]="service">
12743
- * </kendo-grid-columnmenu-autosize-column>
12744
- * </ng-template>
12745
- * <kendo-grid-column field="Field1"></kendo-grid-column>
12746
- * <kendo-grid-column field="Field2"></kendo-grid-column>
12747
- * </kendo-grid>
12748
- * `
12749
- * })
12750
- *
12751
- * class AppComponent {
12752
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
12753
- * }
12754
- *
12281
+ * ```html
12282
+ * <kendo-grid [columnMenu]="true" ...>
12283
+ * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
12284
+ * <kendo-grid-columnmenu-autosize-column [column]="column" [service]="service">
12285
+ * </kendo-grid-columnmenu-autosize-column>
12286
+ * </ng-template>
12287
+ * </kendo-grid>
12755
12288
  * ```
12756
12289
  */
12757
12290
  class ColumnMenuAutoSizeColumnComponent extends ColumnMenuItemBase {
@@ -12802,36 +12335,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12802
12335
  }] } });
12803
12336
 
12804
12337
  /**
12805
- * Represents the component for resizing all columns to the minimum possible width so that they fit the widest header or cell content without wrapping.
12806
- * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
12807
- *
12808
- * > To enable the autosize-all-columns option, set the [`resizable`]({% slug api_grid_gridcomponent %}#toc-resizable)
12809
- * > property of the Grid to `true`.
12338
+ * 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.
12339
+ * [See example](slug:columnmenu_grid#toc-autosize-all-columns-item).
12810
12340
  *
12811
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12812
- * > the template to the `service` input of the `kendo-grid-columnmenu-autosize-all-columns` component.
12341
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
12342
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12343
+ * the template to the `service` input of the `kendo-grid-columnmenu-autosize-all-columns` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
12813
12344
  *
12814
12345
  * @example
12815
- * ```ts-preview
12816
- *
12817
- * _@Component({
12818
- * selector: 'my-app',
12819
- * template: `
12820
- * <kendo-grid [data]="data" [columnMenu]="true">
12821
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
12822
- * <kendo-grid-columnmenu-autosize-all-columns [service]="service">
12823
- * </kendo-grid-columnmenu-autosize-all-columns>
12824
- * </ng-template>
12825
- * <kendo-grid-column field="Field1"></kendo-grid-column>
12826
- * <kendo-grid-column field="Field2"></kendo-grid-column>
12827
- * </kendo-grid>
12828
- * `
12829
- * })
12830
- *
12831
- * class AppComponent {
12832
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
12833
- * }
12834
- *
12346
+ * ```html
12347
+ * <kendo-grid [columnMenu]="true" ...>
12348
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
12349
+ * <kendo-grid-columnmenu-autosize-all-columns [service]="service">
12350
+ * </kendo-grid-columnmenu-autosize-all-columns>
12351
+ * </ng-template>
12352
+ * </kendo-grid>
12835
12353
  * ```
12836
12354
  */
12837
12355
  class ColumnMenuAutoSizeAllColumnsComponent extends ColumnMenuItemBase {
@@ -12879,7 +12397,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12879
12397
 
12880
12398
  const POPUP_CLASS = 'k-grid-columnmenu-popup';
12881
12399
  /**
12882
- * Represents the [column menu]({% slug columnmenu_grid %}) component.
12400
+ * Represents the [column menu](slug:columnmenu_grid#toc-customizing-the-position) component.
12401
+ *
12402
+ * <kendo-grid ...>
12403
+ * <kendo-grid-column field="ProductName" [columnMenu]="false">
12404
+ * <ng-template kendoGridHeaderTemplate let-column>
12405
+ * <kendo-grid-column-menu [column]="column"> </kendo-grid-column-menu>
12406
+ * </ng-template>
12407
+ * </kendo-grid-column>
12408
+ * </kendo-grid>
12883
12409
  */
12884
12410
  class ColumnMenuComponent {
12885
12411
  constructor(navigationService, popupService, localization, service, ctx) {
@@ -13230,6 +12756,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
13230
12756
 
13231
12757
  /**
13232
12758
  * Represents a component which accommodates the filter operators.
12759
+ *
12760
+ * @example
12761
+ * ```html
12762
+ * <kendo-grid [data]="gridData">
12763
+ * <kendo-grid-column field="ProductName">
12764
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
12765
+ * <input />
12766
+ * <kendo-grid-filter-cell-operators
12767
+ * [operators]="[{text: 'Equals', value: 'eq'}]">
12768
+ * </kendo-grid-filter-cell-operators>
12769
+ * </ng-template>
12770
+ * </kendo-grid-column>
12771
+ * <kendo-grid>
12772
+ * ```
13233
12773
  */
13234
12774
  class FilterCellOperatorsComponent {
13235
12775
  constructor(localization, sizing) {
@@ -13248,6 +12788,7 @@ class FilterCellOperatorsComponent {
13248
12788
  /**
13249
12789
  * Determines if the list of operators will be displayed.
13250
12790
  * @type {boolean}
12791
+ * @default true
13251
12792
  */
13252
12793
  this.showOperators = true;
13253
12794
  /**
@@ -13453,36 +12994,35 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
13453
12994
  }] } });
13454
12995
 
13455
12996
  /**
13456
- * Represents a string-filter cell component
12997
+ * Represents a string filter-cell component
13457
12998
  * ([see example]({% slug filter_row %}#toc-hiding-filter-operators)).
13458
12999
  *
13459
13000
  * @example
13460
- *
13461
- * ```html-no-run
13462
- * <kendo-grid-column field="ProductName" title="Product Name">
13463
- * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13464
- * <kendo-grid-string-filter-cell
13465
- * [showOperators]="false"
13466
- * [column]="column"
13467
- * [filter]="filter">
13468
- * </kendo-grid-string-filter-cell>
13469
- * </ng-template>
13470
- * </kendo-grid-column>
13471
- * ```
13001
+ * ```html
13002
+ * <kendo-grid-column field="ProductName" title="Product Name">
13003
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13004
+ * <kendo-grid-string-filter-cell
13005
+ * [column]="column"
13006
+ * [filter]="filter">
13007
+ * </kendo-grid-string-filter-cell>
13008
+ * </ng-template>
13009
+ * </kendo-grid-column>
13010
+ * ```
13472
13011
  */
13473
13012
  class StringFilterCellComponent extends StringFilterComponent {
13474
13013
  constructor(filterService, localization, sizingService) {
13475
13014
  super(filterService, localization);
13476
13015
  /**
13477
13016
  * Determines the delay time (in milliseconds) before the filter value is submitted.
13478
- * A value of `0` indicates no delay. The default value is `500`.
13017
+ * A value of `0` indicates no delay.
13479
13018
  * @type {boolean}
13019
+ * @default 500
13480
13020
  */
13481
13021
  this.filterDelay = 500;
13482
13022
  /**
13483
13023
  * Determines if the drop-down filter operators will be displayed.
13484
- * The default value is `true`.
13485
13024
  * @type {boolean}
13025
+ * @default true
13486
13026
  */
13487
13027
  this.showOperators = true;
13488
13028
  this.subs = sizingService.changes.subscribe((size) => this.size = size);
@@ -13548,19 +13088,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
13548
13088
  }] } });
13549
13089
 
13550
13090
  /**
13551
- * Represents a numeric filter cell.
13091
+ * Represents a numeric filter-cell component.
13092
+ * [See example](slug:filter_row#toc-built-in-filter-row-components).
13552
13093
  *
13553
13094
  * @example
13554
- * ```html-no-run
13555
- * <kendo-grid-column field="ProductName" title="Product Name">
13556
- * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13557
- * <kendo-grid-numeric-filter-cell
13558
- * [column]="column"
13559
- * [filter]="filter">
13560
- * </kendo-grid-numeric-filter-cell>
13561
- * </ng-template>
13562
- * </kendo-grid-column>
13563
- * ```
13095
+ * ```html
13096
+ * <kendo-grid-column field="UnitPrice">
13097
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13098
+ * <kendo-grid-numeric-filter-cell
13099
+ * [column]="column"
13100
+ * [filter]="filter">
13101
+ * </kendo-grid-numeric-filter-cell>
13102
+ * </ng-template>
13103
+ * </kendo-grid-column>
13104
+ * ```
13564
13105
  */
13565
13106
  class NumericFilterCellComponent extends NumericFilterComponent {
13566
13107
  constructor(filterService, localization, sizingService) {
@@ -13570,12 +13111,14 @@ class NumericFilterCellComponent extends NumericFilterComponent {
13570
13111
  * Determines the delay time (in milliseconds) before the filter value is submitted.
13571
13112
  * A value of `0` indicates no delay. The default value is `500`.
13572
13113
  * @type {boolean}
13114
+ * @default 500
13573
13115
  */
13574
13116
  this.filterDelay = 500;
13575
13117
  /**
13576
13118
  * Determines if the drop-down filter operators will be displayed.
13577
13119
  * The default value is `true`.
13578
13120
  * @type {boolean}
13121
+ * @default true
13579
13122
  */
13580
13123
  this.showOperators = true;
13581
13124
  this.subs = sizingService.changes.subscribe((size) => this.size = size);
@@ -13674,19 +13217,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
13674
13217
 
13675
13218
  /**
13676
13219
  * Represents a Boolean filter-cell component.
13220
+ * [See example](slug:filter_row#toc-built-in-filter-row-components).
13677
13221
  *
13678
13222
  * @example
13679
13223
  *
13680
- * ```html-no-run
13681
- * <kendo-grid-column field="ProductName" title="Product Name">
13682
- * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13683
- * <kendo-grid-boolean-filter-cell
13684
- * [column]="column"
13685
- * [filter]="filter">
13686
- * </kendo-grid-boolean-filter-cell>
13687
- * </ng-template>
13688
- * </kendo-grid-column>
13689
- * ```
13224
+ * ```html
13225
+ * <kendo-grid-column field="Discontinued">
13226
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13227
+ * <kendo-grid-boolean-filter-cell
13228
+ * [column]="column"
13229
+ * [filter]="filter">
13230
+ * </kendo-grid-boolean-filter-cell>
13231
+ * </ng-template>
13232
+ * </kendo-grid-column>
13233
+ * ```
13690
13234
  */
13691
13235
  class BooleanFilterCellComponent extends BooleanFilterComponent {
13692
13236
  constructor(filterService, localization, cd, sizingService) {
@@ -13765,29 +13309,42 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
13765
13309
  }], ctorParameters: function () { return [{ type: FilterService }, { type: i1.LocalizationService }, { type: i0.ChangeDetectorRef }, { type: SizingOptionsService }]; } });
13766
13310
 
13767
13311
  /**
13768
- * Represents a date-filter cell component.
13312
+ * Represents a [DatePicker](slug:overview_datepicker) filter-cell component.
13769
13313
  *
13770
13314
  * @example
13771
13315
  *
13772
- * ```html-no-run
13773
- * <kendo-grid-column field="OrderDate" title="Order Date">
13774
- * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13775
- * <kendo-grid-date-filter-cell
13776
- * [showOperators]="false"
13777
- * [column]="column"
13778
- * [filter]="filter">
13779
- * </kendo-grid-date-filter-cell>
13780
- * </ng-template>
13781
- * </kendo-grid-column>
13782
- * ```
13316
+ * ```html
13317
+ * <kendo-grid-column field="FirstOrderedOn">
13318
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13319
+ * <kendo-grid-date-filter-cell
13320
+ * [column]="column"
13321
+ * [filter]="filter">
13322
+ * </kendo-grid-date-filter-cell>
13323
+ * </ng-template>
13324
+ * </kendo-grid-column>
13325
+ * ```
13783
13326
  */
13784
13327
  class DateFilterCellComponent extends DateFilterComponent {
13785
13328
  constructor(filterService, localization, sizingService) {
13786
13329
  super(filterService, localization);
13787
13330
  this.localization = localization;
13788
13331
  /**
13789
- * Determines if the drop-down filter operators will be displayed. The default value is `true`.
13332
+ * Represents a [DatePicker](slug:overview_datepicker) filter-cell component.
13333
+ * [See example](slug:filter_row#toc-built-in-filter-row-components).
13334
+ * @example
13335
+ *
13336
+ * ```html
13337
+ * <kendo-grid-column field="Discontinued">
13338
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13339
+ * <kendo-grid-date-filter-cell
13340
+ * [column]="column"
13341
+ * [filter]="filter">
13342
+ * </kendo-grid-date-filter-cell>
13343
+ * </ng-template>
13344
+ * </kendo-grid-column>
13345
+ * ```
13790
13346
  * @type {boolean}
13347
+ * @default true
13791
13348
  */
13792
13349
  this.showOperators = true;
13793
13350
  this.subs = sizingService.changes.subscribe((size) => this.size = size);
@@ -15836,68 +15393,20 @@ const IGNORE_CONTAINER_CLASSES = 'k-grid k-grid-ignore-click';
15836
15393
 
15837
15394
  /**
15838
15395
  * Represents the command columns of the Grid. You have to define the content of the
15839
- * column inside an `<ng-template>` tag. The template context is set to the current
15840
- * data item. For more information and examples on using the passed fields
15841
- * and the command directives, refer to the article on
15842
- * [editing the Grid in Angular Reactive Forms]({% slug inline_editing_grid %}#toc-using-reactive-forms).
15843
- *
15844
- * The following additional fields are passed:
15845
- * - `columnIndex`&mdash;The current column index.
15846
- * - `rowIndex`&mdash;The current data row index. If inside a new item row, `rowIndex`is `-1`.
15847
- * - `dataItem`&mdash;The current data item.
15848
- * - `column`&mdash;The current column instance.
15849
- * - `isNew`&mdash;The state of the current item.
15850
- *
15851
- * Usually, the template contains CRUD command directives such as:
15852
- * - [EditCommandDirective]({% slug api_grid_editcommanddirective %})
15853
- * - [RemoveCommandDirective]({% slug api_grid_removecommanddirective %})
15854
- * - [CancelCommandDirective]({% slug api_grid_cancelcommanddirective %})
15855
- * - [SaveCommandDirective]({% slug api_grid_savecommanddirective %})
15396
+ * column inside an `<ng-template>` tag.
15397
+ * For more information and examples, refer to the [Command Column Directives](slug:editing_directives_grid#toc-command-column-directives) article.
15856
15398
  *
15857
15399
  * @example
15858
- * ```ts-preview
15859
- *
15860
- * _@Component({
15861
- * selector: 'my-app',
15862
- * template: `
15863
- * <kendo-grid [data]="gridData">
15864
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
15865
- * </kendo-grid-column>
15866
- * <kendo-grid-column field="ProductName" title="Product Name">
15867
- * </kendo-grid-column>
15868
- * <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
15869
- * </kendo-grid-column>
15870
- * <kendo-grid-command-column title="command" [width]="220">
15871
- * <ng-template kendoGridCellTemplate>
15872
- * <button kendoGridEditCommand class="k-primary">Edit</button>
15873
- * <button kendoGridRemoveCommand>Remove</button>
15874
- * </ng-template>
15875
- * </kendo-grid-command-column>
15876
- * </kendo-grid>
15877
- * `
15878
- * })
15879
- *
15880
- * class AppComponent {
15881
- * public gridData: any[];
15882
- *
15883
- * constructor() {
15884
- * this.gridData = products;
15885
- * }
15886
- * }
15887
- *
15888
- * const products = [{
15889
- * "ProductID": 1,
15890
- * "ProductName": "Chai",
15891
- * "UnitPrice": 18.0000,
15892
- * "Discontinued": true
15893
- * }, {
15894
- * "ProductID": 2,
15895
- * "ProductName": "Chang",
15896
- * "UnitPrice": 19.0000,
15897
- * "Discontinued": false
15898
- * }
15899
- * ];
15900
- *
15400
+ * ```html
15401
+ * <kendo-grid [data]="gridData">
15402
+ * <kendo-grid-column field="ProductID"></kendo-grid-column>
15403
+ * <kendo-grid-command-column title="command" [width]="220">
15404
+ * <ng-template kendoGridCellTemplate>
15405
+ * <button kendoGridEditCommand class="k-primary">Edit</button>
15406
+ * <button kendoGridRemoveCommand>Remove</button>
15407
+ * </ng-template>
15408
+ * </kendo-grid-command-column>
15409
+ * </kendo-grid>
15901
15410
  * ```
15902
15411
  */
15903
15412
  class CommandColumnComponent extends ColumnBase {
@@ -18941,33 +18450,11 @@ const handleExpandCollapseDetailsService = (service, expandEmitter, collapseEmit
18941
18450
  const isInEditedCell = (element, gridElement) => closest(element, matchesClasses('k-grid-edit-cell')) &&
18942
18451
  closest(element, matchesNodeName('kendo-grid')) === gridElement;
18943
18452
  /**
18944
- * Represents the Kendo UI Grid component for Angular.
18453
+ * Represents the Kendo UI for Angular Data Grid component.
18945
18454
  *
18946
18455
  * @example
18947
- * ```ts-preview
18948
- * _@Component({
18949
- * selector: 'my-app',
18950
- * template: `
18951
- * <kendo-grid [data]="gridData">
18952
- * </kendo-grid>
18953
- * `
18954
- * })
18955
- * class AppComponent {
18956
- * public gridData: any[] = products;
18957
- * }
18958
- *
18959
- * const products = [{
18960
- * "ProductID": 1,
18961
- * "ProductName": "Chai",
18962
- * "UnitPrice": 18.0000,
18963
- * "Discontinued": true
18964
- * }, {
18965
- * "ProductID": 2,
18966
- * "ProductName": "Chang",
18967
- * "UnitPrice": 19.0000,
18968
- * "Discontinued": false
18969
- * }
18970
- * ];
18456
+ * ```html
18457
+ * <kendo-grid [data]="gridData"></kendo-grid>
18971
18458
  * ```
18972
18459
  */
18973
18460
  class GridComponent {
@@ -19003,64 +18490,25 @@ class GridComponent {
19003
18490
  /**
19004
18491
  * Defines the scroll mode used by the Grid.
19005
18492
  *
19006
- * The available options are:
19007
- * - `none`&mdash;Renders no scrollbar.
19008
- * - `scrollable`&mdash;The default scroll mode. It requires the setting of the `height` option.
19009
- * - `virtual`&mdash;Displays no pager and renders a portion of the data (optimized rendering) while the user is scrolling the content.
18493
+ * @default 'scrollable'
19010
18494
  */
19011
18495
  this.scrollable = 'scrollable';
19012
18496
  /**
19013
- * Enables the single-row [selection]({% slug selection_grid %}) of the Grid.
18497
+ * Enables the [single-row selection](slug:grid_row_selection) of the Grid.
18498
+ *
18499
+ * @default false
19014
18500
  */
19015
18501
  this.selectable = false;
19016
18502
  /**
19017
18503
  * A function that defines how to track changes for the data rows.
19018
- *
19019
18504
  * By default, the Grid tracks changes by the index of the data item.
19020
18505
  * Edited rows are tracked by reference.
19021
- * In some cases, you might need to override the default behavior,
19022
- * for example, when you implement editing with immutable data items.
19023
- *
19024
- * The following example demonstrates how to track items only by index.
19025
- *
19026
- * @example
19027
- * ```ts
19028
- * import { Component } from '@angular/core';
19029
- * import { GridItem } from '@progress/kendo-angular-grid';
19030
- *
19031
- * _@Component({
19032
- * selector: 'my-app',
19033
- * template: `
19034
- * <kendo-grid [data]="gridData" [trackBy]="trackBy">
19035
- * </kendo-grid>
19036
- * `
19037
- * })
19038
- * class AppComponent {
19039
- * public gridData: any[] = products;
19040
- *
19041
- * public trackBy(index: number, item: GridItem): any {
19042
- * console.log(item);
19043
- * return index;
19044
- * }
19045
- * }
19046
- *
19047
- * const products = [{
19048
- * "ProductID": 1,
19049
- * "ProductName": "Chai",
19050
- * "UnitPrice": 18.0000,
19051
- * "Discontinued": true
19052
- * }, {
19053
- * "ProductID": 2,
19054
- * "ProductName": "Chang",
19055
- * "UnitPrice": 19.0000,
19056
- * "Discontinued": false
19057
- * }
19058
- * ];
19059
- * ```
18506
+ * [See exmpale](slug:track_changes_grid)
19060
18507
  */
19061
18508
  this.trackBy = defaultTrackBy;
19062
18509
  /**
19063
18510
  * If set to `true`, the grid will render only the columns in the current viewport.
18511
+ * @default false
19064
18512
  */
19065
18513
  this.virtualColumns = false;
19066
18514
  /**
@@ -19069,35 +18517,31 @@ class GridComponent {
19069
18517
  this.gridData = () => { return this.flatData; };
19070
18518
  /**
19071
18519
  * Enables the [filtering]({% slug filtering_grid %}) of the Grid columns that have their `field` option set.
18520
+ * @default false
19072
18521
  */
19073
18522
  this.filterable = false;
19074
18523
  /**
19075
18524
  * Enables the [sorting]({% slug sorting_grid %}) of the Grid columns that have their `field` option set.
18525
+ * @default false
19076
18526
  */
19077
18527
  this.sortable = false;
19078
18528
  /**
19079
- * Configures the pager of the Grid ([see example]({% slug paging_grid %})).
19080
- *
19081
- * The available options are:
19082
- * - `buttonCount: Number`&mdash;Sets the maximum numeric buttons count before the buttons are collapsed. Defaults to `10`.
19083
- * - `info: Boolean`&mdash;Toggles the information about the current page and the total number of records. Defaults to `true`.
19084
- * - `type: PagerType`&mdash;Accepts the `numeric` (buttons with numbers) and `input` (input for typing the page number) values. Defaults to `'numeric'`.
19085
- * - `pageSizes: Boolean` or `Array<number>`&mdash;Shows a menu for selecting the page size. Defaults to `false`.
19086
- * - `previousNext: Boolean`&mdash;Toggles the **Previous** and **Next** buttons. Defaults to `true`.
19087
- * - `responsive: Boolean`&mdash;Toggles the built-in responsive behavior of the Pager. Defaults to `true`.
18529
+ * Configures the pager of the Grid ([see example](slug:paging_grid_settings)).
18530
+ * @default false
19088
18531
  */
19089
18532
  this.pageable = false;
19090
18533
  /**
19091
- * If set to `true`, the user can group the Grid by dragging the column header cells.
19092
- * By default, grouping is disabled ([see example]({% slug grouping_grid %})).
18534
+ * If set to `true`, the user can group the Grid by dragging the column header cells ([see example]({% slug grouping_grid %})).
18535
+ * @default false
19093
18536
  */
19094
18537
  this.groupable = false;
19095
18538
  /**
19096
18539
  * Indicates whether the Grid columns will be resized during initialization so that
19097
- * they fit their headers and row content. Defaults to `false`.
18540
+ * they fit their headers and row content.
19098
18541
  * Columns with `autoSize` set to `false` are excluded.
19099
18542
  * To dynamically update the column width to match the new content,
19100
18543
  * refer to [this example]({% slug resizing_columns_grid %}).
18544
+ * @default false
19101
18545
  */
19102
18546
  this.autoSize = false;
19103
18547
  /**
@@ -19122,8 +18566,8 @@ class GridComponent {
19122
18566
  this.columnMenu = false;
19123
18567
  /**
19124
18568
  * Specifies if the header of the grid will be hidden. The header is visible by default.
19125
- *
19126
- * > The header includes column headers and the [filter row]({% slug filtering_grid %}#toc-filter-row).
18569
+ * The header includes column headers and the [filter row](slug:filter_row).
18570
+ * @default false
19127
18571
  */
19128
18572
  this.hideHeader = false;
19129
18573
  /**
@@ -19435,7 +18879,7 @@ class GridComponent {
19435
18879
  return this.selectionService.enableMarquee || this.cellSelectionService.enableMarquee;
19436
18880
  }
19437
18881
  /**
19438
- * Enables the [row reordering]({% slug ToDo %}) of the Grid.
18882
+ * Enables the [row reordering]({% slug reordering_rows_grid %}) of the Grid.
19439
18883
  * @default false
19440
18884
  */
19441
18885
  set rowReorderable(value) {
@@ -19484,49 +18928,8 @@ class GridComponent {
19484
18928
  return this.navigable;
19485
18929
  }
19486
18930
  /**
19487
- * Defines a function that is executed for every data row in the component.
19488
- *
19489
- * @example
19490
- * ```ts
19491
- * import { Component, ViewEncapsulation } from '@angular/core';
19492
- * import { RowClassArgs } from '@progress/kendo-angular-grid';
19493
- *
19494
- * _@Component({
19495
- * selector: 'my-app',
19496
- * encapsulation: ViewEncapsulation.None,
19497
- * styles: [`
19498
- * .k-grid tr.even { background-color: #f45c42; }
19499
- * .k-grid tr.odd { background-color: #41f4df; }
19500
- * `],
19501
- * template: `
19502
- * <kendo-grid [data]="gridData" [rowClass]="rowCallback">
19503
- * </kendo-grid>
19504
- * `
19505
- * })
19506
- * class AppComponent {
19507
- * public gridData: any[] = products;
19508
- *
19509
- * public rowCallback(context: RowClassArgs) {
19510
- * const isEven = context.index % 2 === 0;
19511
- * return {
19512
- * even: isEven,
19513
- * odd: !isEven
19514
- * };
19515
- * }
19516
- * }
19517
- *
19518
- * const products = [{
19519
- * "ProductID": 1,
19520
- * "ProductName": "Chai",
19521
- * "UnitPrice": 18.0000,
19522
- * "Discontinued": true
19523
- * }, {
19524
- * "ProductID": 2,
19525
- * "ProductName": "Chang",
19526
- * "UnitPrice": 19.0000,
19527
- * "Discontinued": false
19528
- * }
19529
- * ];
18931
+ * Defines a function that is executed for every data row in the component
18932
+ * ([see example](slug:styling_grid_rows)).
19530
18933
  * ```
19531
18934
  */
19532
18935
  set rowClass(fn) {
@@ -19828,9 +19231,9 @@ class GridComponent {
19828
19231
  * This method is provided only for backwards-compatibility with legacy versions.
19829
19232
  * These versions tracked the expanded group state internally using the hierarchical group index.
19830
19233
  *
19831
- * > * When you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive,
19832
- * > the `expandGroup` method is not supported.
19833
- * > * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
19234
+ * The `expandGroup` method is not supported when you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive.
19235
+ *
19236
+ * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
19834
19237
  *
19835
19238
  * @param {string} index - The underscore separated hierarchical index of the group.
19836
19239
  */
@@ -19844,9 +19247,9 @@ class GridComponent {
19844
19247
  * This method is provided only for backwards-compatibility with legacy versions.
19845
19248
  * These versions tracked the expanded group state internally using the hierarchical group index.
19846
19249
  *
19847
- * > * When you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive,
19848
- * > the `collapseGroup` method is not supported.
19849
- * > * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
19250
+ * The `collapseGroup` method is not supported when you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive.
19251
+ *
19252
+ * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
19850
19253
  *
19851
19254
  * @param {string} index - The underscore separated hierarchical index of the group.
19852
19255
  */
@@ -20104,7 +19507,7 @@ class GridComponent {
20104
19507
  this.focusEditElement('.k-grid-add-row');
20105
19508
  }
20106
19509
  /**
20107
- * Puts the cell that is specified by the table row and column in edit mode.
19510
+ * Puts the cell that is specified by the table row and column in edit mode ([see example](slug:editing_incell_grid)).
20108
19511
  *
20109
19512
  * @param {number} rowIndex - The data row index that will be switched in the edit mode.
20110
19513
  * @param {number|string|any} column - The leaf column index, or the field name or the column instance that should be edited.
@@ -20159,7 +19562,7 @@ class GridComponent {
20159
19562
  * Exports the Grid element to a Drawing [Group]({% slug api_kendo-drawing_group %}) by using the `kendo-grid-pdf` component options.
20160
19563
  * ([see example]({% slug pdfexport_grid %}#toc-exporting-multiple-grids-to-the-same-pdf)).
20161
19564
  *
20162
- * @return {Promise} - A promise that will be resolved with the Drawing `Group`.
19565
+ * @return {Promise} A promise that will be resolved with the Drawing `Group`.
20163
19566
  */
20164
19567
  drawPDF() {
20165
19568
  const promise = createPromise();
@@ -20175,138 +19578,19 @@ class GridComponent {
20175
19578
  /**
20176
19579
  * Applies the minimum possible width for the specified column,
20177
19580
  * so that the whole text fits without wrapping. This method expects the Grid
20178
- * to be resizable (set `resizable` to `true`).
20179
- * Makes sense to execute this method only
19581
+ * to be [resizable](slug:resizing_columns_grid). The method must be executed
20180
19582
  * after the Grid is already populated with data.
20181
- *
20182
- * @example
20183
- * ```ts
20184
- * _@Component({
20185
- * selector: 'my-app',
20186
- * template: `
20187
- * <kendo-grid
20188
- * #grid
20189
- * [data]="gridData"
20190
- * [resizable]="true"
20191
- * style="height: 300px">
20192
- * <ng-template kendoGridToolbarTemplate>
20193
- * <button kendoButton (click)="grid.autoFitColumn(groupColumn)">
20194
- * Auto-fit the group column
20195
- * </button>
20196
- * </ng-template>
20197
- * <kendo-grid-column-group #groupColumn title="Product Info">
20198
- * <kendo-grid-column
20199
- * field="ProductID"
20200
- * [width]="50"
20201
- * [minResizableWidth]="30"
20202
- * title="ID">
20203
- * </kendo-grid-column>
20204
- *
20205
- * <kendo-grid-column
20206
- * field="ProductName"
20207
- * title="Product Name">
20208
- * </kendo-grid-column>
20209
- * </kendo-grid-column-group>
20210
- *
20211
- * <kendo-grid-column
20212
- * field="UnitPrice"
20213
- * title="Unit Price"
20214
- * [width]="180"
20215
- * filter="numeric"
20216
- * format="{0:c}">
20217
- * </kendo-grid-column>
20218
- * </kendo-grid>
20219
- * `
20220
- * })
20221
- * class AppComponent {
20222
- * public gridData: any[] = products;
20223
- * }
20224
- *
20225
- * const products = [{
20226
- * "ProductID": 1,
20227
- * "ProductName": "Chai",
20228
- * "UnitPrice": 18.0000,
20229
- * "Discontinued": true
20230
- * }, {
20231
- * "ProductID": 2,
20232
- * "ProductName": "Chang",
20233
- * "UnitPrice": 19.0000,
20234
- * "Discontinued": false
20235
- * }
20236
- * ];
20237
- * ```
19583
+ * [See example](slug:resizing_columns_grid#toc-auto-fitting-the-content)
20238
19584
  */
20239
19585
  autoFitColumn(column) {
20240
19586
  this.columnResizingService.autoFit(column);
20241
19587
  }
20242
19588
  /**
20243
19589
  * Adjusts the width of the specified columns to fit the entire content, including headers, without wrapping.
20244
- * If no columns are specified, `autoFitColumns` is applied to all columns.
20245
- *
20246
- * This method requires the Grid to be resizable (set `resizable` to `true`).
20247
- *
20248
- * @example
20249
- * ```ts
20250
- * _@Component({
20251
- * selector: 'my-app',
20252
- * template: `
20253
- * <kendo-grid
20254
- * #grid
20255
- * [data]="gridData"
20256
- * [resizable]="true"
20257
- * style="height: 300px">
20258
- * <ng-template kendoGridToolbarTemplate>
20259
- * <button kendoButton (click)="grid.autoFitColumns([firstColumn, lastColumn])">
20260
- * Auto-fit the first and last column
20261
- * </button>
20262
- * <button kendoButton (click)="grid.autoFitColumns()">
20263
- * Auto-fit all columns
20264
- * </button>
20265
- * </ng-template>
20266
- * <kendo-grid-column-group title="Product Info">
20267
- * <kendo-grid-column
20268
- * #firstColumn
20269
- * field="ProductID"
20270
- * [width]="50"
20271
- * [minResizableWidth]="30"
20272
- * title="ID">
20273
- * </kendo-grid-column>
20274
- *
20275
- * <kendo-grid-column
20276
- * field="ProductName"
20277
- * title="Product Name"
20278
- * >
20279
- * </kendo-grid-column>
20280
- * </kendo-grid-column-group>
20281
- *
20282
- * <kendo-grid-column
20283
- * #lastColumn
20284
- * field="UnitPrice"
20285
- * title="Unit Price"
20286
- * [width]="180"
20287
- * filter="numeric"
20288
- * format="{0:c}">
20289
- * </kendo-grid-column>
20290
- * </kendo-grid>
20291
- * `
20292
- * })
20293
- * class AppComponent {
20294
- * public gridData: any[] = products;
20295
- * }
19590
+ * If no columns are specified, `autoFitColumns` is applied to all columns.The method must be executed
19591
+ * after the Grid is already populated with data.
19592
+ * [See example](slug:resizing_columns_grid#toc-auto-fitting-the-content)
20296
19593
  *
20297
- * const products = [{
20298
- * "ProductID": 1,
20299
- * "ProductName": "Chai",
20300
- * "UnitPrice": 18.0000,
20301
- * "Discontinued": true
20302
- * }, {
20303
- * "ProductID": 2,
20304
- * "ProductName": "Chang",
20305
- * "UnitPrice": 19.0000,
20306
- * "Discontinued": false
20307
- * }
20308
- * ];
20309
- * ```
20310
19594
  */
20311
19595
  autoFitColumns(columns = this.columns) {
20312
19596
  let cols;
@@ -20367,10 +19651,10 @@ class GridComponent {
20367
19651
  /**
20368
19652
  * Focuses the cell with the specified row and column index.
20369
19653
  *
20370
- * The row index is based on the logical structure of the Grid and does not correspond to the data item index:
20371
- * * Header rows are included, starting at index 0.
20372
- * * Group headers and footers are included.
20373
- * * The row indexing is absolute and does not change with paging.
19654
+ * The row index is based on the logical structure of the Grid and does not correspond to the data item index.
19655
+ * Header rows are included, starting at index 0.
19656
+ * Group headers and footers are included.
19657
+ * The row indexing is absolute and does not change with paging.
20374
19658
  *
20375
19659
  * If the Grid is configured for scrolling, including virtual scrolling, the scroll position will be updated.
20376
19660
  * If the row is not present on the current page, the method will have no effect.
@@ -20421,67 +19705,6 @@ class GridComponent {
20421
19705
  * @param {number} destIndex - The new position of the column.
20422
19706
  * @param {ColumnReorderConfig} options - Additional options.
20423
19707
  *
20424
- * @example
20425
- * ```ts
20426
- * _@Component({
20427
- * selector: 'my-app',
20428
- * template: `
20429
- * <kendo-grid
20430
- * #grid
20431
- * [data]="gridData"
20432
- * [reorderable]="true"
20433
- * style="height: 300px">
20434
- * <ng-template kendoGridToolbarTemplate>
20435
- * <button kendoButton
20436
- * (click)="grid.reorderColumn(groupColumn, 2, { before: true })">
20437
- * Move the group column before the last one.
20438
- * </button>
20439
- * </ng-template>
20440
- * <kendo-grid-column-group #groupColumn title="Product Info">
20441
- * <kendo-grid-column
20442
- * field="ProductID"
20443
- * [width]="50"
20444
- * title="ID">
20445
- * </kendo-grid-column>
20446
- *
20447
- * <kendo-grid-column
20448
- * field="ProductName"
20449
- * title="Product Name">
20450
- * </kendo-grid-column>
20451
- * </kendo-grid-column-group>
20452
- *
20453
- * <kendo-grid-column
20454
- * field="UnitPrice"
20455
- * title="Unit Price"
20456
- * [width]="180"
20457
- * format="{0:c}">
20458
- * </kendo-grid-column>
20459
- *
20460
- * <kendo-grid-column
20461
- * field="Discontinued"
20462
- * title="Discontinued"
20463
- * [width]="100">
20464
- * </kendo-grid-column>
20465
- * </kendo-grid>
20466
- * `
20467
- * })
20468
- * class AppComponent {
20469
- * public gridData: any[] = products;
20470
- * }
20471
- *
20472
- * const products = [{
20473
- * "ProductID": 1,
20474
- * "ProductName": "Chai",
20475
- * "UnitPrice": 18.0000,
20476
- * "Discontinued": true
20477
- * }, {
20478
- * "ProductID": 2,
20479
- * "ProductName": "Chang",
20480
- * "UnitPrice": 19.0000,
20481
- * "Discontinued": false
20482
- * }
20483
- * ];
20484
- * ```
20485
19708
  */
20486
19709
  reorderColumn(source, destIndex, options = { before: false }) {
20487
19710
  const columnsForLevel = sortColumns(this.allColumnsForLevel(source.level));
@@ -22871,7 +22094,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
22871
22094
 
22872
22095
  /**
22873
22096
  * Custom component messages override default component messages
22874
- * ([see example]({% slug globalization_grid %}#toc-localization)).
22097
+ * ([see example](slug:globalization_grid#toc-custom-messages)).
22875
22098
  */
22876
22099
  class CustomMessagesComponent extends GridMessages {
22877
22100
  constructor(service) {
@@ -23069,11 +22292,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23069
22292
  }] });
23070
22293
 
23071
22294
  /**
23072
- * Represents the `Contains` (**Contains**) filter operator.
23073
- *
23074
- * For more information and examples, refer to:
23075
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23076
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22295
+ * Represents the `Contains` (**Contains**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
22296
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23077
22297
  */
23078
22298
  class ContainsFilterOperatorComponent extends FilterOperatorBase {
23079
22299
  constructor(localization) { super("contains", localization); }
@@ -23100,11 +22320,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23100
22320
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23101
22321
 
23102
22322
  /**
23103
- * Represents the `DoesNotContain` (**Does not contain**) filter operator.
22323
+ * Represents the `DoesNotContain` (**Does not contain**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23104
22324
  *
23105
- * For more information and examples, refer to:
23106
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23107
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22325
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23108
22326
  */
23109
22327
  class DoesNotContainFilterOperatorComponent extends FilterOperatorBase {
23110
22328
  constructor(localization) { super("doesnotcontain", localization); }
@@ -23131,11 +22349,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23131
22349
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23132
22350
 
23133
22351
  /**
23134
- * Represents the `EndsWith` (**Ends with**) string filter operator.
22352
+ * Represents the `EndsWith` (**Ends with**) string filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23135
22353
  *
23136
- * For more information and examples, refer to:
23137
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23138
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22354
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23139
22355
  */
23140
22356
  class EndsWithFilterOperatorComponent extends FilterOperatorBase {
23141
22357
  constructor(localization) { super("endswith", localization); }
@@ -23162,11 +22378,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23162
22378
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23163
22379
 
23164
22380
  /**
23165
- * Represents the `Equal` (**Is equal to**) filter operator.
22381
+ * Represents the `Equal` (**Is equal to**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23166
22382
  *
23167
- * For more information and examples, refer to:
23168
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23169
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22383
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23170
22384
  */
23171
22385
  class EqualFilterOperatorComponent extends FilterOperatorBase {
23172
22386
  constructor(localization) { super("eq", localization); }
@@ -23193,11 +22407,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23193
22407
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23194
22408
 
23195
22409
  /**
23196
- * Represents the `IsEmpty` (**Is empty**) filter operator.
22410
+ * Represents the `IsEmpty` (**Is empty**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23197
22411
  *
23198
- * For more information and examples, refer to:
23199
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23200
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22412
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23201
22413
  */
23202
22414
  class IsEmptyFilterOperatorComponent extends FilterOperatorBase {
23203
22415
  constructor(localization) { super("isempty", localization); }
@@ -23224,11 +22436,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23224
22436
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23225
22437
 
23226
22438
  /**
23227
- * Represents the `IsNotEmpty` (**Is not empty**) filter operator.
22439
+ * Represents the `IsNotEmpty` (**Is not empty**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23228
22440
  *
23229
- * For more information and examples, refer to:
23230
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23231
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22441
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23232
22442
  */
23233
22443
  class IsNotEmptyFilterOperatorComponent extends FilterOperatorBase {
23234
22444
  constructor(localization) { super("isnotempty", localization); }
@@ -23255,11 +22465,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23255
22465
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23256
22466
 
23257
22467
  /**
23258
- * Represents the `IsNotNull` (**Is not null**) filter operator.
22468
+ * Represents the `IsNotNull` (**Is not null**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23259
22469
  *
23260
- * For more information and examples, refer to:
23261
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23262
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22470
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23263
22471
  */
23264
22472
  class IsNotNullFilterOperatorComponent extends FilterOperatorBase {
23265
22473
  constructor(localization) { super("isnotnull", localization); }
@@ -23286,11 +22494,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23286
22494
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23287
22495
 
23288
22496
  /**
23289
- * Represents the `IsNull` (**Is null**) filter operator.
22497
+ * Represents the `IsNull` (**Is null**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23290
22498
  *
23291
- * For more information and examples, refer to:
23292
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23293
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22499
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23294
22500
  */
23295
22501
  class IsNullFilterOperatorComponent extends FilterOperatorBase {
23296
22502
  constructor(localization) { super("isnull", localization); }
@@ -23317,11 +22523,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23317
22523
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23318
22524
 
23319
22525
  /**
23320
- * Represents the `NotEqual` (**Is not equal to**) filter operator.
22526
+ * Represents the `NotEqual` (**Is not equal to**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23321
22527
  *
23322
- * For more information and examples, refer to:
23323
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23324
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22528
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23325
22529
  */
23326
22530
  class NotEqualFilterOperatorComponent extends FilterOperatorBase {
23327
22531
  constructor(localization) { super("neq", localization); }
@@ -23348,11 +22552,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23348
22552
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23349
22553
 
23350
22554
  /**
23351
- * Represents the `StartsWith` (**Starts with**) filter operator.
22555
+ * Represents the `StartsWith` (**Starts with**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23352
22556
  *
23353
- * For more information and examples, refer to:
23354
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23355
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22557
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23356
22558
  */
23357
22559
  class StartsWithFilterOperatorComponent extends FilterOperatorBase {
23358
22560
  constructor(localization) { super("startswith", localization); }
@@ -23378,12 +22580,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23378
22580
  }]
23379
22581
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23380
22582
 
23381
- /*
23382
- * Represents the `Greater` (**Is greater than**) numeric filter operator.
23383
- *
23384
- * For more information and examples, refer to:
23385
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23386
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22583
+ /**
22584
+ * Represents the `Greater` (**Is greater than**) [numeric filter](slug:filtering_grid#toc-numeric-filter) operator.
22585
+ * [See example](slug:filter_row#toc-default-filter-operator).
23387
22586
  */
23388
22587
  class GreaterFilterOperatorComponent extends FilterOperatorBase {
23389
22588
  constructor(localization) { super("gt", localization); }
@@ -23410,11 +22609,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23410
22609
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23411
22610
 
23412
22611
  /**
23413
- * Represents the `GreaterOrEqualTo` (**Is greater than or equal to**) numeric filter operator.
23414
- *
23415
- * For more information and examples, refer to:
23416
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23417
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22612
+ * Represents the `GreaterOrEqualTo` (**Is greater than or equal to**) [numeric filter](slug:filtering_grid#toc-numeric-filter) operator.
22613
+ * [See example](slug:filter_row#toc-default-filter-operator).
23418
22614
  */
23419
22615
  class GreaterOrEqualToFilterOperatorComponent extends FilterOperatorBase {
23420
22616
  constructor(localization) { super("gte", localization); }
@@ -23440,12 +22636,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23440
22636
  }]
23441
22637
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23442
22638
 
23443
- /*
23444
- * Represents the `Less` (**Is less than**) numeric filter operator.
22639
+ /**
22640
+ * Represents the `Less` (**Is less than**) [numeric filter](slug:filtering_grid#toc-numeric-filter) operator.
23445
22641
  *
23446
- * For more information and examples, refer to:
23447
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23448
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22642
+ * [See example](slug:filter_row#toc-default-filter-operator).
23449
22643
  */
23450
22644
  class LessFilterOperatorComponent extends FilterOperatorBase {
23451
22645
  constructor(localization) { super("lt", localization); }
@@ -23471,12 +22665,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23471
22665
  }]
23472
22666
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23473
22667
 
23474
- /*
23475
- * Represents the `LessOrEqualTo` (**Is less than or equal to**) numeric filter operator.
22668
+ /**
22669
+ * Represents the `LessOrEqualTo` (**Is less than or equal to**) [numeric filter](slug:filtering_grid#toc-numeric-filter) operator.
23476
22670
  *
23477
- * For more information and examples, refer to:
23478
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23479
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22671
+ * [See example](slug:filter_row#toc-default-filter-operator).
23480
22672
  */
23481
22673
  class LessOrEqualToFilterOperatorComponent extends FilterOperatorBase {
23482
22674
  constructor(localization) { super("lte", localization); }
@@ -23502,12 +22694,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23502
22694
  }]
23503
22695
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23504
22696
 
23505
- /*
23506
- * Represents the `Greater` (**Is after**) date filter operator.
23507
- *
23508
- * For more information and examples, refer to:
23509
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23510
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22697
+ /**
22698
+ * Represents the `Greater` (**Is after**) [date filter](slug:filtering_grid#toc-date-filter) operator.
22699
+ * [See example](slug:filter_row#toc-default-filter-operator).
23511
22700
  */
23512
22701
  class AfterFilterOperatorComponent extends FilterOperatorBase {
23513
22702
  constructor(localization) { super("after", localization); }
@@ -23542,12 +22731,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23542
22731
  }]
23543
22732
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23544
22733
 
23545
- /*
23546
- * Represents the `GreaterOrEqualTo` (**Is after or equal to**) date filter operator.
23547
- *
23548
- * For more information and examples, refer to:
23549
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23550
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22734
+ /**
22735
+ * Represents the `GreaterOrEqualTo` (**Is after or equal to**) [date filter](slug:filtering_grid#toc-date-filter) operator.
22736
+ * [See example](slug:filter_row#toc-default-filter-operator).
23551
22737
  */
23552
22738
  class AfterEqFilterOperatorComponent extends FilterOperatorBase {
23553
22739
  constructor(localization) { super("after-eq", localization); }
@@ -23582,12 +22768,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23582
22768
  }]
23583
22769
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23584
22770
 
23585
- /*
23586
- * Represents the `LessOrEqualTo` (**Is before or equal to**) date filter operator.
23587
- *
23588
- * For more information and examples, refer to:
23589
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23590
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22771
+ /**
22772
+ * Represents the `LessOrEqualTo` (**Is before or equal to**) [date filter](slug:filtering_grid#toc-date-filter) operator.
22773
+ * [See example](slug:filter_row#toc-default-filter-operator).
23591
22774
  */
23592
22775
  class BeforeEqFilterOperatorComponent extends FilterOperatorBase {
23593
22776
  constructor(localization) { super("before-eq", localization); }
@@ -23622,12 +22805,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23622
22805
  }]
23623
22806
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23624
22807
 
23625
- /*
23626
- * Represents the `Less then` (**Is before**) date filter operator.
23627
- *
23628
- * For more information and examples, refer to:
23629
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23630
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22808
+ /**
22809
+ * Represents the `Less than` (**Is before**) [date filter](slug:filtering_grid#toc-date-filter) operator.
22810
+ * [See example](slug:filter_row#toc-default-filter-operator).
23631
22811
  */
23632
22812
  class BeforeFilterOperatorComponent extends FilterOperatorBase {
23633
22813
  constructor(localization) { super("before", localization); }
@@ -24067,27 +23247,18 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
24067
23247
  }] });
24068
23248
 
24069
23249
  /**
24070
- * Represents the component for selecting columns in the Grid. To enable the user to show or hide columns,
24071
- * add the component inside a [ToolbarTemplate]({% slug api_grid_toolbartemplatedirective %}) directive.
23250
+ * Represents the component for toggling the visibility of the Grid columns. [See example](slug:columnmenu_grid#toc-using-standalone-column-chooser).
23251
+ * To show and hide the columns without including the column chooser item in the [Column Menu](slug:columnmenu_grid),
23252
+ * add the component inside the [ToolbarTemplate](slug:toolbartemplate_grid) directive.
24072
23253
  *
24073
23254
  * @example
24074
- * ```ts-preview
24075
- * _@Component({
24076
- * selector: 'my-app',
24077
- * template: `
24078
- * <kendo-grid [data]="data">
24079
- * <ng-template kendoGridToolbarTemplate>
24080
- * <kendo-grid-column-chooser></kendo-grid-column-chooser>
24081
- * </ng-template>
24082
- * <kendo-grid-column field="Field1"></kendo-grid-column>
24083
- * <kendo-grid-column field="Field2" [hidden]="true"></kendo-grid-column>
24084
- * </kendo-grid>
24085
- * `
24086
- * })
24087
- *
24088
- * class AppComponent {
24089
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
24090
- * }
23255
+ * ```html
23256
+ * <kendo-grid [data]="data">
23257
+ * <ng-template kendoGridToolbarTemplate>
23258
+ * <kendo-grid-column-chooser></kendo-grid-column-chooser>
23259
+ * </ng-template>
23260
+ * <kendo-grid-column field="ProductID"></kendo-grid-column>
23261
+ * </kendo-grid>
24091
23262
  * ```
24092
23263
  */
24093
23264
  class ColumnChooserComponent {
@@ -24104,10 +23275,14 @@ class ColumnChooserComponent {
24104
23275
  this.columnsIcon = columnsIcon;
24105
23276
  /**
24106
23277
  * Specifies if the changes in the visibility of the column will be immediately applied.
23278
+ *
23279
+ * @default false
24107
23280
  */
24108
23281
  this.autoSync = false;
24109
23282
  /**
24110
23283
  * Specifies if all columns can be hidden.
23284
+ *
23285
+ * @default true
24111
23286
  */
24112
23287
  this.allowHideAll = true;
24113
23288
  }
@@ -24366,65 +23541,14 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
24366
23541
  }] });
24367
23542
 
24368
23543
  /**
24369
- * Represents the checkbox for selecting columns in the Grid. If the column is
24370
- * defined as empty, it renders a default checkbox for row selection.
24371
- * You can also define the content of the column inside an `<ng-template>` tag.
24372
- * The input requires you to include the `SelectionCheckbox` option.
24373
- *
24374
- * The template context is set to the current data item and the following additional fields are passed:
24375
- * - `columnIndex`&mdash;The current column index.
24376
- * - `rowIndex`&mdash;The current data row index. If inside a new item row, it will be `-1`.
24377
- * - `dataItem`&mdash;The current data item.
24378
- * - `column`&mdash;The current column instance.
24379
- * - `isNew`&mdash;The state of the current item.
24380
- *
24381
- * For more examples, refer to:
24382
- * - [Selecting or deselecting all items on a page]({% slug selection_grid %}#toc-select-all-feature)
24383
- * - [Persisting the selection]({% slug selection_grid %}#toc-in-combination-with-the-select-all-feature)
23544
+ * Represents the checkbox column for selecting rows in the Grid. [See example](slug:grid_row_selection#toc-select-all-checkbox).
24384
23545
  *
24385
23546
  * @example
24386
- * ```ts-preview
24387
- *
24388
- * _@Component({
24389
- * selector: 'my-app',
24390
- * template: `
24391
- * <kendo-grid [data]="gridData" [selectable]="{enabled: true, checkboxOnly: true}">
24392
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
24393
- * </kendo-grid-column>
24394
- * <kendo-grid-column field="ProductName" title="Product Name">
24395
- * </kendo-grid-column>
24396
- * <kendo-grid-checkbox-column title="Default checkbox">
24397
- * </kendo-grid-checkbox-column>
24398
- * <kendo-grid-checkbox-column title="Custom checkbox">
24399
- * <ng-template kendoGridCellTemplate let-idx="rowIndex">
24400
- * Select row <input [kendoGridSelectionCheckbox]="idx" />
24401
- * </ng-template>
24402
- * </kendo-grid-checkbox-column>
24403
- * </kendo-grid>
24404
- * `
24405
- * })
24406
- *
24407
- * class AppComponent {
24408
- * public gridData: any[];
24409
- *
24410
- * constructor() {
24411
- * this.gridData = products;
24412
- * }
24413
- * }
24414
- *
24415
- * const products = [{
24416
- * "ProductID": 1,
24417
- * "ProductName": "Chai",
24418
- * "UnitPrice": 18.0000,
24419
- * "Discontinued": true
24420
- * }, {
24421
- * "ProductID": 2,
24422
- * "ProductName": "Chang",
24423
- * "UnitPrice": 19.0000,
24424
- * "Discontinued": false
24425
- * }
24426
- * ];
24427
- *
23547
+ * ```hmtl
23548
+ * <kendo-grid [selectable]="{enabled: true, checkboxOnly: true}">
23549
+ * <kendo-grid-checkbox-column title="Default checkbox"></kendo-grid-checkbox-column>
23550
+ * <kendo-grid-column field="ProductID"></kendo-grid-column>
23551
+ * </kendo-grid>
24428
23552
  * ```
24429
23553
  */
24430
23554
  class CheckboxColumnComponent extends ColumnBase {
@@ -24931,7 +24055,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
24931
24055
  }] } });
24932
24056
 
24933
24057
  /**
24934
- * Represents the drag handle for reordering rows in the Grid.
24058
+ * Represents the drag handle for reordering rows in the Grid ([see example](slug:reordering_rows_grid))
24935
24059
  */
24936
24060
  class RowReorderColumnComponent extends ColumnBase {
24937
24061
  constructor(parent, idService) {
@@ -25845,29 +24969,19 @@ const declarations$2 = [
25845
24969
  *
25846
24970
  * @example
25847
24971
  *
25848
- * ```ts-no-run
25849
- * // Import the Grid module
25850
- * import { GridModule } from '@progress/kendo-angular-grid';
25851
- *
25852
- * // The browser platform with a compiler
25853
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
25854
- *
24972
+ * ```ts
25855
24973
  * import { NgModule } from '@angular/core';
25856
- *
25857
- * // Import the app component
24974
+ * import { GridModule } from '@progress/kendo-angular-grid';
24975
+ * import { BrowserModule } from "@angular/platform-browser";
25858
24976
  * import { AppComponent } from './app.component';
25859
24977
  *
25860
- * // Define the app module
25861
- * _@NgModule({
25862
- * declarations: [AppComponent], // declare app component
25863
- * imports: [BrowserModule, GridModule], // import Grid module
24978
+ * @NgModule({
24979
+ * declarations: [AppComponent],
24980
+ * imports: [BrowserModule, GridModule],
25864
24981
  * bootstrap: [AppComponent]
25865
24982
  * })
25866
24983
  * export class AppModule {}
25867
24984
  *
25868
- * // Compile and launch the module
25869
- * platformBrowserDynamic().bootstrapModule(AppModule);
25870
- *
25871
24985
  * ```
25872
24986
  */
25873
24987
  class GridModule {
@@ -25950,6 +25064,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
25950
25064
  }]
25951
25065
  }] });
25952
25066
 
25067
+ /**
25068
+ * Represents the Kendo UI PDFMargin component for Angular.
25069
+ * The supported units are:
25070
+ * `"mm"`
25071
+ * `"cm"`
25072
+ * `"in"`
25073
+ * `"pt"` (default).
25074
+ * Numbers are considered to be points (`"pt"`).
25075
+ */
25953
25076
  class PDFMarginComponent extends PDFExportMarginComponent {
25954
25077
  }
25955
25078
  PDFMarginComponent.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "13.3.12", ngImport: i0, type: PDFMarginComponent, deps: null, target: i0.ɵɵFactoryTarget.Component });
@@ -26485,28 +25608,19 @@ const declarations$1 = [
26485
25608
  *
26486
25609
  * @example
26487
25610
  *
26488
- * ```ts-no-run
26489
- * // Import the Grid and PDF modules
26490
- * import { GridModule, PDFModule } from '@progress/kendo-angular-grid';
26491
- *
26492
- * // The browser platform with a compiler
26493
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
26494
- *
25611
+ * ```ts
26495
25612
  * import { NgModule } from '@angular/core';
26496
- *
26497
- * // Import the app component
25613
+ * import { BrowserModule } from "@angular/platform-browser";
25614
+ * import { GridModule, PDFModule } from '@progress/kendo-angular-grid';
26498
25615
  * import { AppComponent } from './app.component';
26499
25616
  *
26500
- * // Define the app module
26501
- * _@NgModule({
26502
- * declarations: [AppComponent], // declare app component
26503
- * imports: [BrowserModule, GridModule, PDFModule], // import Grid and PDF modules
25617
+ * @NgModule({
25618
+ * declarations: [AppComponent],
25619
+ * imports: [BrowserModule, GridModule, PDFModule],
26504
25620
  * bootstrap: [AppComponent]
26505
25621
  * })
26506
- * export class AppModule {}
26507
25622
  *
26508
- * // Compile and launch the module
26509
- * platformBrowserDynamic().bootstrapModule(AppModule);
25623
+ * export class AppModule {}
26510
25624
  *
26511
25625
  * ```
26512
25626
  */
@@ -26766,29 +25880,19 @@ const declarations = [ExcelComponent, ExcelCommandDirective];
26766
25880
  *
26767
25881
  * @example
26768
25882
  *
26769
- * ```ts-no-run
26770
- * // Import the Grid and Excel modules
26771
- * import { GridModule, ExcelModule } from '@progress/kendo-angular-grid';
26772
- *
26773
- * // The browser platform with a compiler
26774
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
26775
- *
25883
+ * ```ts
26776
25884
  * import { NgModule } from '@angular/core';
26777
- *
26778
- * // Import the app component
25885
+ * import { BrowserModule } from "@angular/platform-browser";
25886
+ * import { GridModule, ExcelModule } from '@progress/kendo-angular-grid';
26779
25887
  * import { AppComponent } from './app.component';
26780
25888
  *
26781
- * // Define the app module
26782
25889
  * _@NgModule({
26783
- * declarations: [AppComponent], // declare app component
26784
- * imports: [BrowserModule, GridModule, ExcelModule], // import Grid and Excel modules
25890
+ * declarations: [AppComponent],
25891
+ * imports: [BrowserModule, GridModule, ExcelModule],
26785
25892
  * bootstrap: [AppComponent]
26786
25893
  * })
26787
25894
  * export class AppModule {}
26788
25895
  *
26789
- * // Compile and launch the module
26790
- * platformBrowserDynamic().bootstrapModule(AppModule);
26791
- *
26792
25896
  * ```
26793
25897
  */
26794
25898
  class ExcelModule {