@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() {
@@ -934,7 +935,7 @@ class PreventableEvent {
934
935
  this.prevented = true;
935
936
  }
936
937
  /**
937
- * Returns `true` if the event was prevented
938
+ * Returns a respective boolean if the event was prevented
938
939
  * by any of its subscribers.
939
940
  *
940
941
  * @returns `true` if the default action was prevented.
@@ -2832,8 +2833,8 @@ const packageMetadata = {
2832
2833
  name: '@progress/kendo-angular-grid',
2833
2834
  productName: 'Kendo UI for Angular',
2834
2835
  productCodes: ['KENDOUIANGULAR', 'KENDOUICOMPLETE'],
2835
- publishDate: 1681884669,
2836
- version: '12.0.0-develop.9',
2836
+ publishDate: 1683028339,
2837
+ version: '12.0.1-develop.1',
2837
2838
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
2838
2839
  };
2839
2840
 
@@ -3212,9 +3213,9 @@ class ColumnBase {
3212
3213
  */
3213
3214
  this.matchesMedia = true;
3214
3215
  /**
3215
- * The column index after reordering.
3216
+ * The column index after reordering. The `orderIndex` is a read-only property. Setting this field does not affect column order.
3216
3217
  *
3217
- * > `orderIndex` is a read-only property. Setting this field does not affect column order.
3218
+ * @default 0
3218
3219
  */
3219
3220
  this.orderIndex = 0;
3220
3221
  /**
@@ -3237,6 +3238,7 @@ class ColumnBase {
3237
3238
  this.reorderable = true;
3238
3239
  /**
3239
3240
  * 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)).
3241
+ * The `autoFitColumn` and `autoFitColumns` methods have higher priority.
3240
3242
  * @default 10
3241
3243
  */
3242
3244
  this.minResizableWidth = 10;
@@ -3249,18 +3251,22 @@ class ColumnBase {
3249
3251
  this.sticky = false;
3250
3252
  /**
3251
3253
  * Specifies if the column can be locked or unlocked from the column menu or by reordering the columns.
3254
+ * @default true
3252
3255
  */
3253
3256
  this.lockable = true;
3254
3257
  /**
3255
3258
  * Specifies if the column can be stuck or unstuck from the column menu.
3259
+ * @default true
3256
3260
  */
3257
3261
  this.stickable = true;
3258
3262
  /**
3259
3263
  * Specifies if the column menu will be shown for the column.
3264
+ * @default true
3260
3265
  */
3261
3266
  this.columnMenu = true;
3262
3267
  /**
3263
3268
  * Specifies if the column will be included in the column-chooser list.
3269
+ * @default true
3264
3270
  */
3265
3271
  this.includeInChooser = true;
3266
3272
  /**
@@ -3308,44 +3314,6 @@ class ColumnBase {
3308
3314
  *
3309
3315
  * @default false
3310
3316
  *
3311
- * @example
3312
- * ```ts
3313
- * _@Component({
3314
- * selector: 'my-app',
3315
- * template: `
3316
- * <kendo-grid [data]="gridData" [scrollable]="scrollable" style="height: 200px">
3317
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120" [locked]="true">
3318
- * </kendo-grid-column>
3319
- * <kendo-grid-column field="ProductName" title="Product Name" [width]="200">
3320
- * </kendo-grid-column>
3321
- * <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
3322
- * </kendo-grid-column>
3323
- * </kendo-grid>
3324
- * `
3325
- * })
3326
- *
3327
- * class AppComponent {
3328
- * public gridData: any[];
3329
- *
3330
- * constructor() {
3331
- * this.gridData = products;
3332
- * }
3333
- * }
3334
- *
3335
- * const products = [{
3336
- * "ProductID": 1,
3337
- * "ProductName": "Chai",
3338
- * "UnitPrice": 18.0000,
3339
- * "Discontinued": true
3340
- * }, {
3341
- * "ProductID": 2,
3342
- * "ProductName": "Chang",
3343
- * "UnitPrice": 19.0000,
3344
- * "Discontinued": false
3345
- * }
3346
- * ];
3347
- *
3348
- * ```
3349
3317
  */
3350
3318
  set locked(value) {
3351
3319
  this._locked = value;
@@ -3529,113 +3497,56 @@ function isColumnComponent(column) {
3529
3497
  return isPresent(column.field);
3530
3498
  }
3531
3499
  /**
3532
- * Represents the columns of the [Angular Data Grid]({% slug overview_grid %}).
3500
+ * Represents the column of the Grid. [See example](slug:columns_config#toc-using-the-column-component)
3533
3501
  *
3534
3502
  * @example
3535
- * ```ts-preview
3536
- *
3537
- * _@Component({
3538
- * selector: 'my-app',
3539
- * template: `
3540
- * <kendo-grid [data]="gridData">
3541
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
3542
- * </kendo-grid-column>
3543
- * <kendo-grid-column field="ProductName" title="Product Name">
3544
- * </kendo-grid-column>
3545
- * <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
3546
- * </kendo-grid-column>
3547
- * <kendo-grid-column field="Discontinued" [width]="120">
3548
- * <ng-template kendoGridCellTemplate let-dataItem>
3549
- * <input type="checkbox" [checked]="dataItem.Discontinued" disabled/>
3550
- * </ng-template>
3551
- * </kendo-grid-column>
3552
- * </kendo-grid>
3553
- * `
3554
- * })
3555
- *
3556
- * class AppComponent {
3557
- * public gridData: any[];
3558
- *
3559
- * constructor() {
3560
- * this.gridData = products;
3561
- * }
3562
- * }
3563
- *
3564
- * const products = [{
3565
- * "ProductID": 1,
3566
- * "ProductName": "Chai",
3567
- * "UnitPrice": 18.0000,
3568
- * "Discontinued": true
3569
- * }, {
3570
- * "ProductID": 2,
3571
- * "ProductName": "Chang",
3572
- * "UnitPrice": 19.0000,
3573
- * "Discontinued": false
3574
- * }
3575
- * ];
3576
- *
3503
+ * ```html
3504
+ * <kendo-grid [data]="gridData">
3505
+ * <kendo-grid-column field="ProductID" title="Product ID"></kendo-grid-column>
3506
+ * <kendo-grid-column field="ProductName" title="Product Name"></kendo-grid-column>
3507
+ * <kendo-grid-column field="UnitPrice" title="Unit Price"></kendo-grid-column>
3508
+ * </kendo-grid>
3577
3509
  * ```
3578
3510
  */
3579
3511
  class ColumnComponent extends ColumnBase {
3580
3512
  constructor(parent, idService) {
3581
3513
  super(parent, idService);
3582
3514
  /**
3583
- * Allows the column headers to be clicked and the `sortChange` event emitted.
3584
- * You have to handle the `sortChange` event yourself and sort the data.
3515
+ * Allows the user to click the column headers and emits the `sortChange` event. [See example](slug:sorting_grid).
3516
+ *
3517
+ * @default true
3585
3518
  */
3586
3519
  this.sortable = true;
3587
3520
  /**
3588
- * Determines if the column can be dragged to the group panel. The default value is `true`.
3521
+ * Determines if the column can be dragged to the group panel.
3589
3522
  * If set to `false`, you can group the columns by the column field by using the API of the Grid.
3523
+ *
3524
+ * @default true
3590
3525
  */
3591
3526
  this.groupable = true;
3592
3527
  /**
3593
- * Defines the editor type ([see example]({% slug inline_editing_grid %}#toc-using-reactive-forms)).
3594
- * Used when the column enters the edit mode. The default value is `text`.
3528
+ * Defines the editor type. [See example](slug:inline_editing_grid#toc-using-reactive-forms).
3529
+ * Used when the column enters the edit mode.
3595
3530
  *
3596
- * @example
3597
- * ```html-no-run
3598
- * <kendo-grid>
3599
- * <kendo-grid-column field="UnitPrice" editor="numeric">
3600
- * </kendo-grid-column>
3601
- * </kendo-grid>
3602
- * ```
3531
+ * @default 'text'
3603
3532
  */
3604
3533
  this.editor = 'text';
3605
3534
  /**
3606
- * Defines the filter type that is displayed inside the filter row. The default value is `text`.
3535
+ * Defines the filter type that is displayed inside the filter row. [See example](slug:filtering_grid#toc-filter-data-types).
3607
3536
  *
3608
- * @example
3609
- * ```html-no-run
3610
- * <kendo-grid>
3611
- * <kendo-grid-column field="UnitPrice" filter="numeric">
3612
- * </kendo-grid-column>
3613
- * </kendo-grid>
3614
- * ```
3537
+ * @default 'text'
3615
3538
  */
3616
3539
  this.filter = 'text';
3617
3540
  /**
3618
- * Defines if a filter UI will be displayed for this column. The default value is `true`.
3541
+ * Defines if a filter UI will be displayed for this column. [See example](slug:filtering_grid).
3619
3542
  *
3620
- * @example
3621
- * ```html-no-run
3622
- * <kendo-grid>
3623
- * <kendo-grid-column field="UnitPrice" [filterable]="false">
3624
- * </kendo-grid-column>
3625
- * </kendo-grid>
3626
- * ```
3543
+ * @default true
3627
3544
  */
3628
3545
  this.filterable = true;
3629
3546
  /**
3630
- * Defines whether the column is editable. The default value is `true`.
3547
+ * Defines whether the column is editable. [See example](slug:make_fields_uneditable_grid).
3631
3548
  *
3632
- * @example
3633
- * ```html-no-run
3634
- * <kendo-grid>
3635
- * <kendo-grid-column field="UnitPrice" [editable]="false">
3636
- * </kendo-grid-column>
3637
- * </kendo-grid>
3638
- * ```
3549
+ * @default true
3639
3550
  */
3640
3551
  this.editable = true;
3641
3552
  }
@@ -3746,62 +3657,15 @@ function isSpanColumnComponent(column) {
3746
3657
  * [grouping]({% slug grouping_grid %}). Wrap the columns that will be
3747
3658
  * merged inside the `<kendo-grid-span-column>` tag.
3748
3659
  *
3749
- * @example
3750
- * ```ts-preview
3751
- *
3752
- * _@Component({
3753
- * selector: 'my-app',
3754
- * template: `
3755
- * <kendo-grid
3756
- * [sortable]="true"
3757
- * [filterable]="true"
3758
- * [kendoGridBinding]="products">
3759
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
3760
- * </kendo-grid-column>
3761
- * <kendo-grid-span-column>
3762
- * <kendo-grid-column field="ProductName" title="Product Name">
3763
- * </kendo-grid-column>
3764
- * <kendo-grid-column field="UnitPrice" title="Unit Price" filter="numeric" [width]="180" format="{0:c}">
3765
- * </kendo-grid-column>
3766
- * </kendo-grid-span-column>
3767
- * <kendo-grid-column field="Discontinued" [width]="120" filter="boolean">
3768
- * <ng-template kendoGridCellTemplate let-dataItem>
3769
- * <input type="checkbox" [checked]="dataItem.Discontinued" disabled/>
3770
- * </ng-template>
3771
- * </kendo-grid-column>
3772
- * </kendo-grid>
3773
- * `
3774
- * })
3775
- *
3776
- * class AppComponent {
3777
- * public products = [{
3778
- * "ProductID": 1,
3779
- * "ProductName": "Chai",
3780
- * "UnitPrice": 18.0000,
3781
- * "Discontinued": true
3782
- * }, {
3783
- * "ProductID": 2,
3784
- * "ProductName": "Chang",
3785
- * "UnitPrice": 19.0000,
3786
- * "Discontinued": false
3787
- * }
3788
- * ];
3789
- * }
3790
- *
3791
- * ```
3792
- *
3793
- * By default, the data cell displays the data for the specified fields. To further customize
3794
- * the span-column functionality, use a [cell template]({% slug api_grid_celltemplatedirective %}).
3795
- *
3796
- * ```html-no-run
3660
+ * ```html
3797
3661
  * <kendo-grid-span-column>
3798
- * <kendo-grid-column field="field1" title="Field 1"></kendo-grid-column>
3799
- * <kendo-grid-column field="field2" title="Field 2"></kendo-grid-column>
3800
- * <ng-template kendoGridCellTemplate let-dataItem>
3801
- * <h5>{{ dataItem.field1 }}</h5>
3802
- * <p>{{ dataItem.field2 }}</p>
3803
- * </ng-template>
3804
- * </kendo-grid-span-column>
3662
+ * <kendo-grid-column field="field1"></kendo-grid-column>
3663
+ * <kendo-grid-column field="field2"></kendo-grid-column>
3664
+ * <ng-template kendoGridCellTemplate let-dataItem>
3665
+ * <h5>{{ dataItem.field1 }}</h5>
3666
+ * <p>{{ dataItem.field2 }}</p>
3667
+ * </ng-template>
3668
+ * </kendo-grid-span-column>
3805
3669
  * ```
3806
3670
  */
3807
3671
  class SpanColumnComponent extends ColumnBase {
@@ -3827,24 +3691,9 @@ class SpanColumnComponent extends ColumnBase {
3827
3691
  }
3828
3692
  }
3829
3693
  /**
3830
- * Defines whether the edit template of the column will be rendered. The default value is `false`.
3831
- *
3832
- * > To enable the editing functionality for a spanned column, set an edit template for it.
3833
- *
3834
- * @example
3835
- * ```html-no-run
3836
- * <kendo-grid>
3837
- * <kendo-grid-span-column [editable]="false">
3838
- * <kendo-grid-column field="UnitPrice">
3839
- * </kendo-grid-column>
3840
- * <kendo-grid-column field="ProductName">
3841
- * </kendo-grid-column>
3842
- * <ng-template kendoGridEditTemplate>
3843
- * .....
3844
- * </ng-template>
3845
- * </kendo-grid-span-column>
3846
- * </kendo-grid>
3847
- * ```
3694
+ * Defines whether the edit template of the column will be rendered.
3695
+ * To enable the editing functionality for a spanned column, set an edit template for it ([see exmaple](slug:custom_reactive_editing_grid)).
3696
+ * @default false
3848
3697
  */
3849
3698
  set editable(value) {
3850
3699
  this._editable = value;
@@ -3888,57 +3737,8 @@ class SpanColumnComponent extends ColumnBase {
3888
3737
  return this.childColumns.filter(c => c.isVisible).length;
3889
3738
  }
3890
3739
  /**
3891
- * Toggles the locked (frozen) state of the columns. Locked columns are visible
3892
- * at all times during the horizontal scrolling of the Grid.
3893
- *
3894
- * For the option to work properly, make sure that:
3895
- * - Scrolling is enabled.
3896
- * - The `height` option of the Grid is set.
3897
- * - The widths of all Grid columns are explicitly set in pixels. In this way,
3898
- * the Grid adjusts the layout of the locked and unlocked columns.
3899
- *
3740
+ * Toggles the locked (frozen) state of the columns ([see example](slug:locked_columns_grid)).
3900
3741
  * @default false
3901
- *
3902
- * @example
3903
- * ```ts
3904
- * _@Component({
3905
- * selector: 'my-app',
3906
- * template: `
3907
- * <kendo-grid [data]="gridData" [scrollable]="scrollable" style="height: 200px">
3908
- * <kendo-grid-span-column [locked]="true">
3909
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
3910
- * </kendo-grid-column>
3911
- * <kendo-grid-column field="ProductName" title="Product Name" [width]="200">
3912
- * </kendo-grid-column>
3913
- * </kendo-grid-span-column>
3914
- * <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
3915
- * </kendo-grid-column>
3916
- * </kendo-grid>
3917
- * `
3918
- * })
3919
- *
3920
- * class AppComponent {
3921
- * public gridData: any[];
3922
- *
3923
- * constructor() {
3924
- * this.gridData = products;
3925
- * }
3926
- * }
3927
- *
3928
- * const products = [{
3929
- * "ProductID": 1,
3930
- * "ProductName": "Chai",
3931
- * "UnitPrice": 18.0000,
3932
- * "Discontinued": true
3933
- * }, {
3934
- * "ProductID": 2,
3935
- * "ProductName": "Chang",
3936
- * "UnitPrice": 19.0000,
3937
- * "Discontinued": false
3938
- * }
3939
- * ];
3940
- *
3941
- * ```
3942
3742
  */
3943
3743
  set locked(value) {
3944
3744
  this._locked = value;
@@ -4072,56 +3872,17 @@ function isColumnGroupComponent(column) {
4072
3872
  }
4073
3873
  /**
4074
3874
  * Represents the column group header of the Grid
4075
- * ([more information and examples]({% slug multicolumnheaders_columns_grid %})).
3875
+ * ([more information and examples](slug:multicolumnheaders_columns_grid)).
4076
3876
  *
4077
3877
  * @example
4078
- * ```ts-preview
4079
- *
4080
- * _@Component({
4081
- * selector: 'my-app',
4082
- * template: `
4083
- * <kendo-grid [data]="gridData">
4084
- * <kendo-grid-column-group title="Product Info">
4085
- * <ng-template kendoGridHeaderTemplate let-columnIndex="columnIndex" let-column="column">
4086
- * Column index: {{columnIndex}} / column title: {{column.title}}
4087
- * </ng-template>
4088
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
4089
- * </kendo-grid-column>
4090
- * <kendo-grid-column field="ProductName" title="Product Name">
4091
- * </kendo-grid-column>
4092
- * </kendo-grid-column-group>
4093
- * <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
4094
- * </kendo-grid-column>
4095
- * <kendo-grid-column field="Discontinued" [width]="120">
4096
- * <ng-template kendoGridCellTemplate let-dataItem>
4097
- * <input type="checkbox" [checked]="dataItem.Discontinued" disabled/>
4098
- * </ng-template>
4099
- * </kendo-grid-column>
4100
- * </kendo-grid>
4101
- * `
4102
- * })
4103
- *
4104
- * class AppComponent {
4105
- * public gridData: any[];
4106
- *
4107
- * constructor() {
4108
- * this.gridData = products;
4109
- * }
4110
- * }
4111
- *
4112
- * const products = [{
4113
- * "ProductID": 1,
4114
- * "ProductName": "Chai",
4115
- * "UnitPrice": 18.0000,
4116
- * "Discontinued": true
4117
- * }, {
4118
- * "ProductID": 2,
4119
- * "ProductName": "Chang",
4120
- * "UnitPrice": 19.0000,
4121
- * "Discontinued": false
4122
- * }
4123
- * ];
4124
- *
3878
+ * ```html
3879
+ * <kendo-grid [data]="gridData">
3880
+ * <kendo-grid-column-group title="Product Info">
3881
+ * <kendo-grid-column field="ProductID"></kendo-grid-column>
3882
+ * <kendo-grid-column field="ProductName"></kendo-grid-column>
3883
+ * </kendo-grid-column-group>
3884
+ * <kendo-grid-column field="UnitPrice"></kendo-grid-column>
3885
+ * </kendo-grid>
4125
3886
  * ```
4126
3887
  */
4127
3888
  class ColumnGroupComponent extends ColumnBase {
@@ -5773,7 +5534,7 @@ class PopupCloseEvent extends PreventableEvent {
5773
5534
  const DEFAULT_POPUP_CLASS = 'k-grid-filter-popup';
5774
5535
  /**
5775
5536
  * The service that is used for the popups of the filter and column menus
5776
- * ([see example]({% slug filter_menu %}#toc-custom-filter-row-components)#toc-filter-menu-with-popup).
5537
+ * ([see example]({% slug filter_menu %}#toc-filter-menu-with-popup)).
5777
5538
  */
5778
5539
  class SinglePopupService {
5779
5540
  constructor(popupService, renderer, ngZone, scrollSyncService, localization) {
@@ -6369,6 +6130,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
6369
6130
  }]
6370
6131
  }], ctorParameters: function () { return [{ type: i0.TemplateRef }]; } });
6371
6132
 
6133
+ /**
6134
+ * @hidden
6135
+ */
6372
6136
  class SizingOptionsService {
6373
6137
  constructor() {
6374
6138
  this.changes = new Subject();
@@ -6479,6 +6243,7 @@ class RowReorderService {
6479
6243
  }
6480
6244
  press(ev) {
6481
6245
  this.dragTarget = ev.dragTarget;
6246
+ this.offsetY = ev.dragEvent.offsetY;
6482
6247
  }
6483
6248
  dragStart() {
6484
6249
  this.createDropIndicator();
@@ -6490,7 +6255,7 @@ class RowReorderService {
6490
6255
  }
6491
6256
  const position = {
6492
6257
  x: ev.dragEvent.clientX,
6493
- y: ev.dragEvent.clientY
6258
+ y: ev.dragEvent.clientY - this.offsetY
6494
6259
  };
6495
6260
  if (isPresent$1(this.hintElement)) {
6496
6261
  this.renderer.setStyle(this.hintElement, 'left', `${position.x}px`);
@@ -6985,7 +6750,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
6985
6750
  }] } });
6986
6751
 
6987
6752
  /**
6988
- * Displays buttons for navigating to the first and to the previous page ([see example]({% slug paging_grid %}#toc-pager-templates)).
6753
+ * Displays buttons for navigating to the first and to the previous page ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
6989
6754
  */
6990
6755
  class PagerPrevButtonsComponent extends PagerElementComponent {
6991
6756
  constructor(localization, pagerContext, cd, navigationService) {
@@ -7087,7 +6852,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
7087
6852
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }, { type: PagerContextService }, { type: i0.ChangeDetectorRef }, { type: NavigationService }]; } });
7088
6853
 
7089
6854
  /**
7090
- * Displays numeric buttons to enable navigation between the pages.
6855
+ * Displays numeric buttons to enable navigation between the pages ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
7091
6856
  */
7092
6857
  class PagerNumericButtonsComponent extends PagerElementComponent {
7093
6858
  constructor(localization, cd, pagerContext) {
@@ -7343,54 +7108,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
7343
7108
  }], ctorParameters: function () { return [{ type: i3.NumericTextBoxComponent }, { type: i0.Renderer2 }]; } });
7344
7109
 
7345
7110
  /**
7346
- * Displays an input element which allows the typing and rendering of page numbers.
7347
- *
7348
- * @example
7349
- * ```ts-preview
7350
- *
7351
- * _@Component({
7352
- * selector: 'my-app',
7353
- * template: `
7354
- * <kendo-grid
7355
- * [kendoGridBinding]="gridData"
7356
- * [pageSize]="1"
7357
- * [pageable]="true"
7358
- * >
7359
- * <kendo-grid-column field="ProductID" title="ID" [width]="40">
7360
- * </kendo-grid-column>
7361
- * <kendo-grid-column field="ProductName" title="Name" [width]="250">
7362
- * </kendo-grid-column>
7363
- * <kendo-grid-column field="UnitPrice" title="Price" [width]="80" format="{0:c}">
7364
- * </kendo-grid-column>
7365
- *
7366
- * <ng-template kendoPagerTemplate let-totalPages="totalPages" let-currentPage="currentPage">
7367
- * <kendo-pager-prev-buttons></kendo-pager-prev-buttons>
7368
- * <kendo-pager-numeric-buttons [buttonCount]="10"></kendo-pager-numeric-buttons>
7369
- * <kendo-pager-next-buttons></kendo-pager-next-buttons>
7370
- * <kendo-pager-input></kendo-pager-input>
7371
- * <kendo-pager-info></kendo-pager-info>
7372
- * </ng-template>
7373
- *
7374
- * </kendo-grid>
7375
- * `
7376
- * })
7377
- *
7378
- * class AppComponent {
7379
- * public gridData = [{
7380
- * "ProductID": 1,
7381
- * "ProductName": "Chai",
7382
- * "UnitPrice": 18.0000,
7383
- * "Discontinued": false
7384
- * }, {
7385
- * "ProductID": 2,
7386
- * "ProductName": "Chang",
7387
- * "UnitPrice": 19.0000,
7388
- * "Discontinued": true
7389
- * }
7390
- * ];
7391
- * }
7392
- *
7393
- * ```
7111
+ * 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)).
7394
7112
  */
7395
7113
  class PagerInputComponent extends PagerElementComponent {
7396
7114
  constructor(localization, pagerContext, zone, navigationService, cd) {
@@ -7514,7 +7232,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
7514
7232
  }] } });
7515
7233
 
7516
7234
  /**
7517
- * Displays buttons for navigating to the next and to the last page ([see example]({% slug paging_grid %}#toc-pager-template)).
7235
+ * Displays buttons for navigating to the next and to the last page ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
7518
7236
  */
7519
7237
  class PagerNextButtonsComponent extends PagerElementComponent {
7520
7238
  constructor(localization, pagerContext, cd, navigationService) {
@@ -7615,7 +7333,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
7615
7333
 
7616
7334
  // eslint-disable no-access-missing-member
7617
7335
  /**
7618
- * Displays information about the current page and the total number of records ([see example]({% slug paging_grid %}#toc-pager-templates)).
7336
+ * Displays information about the current page and the total number of records ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
7619
7337
  */
7620
7338
  class PagerInfoComponent extends PagerElementComponent {
7621
7339
  constructor(localization, cd, pagerContext) {
@@ -7707,7 +7425,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
7707
7425
  }], ctorParameters: function () { return [{ type: i1$4.DropDownListComponent }]; } });
7708
7426
 
7709
7427
  /**
7710
- * Displays a drop-down list for the page size selection ([see example]({% slug paging_grid %}#toc-pager-templates)).
7428
+ * Displays a drop-down list for the page size selection ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
7711
7429
  */
7712
7430
  class PagerPageSizesComponent extends PagerElementComponent {
7713
7431
  constructor(localization, cd, pagerContext, navigationService) {
@@ -7717,97 +7435,8 @@ class PagerPageSizesComponent extends PagerElementComponent {
7717
7435
  this._pageSizes = [];
7718
7436
  }
7719
7437
  /**
7720
- * The page sizes collection. Can be an Array of numbers and/or PageSizeItem objects.
7721
- *
7722
- * @example
7723
- * ```ts-preview
7724
- * _@Component({
7725
- * selector: 'my-app',
7726
- * template: `
7727
- * <kendo-grid [kendoGridBinding]="gridData" [height]="200"
7728
- * [pageable]="true"
7729
- * [pageSize]="pageSize">
7730
- * <ng-template kendoPagerTemplate let-totalPages="totalPages" let-currentPage="currentPage">
7731
- * <kendo-pager-page-sizes [pageSizes]="pagesizes"></kendo-pager-page-sizes>
7732
- * </ng-template>
7733
- * </kendo-grid>
7734
- * `
7735
- * })
7736
- * class AppComponent {
7737
- * public gridData: any[] = products;
7738
- * public pageSize = 2;
7739
- * public pagesizes = [{text: 'One', value: 1}, {text: 'Two', value: 2}, {text: 'All', value : 'all'}];
7740
- * }
7741
- *
7742
- * const products = [{
7743
- * 'ProductID' : 1,
7744
- * 'ProductName' : "Chai",
7745
- * 'SupplierID' : 1,
7746
- * 'CategoryID' : 1,
7747
- * 'QuantityPerUnit' : "10 boxes x 20 bags",
7748
- * 'UnitPrice' : 18.0000,
7749
- * 'UnitsInStock' : 39,
7750
- * 'UnitsOnOrder' : 0,
7751
- * 'ReorderLevel' : 10,
7752
- * 'Discontinued' : false
7753
- *
7754
- * }, {
7755
- * 'ProductID' : 2,
7756
- * 'ProductName' : "Chang",
7757
- * 'SupplierID' : 1,
7758
- * 'CategoryID' : 1,
7759
- * 'QuantityPerUnit' : "24 - 12 oz bottles",
7760
- * 'UnitPrice' : 19.0000,
7761
- * 'UnitsInStock' : 17,
7762
- * 'UnitsOnOrder' : 40,
7763
- * 'ReorderLevel' : 25,
7764
- * 'Discontinued' : false
7765
- * }, {
7766
- * 'ProductID' : 3,
7767
- * 'ProductName' : "Aniseed Syrup",
7768
- * 'SupplierID' : 1,
7769
- * 'CategoryID' : 2,
7770
- * 'QuantityPerUnit' : "12 - 550 ml bottles",
7771
- * 'UnitPrice' : 10.0000,
7772
- * 'UnitsInStock' : 13,
7773
- * 'UnitsOnOrder' : 70,
7774
- * 'ReorderLevel' : 25,
7775
- * 'Discontinued' : false
7776
- * }, {
7777
- * 'ProductID' : 4,
7778
- * 'ProductName' : "Chef Anton\'s Cajun Seasoning",
7779
- * 'SupplierID' : 2,
7780
- * 'CategoryID' : 2,
7781
- * 'QuantityPerUnit' : "48 - 6 oz jars",
7782
- * 'UnitPrice' : 22.0000,
7783
- * 'UnitsInStock' : 53,
7784
- * 'UnitsOnOrder' : 0,
7785
- * 'ReorderLevel' : 0,
7786
- * 'Discontinued' : false
7787
- * }, {
7788
- * 'ProductID' : 5,
7789
- * 'ProductName' : "Chef Anton\'s Gumbo Mix",
7790
- * 'SupplierID' : 2,
7791
- * 'CategoryID' : 2,
7792
- * 'QuantityPerUnit' : "36 boxes",
7793
- * 'UnitPrice' : 21.3500,
7794
- * 'UnitsInStock' : 0,
7795
- * 'UnitsOnOrder' : 0,
7796
- * 'ReorderLevel' : 0,
7797
- * 'Discontinued' : true
7798
- * }, {
7799
- * 'ProductID' : 6,
7800
- * 'ProductName' : "Grandma\'s Boysenberry Spread",
7801
- * 'SupplierID' : 3,
7802
- * 'CategoryID' : 2,
7803
- * 'QuantityPerUnit' : "12 - 8 oz jars",
7804
- * 'UnitPrice' : 25.0000,
7805
- * 'UnitsInStock' : 120,
7806
- * 'UnitsOnOrder' : 0,
7807
- * 'ReorderLevel' : 25,
7808
- * 'Discontinued' : false
7809
- * }];
7810
- * ```
7438
+ * The page sizes collection. Can be an Array of numbers and/or [`PageSizeItem`](slug:api_grid_pagesizeitem) objects
7439
+ * ([see example]({% slug paging_grid %}#toc-pager-templates))
7811
7440
  */
7812
7441
  set pageSizes(pageSizes) {
7813
7442
  let normalizedItems = [];
@@ -9238,8 +8867,9 @@ class StringFilterComponent extends BaseFilterCellComponent {
9238
8867
  super(filterService);
9239
8868
  this.localization = localization;
9240
8869
  /**
9241
- * The default filter operator. Defaults to `contains`.
8870
+ * The default filter operator.
9242
8871
  * @type {string}
8872
+ * @default 'contains'
9243
8873
  */
9244
8874
  this.operator = "contains";
9245
8875
  }
@@ -9705,8 +9335,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
9705
9335
  }] } });
9706
9336
 
9707
9337
  /**
9708
- * Represents a string-filter menu component.
9709
- * ([see example]({% slug filter_menu %}#toc-built-in-filter-menu-components)).
9338
+ * Represents a string-filter menu component
9339
+ * ([see example](slug:filter_menu#toc-built-in-filter-menu-components)).
9340
+ *
9341
+ * ```html
9342
+ * <kendo-grid-column field="ProductName">
9343
+ * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
9344
+ * <kendo-grid-string-filter-menu
9345
+ * [column]="column"
9346
+ * [filter]="filter"
9347
+ * [filterService]="filterService">
9348
+ * </kendo-grid-string-filter-menu>
9349
+ * </ng-template>
9350
+ * </kendo-grid-column>
9351
+ * ```
9710
9352
  */
9711
9353
  class StringFilterMenuComponent extends StringFilterComponent {
9712
9354
  constructor(localization) {
@@ -9719,6 +9361,7 @@ class StringFilterMenuComponent extends StringFilterComponent {
9719
9361
  this.filter = { filters: [], logic: "and" };
9720
9362
  /**
9721
9363
  * Determines if the inputs of second criteria will displayed.
9364
+ * @default true
9722
9365
  */
9723
9366
  this.extra = true;
9724
9367
  }
@@ -9849,18 +9492,21 @@ class NumericFilterComponent extends BaseFilterCellComponent {
9849
9492
  super(filterService);
9850
9493
  this.localization = localization;
9851
9494
  /**
9852
- * The default filter operator. Defaults to `eq`.
9495
+ * The default filter operator.
9853
9496
  * @type {string}
9497
+ * @default 'eq'
9854
9498
  */
9855
9499
  this.operator = "eq";
9856
9500
  /**
9857
9501
  * Specifies the value that is used to increment or decrement the component value.
9858
9502
  * @type {numeric}
9503
+ * @default 1
9859
9504
  */
9860
9505
  this.step = 1;
9861
9506
  /**
9862
9507
  * Specifies whether the **Up** and **Down** spin buttons will be rendered.
9863
9508
  * @type {boolean}
9509
+ * @default true
9864
9510
  */
9865
9511
  this.spinners = true;
9866
9512
  this.defaultOperators = numericOperators(this.localization);
@@ -10073,21 +9719,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
10073
9719
  }] } });
10074
9720
 
10075
9721
  /**
10076
- * Represents a numeric-filter menu component.
9722
+ * Represents a numeric filter-menu component.
10077
9723
  *
10078
9724
  * @example
10079
- * ```html-no-run
10080
- * <kendo-grid-column field="UnitPrice" title="Unit Price">
10081
- * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
10082
- * <kendo-grid-numeric-filter-menu
10083
- * [column]="column"
10084
- * [filter]="filter"
10085
- * [filterService]="filterService"
10086
- * >
10087
- * </kendo-grid-numeric-filter-menu>
10088
- * </ng-template>
10089
- * </kendo-grid-column>
10090
- * ```
9725
+ * ```html
9726
+ * <kendo-grid-column field="UnitPrice">
9727
+ * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
9728
+ * <kendo-grid-numeric-filter-menu
9729
+ * [column]="column"
9730
+ * [filter]="filter"
9731
+ * [filterService]="filterService">
9732
+ * </kendo-grid-numeric-filter-menu>
9733
+ * </ng-template>
9734
+ * </kendo-grid-column>
9735
+ * ```
10091
9736
  */
10092
9737
  class NumericFilterMenuComponent extends NumericFilterComponent {
10093
9738
  constructor(localization) {
@@ -10100,6 +9745,7 @@ class NumericFilterMenuComponent extends NumericFilterComponent {
10100
9745
  this.filter = { filters: [], logic: "and" };
10101
9746
  /**
10102
9747
  * Determines if the inputs of second criteria will displayed.
9748
+ * @default true
10103
9749
  */
10104
9750
  this.extra = true;
10105
9751
  /**
@@ -10272,25 +9918,29 @@ class DateFilterComponent extends BaseFilterCellComponent {
10272
9918
  /**
10273
9919
  * The default filter operator. Defaults to `contains`.
10274
9920
  * @type {string}
9921
+ * @default 'gte'
10275
9922
  */
10276
9923
  this.operator = "gte";
10277
9924
  /**
10278
9925
  * Defines the active view that the calendar initially renders.
10279
9926
  * By default, the active view is `month`.
10280
- *
10281
- * > You have to set `activeView` within the `topView`-`bottomView` range.
9927
+ * You have to set `activeView` within the `topView`-`bottomView` range.
9928
+ * @default 'month'
10282
9929
  */
10283
9930
  this.activeView = "month";
10284
9931
  /**
10285
9932
  * Defines the bottommost calendar view, to which the user can navigate.
9933
+ * @default 'month'
10286
9934
  */
10287
9935
  this.bottomView = "month";
10288
9936
  /**
10289
9937
  * Defines the topmost calendar view, to which the user can navigate.
9938
+ * @default 'century'
10290
9939
  */
10291
9940
  this.topView = "century";
10292
9941
  /**
10293
9942
  * Determines whether to display a week number column in the `month` view of the Calendar.
9943
+ * @default false
10294
9944
  */
10295
9945
  this.weekNumber = false;
10296
9946
  this.defaultOperators = dateOperators(this.localization);
@@ -10525,21 +10175,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
10525
10175
  }] } });
10526
10176
 
10527
10177
  /**
10528
- * Represents a date-filter menu component.
10178
+ * Represents a date filter-menu component.
10529
10179
  *
10530
10180
  * @example
10531
- * ```html-no-run
10532
- * <kendo-grid-column field="OrderDate" title="Order Date">
10533
- * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
10534
- * <kendo-grid-date-filter-menu
10535
- * [column]="column"
10536
- * [filter]="filter"
10537
- * [filterService]="filterService"
10538
- * >
10539
- * </kendo-grid-date-filter-menu>
10540
- * </ng-template>
10541
- * </kendo-grid-column>
10542
- * ```
10181
+ * ```html
10182
+ * <kendo-grid-column field="FirstOrderedOn">
10183
+ * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
10184
+ * <kendo-grid-date-filter-menu
10185
+ * [column]="column"
10186
+ * [filter]="filter"
10187
+ * [filterService]="filterService">
10188
+ * </kendo-grid-date-filter-menu>
10189
+ * </ng-template>
10190
+ * </kendo-grid-column>
10191
+ * ```
10543
10192
  */
10544
10193
  class DateFilterMenuComponent extends DateFilterComponent {
10545
10194
  constructor(localization) {
@@ -10552,6 +10201,7 @@ class DateFilterMenuComponent extends DateFilterComponent {
10552
10201
  this.filter = { filters: [], logic: "and" };
10553
10202
  /**
10554
10203
  * Determines if the inputs of second criteria will be displayed.
10204
+ * @default true
10555
10205
  */
10556
10206
  this.extra = true;
10557
10207
  }
@@ -10808,21 +10458,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
10808
10458
  }] } });
10809
10459
 
10810
10460
  /**
10811
- * Represents a Boolean-filter menu component.
10461
+ * Represents a Boolean-filter menu component. [See example](slug:filter_menu#toc-built-in-filter-menu-components)
10812
10462
  *
10813
10463
  * @example
10814
- * ```html-no-run
10815
- * <kendo-grid-column field="Discontinued" title="Discontinued">
10816
- * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
10817
- * <kendo-grid-boolean-filter-menu
10818
- * [column]="column"
10819
- * [filter]="filter"
10820
- * [filterService]="filterService"
10821
- * >
10822
- * </kendo-grid-boolean-filter-menu>
10823
- * </ng-template>
10824
- * </kendo-grid-column>
10825
- * ```
10464
+ *
10465
+ * ```html
10466
+ * <kendo-grid-column field="Discontinued" title="Discontinued">
10467
+ * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
10468
+ * <kendo-grid-boolean-filter-menu
10469
+ * [column]="column"
10470
+ * [filter]="filter"
10471
+ * [filterService]="filterService">
10472
+ * </kendo-grid-boolean-filter-menu>
10473
+ * </ng-template>
10474
+ * </kendo-grid-column>
10475
+ * ```
10826
10476
  */
10827
10477
  class BooleanFilterMenuComponent extends BooleanFilterComponent {
10828
10478
  constructor(localization) {
@@ -11352,27 +11002,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
11352
11002
  * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11353
11003
  *
11354
11004
  * @example
11355
- * ```ts-preview
11356
- *
11357
- * _@Component({
11358
- * selector: 'my-app',
11359
- * template: `
11360
- * <kendo-grid [data]="data" [columnMenu]="true">
11361
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
11362
- * <span class="k-icon k-i-x" (click)="service.close()"
11363
- * style="position: absolute; right: 5px; top: 5px;cursor: pointer;"></span>
11364
- * <kendo-grid-columnmenu-sort [service]="service">
11365
- * </kendo-grid-columnmenu-sort>
11366
- * </ng-template>
11367
- * <kendo-grid-column field="Field1"></kendo-grid-column>
11368
- * <kendo-grid-column field="Field2"></kendo-grid-column>
11369
- * </kendo-grid>
11370
- * `
11371
- * })
11372
- *
11373
- * class AppComponent {
11374
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
11375
- * }
11005
+ * ```html
11006
+ * <kendo-grid [data]="data" [columnMenu]="true">
11007
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
11008
+ * <span class="k-icon k-i-x" (click)="service.close()" </span>
11009
+ * <kendo-grid-columnmenu-sort [service]="service">
11010
+ * </kendo-grid-columnmenu-sort>
11011
+ * </ng-template>
11012
+ * <kendo-grid-column field="Field1"></kendo-grid-column>
11013
+ * </kendo-grid>
11376
11014
  *
11377
11015
  * ```
11378
11016
  */
@@ -11487,27 +11125,12 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
11487
11125
  * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11488
11126
  *
11489
11127
  * @example
11490
- * ```ts-preview
11491
- *
11492
- * _@Component({
11493
- * selector: 'my-app',
11494
- * template: `
11495
- * <kendo-grid [data]="data" [columnMenu]="true" [resizable]="true" #grid>
11496
- * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
11497
- * <kendo-grid-columnmenu-item icon="arrows-resizing" text="Fit column"
11498
- * (itemClick)="grid.autoFitColumn(column); service.close()">
11499
- * </kendo-grid-columnmenu-item>
11500
- * </ng-template>
11501
- * <kendo-grid-column field="Field1"></kendo-grid-column>
11502
- * <kendo-grid-column field="Field2"></kendo-grid-column>
11503
- * </kendo-grid>
11504
- * `
11505
- * })
11506
- *
11507
- * class AppComponent {
11508
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
11509
- * }
11510
- *
11128
+ * ```html
11129
+ * <kendo-grid [columnMenu]="true" ...>
11130
+ * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
11131
+ * <kendo-grid-columnmenu-item text="Fit column"></kendo-grid-columnmenu-item>
11132
+ * </ng-template>
11133
+ * </kendo-grid>
11511
11134
  * ```
11512
11135
  */
11513
11136
  class ColumnMenuItemComponent {
@@ -11664,34 +11287,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
11664
11287
  }] } });
11665
11288
 
11666
11289
  /**
11667
- * Represents a column-menu item that can be placed inside a
11668
- * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11669
- * Allows the user to lock or unlock the columns.
11290
+ * Represents the column-menu item for locking and unlocking columns in the Grid. [See example](slug:columnmenu_grid#toc-lock-and-unlock-items).
11670
11291
  *
11671
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11672
- * > the template to the service input of the `kendo-grid-columnmenu-lock` component.
11292
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11293
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11294
+ * the template to the service input of the `kendo-grid-columnmenu-lock` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
11673
11295
  *
11674
11296
  * @example
11675
- * ```ts-preview
11676
- *
11677
- * _@Component({
11678
- * selector: 'my-app',
11679
- * template: `
11680
- * <kendo-grid [data]="data" [columnMenu]="true">
11681
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
11682
- * <kendo-grid-columnmenu-lock [service]="service">
11683
- * </kendo-grid-columnmenu-lock>
11684
- * </ng-template>
11685
- * <kendo-grid-column field="Field1" [width]="100"></kendo-grid-column>
11686
- * <kendo-grid-column field="Field2" [width]="100"></kendo-grid-column>
11687
- * </kendo-grid>
11688
- * `
11689
- * })
11690
- *
11691
- * class AppComponent {
11692
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
11693
- * }
11694
- *
11297
+ * ```html
11298
+ * <kendo-grid [data]="data" [columnMenu]="true" ...>
11299
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
11300
+ * <kendo-grid-columnmenu-lock [service]="service">
11301
+ * </kendo-grid-columnmenu-lock>
11302
+ * </ng-template>
11303
+ * </kendo-grid>
11695
11304
  * ```
11696
11305
  */
11697
11306
  class ColumnMenuLockComponent extends ColumnMenuItemBase {
@@ -11771,33 +11380,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
11771
11380
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }, { type: ColumnInfoService }, { type: i0.ChangeDetectorRef }]; } });
11772
11381
 
11773
11382
  /**
11774
- * Represents a column-menu item that can be placed inside a
11775
- * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11776
- * Allows the user to stick or unstick the columns.
11383
+ * Represents the column-menu item that sticks or unsticks columns in the Grid.
11384
+ * [See example](slug:columnmenu_grid#toc-stick-and-unstick-items).
11777
11385
  *
11778
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11779
- * > the template to the service input of the `kendo-grid-columnmenu-stick` component.
11386
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11387
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11388
+ * the template to the service input of the `kendo-grid-columnmenu-lock` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
11780
11389
  *
11781
11390
  * @example
11782
- * ```ts-preview
11783
- *
11784
- * _@Component({
11785
- * selector: 'my-app',
11786
- * template: `
11787
- * <kendo-grid [data]="data" [columnMenu]="true">
11788
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
11789
- * <kendo-grid-columnmenu-stick [service]="service">
11790
- * </kendo-grid-columnmenu-stick>
11791
- * </ng-template>
11792
- * <kendo-grid-column field="Field1" [width]="100"></kendo-grid-column>
11793
- * <kendo-grid-column field="Field2" [width]="100"></kendo-grid-column>
11794
- * </kendo-grid>
11795
- * `
11796
- * })
11797
- *
11798
- * class AppComponent {
11799
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
11800
- * }
11391
+ * ```html
11392
+ * <kendo-grid [data]="data" [columnMenu]="true">
11393
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
11394
+ * <kendo-grid-columnmenu-stick [service]="service">
11395
+ * </kendo-grid-columnmenu-stick>
11396
+ * </ng-template>
11397
+ * </kendo-grid>
11801
11398
  *
11802
11399
  * ```
11803
11400
  */
@@ -11878,33 +11475,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
11878
11475
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }, { type: ColumnInfoService }, { type: i0.ChangeDetectorRef }]; } });
11879
11476
 
11880
11477
  /**
11881
- * Represents the component for editing column filters in the Grid that can be placed
11882
- * inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11478
+ * Represents the column-menu item which combines the lock and sticky column functionalities.
11883
11479
  *
11884
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11885
- * > the template to the service input of the `kendo-grid-columnmenu-filter` component.
11480
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11481
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11482
+ * the template to the service input of the `kendo-grid-columnmenu-filter` component. [See example](slug:columnmenu_grid#toc-set-column-position-item).
11886
11483
  *
11887
11484
  * @example
11888
- * ```ts-preview
11889
- *
11890
- * _@Component({
11891
- * selector: 'my-app',
11892
- * template: `
11893
- * <kendo-grid [kendoGridBinding]="data" [columnMenu]="true">
11894
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
11895
- * <kendo-grid-columnmenu-filter [service]="service">
11896
- * </kendo-grid-columnmenu-filter>
11897
- * </ng-template>
11898
- * <kendo-grid-column field="Field1"></kendo-grid-column>
11899
- * <kendo-grid-column field="Field2"></kendo-grid-column>
11900
- * </kendo-grid>
11901
- * `
11902
- * })
11903
- *
11904
- * class AppComponent {
11905
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
11906
- * }
11907
- *
11485
+ * ```html
11486
+ * <kendo-grid [data]="data" [columnMenu]="true" ...>
11487
+ * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
11488
+ * <kendo-grid-columnmenu-position [service]="service" [showLock]="true" [showStick]="true">
11489
+ * </kendo-grid-columnmenu-position>
11490
+ * </ng-template>
11491
+ * </kendo-grid>
11908
11492
  * ```
11909
11493
  */
11910
11494
  class ColumnMenuPositionComponent extends ColumnMenuItemBase {
@@ -11922,6 +11506,7 @@ class ColumnMenuPositionComponent extends ColumnMenuItemBase {
11922
11506
  this.collapse = new EventEmitter();
11923
11507
  /**
11924
11508
  * Specifies if the content is expanded.
11509
+ * @default false
11925
11510
  */
11926
11511
  this.expanded = false;
11927
11512
  /**
@@ -12253,33 +11838,19 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12253
11838
  }] } });
12254
11839
 
12255
11840
  /**
12256
- * Represents the component for selecting columns in the Grid that can be placed
12257
- * inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11841
+ * Represents the column-menu item for selecting columns in the Grid. [See example](slug:columnmenu_grid#toc-column-chooser-item).
12258
11842
  *
12259
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12260
- * > the template to the service input of the `kendo-grid-columnmenu-chooser` component.
11843
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11844
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11845
+ * the template to the service input of the `kendo-grid-columnmenu-chooser` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
12261
11846
  *
12262
11847
  * @example
12263
- * ```ts-preview
12264
- *
12265
- * _@Component({
12266
- * selector: 'my-app',
12267
- * template: `
12268
- * <kendo-grid [data]="data" [columnMenu]="true">
12269
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
12270
- * <kendo-grid-columnmenu-chooser [service]="service">
12271
- * </kendo-grid-columnmenu-chooser>
12272
- * </ng-template>
12273
- * <kendo-grid-column field="Field1"></kendo-grid-column>
12274
- * <kendo-grid-column field="Field2" [hidden]="true"></kendo-grid-column>
12275
- * </kendo-grid>
12276
- * `
12277
- * })
12278
- *
12279
- * class AppComponent {
12280
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
12281
- * }
12282
- *
11848
+ * ```html
11849
+ * <kendo-grid [columnMenu]="true" ...>
11850
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
11851
+ * <kendo-grid-columnmenu-chooser [service]="service"> </kendo-grid-columnmenu-chooser>
11852
+ * </ng-template>
11853
+ * </kendo-grid>
12283
11854
  * ```
12284
11855
  */
12285
11856
  class ColumnMenuChooserComponent extends ColumnMenuItemBase {
@@ -12299,6 +11870,7 @@ class ColumnMenuChooserComponent extends ColumnMenuItemBase {
12299
11870
  this.collapse = new EventEmitter();
12300
11871
  /**
12301
11872
  * Specifies if the content is expanded.
11873
+ * @default false
12302
11874
  */
12303
11875
  this.expanded = false;
12304
11876
  /**
@@ -12407,33 +11979,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12407
11979
  }] } });
12408
11980
 
12409
11981
  /**
12410
- * Represents the component for editing column filters in the Grid that can be placed
12411
- * inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11982
+ * Represents the column-menu item for editing column filters in the Grid. [See example](slug:columnmenu_grid#toc-filter-item).
12412
11983
  *
12413
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12414
- * > the template to the service input of the `kendo-grid-columnmenu-filter` component.
11984
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11985
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11986
+ * the template to the service input of the `kendo-grid-columnmenu-filter` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
12415
11987
  *
12416
11988
  * @example
12417
- * ```ts-preview
12418
- *
12419
- * _@Component({
12420
- * selector: 'my-app',
12421
- * template: `
12422
- * <kendo-grid [kendoGridBinding]="data" [columnMenu]="true">
12423
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
12424
- * <kendo-grid-columnmenu-filter [service]="service">
12425
- * </kendo-grid-columnmenu-filter>
12426
- * </ng-template>
12427
- * <kendo-grid-column field="Field1"></kendo-grid-column>
12428
- * <kendo-grid-column field="Field2"></kendo-grid-column>
12429
- * </kendo-grid>
12430
- * `
12431
- * })
12432
- *
12433
- * class AppComponent {
12434
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
12435
- * }
12436
- *
11989
+ * ```html
11990
+ * <kendo-grid [columnMenu]="true" ...>
11991
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
11992
+ * <kendo-grid-columnmenu-filter [service]="service">
11993
+ * </kendo-grid-columnmenu-filter>
11994
+ * </ng-template>
11995
+ * </kendo-grid>
12437
11996
  * ```
12438
11997
  */
12439
11998
  class ColumnMenuFilterComponent extends ColumnMenuItemBase {
@@ -12451,6 +12010,7 @@ class ColumnMenuFilterComponent extends ColumnMenuItemBase {
12451
12010
  this.collapse = new EventEmitter();
12452
12011
  /**
12453
12012
  * Specifies if the content is expanded.
12013
+ * @default false
12454
12014
  */
12455
12015
  this.expanded = false;
12456
12016
  /**
@@ -12670,34 +12230,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12670
12230
  }] } });
12671
12231
 
12672
12232
  /**
12673
- * Represents a column-menu item for sorting Grid columns that can be placed inside a
12674
- * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
12675
- * Allows the user to sort the column.
12233
+ * Represents the column-menu item for sorting Grid columns.
12234
+ * [See example](slug:columnmenu_grid#toc-sort-item).
12676
12235
  *
12677
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12678
- * > the template to the service input of the `kendo-grid-columnmenu-sort` component.
12236
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
12237
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12238
+ * the template to the service input of the `kendo-grid-columnmenu-sort` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
12679
12239
  *
12680
12240
  * @example
12681
- * ```ts-preview
12682
- *
12683
- * _@Component({
12684
- * selector: 'my-app',
12685
- * template: `
12686
- * <kendo-grid [kendoGridBinding]="data" [sortable]="true" [columnMenu]="true">
12687
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
12688
- * <kendo-grid-columnmenu-sort [service]="service">
12689
- * </kendo-grid-columnmenu-sort>
12690
- * </ng-template>
12691
- * <kendo-grid-column field="Field1" [width]="100"></kendo-grid-column>
12692
- * <kendo-grid-column field="Field2" [width]="100"></kendo-grid-column>
12693
- * </kendo-grid>
12694
- * `
12695
- * })
12696
- *
12697
- * class AppComponent {
12698
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }, { Field1: 'Foo1', Field2: 'Bar1' }];
12699
- * }
12700
- *
12241
+ * ```html
12242
+ * <kendo-grid [kendoGridBinding]="data" [sortable]="true" [columnMenu]="true">
12243
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
12244
+ * <kendo-grid-columnmenu-sort [service]="service">
12245
+ * </kendo-grid-columnmenu-sort>
12246
+ * </ng-template>
12247
+ * </kendo-grid>
12701
12248
  * ```
12702
12249
  */
12703
12250
  class ColumnMenuSortComponent extends ColumnMenuItemBase {
@@ -12781,36 +12328,22 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12781
12328
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }, { type: SortService }, { type: i0.Renderer2 }]; } });
12782
12329
 
12783
12330
  /**
12784
- * Represents the component for resizing the specified column to the minimum possible width so that it fits the header or cell content without wrapping.
12331
+ * 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.
12332
+ * [See example](slug:slug:columnmenu_grid#toc-autosize-column-item).
12785
12333
  * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
12334
+ * [See example](slug:columnmenu_grid#toc-customizing-the-content).
12786
12335
  *
12787
- * > To enable the autosize-column option, set the [`resizable`]({% slug api_grid_gridcomponent %}#toc-resizable)
12788
- * > property of the Grid to `true`.
12789
- *
12790
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) and `column` that are passed by
12791
- * > the template to the `service` and `column` input of the `kendo-grid-columnmenu-autosize-column` component.
12336
+ * You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) and `column` that are passed by
12337
+ * the template to the `service` and `column` input of the `kendo-grid-columnmenu-autosize-column` component.
12792
12338
  *
12793
12339
  * @example
12794
- * ```ts-preview
12795
- *
12796
- * _@Component({
12797
- * selector: 'my-app',
12798
- * template: `
12799
- * <kendo-grid [data]="data" [columnMenu]="true">
12800
- * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
12801
- * <kendo-grid-columnmenu-autosize-column [column]="column" [service]="service">
12802
- * </kendo-grid-columnmenu-autosize-column>
12803
- * </ng-template>
12804
- * <kendo-grid-column field="Field1"></kendo-grid-column>
12805
- * <kendo-grid-column field="Field2"></kendo-grid-column>
12806
- * </kendo-grid>
12807
- * `
12808
- * })
12809
- *
12810
- * class AppComponent {
12811
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
12812
- * }
12813
- *
12340
+ * ```html
12341
+ * <kendo-grid [columnMenu]="true" ...>
12342
+ * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
12343
+ * <kendo-grid-columnmenu-autosize-column [column]="column" [service]="service">
12344
+ * </kendo-grid-columnmenu-autosize-column>
12345
+ * </ng-template>
12346
+ * </kendo-grid>
12814
12347
  * ```
12815
12348
  */
12816
12349
  class ColumnMenuAutoSizeColumnComponent extends ColumnMenuItemBase {
@@ -12861,36 +12394,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12861
12394
  }] } });
12862
12395
 
12863
12396
  /**
12864
- * Represents the component for resizing all columns to the minimum possible width so that they fit the widest header or cell content without wrapping.
12865
- * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
12866
- *
12867
- * > To enable the autosize-all-columns option, set the [`resizable`]({% slug api_grid_gridcomponent %}#toc-resizable)
12868
- * > property of the Grid to `true`.
12397
+ * 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.
12398
+ * [See example](slug:columnmenu_grid#toc-autosize-all-columns-item).
12869
12399
  *
12870
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12871
- * > the template to the `service` input of the `kendo-grid-columnmenu-autosize-all-columns` component.
12400
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
12401
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12402
+ * the template to the `service` input of the `kendo-grid-columnmenu-autosize-all-columns` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
12872
12403
  *
12873
12404
  * @example
12874
- * ```ts-preview
12875
- *
12876
- * _@Component({
12877
- * selector: 'my-app',
12878
- * template: `
12879
- * <kendo-grid [data]="data" [columnMenu]="true">
12880
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
12881
- * <kendo-grid-columnmenu-autosize-all-columns [service]="service">
12882
- * </kendo-grid-columnmenu-autosize-all-columns>
12883
- * </ng-template>
12884
- * <kendo-grid-column field="Field1"></kendo-grid-column>
12885
- * <kendo-grid-column field="Field2"></kendo-grid-column>
12886
- * </kendo-grid>
12887
- * `
12888
- * })
12889
- *
12890
- * class AppComponent {
12891
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
12892
- * }
12893
- *
12405
+ * ```html
12406
+ * <kendo-grid [columnMenu]="true" ...>
12407
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
12408
+ * <kendo-grid-columnmenu-autosize-all-columns [service]="service">
12409
+ * </kendo-grid-columnmenu-autosize-all-columns>
12410
+ * </ng-template>
12411
+ * </kendo-grid>
12894
12412
  * ```
12895
12413
  */
12896
12414
  class ColumnMenuAutoSizeAllColumnsComponent extends ColumnMenuItemBase {
@@ -12938,7 +12456,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12938
12456
 
12939
12457
  const POPUP_CLASS = 'k-grid-columnmenu-popup';
12940
12458
  /**
12941
- * Represents the [column menu]({% slug columnmenu_grid %}) component.
12459
+ * Represents the [column menu](slug:columnmenu_grid#toc-customizing-the-position) component.
12460
+ *
12461
+ * <kendo-grid ...>
12462
+ * <kendo-grid-column field="ProductName" [columnMenu]="false">
12463
+ * <ng-template kendoGridHeaderTemplate let-column>
12464
+ * <kendo-grid-column-menu [column]="column"> </kendo-grid-column-menu>
12465
+ * </ng-template>
12466
+ * </kendo-grid-column>
12467
+ * </kendo-grid>
12942
12468
  */
12943
12469
  class ColumnMenuComponent {
12944
12470
  constructor(navigationService, popupService, localization, service, ctx) {
@@ -13289,6 +12815,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
13289
12815
 
13290
12816
  /**
13291
12817
  * Represents a component which accommodates the filter operators.
12818
+ *
12819
+ * @example
12820
+ * ```html
12821
+ * <kendo-grid [data]="gridData">
12822
+ * <kendo-grid-column field="ProductName">
12823
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
12824
+ * <input />
12825
+ * <kendo-grid-filter-cell-operators
12826
+ * [operators]="[{text: 'Equals', value: 'eq'}]">
12827
+ * </kendo-grid-filter-cell-operators>
12828
+ * </ng-template>
12829
+ * </kendo-grid-column>
12830
+ * <kendo-grid>
12831
+ * ```
13292
12832
  */
13293
12833
  class FilterCellOperatorsComponent {
13294
12834
  constructor(localization, sizing) {
@@ -13307,6 +12847,7 @@ class FilterCellOperatorsComponent {
13307
12847
  /**
13308
12848
  * Determines if the list of operators will be displayed.
13309
12849
  * @type {boolean}
12850
+ * @default true
13310
12851
  */
13311
12852
  this.showOperators = true;
13312
12853
  /**
@@ -13512,36 +13053,35 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
13512
13053
  }] } });
13513
13054
 
13514
13055
  /**
13515
- * Represents a string-filter cell component
13056
+ * Represents a string filter-cell component
13516
13057
  * ([see example]({% slug filter_row %}#toc-hiding-filter-operators)).
13517
13058
  *
13518
13059
  * @example
13519
- *
13520
- * ```html-no-run
13521
- * <kendo-grid-column field="ProductName" title="Product Name">
13522
- * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13523
- * <kendo-grid-string-filter-cell
13524
- * [showOperators]="false"
13525
- * [column]="column"
13526
- * [filter]="filter">
13527
- * </kendo-grid-string-filter-cell>
13528
- * </ng-template>
13529
- * </kendo-grid-column>
13530
- * ```
13060
+ * ```html
13061
+ * <kendo-grid-column field="ProductName" title="Product Name">
13062
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13063
+ * <kendo-grid-string-filter-cell
13064
+ * [column]="column"
13065
+ * [filter]="filter">
13066
+ * </kendo-grid-string-filter-cell>
13067
+ * </ng-template>
13068
+ * </kendo-grid-column>
13069
+ * ```
13531
13070
  */
13532
13071
  class StringFilterCellComponent extends StringFilterComponent {
13533
13072
  constructor(filterService, localization, sizingService) {
13534
13073
  super(filterService, localization);
13535
13074
  /**
13536
13075
  * Determines the delay time (in milliseconds) before the filter value is submitted.
13537
- * A value of `0` indicates no delay. The default value is `500`.
13076
+ * A value of `0` indicates no delay.
13538
13077
  * @type {boolean}
13078
+ * @default 500
13539
13079
  */
13540
13080
  this.filterDelay = 500;
13541
13081
  /**
13542
13082
  * Determines if the drop-down filter operators will be displayed.
13543
- * The default value is `true`.
13544
13083
  * @type {boolean}
13084
+ * @default true
13545
13085
  */
13546
13086
  this.showOperators = true;
13547
13087
  this.subs = sizingService.changes.subscribe((size) => this.size = size);
@@ -13607,19 +13147,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
13607
13147
  }] } });
13608
13148
 
13609
13149
  /**
13610
- * Represents a numeric filter cell.
13150
+ * Represents a numeric filter-cell component.
13151
+ * [See example](slug:filter_row#toc-built-in-filter-row-components).
13611
13152
  *
13612
13153
  * @example
13613
- * ```html-no-run
13614
- * <kendo-grid-column field="ProductName" title="Product Name">
13615
- * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13616
- * <kendo-grid-numeric-filter-cell
13617
- * [column]="column"
13618
- * [filter]="filter">
13619
- * </kendo-grid-numeric-filter-cell>
13620
- * </ng-template>
13621
- * </kendo-grid-column>
13622
- * ```
13154
+ * ```html
13155
+ * <kendo-grid-column field="UnitPrice">
13156
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13157
+ * <kendo-grid-numeric-filter-cell
13158
+ * [column]="column"
13159
+ * [filter]="filter">
13160
+ * </kendo-grid-numeric-filter-cell>
13161
+ * </ng-template>
13162
+ * </kendo-grid-column>
13163
+ * ```
13623
13164
  */
13624
13165
  class NumericFilterCellComponent extends NumericFilterComponent {
13625
13166
  constructor(filterService, localization, sizingService) {
@@ -13629,12 +13170,14 @@ class NumericFilterCellComponent extends NumericFilterComponent {
13629
13170
  * Determines the delay time (in milliseconds) before the filter value is submitted.
13630
13171
  * A value of `0` indicates no delay. The default value is `500`.
13631
13172
  * @type {boolean}
13173
+ * @default 500
13632
13174
  */
13633
13175
  this.filterDelay = 500;
13634
13176
  /**
13635
13177
  * Determines if the drop-down filter operators will be displayed.
13636
13178
  * The default value is `true`.
13637
13179
  * @type {boolean}
13180
+ * @default true
13638
13181
  */
13639
13182
  this.showOperators = true;
13640
13183
  this.subs = sizingService.changes.subscribe((size) => this.size = size);
@@ -13733,19 +13276,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
13733
13276
 
13734
13277
  /**
13735
13278
  * Represents a Boolean filter-cell component.
13279
+ * [See example](slug:filter_row#toc-built-in-filter-row-components).
13736
13280
  *
13737
13281
  * @example
13738
13282
  *
13739
- * ```html-no-run
13740
- * <kendo-grid-column field="ProductName" title="Product Name">
13741
- * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13742
- * <kendo-grid-boolean-filter-cell
13743
- * [column]="column"
13744
- * [filter]="filter">
13745
- * </kendo-grid-boolean-filter-cell>
13746
- * </ng-template>
13747
- * </kendo-grid-column>
13748
- * ```
13283
+ * ```html
13284
+ * <kendo-grid-column field="Discontinued">
13285
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13286
+ * <kendo-grid-boolean-filter-cell
13287
+ * [column]="column"
13288
+ * [filter]="filter">
13289
+ * </kendo-grid-boolean-filter-cell>
13290
+ * </ng-template>
13291
+ * </kendo-grid-column>
13292
+ * ```
13749
13293
  */
13750
13294
  class BooleanFilterCellComponent extends BooleanFilterComponent {
13751
13295
  constructor(filterService, localization, cd, sizingService) {
@@ -13824,29 +13368,42 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
13824
13368
  }], ctorParameters: function () { return [{ type: FilterService }, { type: i1.LocalizationService }, { type: i0.ChangeDetectorRef }, { type: SizingOptionsService }]; } });
13825
13369
 
13826
13370
  /**
13827
- * Represents a date-filter cell component.
13371
+ * Represents a [DatePicker](slug:overview_datepicker) filter-cell component.
13828
13372
  *
13829
13373
  * @example
13830
13374
  *
13831
- * ```html-no-run
13832
- * <kendo-grid-column field="OrderDate" title="Order Date">
13833
- * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13834
- * <kendo-grid-date-filter-cell
13835
- * [showOperators]="false"
13836
- * [column]="column"
13837
- * [filter]="filter">
13838
- * </kendo-grid-date-filter-cell>
13839
- * </ng-template>
13840
- * </kendo-grid-column>
13841
- * ```
13375
+ * ```html
13376
+ * <kendo-grid-column field="FirstOrderedOn">
13377
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13378
+ * <kendo-grid-date-filter-cell
13379
+ * [column]="column"
13380
+ * [filter]="filter">
13381
+ * </kendo-grid-date-filter-cell>
13382
+ * </ng-template>
13383
+ * </kendo-grid-column>
13384
+ * ```
13842
13385
  */
13843
13386
  class DateFilterCellComponent extends DateFilterComponent {
13844
13387
  constructor(filterService, localization, sizingService) {
13845
13388
  super(filterService, localization);
13846
13389
  this.localization = localization;
13847
13390
  /**
13848
- * Determines if the drop-down filter operators will be displayed. The default value is `true`.
13391
+ * Represents a [DatePicker](slug:overview_datepicker) filter-cell component.
13392
+ * [See example](slug:filter_row#toc-built-in-filter-row-components).
13393
+ * @example
13394
+ *
13395
+ * ```html
13396
+ * <kendo-grid-column field="Discontinued">
13397
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13398
+ * <kendo-grid-date-filter-cell
13399
+ * [column]="column"
13400
+ * [filter]="filter">
13401
+ * </kendo-grid-date-filter-cell>
13402
+ * </ng-template>
13403
+ * </kendo-grid-column>
13404
+ * ```
13849
13405
  * @type {boolean}
13406
+ * @default true
13850
13407
  */
13851
13408
  this.showOperators = true;
13852
13409
  this.subs = sizingService.changes.subscribe((size) => this.size = size);
@@ -15899,68 +15456,20 @@ const IGNORE_CONTAINER_CLASSES = 'k-grid k-grid-ignore-click';
15899
15456
 
15900
15457
  /**
15901
15458
  * Represents the command columns of the Grid. You have to define the content of the
15902
- * column inside an `<ng-template>` tag. The template context is set to the current
15903
- * data item. For more information and examples on using the passed fields
15904
- * and the command directives, refer to the article on
15905
- * [editing the Grid in Angular Reactive Forms]({% slug inline_editing_grid %}#toc-using-reactive-forms).
15906
- *
15907
- * The following additional fields are passed:
15908
- * - `columnIndex`&mdash;The current column index.
15909
- * - `rowIndex`&mdash;The current data row index. If inside a new item row, `rowIndex`is `-1`.
15910
- * - `dataItem`&mdash;The current data item.
15911
- * - `column`&mdash;The current column instance.
15912
- * - `isNew`&mdash;The state of the current item.
15913
- *
15914
- * Usually, the template contains CRUD command directives such as:
15915
- * - [EditCommandDirective]({% slug api_grid_editcommanddirective %})
15916
- * - [RemoveCommandDirective]({% slug api_grid_removecommanddirective %})
15917
- * - [CancelCommandDirective]({% slug api_grid_cancelcommanddirective %})
15918
- * - [SaveCommandDirective]({% slug api_grid_savecommanddirective %})
15459
+ * column inside an `<ng-template>` tag.
15460
+ * For more information and examples, refer to the [Command Column Directives](slug:editing_directives_grid#toc-command-column-directives) article.
15919
15461
  *
15920
15462
  * @example
15921
- * ```ts-preview
15922
- *
15923
- * _@Component({
15924
- * selector: 'my-app',
15925
- * template: `
15926
- * <kendo-grid [data]="gridData">
15927
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
15928
- * </kendo-grid-column>
15929
- * <kendo-grid-column field="ProductName" title="Product Name">
15930
- * </kendo-grid-column>
15931
- * <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
15932
- * </kendo-grid-column>
15933
- * <kendo-grid-command-column title="command" [width]="220">
15934
- * <ng-template kendoGridCellTemplate>
15935
- * <button kendoGridEditCommand class="k-primary">Edit</button>
15936
- * <button kendoGridRemoveCommand>Remove</button>
15937
- * </ng-template>
15938
- * </kendo-grid-command-column>
15939
- * </kendo-grid>
15940
- * `
15941
- * })
15942
- *
15943
- * class AppComponent {
15944
- * public gridData: any[];
15945
- *
15946
- * constructor() {
15947
- * this.gridData = products;
15948
- * }
15949
- * }
15950
- *
15951
- * const products = [{
15952
- * "ProductID": 1,
15953
- * "ProductName": "Chai",
15954
- * "UnitPrice": 18.0000,
15955
- * "Discontinued": true
15956
- * }, {
15957
- * "ProductID": 2,
15958
- * "ProductName": "Chang",
15959
- * "UnitPrice": 19.0000,
15960
- * "Discontinued": false
15961
- * }
15962
- * ];
15963
- *
15463
+ * ```html
15464
+ * <kendo-grid [data]="gridData">
15465
+ * <kendo-grid-column field="ProductID"></kendo-grid-column>
15466
+ * <kendo-grid-command-column title="command" [width]="220">
15467
+ * <ng-template kendoGridCellTemplate>
15468
+ * <button kendoGridEditCommand class="k-primary">Edit</button>
15469
+ * <button kendoGridRemoveCommand>Remove</button>
15470
+ * </ng-template>
15471
+ * </kendo-grid-command-column>
15472
+ * </kendo-grid>
15964
15473
  * ```
15965
15474
  */
15966
15475
  class CommandColumnComponent extends ColumnBase {
@@ -19010,33 +18519,11 @@ const handleExpandCollapseDetailsService = (service, expandEmitter, collapseEmit
19010
18519
  const isInEditedCell = (element, gridElement) => closest(element, matchesClasses('k-grid-edit-cell')) &&
19011
18520
  closest(element, matchesNodeName('kendo-grid')) === gridElement;
19012
18521
  /**
19013
- * Represents the Kendo UI Grid component for Angular.
18522
+ * Represents the Kendo UI for Angular Data Grid component.
19014
18523
  *
19015
18524
  * @example
19016
- * ```ts-preview
19017
- * _@Component({
19018
- * selector: 'my-app',
19019
- * template: `
19020
- * <kendo-grid [data]="gridData">
19021
- * </kendo-grid>
19022
- * `
19023
- * })
19024
- * class AppComponent {
19025
- * public gridData: any[] = products;
19026
- * }
19027
- *
19028
- * const products = [{
19029
- * "ProductID": 1,
19030
- * "ProductName": "Chai",
19031
- * "UnitPrice": 18.0000,
19032
- * "Discontinued": true
19033
- * }, {
19034
- * "ProductID": 2,
19035
- * "ProductName": "Chang",
19036
- * "UnitPrice": 19.0000,
19037
- * "Discontinued": false
19038
- * }
19039
- * ];
18525
+ * ```html
18526
+ * <kendo-grid [data]="gridData"></kendo-grid>
19040
18527
  * ```
19041
18528
  */
19042
18529
  class GridComponent {
@@ -19072,64 +18559,25 @@ class GridComponent {
19072
18559
  /**
19073
18560
  * Defines the scroll mode used by the Grid.
19074
18561
  *
19075
- * The available options are:
19076
- * - `none`&mdash;Renders no scrollbar.
19077
- * - `scrollable`&mdash;The default scroll mode. It requires the setting of the `height` option.
19078
- * - `virtual`&mdash;Displays no pager and renders a portion of the data (optimized rendering) while the user is scrolling the content.
18562
+ * @default 'scrollable'
19079
18563
  */
19080
18564
  this.scrollable = 'scrollable';
19081
18565
  /**
19082
- * Enables the single-row [selection]({% slug selection_grid %}) of the Grid.
18566
+ * Enables the [single-row selection](slug:grid_row_selection) of the Grid.
18567
+ *
18568
+ * @default false
19083
18569
  */
19084
18570
  this.selectable = false;
19085
18571
  /**
19086
18572
  * A function that defines how to track changes for the data rows.
19087
- *
19088
18573
  * By default, the Grid tracks changes by the index of the data item.
19089
18574
  * Edited rows are tracked by reference.
19090
- * In some cases, you might need to override the default behavior,
19091
- * for example, when you implement editing with immutable data items.
19092
- *
19093
- * The following example demonstrates how to track items only by index.
19094
- *
19095
- * @example
19096
- * ```ts
19097
- * import { Component } from '@angular/core';
19098
- * import { GridItem } from '@progress/kendo-angular-grid';
19099
- *
19100
- * _@Component({
19101
- * selector: 'my-app',
19102
- * template: `
19103
- * <kendo-grid [data]="gridData" [trackBy]="trackBy">
19104
- * </kendo-grid>
19105
- * `
19106
- * })
19107
- * class AppComponent {
19108
- * public gridData: any[] = products;
19109
- *
19110
- * public trackBy(index: number, item: GridItem): any {
19111
- * console.log(item);
19112
- * return index;
19113
- * }
19114
- * }
19115
- *
19116
- * const products = [{
19117
- * "ProductID": 1,
19118
- * "ProductName": "Chai",
19119
- * "UnitPrice": 18.0000,
19120
- * "Discontinued": true
19121
- * }, {
19122
- * "ProductID": 2,
19123
- * "ProductName": "Chang",
19124
- * "UnitPrice": 19.0000,
19125
- * "Discontinued": false
19126
- * }
19127
- * ];
19128
- * ```
18575
+ * [See exmpale](slug:track_changes_grid)
19129
18576
  */
19130
18577
  this.trackBy = defaultTrackBy;
19131
18578
  /**
19132
18579
  * If set to `true`, the grid will render only the columns in the current viewport.
18580
+ * @default false
19133
18581
  */
19134
18582
  this.virtualColumns = false;
19135
18583
  /**
@@ -19138,35 +18586,31 @@ class GridComponent {
19138
18586
  this.gridData = () => { return this.flatData; };
19139
18587
  /**
19140
18588
  * Enables the [filtering]({% slug filtering_grid %}) of the Grid columns that have their `field` option set.
18589
+ * @default false
19141
18590
  */
19142
18591
  this.filterable = false;
19143
18592
  /**
19144
18593
  * Enables the [sorting]({% slug sorting_grid %}) of the Grid columns that have their `field` option set.
18594
+ * @default false
19145
18595
  */
19146
18596
  this.sortable = false;
19147
18597
  /**
19148
- * Configures the pager of the Grid ([see example]({% slug paging_grid %})).
19149
- *
19150
- * The available options are:
19151
- * - `buttonCount: Number`&mdash;Sets the maximum numeric buttons count before the buttons are collapsed. Defaults to `10`.
19152
- * - `info: Boolean`&mdash;Toggles the information about the current page and the total number of records. Defaults to `true`.
19153
- * - `type: PagerType`&mdash;Accepts the `numeric` (buttons with numbers) and `input` (input for typing the page number) values. Defaults to `'numeric'`.
19154
- * - `pageSizes: Boolean` or `Array<number>`&mdash;Shows a menu for selecting the page size. Defaults to `false`.
19155
- * - `previousNext: Boolean`&mdash;Toggles the **Previous** and **Next** buttons. Defaults to `true`.
19156
- * - `responsive: Boolean`&mdash;Toggles the built-in responsive behavior of the Pager. Defaults to `true`.
18598
+ * Configures the pager of the Grid ([see example](slug:paging_grid_settings)).
18599
+ * @default false
19157
18600
  */
19158
18601
  this.pageable = false;
19159
18602
  /**
19160
- * If set to `true`, the user can group the Grid by dragging the column header cells.
19161
- * By default, grouping is disabled ([see example]({% slug grouping_grid %})).
18603
+ * If set to `true`, the user can group the Grid by dragging the column header cells ([see example]({% slug grouping_grid %})).
18604
+ * @default false
19162
18605
  */
19163
18606
  this.groupable = false;
19164
18607
  /**
19165
18608
  * Indicates whether the Grid columns will be resized during initialization so that
19166
- * they fit their headers and row content. Defaults to `false`.
18609
+ * they fit their headers and row content.
19167
18610
  * Columns with `autoSize` set to `false` are excluded.
19168
18611
  * To dynamically update the column width to match the new content,
19169
18612
  * refer to [this example]({% slug resizing_columns_grid %}).
18613
+ * @default false
19170
18614
  */
19171
18615
  this.autoSize = false;
19172
18616
  /**
@@ -19191,8 +18635,8 @@ class GridComponent {
19191
18635
  this.columnMenu = false;
19192
18636
  /**
19193
18637
  * Specifies if the header of the grid will be hidden. The header is visible by default.
19194
- *
19195
- * > The header includes column headers and the [filter row]({% slug filtering_grid %}#toc-filter-row).
18638
+ * The header includes column headers and the [filter row](slug:filter_row).
18639
+ * @default false
19196
18640
  */
19197
18641
  this.hideHeader = false;
19198
18642
  /**
@@ -19504,7 +18948,7 @@ class GridComponent {
19504
18948
  return this.selectionService.enableMarquee || this.cellSelectionService.enableMarquee;
19505
18949
  }
19506
18950
  /**
19507
- * Enables the [row reordering]({% slug ToDo %}) of the Grid.
18951
+ * Enables the [row reordering]({% slug reordering_rows_grid %}) of the Grid.
19508
18952
  * @default false
19509
18953
  */
19510
18954
  set rowReorderable(value) {
@@ -19554,49 +18998,8 @@ class GridComponent {
19554
18998
  return this.navigable;
19555
18999
  }
19556
19000
  /**
19557
- * Defines a function that is executed for every data row in the component.
19558
- *
19559
- * @example
19560
- * ```ts
19561
- * import { Component, ViewEncapsulation } from '@angular/core';
19562
- * import { RowClassArgs } from '@progress/kendo-angular-grid';
19563
- *
19564
- * _@Component({
19565
- * selector: 'my-app',
19566
- * encapsulation: ViewEncapsulation.None,
19567
- * styles: [`
19568
- * .k-grid tr.even { background-color: #f45c42; }
19569
- * .k-grid tr.odd { background-color: #41f4df; }
19570
- * `],
19571
- * template: `
19572
- * <kendo-grid [data]="gridData" [rowClass]="rowCallback">
19573
- * </kendo-grid>
19574
- * `
19575
- * })
19576
- * class AppComponent {
19577
- * public gridData: any[] = products;
19578
- *
19579
- * public rowCallback(context: RowClassArgs) {
19580
- * const isEven = context.index % 2 === 0;
19581
- * return {
19582
- * even: isEven,
19583
- * odd: !isEven
19584
- * };
19585
- * }
19586
- * }
19587
- *
19588
- * const products = [{
19589
- * "ProductID": 1,
19590
- * "ProductName": "Chai",
19591
- * "UnitPrice": 18.0000,
19592
- * "Discontinued": true
19593
- * }, {
19594
- * "ProductID": 2,
19595
- * "ProductName": "Chang",
19596
- * "UnitPrice": 19.0000,
19597
- * "Discontinued": false
19598
- * }
19599
- * ];
19001
+ * Defines a function that is executed for every data row in the component
19002
+ * ([see example](slug:styling_grid_rows)).
19600
19003
  * ```
19601
19004
  */
19602
19005
  set rowClass(fn) {
@@ -19898,9 +19301,9 @@ class GridComponent {
19898
19301
  * This method is provided only for backwards-compatibility with legacy versions.
19899
19302
  * These versions tracked the expanded group state internally using the hierarchical group index.
19900
19303
  *
19901
- * > * When you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive,
19902
- * > the `expandGroup` method is not supported.
19903
- * > * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
19304
+ * The `expandGroup` method is not supported when you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive.
19305
+ *
19306
+ * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
19904
19307
  *
19905
19308
  * @param {string} index - The underscore separated hierarchical index of the group.
19906
19309
  */
@@ -19914,9 +19317,9 @@ class GridComponent {
19914
19317
  * This method is provided only for backwards-compatibility with legacy versions.
19915
19318
  * These versions tracked the expanded group state internally using the hierarchical group index.
19916
19319
  *
19917
- * > * When you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive,
19918
- * > the `collapseGroup` method is not supported.
19919
- * > * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
19320
+ * The `collapseGroup` method is not supported when you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive.
19321
+ *
19322
+ * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
19920
19323
  *
19921
19324
  * @param {string} index - The underscore separated hierarchical index of the group.
19922
19325
  */
@@ -20175,7 +19578,7 @@ class GridComponent {
20175
19578
  this.focusEditElement('.k-grid-add-row');
20176
19579
  }
20177
19580
  /**
20178
- * Puts the cell that is specified by the table row and column in edit mode.
19581
+ * Puts the cell that is specified by the table row and column in edit mode ([see example](slug:editing_incell_grid)).
20179
19582
  *
20180
19583
  * @param {number} rowIndex - The data row index that will be switched in the edit mode.
20181
19584
  * @param {number|string|any} column - The leaf column index, or the field name or the column instance that should be edited.
@@ -20230,7 +19633,7 @@ class GridComponent {
20230
19633
  * Exports the Grid element to a Drawing [Group]({% slug api_kendo-drawing_group %}) by using the `kendo-grid-pdf` component options.
20231
19634
  * ([see example]({% slug pdfexport_grid %}#toc-exporting-multiple-grids-to-the-same-pdf)).
20232
19635
  *
20233
- * @return {Promise} - A promise that will be resolved with the Drawing `Group`.
19636
+ * @return {Promise} A promise that will be resolved with the Drawing `Group`.
20234
19637
  */
20235
19638
  drawPDF() {
20236
19639
  const promise = createPromise();
@@ -20246,138 +19649,19 @@ class GridComponent {
20246
19649
  /**
20247
19650
  * Applies the minimum possible width for the specified column,
20248
19651
  * so that the whole text fits without wrapping. This method expects the Grid
20249
- * to be resizable (set `resizable` to `true`).
20250
- * Makes sense to execute this method only
19652
+ * to be [resizable](slug:resizing_columns_grid). The method must be executed
20251
19653
  * after the Grid is already populated with data.
20252
- *
20253
- * @example
20254
- * ```ts
20255
- * _@Component({
20256
- * selector: 'my-app',
20257
- * template: `
20258
- * <kendo-grid
20259
- * #grid
20260
- * [data]="gridData"
20261
- * [resizable]="true"
20262
- * style="height: 300px">
20263
- * <ng-template kendoGridToolbarTemplate>
20264
- * <button kendoButton (click)="grid.autoFitColumn(groupColumn)">
20265
- * Auto-fit the group column
20266
- * </button>
20267
- * </ng-template>
20268
- * <kendo-grid-column-group #groupColumn title="Product Info">
20269
- * <kendo-grid-column
20270
- * field="ProductID"
20271
- * [width]="50"
20272
- * [minResizableWidth]="30"
20273
- * title="ID">
20274
- * </kendo-grid-column>
20275
- *
20276
- * <kendo-grid-column
20277
- * field="ProductName"
20278
- * title="Product Name">
20279
- * </kendo-grid-column>
20280
- * </kendo-grid-column-group>
20281
- *
20282
- * <kendo-grid-column
20283
- * field="UnitPrice"
20284
- * title="Unit Price"
20285
- * [width]="180"
20286
- * filter="numeric"
20287
- * format="{0:c}">
20288
- * </kendo-grid-column>
20289
- * </kendo-grid>
20290
- * `
20291
- * })
20292
- * class AppComponent {
20293
- * public gridData: any[] = products;
20294
- * }
20295
- *
20296
- * const products = [{
20297
- * "ProductID": 1,
20298
- * "ProductName": "Chai",
20299
- * "UnitPrice": 18.0000,
20300
- * "Discontinued": true
20301
- * }, {
20302
- * "ProductID": 2,
20303
- * "ProductName": "Chang",
20304
- * "UnitPrice": 19.0000,
20305
- * "Discontinued": false
20306
- * }
20307
- * ];
20308
- * ```
19654
+ * [See example](slug:resizing_columns_grid#toc-auto-fitting-the-content)
20309
19655
  */
20310
19656
  autoFitColumn(column) {
20311
19657
  this.columnResizingService.autoFit(column);
20312
19658
  }
20313
19659
  /**
20314
19660
  * Adjusts the width of the specified columns to fit the entire content, including headers, without wrapping.
20315
- * If no columns are specified, `autoFitColumns` is applied to all columns.
20316
- *
20317
- * This method requires the Grid to be resizable (set `resizable` to `true`).
20318
- *
20319
- * @example
20320
- * ```ts
20321
- * _@Component({
20322
- * selector: 'my-app',
20323
- * template: `
20324
- * <kendo-grid
20325
- * #grid
20326
- * [data]="gridData"
20327
- * [resizable]="true"
20328
- * style="height: 300px">
20329
- * <ng-template kendoGridToolbarTemplate>
20330
- * <button kendoButton (click)="grid.autoFitColumns([firstColumn, lastColumn])">
20331
- * Auto-fit the first and last column
20332
- * </button>
20333
- * <button kendoButton (click)="grid.autoFitColumns()">
20334
- * Auto-fit all columns
20335
- * </button>
20336
- * </ng-template>
20337
- * <kendo-grid-column-group title="Product Info">
20338
- * <kendo-grid-column
20339
- * #firstColumn
20340
- * field="ProductID"
20341
- * [width]="50"
20342
- * [minResizableWidth]="30"
20343
- * title="ID">
20344
- * </kendo-grid-column>
20345
- *
20346
- * <kendo-grid-column
20347
- * field="ProductName"
20348
- * title="Product Name"
20349
- * >
20350
- * </kendo-grid-column>
20351
- * </kendo-grid-column-group>
20352
- *
20353
- * <kendo-grid-column
20354
- * #lastColumn
20355
- * field="UnitPrice"
20356
- * title="Unit Price"
20357
- * [width]="180"
20358
- * filter="numeric"
20359
- * format="{0:c}">
20360
- * </kendo-grid-column>
20361
- * </kendo-grid>
20362
- * `
20363
- * })
20364
- * class AppComponent {
20365
- * public gridData: any[] = products;
20366
- * }
19661
+ * If no columns are specified, `autoFitColumns` is applied to all columns.The method must be executed
19662
+ * after the Grid is already populated with data.
19663
+ * [See example](slug:resizing_columns_grid#toc-auto-fitting-the-content)
20367
19664
  *
20368
- * const products = [{
20369
- * "ProductID": 1,
20370
- * "ProductName": "Chai",
20371
- * "UnitPrice": 18.0000,
20372
- * "Discontinued": true
20373
- * }, {
20374
- * "ProductID": 2,
20375
- * "ProductName": "Chang",
20376
- * "UnitPrice": 19.0000,
20377
- * "Discontinued": false
20378
- * }
20379
- * ];
20380
- * ```
20381
19665
  */
20382
19666
  autoFitColumns(columns = this.columns) {
20383
19667
  let cols;
@@ -20438,10 +19722,10 @@ class GridComponent {
20438
19722
  /**
20439
19723
  * Focuses the cell with the specified row and column index.
20440
19724
  *
20441
- * The row index is based on the logical structure of the Grid and does not correspond to the data item index:
20442
- * * Header rows are included, starting at index 0.
20443
- * * Group headers and footers are included.
20444
- * * The row indexing is absolute and does not change with paging.
19725
+ * The row index is based on the logical structure of the Grid and does not correspond to the data item index.
19726
+ * Header rows are included, starting at index 0.
19727
+ * Group headers and footers are included.
19728
+ * The row indexing is absolute and does not change with paging.
20445
19729
  *
20446
19730
  * If the Grid is configured for scrolling, including virtual scrolling, the scroll position will be updated.
20447
19731
  * If the row is not present on the current page, the method will have no effect.
@@ -20492,67 +19776,6 @@ class GridComponent {
20492
19776
  * @param {number} destIndex - The new position of the column.
20493
19777
  * @param {ColumnReorderConfig} options - Additional options.
20494
19778
  *
20495
- * @example
20496
- * ```ts
20497
- * _@Component({
20498
- * selector: 'my-app',
20499
- * template: `
20500
- * <kendo-grid
20501
- * #grid
20502
- * [data]="gridData"
20503
- * [reorderable]="true"
20504
- * style="height: 300px">
20505
- * <ng-template kendoGridToolbarTemplate>
20506
- * <button kendoButton
20507
- * (click)="grid.reorderColumn(groupColumn, 2, { before: true })">
20508
- * Move the group column before the last one.
20509
- * </button>
20510
- * </ng-template>
20511
- * <kendo-grid-column-group #groupColumn title="Product Info">
20512
- * <kendo-grid-column
20513
- * field="ProductID"
20514
- * [width]="50"
20515
- * title="ID">
20516
- * </kendo-grid-column>
20517
- *
20518
- * <kendo-grid-column
20519
- * field="ProductName"
20520
- * title="Product Name">
20521
- * </kendo-grid-column>
20522
- * </kendo-grid-column-group>
20523
- *
20524
- * <kendo-grid-column
20525
- * field="UnitPrice"
20526
- * title="Unit Price"
20527
- * [width]="180"
20528
- * format="{0:c}">
20529
- * </kendo-grid-column>
20530
- *
20531
- * <kendo-grid-column
20532
- * field="Discontinued"
20533
- * title="Discontinued"
20534
- * [width]="100">
20535
- * </kendo-grid-column>
20536
- * </kendo-grid>
20537
- * `
20538
- * })
20539
- * class AppComponent {
20540
- * public gridData: any[] = products;
20541
- * }
20542
- *
20543
- * const products = [{
20544
- * "ProductID": 1,
20545
- * "ProductName": "Chai",
20546
- * "UnitPrice": 18.0000,
20547
- * "Discontinued": true
20548
- * }, {
20549
- * "ProductID": 2,
20550
- * "ProductName": "Chang",
20551
- * "UnitPrice": 19.0000,
20552
- * "Discontinued": false
20553
- * }
20554
- * ];
20555
- * ```
20556
19779
  */
20557
19780
  reorderColumn(source, destIndex, options = { before: false }) {
20558
19781
  const columnsForLevel = sortColumns(this.allColumnsForLevel(source.level));
@@ -22943,7 +22166,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
22943
22166
 
22944
22167
  /**
22945
22168
  * Custom component messages override default component messages
22946
- * ([see example]({% slug globalization_grid %}#toc-localization)).
22169
+ * ([see example](slug:globalization_grid#toc-custom-messages)).
22947
22170
  */
22948
22171
  class CustomMessagesComponent extends GridMessages {
22949
22172
  constructor(service) {
@@ -23141,11 +22364,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23141
22364
  }] });
23142
22365
 
23143
22366
  /**
23144
- * Represents the `Contains` (**Contains**) filter operator.
23145
- *
23146
- * For more information and examples, refer to:
23147
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23148
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22367
+ * Represents the `Contains` (**Contains**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
22368
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23149
22369
  */
23150
22370
  class ContainsFilterOperatorComponent extends FilterOperatorBase {
23151
22371
  constructor(localization) { super("contains", localization); }
@@ -23172,11 +22392,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23172
22392
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23173
22393
 
23174
22394
  /**
23175
- * Represents the `DoesNotContain` (**Does not contain**) filter operator.
22395
+ * Represents the `DoesNotContain` (**Does not contain**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23176
22396
  *
23177
- * For more information and examples, refer to:
23178
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23179
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22397
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23180
22398
  */
23181
22399
  class DoesNotContainFilterOperatorComponent extends FilterOperatorBase {
23182
22400
  constructor(localization) { super("doesnotcontain", localization); }
@@ -23203,11 +22421,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23203
22421
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23204
22422
 
23205
22423
  /**
23206
- * Represents the `EndsWith` (**Ends with**) string filter operator.
22424
+ * Represents the `EndsWith` (**Ends with**) string filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23207
22425
  *
23208
- * For more information and examples, refer to:
23209
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23210
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22426
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23211
22427
  */
23212
22428
  class EndsWithFilterOperatorComponent extends FilterOperatorBase {
23213
22429
  constructor(localization) { super("endswith", localization); }
@@ -23234,11 +22450,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23234
22450
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23235
22451
 
23236
22452
  /**
23237
- * Represents the `Equal` (**Is equal to**) filter operator.
22453
+ * Represents the `Equal` (**Is equal to**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23238
22454
  *
23239
- * For more information and examples, refer to:
23240
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23241
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22455
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23242
22456
  */
23243
22457
  class EqualFilterOperatorComponent extends FilterOperatorBase {
23244
22458
  constructor(localization) { super("eq", localization); }
@@ -23265,11 +22479,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23265
22479
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23266
22480
 
23267
22481
  /**
23268
- * Represents the `IsEmpty` (**Is empty**) filter operator.
22482
+ * Represents the `IsEmpty` (**Is empty**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23269
22483
  *
23270
- * For more information and examples, refer to:
23271
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23272
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22484
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23273
22485
  */
23274
22486
  class IsEmptyFilterOperatorComponent extends FilterOperatorBase {
23275
22487
  constructor(localization) { super("isempty", localization); }
@@ -23296,11 +22508,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23296
22508
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23297
22509
 
23298
22510
  /**
23299
- * Represents the `IsNotEmpty` (**Is not empty**) filter operator.
22511
+ * Represents the `IsNotEmpty` (**Is not empty**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23300
22512
  *
23301
- * For more information and examples, refer to:
23302
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23303
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22513
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23304
22514
  */
23305
22515
  class IsNotEmptyFilterOperatorComponent extends FilterOperatorBase {
23306
22516
  constructor(localization) { super("isnotempty", localization); }
@@ -23327,11 +22537,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23327
22537
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23328
22538
 
23329
22539
  /**
23330
- * Represents the `IsNotNull` (**Is not null**) filter operator.
22540
+ * Represents the `IsNotNull` (**Is not null**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23331
22541
  *
23332
- * For more information and examples, refer to:
23333
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23334
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22542
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23335
22543
  */
23336
22544
  class IsNotNullFilterOperatorComponent extends FilterOperatorBase {
23337
22545
  constructor(localization) { super("isnotnull", localization); }
@@ -23358,11 +22566,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23358
22566
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23359
22567
 
23360
22568
  /**
23361
- * Represents the `IsNull` (**Is null**) filter operator.
22569
+ * Represents the `IsNull` (**Is null**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23362
22570
  *
23363
- * For more information and examples, refer to:
23364
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23365
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22571
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23366
22572
  */
23367
22573
  class IsNullFilterOperatorComponent extends FilterOperatorBase {
23368
22574
  constructor(localization) { super("isnull", localization); }
@@ -23389,11 +22595,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23389
22595
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23390
22596
 
23391
22597
  /**
23392
- * Represents the `NotEqual` (**Is not equal to**) filter operator.
22598
+ * Represents the `NotEqual` (**Is not equal to**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23393
22599
  *
23394
- * For more information and examples, refer to:
23395
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23396
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22600
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23397
22601
  */
23398
22602
  class NotEqualFilterOperatorComponent extends FilterOperatorBase {
23399
22603
  constructor(localization) { super("neq", localization); }
@@ -23420,11 +22624,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23420
22624
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23421
22625
 
23422
22626
  /**
23423
- * Represents the `StartsWith` (**Starts with**) filter operator.
22627
+ * Represents the `StartsWith` (**Starts with**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23424
22628
  *
23425
- * For more information and examples, refer to:
23426
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23427
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22629
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23428
22630
  */
23429
22631
  class StartsWithFilterOperatorComponent extends FilterOperatorBase {
23430
22632
  constructor(localization) { super("startswith", localization); }
@@ -23450,12 +22652,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23450
22652
  }]
23451
22653
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23452
22654
 
23453
- /*
23454
- * Represents the `Greater` (**Is greater than**) numeric filter operator.
23455
- *
23456
- * For more information and examples, refer to:
23457
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23458
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22655
+ /**
22656
+ * Represents the `Greater` (**Is greater than**) [numeric filter](slug:filtering_grid#toc-numeric-filter) operator.
22657
+ * [See example](slug:filter_row#toc-default-filter-operator).
23459
22658
  */
23460
22659
  class GreaterFilterOperatorComponent extends FilterOperatorBase {
23461
22660
  constructor(localization) { super("gt", localization); }
@@ -23482,11 +22681,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23482
22681
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23483
22682
 
23484
22683
  /**
23485
- * Represents the `GreaterOrEqualTo` (**Is greater than or equal to**) numeric filter operator.
23486
- *
23487
- * For more information and examples, refer to:
23488
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23489
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22684
+ * Represents the `GreaterOrEqualTo` (**Is greater than or equal to**) [numeric filter](slug:filtering_grid#toc-numeric-filter) operator.
22685
+ * [See example](slug:filter_row#toc-default-filter-operator).
23490
22686
  */
23491
22687
  class GreaterOrEqualToFilterOperatorComponent extends FilterOperatorBase {
23492
22688
  constructor(localization) { super("gte", localization); }
@@ -23512,12 +22708,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23512
22708
  }]
23513
22709
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23514
22710
 
23515
- /*
23516
- * Represents the `Less` (**Is less than**) numeric filter operator.
22711
+ /**
22712
+ * Represents the `Less` (**Is less than**) [numeric filter](slug:filtering_grid#toc-numeric-filter) operator.
23517
22713
  *
23518
- * For more information and examples, refer to:
23519
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23520
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22714
+ * [See example](slug:filter_row#toc-default-filter-operator).
23521
22715
  */
23522
22716
  class LessFilterOperatorComponent extends FilterOperatorBase {
23523
22717
  constructor(localization) { super("lt", localization); }
@@ -23543,12 +22737,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23543
22737
  }]
23544
22738
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23545
22739
 
23546
- /*
23547
- * Represents the `LessOrEqualTo` (**Is less than or equal to**) numeric filter operator.
22740
+ /**
22741
+ * Represents the `LessOrEqualTo` (**Is less than or equal to**) [numeric filter](slug:filtering_grid#toc-numeric-filter) operator.
23548
22742
  *
23549
- * For more information and examples, refer to:
23550
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23551
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22743
+ * [See example](slug:filter_row#toc-default-filter-operator).
23552
22744
  */
23553
22745
  class LessOrEqualToFilterOperatorComponent extends FilterOperatorBase {
23554
22746
  constructor(localization) { super("lte", localization); }
@@ -23574,12 +22766,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23574
22766
  }]
23575
22767
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23576
22768
 
23577
- /*
23578
- * Represents the `Greater` (**Is after**) date filter operator.
23579
- *
23580
- * For more information and examples, refer to:
23581
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23582
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22769
+ /**
22770
+ * Represents the `Greater` (**Is after**) [date filter](slug:filtering_grid#toc-date-filter) operator.
22771
+ * [See example](slug:filter_row#toc-default-filter-operator).
23583
22772
  */
23584
22773
  class AfterFilterOperatorComponent extends FilterOperatorBase {
23585
22774
  constructor(localization) { super("after", localization); }
@@ -23614,12 +22803,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23614
22803
  }]
23615
22804
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23616
22805
 
23617
- /*
23618
- * Represents the `GreaterOrEqualTo` (**Is after or equal to**) date filter operator.
23619
- *
23620
- * For more information and examples, refer to:
23621
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23622
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22806
+ /**
22807
+ * Represents the `GreaterOrEqualTo` (**Is after or equal to**) [date filter](slug:filtering_grid#toc-date-filter) operator.
22808
+ * [See example](slug:filter_row#toc-default-filter-operator).
23623
22809
  */
23624
22810
  class AfterEqFilterOperatorComponent extends FilterOperatorBase {
23625
22811
  constructor(localization) { super("after-eq", localization); }
@@ -23654,12 +22840,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23654
22840
  }]
23655
22841
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23656
22842
 
23657
- /*
23658
- * Represents the `LessOrEqualTo` (**Is before or equal to**) date filter operator.
23659
- *
23660
- * For more information and examples, refer to:
23661
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23662
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22843
+ /**
22844
+ * Represents the `LessOrEqualTo` (**Is before or equal to**) [date filter](slug:filtering_grid#toc-date-filter) operator.
22845
+ * [See example](slug:filter_row#toc-default-filter-operator).
23663
22846
  */
23664
22847
  class BeforeEqFilterOperatorComponent extends FilterOperatorBase {
23665
22848
  constructor(localization) { super("before-eq", localization); }
@@ -23694,12 +22877,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23694
22877
  }]
23695
22878
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23696
22879
 
23697
- /*
23698
- * Represents the `Less then` (**Is before**) date filter operator.
23699
- *
23700
- * For more information and examples, refer to:
23701
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23702
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22880
+ /**
22881
+ * Represents the `Less than` (**Is before**) [date filter](slug:filtering_grid#toc-date-filter) operator.
22882
+ * [See example](slug:filter_row#toc-default-filter-operator).
23703
22883
  */
23704
22884
  class BeforeFilterOperatorComponent extends FilterOperatorBase {
23705
22885
  constructor(localization) { super("before", localization); }
@@ -24139,27 +23319,18 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
24139
23319
  }] });
24140
23320
 
24141
23321
  /**
24142
- * Represents the component for selecting columns in the Grid. To enable the user to show or hide columns,
24143
- * add the component inside a [ToolbarTemplate]({% slug api_grid_toolbartemplatedirective %}) directive.
23322
+ * Represents the component for toggling the visibility of the Grid columns. [See example](slug:columnmenu_grid#toc-using-standalone-column-chooser).
23323
+ * To show and hide the columns without including the column chooser item in the [Column Menu](slug:columnmenu_grid),
23324
+ * add the component inside the [ToolbarTemplate](slug:toolbartemplate_grid) directive.
24144
23325
  *
24145
23326
  * @example
24146
- * ```ts-preview
24147
- * _@Component({
24148
- * selector: 'my-app',
24149
- * template: `
24150
- * <kendo-grid [data]="data">
24151
- * <ng-template kendoGridToolbarTemplate>
24152
- * <kendo-grid-column-chooser></kendo-grid-column-chooser>
24153
- * </ng-template>
24154
- * <kendo-grid-column field="Field1"></kendo-grid-column>
24155
- * <kendo-grid-column field="Field2" [hidden]="true"></kendo-grid-column>
24156
- * </kendo-grid>
24157
- * `
24158
- * })
24159
- *
24160
- * class AppComponent {
24161
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
24162
- * }
23327
+ * ```html
23328
+ * <kendo-grid [data]="data">
23329
+ * <ng-template kendoGridToolbarTemplate>
23330
+ * <kendo-grid-column-chooser></kendo-grid-column-chooser>
23331
+ * </ng-template>
23332
+ * <kendo-grid-column field="ProductID"></kendo-grid-column>
23333
+ * </kendo-grid>
24163
23334
  * ```
24164
23335
  */
24165
23336
  class ColumnChooserComponent {
@@ -24176,10 +23347,14 @@ class ColumnChooserComponent {
24176
23347
  this.columnsIcon = columnsIcon;
24177
23348
  /**
24178
23349
  * Specifies if the changes in the visibility of the column will be immediately applied.
23350
+ *
23351
+ * @default false
24179
23352
  */
24180
23353
  this.autoSync = false;
24181
23354
  /**
24182
23355
  * Specifies if all columns can be hidden.
23356
+ *
23357
+ * @default true
24183
23358
  */
24184
23359
  this.allowHideAll = true;
24185
23360
  }
@@ -24438,65 +23613,14 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
24438
23613
  }] });
24439
23614
 
24440
23615
  /**
24441
- * Represents the checkbox for selecting columns in the Grid. If the column is
24442
- * defined as empty, it renders a default checkbox for row selection.
24443
- * You can also define the content of the column inside an `<ng-template>` tag.
24444
- * The input requires you to include the `SelectionCheckbox` option.
24445
- *
24446
- * The template context is set to the current data item and the following additional fields are passed:
24447
- * - `columnIndex`&mdash;The current column index.
24448
- * - `rowIndex`&mdash;The current data row index. If inside a new item row, it will be `-1`.
24449
- * - `dataItem`&mdash;The current data item.
24450
- * - `column`&mdash;The current column instance.
24451
- * - `isNew`&mdash;The state of the current item.
24452
- *
24453
- * For more examples, refer to:
24454
- * - [Selecting or deselecting all items on a page]({% slug selection_grid %}#toc-select-all-feature)
24455
- * - [Persisting the selection]({% slug selection_grid %}#toc-in-combination-with-the-select-all-feature)
23616
+ * Represents the checkbox column for selecting rows in the Grid. [See example](slug:grid_row_selection#toc-select-all-checkbox).
24456
23617
  *
24457
23618
  * @example
24458
- * ```ts-preview
24459
- *
24460
- * _@Component({
24461
- * selector: 'my-app',
24462
- * template: `
24463
- * <kendo-grid [data]="gridData" [selectable]="{enabled: true, checkboxOnly: true}">
24464
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
24465
- * </kendo-grid-column>
24466
- * <kendo-grid-column field="ProductName" title="Product Name">
24467
- * </kendo-grid-column>
24468
- * <kendo-grid-checkbox-column title="Default checkbox">
24469
- * </kendo-grid-checkbox-column>
24470
- * <kendo-grid-checkbox-column title="Custom checkbox">
24471
- * <ng-template kendoGridCellTemplate let-idx="rowIndex">
24472
- * Select row <input [kendoGridSelectionCheckbox]="idx" />
24473
- * </ng-template>
24474
- * </kendo-grid-checkbox-column>
24475
- * </kendo-grid>
24476
- * `
24477
- * })
24478
- *
24479
- * class AppComponent {
24480
- * public gridData: any[];
24481
- *
24482
- * constructor() {
24483
- * this.gridData = products;
24484
- * }
24485
- * }
24486
- *
24487
- * const products = [{
24488
- * "ProductID": 1,
24489
- * "ProductName": "Chai",
24490
- * "UnitPrice": 18.0000,
24491
- * "Discontinued": true
24492
- * }, {
24493
- * "ProductID": 2,
24494
- * "ProductName": "Chang",
24495
- * "UnitPrice": 19.0000,
24496
- * "Discontinued": false
24497
- * }
24498
- * ];
24499
- *
23619
+ * ```hmtl
23620
+ * <kendo-grid [selectable]="{enabled: true, checkboxOnly: true}">
23621
+ * <kendo-grid-checkbox-column title="Default checkbox"></kendo-grid-checkbox-column>
23622
+ * <kendo-grid-column field="ProductID"></kendo-grid-column>
23623
+ * </kendo-grid>
24500
23624
  * ```
24501
23625
  */
24502
23626
  class CheckboxColumnComponent extends ColumnBase {
@@ -25013,7 +24137,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
25013
24137
  }] } });
25014
24138
 
25015
24139
  /**
25016
- * Represents the drag handle for reordering rows in the Grid.
24140
+ * Represents the drag handle for reordering rows in the Grid ([see example](slug:reordering_rows_grid))
25017
24141
  */
25018
24142
  class RowReorderColumnComponent extends ColumnBase {
25019
24143
  constructor(parent, idService) {
@@ -25931,29 +25055,19 @@ const declarations$2 = [
25931
25055
  *
25932
25056
  * @example
25933
25057
  *
25934
- * ```ts-no-run
25935
- * // Import the Grid module
25936
- * import { GridModule } from '@progress/kendo-angular-grid';
25937
- *
25938
- * // The browser platform with a compiler
25939
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
25940
- *
25058
+ * ```ts
25941
25059
  * import { NgModule } from '@angular/core';
25942
- *
25943
- * // Import the app component
25060
+ * import { GridModule } from '@progress/kendo-angular-grid';
25061
+ * import { BrowserModule } from "@angular/platform-browser";
25944
25062
  * import { AppComponent } from './app.component';
25945
25063
  *
25946
- * // Define the app module
25947
- * _@NgModule({
25948
- * declarations: [AppComponent], // declare app component
25949
- * imports: [BrowserModule, GridModule], // import Grid module
25064
+ * @NgModule({
25065
+ * declarations: [AppComponent],
25066
+ * imports: [BrowserModule, GridModule],
25950
25067
  * bootstrap: [AppComponent]
25951
25068
  * })
25952
25069
  * export class AppModule {}
25953
25070
  *
25954
- * // Compile and launch the module
25955
- * platformBrowserDynamic().bootstrapModule(AppModule);
25956
- *
25957
25071
  * ```
25958
25072
  */
25959
25073
  class GridModule {
@@ -26036,6 +25150,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
26036
25150
  }]
26037
25151
  }] });
26038
25152
 
25153
+ /**
25154
+ * Represents the Kendo UI PDFMargin component for Angular.
25155
+ * The supported units are:
25156
+ * `"mm"`
25157
+ * `"cm"`
25158
+ * `"in"`
25159
+ * `"pt"` (default).
25160
+ * Numbers are considered to be points (`"pt"`).
25161
+ */
26039
25162
  class PDFMarginComponent extends PDFExportMarginComponent {
26040
25163
  }
26041
25164
  PDFMarginComponent.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "13.3.12", ngImport: i0, type: PDFMarginComponent, deps: null, target: i0.ɵɵFactoryTarget.Component });
@@ -26573,28 +25696,19 @@ const declarations$1 = [
26573
25696
  *
26574
25697
  * @example
26575
25698
  *
26576
- * ```ts-no-run
26577
- * // Import the Grid and PDF modules
26578
- * import { GridModule, PDFModule } from '@progress/kendo-angular-grid';
26579
- *
26580
- * // The browser platform with a compiler
26581
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
26582
- *
25699
+ * ```ts
26583
25700
  * import { NgModule } from '@angular/core';
26584
- *
26585
- * // Import the app component
25701
+ * import { BrowserModule } from "@angular/platform-browser";
25702
+ * import { GridModule, PDFModule } from '@progress/kendo-angular-grid';
26586
25703
  * import { AppComponent } from './app.component';
26587
25704
  *
26588
- * // Define the app module
26589
- * _@NgModule({
26590
- * declarations: [AppComponent], // declare app component
26591
- * imports: [BrowserModule, GridModule, PDFModule], // import Grid and PDF modules
25705
+ * @NgModule({
25706
+ * declarations: [AppComponent],
25707
+ * imports: [BrowserModule, GridModule, PDFModule],
26592
25708
  * bootstrap: [AppComponent]
26593
25709
  * })
26594
- * export class AppModule {}
26595
25710
  *
26596
- * // Compile and launch the module
26597
- * platformBrowserDynamic().bootstrapModule(AppModule);
25711
+ * export class AppModule {}
26598
25712
  *
26599
25713
  * ```
26600
25714
  */
@@ -26854,29 +25968,19 @@ const declarations = [ExcelComponent, ExcelCommandDirective];
26854
25968
  *
26855
25969
  * @example
26856
25970
  *
26857
- * ```ts-no-run
26858
- * // Import the Grid and Excel modules
26859
- * import { GridModule, ExcelModule } from '@progress/kendo-angular-grid';
26860
- *
26861
- * // The browser platform with a compiler
26862
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
26863
- *
25971
+ * ```ts
26864
25972
  * import { NgModule } from '@angular/core';
26865
- *
26866
- * // Import the app component
25973
+ * import { BrowserModule } from "@angular/platform-browser";
25974
+ * import { GridModule, ExcelModule } from '@progress/kendo-angular-grid';
26867
25975
  * import { AppComponent } from './app.component';
26868
25976
  *
26869
- * // Define the app module
26870
25977
  * _@NgModule({
26871
- * declarations: [AppComponent], // declare app component
26872
- * imports: [BrowserModule, GridModule, ExcelModule], // import Grid and Excel modules
25978
+ * declarations: [AppComponent],
25979
+ * imports: [BrowserModule, GridModule, ExcelModule],
26873
25980
  * bootstrap: [AppComponent]
26874
25981
  * })
26875
25982
  * export class AppModule {}
26876
25983
  *
26877
- * // Compile and launch the module
26878
- * platformBrowserDynamic().bootstrapModule(AppModule);
26879
- *
26880
25984
  * ```
26881
25985
  */
26882
25986
  class ExcelModule {