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

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 (151) hide show
  1. package/column-menu/column-chooser.component.d.ts +14 -19
  2. package/column-menu/column-menu-autosize-all.component.d.ts +15 -27
  3. package/column-menu/column-menu-autosize.component.d.ts +15 -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-resizing/column-resize.interface.d.ts +1 -1
  15. package/columns/checkbox-column.component.d.ts +6 -57
  16. package/columns/column-base.d.ts +2 -0
  17. package/columns/column-group.component.d.ts +9 -48
  18. package/columns/column.component.d.ts +23 -109
  19. package/columns/command-column.component.d.ts +12 -60
  20. package/columns/reorder-column.component.d.ts +1 -1
  21. package/columns/sort-settings.d.ts +4 -8
  22. package/columns/span-column.component.d.ts +12 -123
  23. package/common/cell-click-event-args.interface.d.ts +1 -1
  24. package/data/change-event-args.interface.d.ts +2 -2
  25. package/data/data.collection.d.ts +1 -1
  26. package/dragdrop/column-reorder-config.d.ts +1 -1
  27. package/editing/add-event-args.interface.d.ts +1 -1
  28. package/editing/cancel-event-args.interface.d.ts +1 -1
  29. package/editing/edit-command.directive.d.ts +2 -2
  30. package/editing/edit-event-args.interface.d.ts +1 -1
  31. package/editing/edit-template.directive.d.ts +1 -2
  32. package/editing/remove-event-args.interface.d.ts +1 -1
  33. package/editing/save-event-args.interface.d.ts +1 -1
  34. package/editing-directives/edit-service.interface.d.ts +1 -1
  35. package/esm2020/column-menu/column-chooser.component.mjs +14 -19
  36. package/esm2020/column-menu/column-menu-autosize-all.component.mjs +15 -27
  37. package/esm2020/column-menu/column-menu-autosize.component.mjs +15 -26
  38. package/esm2020/column-menu/column-menu-chooser.component.mjs +11 -24
  39. package/esm2020/column-menu/column-menu-filter.component.mjs +12 -24
  40. package/esm2020/column-menu/column-menu-item.component.mjs +6 -21
  41. package/esm2020/column-menu/column-menu-lock.component.mjs +11 -25
  42. package/esm2020/column-menu/column-menu-position.component.mjs +12 -24
  43. package/esm2020/column-menu/column-menu-sort.component.mjs +12 -25
  44. package/esm2020/column-menu/column-menu-stick.component.mjs +12 -24
  45. package/esm2020/column-menu/column-menu.component.mjs +9 -1
  46. package/esm2020/columns/checkbox-column.component.mjs +6 -57
  47. package/esm2020/columns/column-base.mjs +1 -0
  48. package/esm2020/columns/column-group.component.mjs +9 -48
  49. package/esm2020/columns/column.component.mjs +22 -79
  50. package/esm2020/columns/command-column.component.mjs +12 -60
  51. package/esm2020/columns/reorder-column.component.mjs +1 -1
  52. package/esm2020/columns/span-column.component.mjs +12 -123
  53. package/esm2020/editing/edit-command.directive.mjs +2 -2
  54. package/esm2020/editing/edit-template.directive.mjs +1 -2
  55. package/esm2020/filtering/cell/boolean-filter-cell.component.mjs +11 -10
  56. package/esm2020/filtering/cell/date-filter-cell.component.mjs +26 -13
  57. package/esm2020/filtering/cell/filter-cell-operators.component.mjs +15 -0
  58. package/esm2020/filtering/cell/numeric-filter-cell.component.mjs +14 -11
  59. package/esm2020/filtering/cell/string-filter-cell.component.mjs +14 -15
  60. package/esm2020/filtering/date-filter.component.mjs +6 -2
  61. package/esm2020/filtering/menu/boolean-filter-menu.component.mjs +13 -13
  62. package/esm2020/filtering/menu/date-filter-menu.component.mjs +13 -13
  63. package/esm2020/filtering/menu/numeric-filter-menu.component.mjs +13 -13
  64. package/esm2020/filtering/menu/string-filter-menu.component.mjs +15 -2
  65. package/esm2020/filtering/numeric-filter.component.mjs +4 -1
  66. package/esm2020/filtering/operators/after-eq-filter-operator.component.mjs +3 -6
  67. package/esm2020/filtering/operators/after-filter-operator.component.mjs +3 -6
  68. package/esm2020/filtering/operators/before-eq-filter-operator.component.mjs +3 -6
  69. package/esm2020/filtering/operators/before-filter-operator.component.mjs +3 -6
  70. package/esm2020/filtering/operators/contains-filter-operator.component.mjs +2 -5
  71. package/esm2020/filtering/operators/ends-with-filter-operator.component.mjs +2 -4
  72. package/esm2020/filtering/operators/eq-filter-operator.component.mjs +2 -4
  73. package/esm2020/filtering/operators/gt-filter-operator.component.mjs +3 -6
  74. package/esm2020/filtering/operators/gte-filter-operator.component.mjs +2 -5
  75. package/esm2020/filtering/operators/is-empty-filter-operator.component.mjs +2 -4
  76. package/esm2020/filtering/operators/is-not-empty-filter-operator.component.mjs +2 -4
  77. package/esm2020/filtering/operators/is-not-null-filter-operator.component.mjs +2 -4
  78. package/esm2020/filtering/operators/isnull-filter-operator.component.mjs +2 -4
  79. package/esm2020/filtering/operators/lt-filter-operator.component.mjs +3 -5
  80. package/esm2020/filtering/operators/lte-filter-operator.component.mjs +3 -5
  81. package/esm2020/filtering/operators/neq-filter-operator.component.mjs +2 -4
  82. package/esm2020/filtering/operators/not-contains-filter-operator.component.mjs +2 -4
  83. package/esm2020/filtering/operators/starts-with-filter-operator.component.mjs +2 -4
  84. package/esm2020/filtering/string-filter.component.mjs +2 -1
  85. package/esm2020/grid.component.mjs +38 -325
  86. package/esm2020/localization/custom-messages.component.mjs +1 -1
  87. package/esm2020/package-metadata.mjs +2 -2
  88. package/esm2020/pager/pager-info.component.mjs +1 -1
  89. package/esm2020/pager/pager-input.component.mjs +1 -48
  90. package/esm2020/pager/pager-next-buttons.component.mjs +1 -1
  91. package/esm2020/pager/pager-numeric-buttons.component.mjs +1 -1
  92. package/esm2020/pager/pager-page-sizes.component.mjs +3 -92
  93. package/esm2020/pager/pager-prev-buttons.component.mjs +1 -1
  94. package/esm2020/pdf/pdf-margin.component.mjs +9 -0
  95. package/esm2020/rendering/common/spacer.component.mjs +2 -1
  96. package/excel/excel.component.d.ts +2 -7
  97. package/fesm2015/progress-kendo-angular-grid.mjs +444 -1265
  98. package/fesm2020/progress-kendo-angular-grid.mjs +444 -1265
  99. package/filtering/cell/boolean-filter-cell.component.d.ts +11 -10
  100. package/filtering/cell/date-filter-cell.component.d.ts +26 -13
  101. package/filtering/cell/filter-cell-operators.component.d.ts +15 -0
  102. package/filtering/cell/numeric-filter-cell.component.d.ts +14 -11
  103. package/filtering/cell/string-filter-cell.component.d.ts +14 -15
  104. package/filtering/date-filter.component.d.ts +8 -12
  105. package/filtering/menu/boolean-filter-menu.component.d.ts +13 -13
  106. package/filtering/menu/date-filter-menu.component.d.ts +13 -13
  107. package/filtering/menu/numeric-filter-menu.component.d.ts +13 -13
  108. package/filtering/menu/string-filter-menu.component.d.ts +15 -2
  109. package/filtering/numeric-filter.component.d.ts +4 -1
  110. package/filtering/operators/after-eq-filter-operator.component.d.ts +4 -0
  111. package/filtering/operators/after-filter-operator.component.d.ts +4 -0
  112. package/filtering/operators/before-eq-filter-operator.component.d.ts +4 -0
  113. package/filtering/operators/before-filter-operator.component.d.ts +4 -0
  114. package/filtering/operators/contains-filter-operator.component.d.ts +2 -5
  115. package/filtering/operators/ends-with-filter-operator.component.d.ts +2 -4
  116. package/filtering/operators/eq-filter-operator.component.d.ts +2 -4
  117. package/filtering/operators/gt-filter-operator.component.d.ts +4 -0
  118. package/filtering/operators/gte-filter-operator.component.d.ts +2 -5
  119. package/filtering/operators/is-empty-filter-operator.component.d.ts +2 -4
  120. package/filtering/operators/is-not-empty-filter-operator.component.d.ts +2 -4
  121. package/filtering/operators/is-not-null-filter-operator.component.d.ts +2 -4
  122. package/filtering/operators/isnull-filter-operator.component.d.ts +2 -4
  123. package/filtering/operators/lt-filter-operator.component.d.ts +5 -0
  124. package/filtering/operators/lte-filter-operator.component.d.ts +5 -0
  125. package/filtering/operators/neq-filter-operator.component.d.ts +2 -4
  126. package/filtering/operators/not-contains-filter-operator.component.d.ts +2 -4
  127. package/filtering/operators/starts-with-filter-operator.component.d.ts +2 -4
  128. package/filtering/string-filter.component.d.ts +2 -1
  129. package/grid.component.d.ts +42 -327
  130. package/grouping/group-key.interface.d.ts +1 -13
  131. package/grouping/group-rows-args.interface.d.ts +1 -1
  132. package/localization/custom-messages.component.d.ts +1 -1
  133. package/localization/messages.d.ts +35 -98
  134. package/navigation/navigation-cell.interface.d.ts +2 -5
  135. package/navigation/navigation-row.interface.d.ts +2 -5
  136. package/package.json +19 -19
  137. package/pager/pager-info.component.d.ts +1 -1
  138. package/pager/pager-input.component.d.ts +1 -48
  139. package/pager/pager-next-buttons.component.d.ts +1 -1
  140. package/pager/pager-numeric-buttons.component.d.ts +1 -1
  141. package/pager/pager-page-sizes.component.d.ts +3 -92
  142. package/pager/pager-prev-buttons.component.d.ts +1 -1
  143. package/pager/pager-settings.d.ts +1 -26
  144. package/pdf/pdf-margin.component.d.ts +9 -0
  145. package/pdf/pdf-margin.interface.d.ts +0 -5
  146. package/rendering/common/spacer.component.d.ts +2 -1
  147. package/row-reordering/types.d.ts +1 -1
  148. package/schematics/ngAdd/index.js +2 -2
  149. package/scrolling/content-scroll-event.d.ts +1 -1
  150. package/scrolling/scroll-request.service.d.ts +2 -1
  151. package/selection/types.d.ts +7 -46
@@ -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() {
@@ -2826,8 +2827,8 @@ const packageMetadata = {
2826
2827
  name: '@progress/kendo-angular-grid',
2827
2828
  productName: 'Kendo UI for Angular',
2828
2829
  productCodes: ['KENDOUIANGULAR', 'KENDOUICOMPLETE'],
2829
- publishDate: 1682434440,
2830
- version: '12.0.0',
2830
+ publishDate: 1683098077,
2831
+ version: '12.0.1-develop.2',
2831
2832
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
2832
2833
  };
2833
2834
 
@@ -2953,8 +2954,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
2953
2954
  * tag with the `kendoGridEditTemplate` directive inside a `<kendo-grid-column>` tag.
2954
2955
  *
2955
2956
  * The template context is set to the current form group and the following additional fields are passed:
2956
- * - `formGroup`&mdash;The current [FormGroup](link:site.data.urls.angular['formgroupapi']). Represents the default context that will be assigned to any template variable which utilizes the `let-x` syntax&mdash;for example, `let-formGroup`.
2957
- * If you use the Grid inside [Template-Driven Forms](link:site.data.urls.angular['forms']), it will be `undefined`.
2957
+ * - `formGroup`&mdash;The current [FormGroup](link:site.data.urls.angular['formgroupapi']). Represents the default context that will be assigned to any template variable which utilizes the `let-x` syntax, for example, `let-formGroup`. If you use the Grid inside [Template-Driven Forms](link:site.data.urls.angular['forms']), it will be `undefined`.
2958
2958
  * - `rowIndex`&mdash;The current data row index. If inside a new item row, `rowIndex` is `-1`. Use it as an alias for a template variable by utilizing the `let-rowIndex="rowIndex"` syntax.
2959
2959
  * - `dataItem`&mdash;The current data item. Use it as an alias for a template variable by utilizing the `let-dataItem="dataItem"` syntax.
2960
2960
  * - `column`&mdash;The current column instance. Use it as an alias for a template variable by utilizing the `let-column="column"` syntax.
@@ -3215,6 +3215,7 @@ class ColumnBase {
3215
3215
  this.reorderable = true;
3216
3216
  /**
3217
3217
  * 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)).
3218
+ * The `autoFitColumn` and `autoFitColumns` methods have higher priority.
3218
3219
  * @default 10
3219
3220
  */
3220
3221
  this.minResizableWidth = 10;
@@ -3469,113 +3470,56 @@ function isColumnComponent(column) {
3469
3470
  return isPresent(column.field);
3470
3471
  }
3471
3472
  /**
3472
- * Represents the columns of the [Angular Data Grid]({% slug overview_grid %}).
3473
+ * Represents the column of the Grid. [See example](slug:columns_config#toc-using-the-column-component)
3473
3474
  *
3474
3475
  * @example
3475
- * ```ts-preview
3476
- *
3477
- * _@Component({
3478
- * selector: 'my-app',
3479
- * template: `
3480
- * <kendo-grid [data]="gridData">
3481
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
3482
- * </kendo-grid-column>
3483
- * <kendo-grid-column field="ProductName" title="Product Name">
3484
- * </kendo-grid-column>
3485
- * <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
3486
- * </kendo-grid-column>
3487
- * <kendo-grid-column field="Discontinued" [width]="120">
3488
- * <ng-template kendoGridCellTemplate let-dataItem>
3489
- * <input type="checkbox" [checked]="dataItem.Discontinued" disabled/>
3490
- * </ng-template>
3491
- * </kendo-grid-column>
3492
- * </kendo-grid>
3493
- * `
3494
- * })
3495
- *
3496
- * class AppComponent {
3497
- * public gridData: any[];
3498
- *
3499
- * constructor() {
3500
- * this.gridData = products;
3501
- * }
3502
- * }
3503
- *
3504
- * const products = [{
3505
- * "ProductID": 1,
3506
- * "ProductName": "Chai",
3507
- * "UnitPrice": 18.0000,
3508
- * "Discontinued": true
3509
- * }, {
3510
- * "ProductID": 2,
3511
- * "ProductName": "Chang",
3512
- * "UnitPrice": 19.0000,
3513
- * "Discontinued": false
3514
- * }
3515
- * ];
3516
- *
3476
+ * ```html
3477
+ * <kendo-grid [data]="gridData">
3478
+ * <kendo-grid-column field="ProductID" title="Product ID"></kendo-grid-column>
3479
+ * <kendo-grid-column field="ProductName" title="Product Name"></kendo-grid-column>
3480
+ * <kendo-grid-column field="UnitPrice" title="Unit Price"></kendo-grid-column>
3481
+ * </kendo-grid>
3517
3482
  * ```
3518
3483
  */
3519
3484
  class ColumnComponent extends ColumnBase {
3520
3485
  constructor(parent, idService) {
3521
3486
  super(parent, idService);
3522
3487
  /**
3523
- * Allows the column headers to be clicked and the `sortChange` event emitted.
3524
- * You have to handle the `sortChange` event yourself and sort the data.
3488
+ * Allows the user to click the column headers and emits the `sortChange` event. [See example](slug:sorting_grid).
3489
+ *
3490
+ * @default true
3525
3491
  */
3526
3492
  this.sortable = true;
3527
3493
  /**
3528
- * Determines if the column can be dragged to the group panel. The default value is `true`.
3494
+ * Determines if the column can be dragged to the group panel.
3529
3495
  * If set to `false`, you can group the columns by the column field by using the API of the Grid.
3496
+ *
3497
+ * @default true
3530
3498
  */
3531
3499
  this.groupable = true;
3532
3500
  /**
3533
- * Defines the editor type ([see example]({% slug inline_editing_grid %}#toc-using-reactive-forms)).
3534
- * Used when the column enters the edit mode. The default value is `text`.
3501
+ * Defines the editor type. [See example](slug:inline_editing_grid#toc-using-reactive-forms).
3502
+ * Used when the column enters the edit mode.
3535
3503
  *
3536
- * @example
3537
- * ```html-no-run
3538
- * <kendo-grid>
3539
- * <kendo-grid-column field="UnitPrice" editor="numeric">
3540
- * </kendo-grid-column>
3541
- * </kendo-grid>
3542
- * ```
3504
+ * @default 'text'
3543
3505
  */
3544
3506
  this.editor = 'text';
3545
3507
  /**
3546
- * Defines the filter type that is displayed inside the filter row. The default value is `text`.
3508
+ * Defines the filter type that is displayed inside the filter row. [See example](slug:filtering_grid#toc-filter-data-types).
3547
3509
  *
3548
- * @example
3549
- * ```html-no-run
3550
- * <kendo-grid>
3551
- * <kendo-grid-column field="UnitPrice" filter="numeric">
3552
- * </kendo-grid-column>
3553
- * </kendo-grid>
3554
- * ```
3510
+ * @default 'text'
3555
3511
  */
3556
3512
  this.filter = 'text';
3557
3513
  /**
3558
- * Defines if a filter UI will be displayed for this column. The default value is `true`.
3514
+ * Defines if a filter UI will be displayed for this column. [See example](slug:filtering_grid).
3559
3515
  *
3560
- * @example
3561
- * ```html-no-run
3562
- * <kendo-grid>
3563
- * <kendo-grid-column field="UnitPrice" [filterable]="false">
3564
- * </kendo-grid-column>
3565
- * </kendo-grid>
3566
- * ```
3516
+ * @default true
3567
3517
  */
3568
3518
  this.filterable = true;
3569
3519
  /**
3570
- * Defines whether the column is editable. The default value is `true`.
3520
+ * Defines whether the column is editable. [See example](slug:make_fields_uneditable_grid).
3571
3521
  *
3572
- * @example
3573
- * ```html-no-run
3574
- * <kendo-grid>
3575
- * <kendo-grid-column field="UnitPrice" [editable]="false">
3576
- * </kendo-grid-column>
3577
- * </kendo-grid>
3578
- * ```
3522
+ * @default true
3579
3523
  */
3580
3524
  this.editable = true;
3581
3525
  }
@@ -3684,62 +3628,15 @@ function isSpanColumnComponent(column) {
3684
3628
  * [grouping]({% slug grouping_grid %}). Wrap the columns that will be
3685
3629
  * merged inside the `<kendo-grid-span-column>` tag.
3686
3630
  *
3687
- * @example
3688
- * ```ts-preview
3689
- *
3690
- * _@Component({
3691
- * selector: 'my-app',
3692
- * template: `
3693
- * <kendo-grid
3694
- * [sortable]="true"
3695
- * [filterable]="true"
3696
- * [kendoGridBinding]="products">
3697
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
3698
- * </kendo-grid-column>
3699
- * <kendo-grid-span-column>
3700
- * <kendo-grid-column field="ProductName" title="Product Name">
3701
- * </kendo-grid-column>
3702
- * <kendo-grid-column field="UnitPrice" title="Unit Price" filter="numeric" [width]="180" format="{0:c}">
3703
- * </kendo-grid-column>
3704
- * </kendo-grid-span-column>
3705
- * <kendo-grid-column field="Discontinued" [width]="120" filter="boolean">
3706
- * <ng-template kendoGridCellTemplate let-dataItem>
3707
- * <input type="checkbox" [checked]="dataItem.Discontinued" disabled/>
3708
- * </ng-template>
3709
- * </kendo-grid-column>
3710
- * </kendo-grid>
3711
- * `
3712
- * })
3713
- *
3714
- * class AppComponent {
3715
- * public products = [{
3716
- * "ProductID": 1,
3717
- * "ProductName": "Chai",
3718
- * "UnitPrice": 18.0000,
3719
- * "Discontinued": true
3720
- * }, {
3721
- * "ProductID": 2,
3722
- * "ProductName": "Chang",
3723
- * "UnitPrice": 19.0000,
3724
- * "Discontinued": false
3725
- * }
3726
- * ];
3727
- * }
3728
- *
3729
- * ```
3730
- *
3731
- * By default, the data cell displays the data for the specified fields. To further customize
3732
- * the span-column functionality, use a [cell template]({% slug api_grid_celltemplatedirective %}).
3733
- *
3734
- * ```html-no-run
3631
+ * ```html
3735
3632
  * <kendo-grid-span-column>
3736
- * <kendo-grid-column field="field1" title="Field 1"></kendo-grid-column>
3737
- * <kendo-grid-column field="field2" title="Field 2"></kendo-grid-column>
3738
- * <ng-template kendoGridCellTemplate let-dataItem>
3739
- * <h5>{{ dataItem.field1 }}</h5>
3740
- * <p>{{ dataItem.field2 }}</p>
3741
- * </ng-template>
3742
- * </kendo-grid-span-column>
3633
+ * <kendo-grid-column field="field1"></kendo-grid-column>
3634
+ * <kendo-grid-column field="field2"></kendo-grid-column>
3635
+ * <ng-template kendoGridCellTemplate let-dataItem>
3636
+ * <h5>{{ dataItem.field1 }}</h5>
3637
+ * <p>{{ dataItem.field2 }}</p>
3638
+ * </ng-template>
3639
+ * </kendo-grid-span-column>
3743
3640
  * ```
3744
3641
  */
3745
3642
  class SpanColumnComponent extends ColumnBase {
@@ -3765,24 +3662,9 @@ class SpanColumnComponent extends ColumnBase {
3765
3662
  }
3766
3663
  }
3767
3664
  /**
3768
- * Defines whether the edit template of the column will be rendered. The default value is `false`.
3769
- *
3770
- * > To enable the editing functionality for a spanned column, set an edit template for it.
3771
- *
3772
- * @example
3773
- * ```html-no-run
3774
- * <kendo-grid>
3775
- * <kendo-grid-span-column [editable]="false">
3776
- * <kendo-grid-column field="UnitPrice">
3777
- * </kendo-grid-column>
3778
- * <kendo-grid-column field="ProductName">
3779
- * </kendo-grid-column>
3780
- * <ng-template kendoGridEditTemplate>
3781
- * .....
3782
- * </ng-template>
3783
- * </kendo-grid-span-column>
3784
- * </kendo-grid>
3785
- * ```
3665
+ * Defines whether the edit template of the column will be rendered.
3666
+ * To enable the editing functionality for a spanned column, set an edit template for it ([see exmaple](slug:custom_reactive_editing_grid)).
3667
+ * @default false
3786
3668
  */
3787
3669
  set editable(value) {
3788
3670
  this._editable = value;
@@ -3826,57 +3708,8 @@ class SpanColumnComponent extends ColumnBase {
3826
3708
  return this.childColumns.filter(c => c.isVisible).length;
3827
3709
  }
3828
3710
  /**
3829
- * Toggles the locked (frozen) state of the columns. Locked columns are visible
3830
- * at all times during the horizontal scrolling of the Grid.
3831
- *
3832
- * For the option to work properly, make sure that:
3833
- * - Scrolling is enabled.
3834
- * - The `height` option of the Grid is set.
3835
- * - The widths of all Grid columns are explicitly set in pixels. In this way,
3836
- * the Grid adjusts the layout of the locked and unlocked columns.
3837
- *
3711
+ * Toggles the locked (frozen) state of the columns ([see example](slug:locked_columns_grid)).
3838
3712
  * @default false
3839
- *
3840
- * @example
3841
- * ```ts
3842
- * _@Component({
3843
- * selector: 'my-app',
3844
- * template: `
3845
- * <kendo-grid [data]="gridData" [scrollable]="scrollable" style="height: 200px">
3846
- * <kendo-grid-span-column [locked]="true">
3847
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
3848
- * </kendo-grid-column>
3849
- * <kendo-grid-column field="ProductName" title="Product Name" [width]="200">
3850
- * </kendo-grid-column>
3851
- * </kendo-grid-span-column>
3852
- * <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
3853
- * </kendo-grid-column>
3854
- * </kendo-grid>
3855
- * `
3856
- * })
3857
- *
3858
- * class AppComponent {
3859
- * public gridData: any[];
3860
- *
3861
- * constructor() {
3862
- * this.gridData = products;
3863
- * }
3864
- * }
3865
- *
3866
- * const products = [{
3867
- * "ProductID": 1,
3868
- * "ProductName": "Chai",
3869
- * "UnitPrice": 18.0000,
3870
- * "Discontinued": true
3871
- * }, {
3872
- * "ProductID": 2,
3873
- * "ProductName": "Chang",
3874
- * "UnitPrice": 19.0000,
3875
- * "Discontinued": false
3876
- * }
3877
- * ];
3878
- *
3879
- * ```
3880
3713
  */
3881
3714
  set locked(value) {
3882
3715
  this._locked = value;
@@ -4008,56 +3841,17 @@ function isColumnGroupComponent(column) {
4008
3841
  }
4009
3842
  /**
4010
3843
  * Represents the column group header of the Grid
4011
- * ([more information and examples]({% slug multicolumnheaders_columns_grid %})).
3844
+ * ([more information and examples](slug:multicolumnheaders_columns_grid)).
4012
3845
  *
4013
3846
  * @example
4014
- * ```ts-preview
4015
- *
4016
- * _@Component({
4017
- * selector: 'my-app',
4018
- * template: `
4019
- * <kendo-grid [data]="gridData">
4020
- * <kendo-grid-column-group title="Product Info">
4021
- * <ng-template kendoGridHeaderTemplate let-columnIndex="columnIndex" let-column="column">
4022
- * Column index: {{columnIndex}} / column title: {{column.title}}
4023
- * </ng-template>
4024
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
4025
- * </kendo-grid-column>
4026
- * <kendo-grid-column field="ProductName" title="Product Name">
4027
- * </kendo-grid-column>
4028
- * </kendo-grid-column-group>
4029
- * <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
4030
- * </kendo-grid-column>
4031
- * <kendo-grid-column field="Discontinued" [width]="120">
4032
- * <ng-template kendoGridCellTemplate let-dataItem>
4033
- * <input type="checkbox" [checked]="dataItem.Discontinued" disabled/>
4034
- * </ng-template>
4035
- * </kendo-grid-column>
4036
- * </kendo-grid>
4037
- * `
4038
- * })
4039
- *
4040
- * class AppComponent {
4041
- * public gridData: any[];
4042
- *
4043
- * constructor() {
4044
- * this.gridData = products;
4045
- * }
4046
- * }
4047
- *
4048
- * const products = [{
4049
- * "ProductID": 1,
4050
- * "ProductName": "Chai",
4051
- * "UnitPrice": 18.0000,
4052
- * "Discontinued": true
4053
- * }, {
4054
- * "ProductID": 2,
4055
- * "ProductName": "Chang",
4056
- * "UnitPrice": 19.0000,
4057
- * "Discontinued": false
4058
- * }
4059
- * ];
4060
- *
3847
+ * ```html
3848
+ * <kendo-grid [data]="gridData">
3849
+ * <kendo-grid-column-group title="Product Info">
3850
+ * <kendo-grid-column field="ProductID"></kendo-grid-column>
3851
+ * <kendo-grid-column field="ProductName"></kendo-grid-column>
3852
+ * </kendo-grid-column-group>
3853
+ * <kendo-grid-column field="UnitPrice"></kendo-grid-column>
3854
+ * </kendo-grid>
4061
3855
  * ```
4062
3856
  */
4063
3857
  class ColumnGroupComponent extends ColumnBase {
@@ -6909,7 +6703,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
6909
6703
  }] } });
6910
6704
 
6911
6705
  /**
6912
- * Displays buttons for navigating to the first and to the previous page ([see example]({% slug paging_grid %}#toc-pager-templates)).
6706
+ * Displays buttons for navigating to the first and to the previous page ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
6913
6707
  */
6914
6708
  class PagerPrevButtonsComponent extends PagerElementComponent {
6915
6709
  constructor(localization, pagerContext, cd, navigationService) {
@@ -7011,7 +6805,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
7011
6805
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }, { type: PagerContextService }, { type: i0.ChangeDetectorRef }, { type: NavigationService }]; } });
7012
6806
 
7013
6807
  /**
7014
- * Displays numeric buttons to enable navigation between the pages.
6808
+ * Displays numeric buttons to enable navigation between the pages ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
7015
6809
  */
7016
6810
  class PagerNumericButtonsComponent extends PagerElementComponent {
7017
6811
  constructor(localization, cd, pagerContext) {
@@ -7267,54 +7061,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
7267
7061
  }], ctorParameters: function () { return [{ type: i3.NumericTextBoxComponent }, { type: i0.Renderer2 }]; } });
7268
7062
 
7269
7063
  /**
7270
- * Displays an input element which allows the typing and rendering of page numbers.
7271
- *
7272
- * @example
7273
- * ```ts-preview
7274
- *
7275
- * _@Component({
7276
- * selector: 'my-app',
7277
- * template: `
7278
- * <kendo-grid
7279
- * [kendoGridBinding]="gridData"
7280
- * [pageSize]="1"
7281
- * [pageable]="true"
7282
- * >
7283
- * <kendo-grid-column field="ProductID" title="ID" [width]="40">
7284
- * </kendo-grid-column>
7285
- * <kendo-grid-column field="ProductName" title="Name" [width]="250">
7286
- * </kendo-grid-column>
7287
- * <kendo-grid-column field="UnitPrice" title="Price" [width]="80" format="{0:c}">
7288
- * </kendo-grid-column>
7289
- *
7290
- * <ng-template kendoPagerTemplate let-totalPages="totalPages" let-currentPage="currentPage">
7291
- * <kendo-pager-prev-buttons></kendo-pager-prev-buttons>
7292
- * <kendo-pager-numeric-buttons [buttonCount]="10"></kendo-pager-numeric-buttons>
7293
- * <kendo-pager-next-buttons></kendo-pager-next-buttons>
7294
- * <kendo-pager-input></kendo-pager-input>
7295
- * <kendo-pager-info></kendo-pager-info>
7296
- * </ng-template>
7297
- *
7298
- * </kendo-grid>
7299
- * `
7300
- * })
7301
- *
7302
- * class AppComponent {
7303
- * public gridData = [{
7304
- * "ProductID": 1,
7305
- * "ProductName": "Chai",
7306
- * "UnitPrice": 18.0000,
7307
- * "Discontinued": false
7308
- * }, {
7309
- * "ProductID": 2,
7310
- * "ProductName": "Chang",
7311
- * "UnitPrice": 19.0000,
7312
- * "Discontinued": true
7313
- * }
7314
- * ];
7315
- * }
7316
- *
7317
- * ```
7064
+ * 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)).
7318
7065
  */
7319
7066
  class PagerInputComponent extends PagerElementComponent {
7320
7067
  constructor(localization, pagerContext, zone, navigationService, cd) {
@@ -7438,7 +7185,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
7438
7185
  }] } });
7439
7186
 
7440
7187
  /**
7441
- * Displays buttons for navigating to the next and to the last page ([see example]({% slug paging_grid %}#toc-pager-template)).
7188
+ * Displays buttons for navigating to the next and to the last page ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
7442
7189
  */
7443
7190
  class PagerNextButtonsComponent extends PagerElementComponent {
7444
7191
  constructor(localization, pagerContext, cd, navigationService) {
@@ -7539,7 +7286,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
7539
7286
 
7540
7287
  // eslint-disable no-access-missing-member
7541
7288
  /**
7542
- * Displays information about the current page and the total number of records ([see example]({% slug paging_grid %}#toc-pager-templates)).
7289
+ * Displays information about the current page and the total number of records ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
7543
7290
  */
7544
7291
  class PagerInfoComponent extends PagerElementComponent {
7545
7292
  constructor(localization, cd, pagerContext) {
@@ -7631,7 +7378,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
7631
7378
  }], ctorParameters: function () { return [{ type: i1$4.DropDownListComponent }]; } });
7632
7379
 
7633
7380
  /**
7634
- * Displays a drop-down list for the page size selection ([see example]({% slug paging_grid %}#toc-pager-templates)).
7381
+ * Displays a drop-down list for the page size selection ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
7635
7382
  */
7636
7383
  class PagerPageSizesComponent extends PagerElementComponent {
7637
7384
  constructor(localization, cd, pagerContext, navigationService) {
@@ -7641,97 +7388,8 @@ class PagerPageSizesComponent extends PagerElementComponent {
7641
7388
  this._pageSizes = [];
7642
7389
  }
7643
7390
  /**
7644
- * The page sizes collection. Can be an Array of numbers and/or PageSizeItem objects.
7645
- *
7646
- * @example
7647
- * ```ts-preview
7648
- * _@Component({
7649
- * selector: 'my-app',
7650
- * template: `
7651
- * <kendo-grid [kendoGridBinding]="gridData" [height]="200"
7652
- * [pageable]="true"
7653
- * [pageSize]="pageSize">
7654
- * <ng-template kendoPagerTemplate let-totalPages="totalPages" let-currentPage="currentPage">
7655
- * <kendo-pager-page-sizes [pageSizes]="pagesizes"></kendo-pager-page-sizes>
7656
- * </ng-template>
7657
- * </kendo-grid>
7658
- * `
7659
- * })
7660
- * class AppComponent {
7661
- * public gridData: any[] = products;
7662
- * public pageSize = 2;
7663
- * public pagesizes = [{text: 'One', value: 1}, {text: 'Two', value: 2}, {text: 'All', value : 'all'}];
7664
- * }
7665
- *
7666
- * const products = [{
7667
- * 'ProductID' : 1,
7668
- * 'ProductName' : "Chai",
7669
- * 'SupplierID' : 1,
7670
- * 'CategoryID' : 1,
7671
- * 'QuantityPerUnit' : "10 boxes x 20 bags",
7672
- * 'UnitPrice' : 18.0000,
7673
- * 'UnitsInStock' : 39,
7674
- * 'UnitsOnOrder' : 0,
7675
- * 'ReorderLevel' : 10,
7676
- * 'Discontinued' : false
7677
- *
7678
- * }, {
7679
- * 'ProductID' : 2,
7680
- * 'ProductName' : "Chang",
7681
- * 'SupplierID' : 1,
7682
- * 'CategoryID' : 1,
7683
- * 'QuantityPerUnit' : "24 - 12 oz bottles",
7684
- * 'UnitPrice' : 19.0000,
7685
- * 'UnitsInStock' : 17,
7686
- * 'UnitsOnOrder' : 40,
7687
- * 'ReorderLevel' : 25,
7688
- * 'Discontinued' : false
7689
- * }, {
7690
- * 'ProductID' : 3,
7691
- * 'ProductName' : "Aniseed Syrup",
7692
- * 'SupplierID' : 1,
7693
- * 'CategoryID' : 2,
7694
- * 'QuantityPerUnit' : "12 - 550 ml bottles",
7695
- * 'UnitPrice' : 10.0000,
7696
- * 'UnitsInStock' : 13,
7697
- * 'UnitsOnOrder' : 70,
7698
- * 'ReorderLevel' : 25,
7699
- * 'Discontinued' : false
7700
- * }, {
7701
- * 'ProductID' : 4,
7702
- * 'ProductName' : "Chef Anton\'s Cajun Seasoning",
7703
- * 'SupplierID' : 2,
7704
- * 'CategoryID' : 2,
7705
- * 'QuantityPerUnit' : "48 - 6 oz jars",
7706
- * 'UnitPrice' : 22.0000,
7707
- * 'UnitsInStock' : 53,
7708
- * 'UnitsOnOrder' : 0,
7709
- * 'ReorderLevel' : 0,
7710
- * 'Discontinued' : false
7711
- * }, {
7712
- * 'ProductID' : 5,
7713
- * 'ProductName' : "Chef Anton\'s Gumbo Mix",
7714
- * 'SupplierID' : 2,
7715
- * 'CategoryID' : 2,
7716
- * 'QuantityPerUnit' : "36 boxes",
7717
- * 'UnitPrice' : 21.3500,
7718
- * 'UnitsInStock' : 0,
7719
- * 'UnitsOnOrder' : 0,
7720
- * 'ReorderLevel' : 0,
7721
- * 'Discontinued' : true
7722
- * }, {
7723
- * 'ProductID' : 6,
7724
- * 'ProductName' : "Grandma\'s Boysenberry Spread",
7725
- * 'SupplierID' : 3,
7726
- * 'CategoryID' : 2,
7727
- * 'QuantityPerUnit' : "12 - 8 oz jars",
7728
- * 'UnitPrice' : 25.0000,
7729
- * 'UnitsInStock' : 120,
7730
- * 'UnitsOnOrder' : 0,
7731
- * 'ReorderLevel' : 25,
7732
- * 'Discontinued' : false
7733
- * }];
7734
- * ```
7391
+ * The page sizes collection. Can be an Array of numbers and/or [`PageSizeItem`](slug:api_grid_pagesizeitem) objects
7392
+ * ([see example]({% slug paging_grid %}#toc-pager-templates))
7735
7393
  */
7736
7394
  set pageSizes(pageSizes) {
7737
7395
  let normalizedItems = [];
@@ -9155,8 +8813,9 @@ class StringFilterComponent extends BaseFilterCellComponent {
9155
8813
  super(filterService);
9156
8814
  this.localization = localization;
9157
8815
  /**
9158
- * The default filter operator. Defaults to `contains`.
8816
+ * The default filter operator.
9159
8817
  * @type {string}
8818
+ * @default 'contains'
9160
8819
  */
9161
8820
  this.operator = "contains";
9162
8821
  }
@@ -9620,8 +9279,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
9620
9279
  }] } });
9621
9280
 
9622
9281
  /**
9623
- * Represents a string-filter menu component.
9624
- * ([see example]({% slug filter_menu %}#toc-built-in-filter-menu-components)).
9282
+ * Represents a string-filter menu component
9283
+ * ([see example](slug:filter_menu#toc-built-in-filter-menu-components)).
9284
+ *
9285
+ * ```html
9286
+ * <kendo-grid-column field="ProductName">
9287
+ * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
9288
+ * <kendo-grid-string-filter-menu
9289
+ * [column]="column"
9290
+ * [filter]="filter"
9291
+ * [filterService]="filterService">
9292
+ * </kendo-grid-string-filter-menu>
9293
+ * </ng-template>
9294
+ * </kendo-grid-column>
9295
+ * ```
9625
9296
  */
9626
9297
  class StringFilterMenuComponent extends StringFilterComponent {
9627
9298
  constructor(localization) {
@@ -9634,6 +9305,7 @@ class StringFilterMenuComponent extends StringFilterComponent {
9634
9305
  this.filter = { filters: [], logic: "and" };
9635
9306
  /**
9636
9307
  * Determines if the inputs of second criteria will displayed.
9308
+ * @default true
9637
9309
  */
9638
9310
  this.extra = true;
9639
9311
  }
@@ -9764,18 +9436,21 @@ class NumericFilterComponent extends BaseFilterCellComponent {
9764
9436
  super(filterService);
9765
9437
  this.localization = localization;
9766
9438
  /**
9767
- * The default filter operator. Defaults to `eq`.
9439
+ * The default filter operator.
9768
9440
  * @type {string}
9441
+ * @default 'eq'
9769
9442
  */
9770
9443
  this.operator = "eq";
9771
9444
  /**
9772
9445
  * Specifies the value that is used to increment or decrement the component value.
9773
9446
  * @type {numeric}
9447
+ * @default 1
9774
9448
  */
9775
9449
  this.step = 1;
9776
9450
  /**
9777
9451
  * Specifies whether the **Up** and **Down** spin buttons will be rendered.
9778
9452
  * @type {boolean}
9453
+ * @default true
9779
9454
  */
9780
9455
  this.spinners = true;
9781
9456
  this.defaultOperators = numericOperators(this.localization);
@@ -9988,21 +9663,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
9988
9663
  }] } });
9989
9664
 
9990
9665
  /**
9991
- * Represents a numeric-filter menu component.
9666
+ * Represents a numeric filter-menu component.
9992
9667
  *
9993
9668
  * @example
9994
- * ```html-no-run
9995
- * <kendo-grid-column field="UnitPrice" title="Unit Price">
9996
- * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
9997
- * <kendo-grid-numeric-filter-menu
9998
- * [column]="column"
9999
- * [filter]="filter"
10000
- * [filterService]="filterService"
10001
- * >
10002
- * </kendo-grid-numeric-filter-menu>
10003
- * </ng-template>
10004
- * </kendo-grid-column>
10005
- * ```
9669
+ * ```html
9670
+ * <kendo-grid-column field="UnitPrice">
9671
+ * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
9672
+ * <kendo-grid-numeric-filter-menu
9673
+ * [column]="column"
9674
+ * [filter]="filter"
9675
+ * [filterService]="filterService">
9676
+ * </kendo-grid-numeric-filter-menu>
9677
+ * </ng-template>
9678
+ * </kendo-grid-column>
9679
+ * ```
10006
9680
  */
10007
9681
  class NumericFilterMenuComponent extends NumericFilterComponent {
10008
9682
  constructor(localization) {
@@ -10015,6 +9689,7 @@ class NumericFilterMenuComponent extends NumericFilterComponent {
10015
9689
  this.filter = { filters: [], logic: "and" };
10016
9690
  /**
10017
9691
  * Determines if the inputs of second criteria will displayed.
9692
+ * @default true
10018
9693
  */
10019
9694
  this.extra = true;
10020
9695
  /**
@@ -10187,25 +9862,29 @@ class DateFilterComponent extends BaseFilterCellComponent {
10187
9862
  /**
10188
9863
  * The default filter operator. Defaults to `contains`.
10189
9864
  * @type {string}
9865
+ * @default 'gte'
10190
9866
  */
10191
9867
  this.operator = "gte";
10192
9868
  /**
10193
9869
  * Defines the active view that the calendar initially renders.
10194
9870
  * By default, the active view is `month`.
10195
- *
10196
- * > You have to set `activeView` within the `topView`-`bottomView` range.
9871
+ * You have to set `activeView` within the `topView`-`bottomView` range.
9872
+ * @default 'month'
10197
9873
  */
10198
9874
  this.activeView = "month";
10199
9875
  /**
10200
9876
  * Defines the bottommost calendar view, to which the user can navigate.
9877
+ * @default 'month'
10201
9878
  */
10202
9879
  this.bottomView = "month";
10203
9880
  /**
10204
9881
  * Defines the topmost calendar view, to which the user can navigate.
9882
+ * @default 'century'
10205
9883
  */
10206
9884
  this.topView = "century";
10207
9885
  /**
10208
9886
  * Determines whether to display a week number column in the `month` view of the Calendar.
9887
+ * @default false
10209
9888
  */
10210
9889
  this.weekNumber = false;
10211
9890
  this.defaultOperators = dateOperators(this.localization);
@@ -10440,21 +10119,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
10440
10119
  }] } });
10441
10120
 
10442
10121
  /**
10443
- * Represents a date-filter menu component.
10122
+ * Represents a date filter-menu component.
10444
10123
  *
10445
10124
  * @example
10446
- * ```html-no-run
10447
- * <kendo-grid-column field="OrderDate" title="Order Date">
10448
- * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
10449
- * <kendo-grid-date-filter-menu
10450
- * [column]="column"
10451
- * [filter]="filter"
10452
- * [filterService]="filterService"
10453
- * >
10454
- * </kendo-grid-date-filter-menu>
10455
- * </ng-template>
10456
- * </kendo-grid-column>
10457
- * ```
10125
+ * ```html
10126
+ * <kendo-grid-column field="FirstOrderedOn">
10127
+ * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
10128
+ * <kendo-grid-date-filter-menu
10129
+ * [column]="column"
10130
+ * [filter]="filter"
10131
+ * [filterService]="filterService">
10132
+ * </kendo-grid-date-filter-menu>
10133
+ * </ng-template>
10134
+ * </kendo-grid-column>
10135
+ * ```
10458
10136
  */
10459
10137
  class DateFilterMenuComponent extends DateFilterComponent {
10460
10138
  constructor(localization) {
@@ -10467,6 +10145,7 @@ class DateFilterMenuComponent extends DateFilterComponent {
10467
10145
  this.filter = { filters: [], logic: "and" };
10468
10146
  /**
10469
10147
  * Determines if the inputs of second criteria will be displayed.
10148
+ * @default true
10470
10149
  */
10471
10150
  this.extra = true;
10472
10151
  }
@@ -10723,21 +10402,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
10723
10402
  }] } });
10724
10403
 
10725
10404
  /**
10726
- * Represents a Boolean-filter menu component.
10405
+ * Represents a Boolean-filter menu component. [See example](slug:filter_menu#toc-built-in-filter-menu-components)
10727
10406
  *
10728
10407
  * @example
10729
- * ```html-no-run
10730
- * <kendo-grid-column field="Discontinued" title="Discontinued">
10731
- * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
10732
- * <kendo-grid-boolean-filter-menu
10733
- * [column]="column"
10734
- * [filter]="filter"
10735
- * [filterService]="filterService"
10736
- * >
10737
- * </kendo-grid-boolean-filter-menu>
10738
- * </ng-template>
10739
- * </kendo-grid-column>
10740
- * ```
10408
+ *
10409
+ * ```html
10410
+ * <kendo-grid-column field="Discontinued" title="Discontinued">
10411
+ * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
10412
+ * <kendo-grid-boolean-filter-menu
10413
+ * [column]="column"
10414
+ * [filter]="filter"
10415
+ * [filterService]="filterService">
10416
+ * </kendo-grid-boolean-filter-menu>
10417
+ * </ng-template>
10418
+ * </kendo-grid-column>
10419
+ * ```
10741
10420
  */
10742
10421
  class BooleanFilterMenuComponent extends BooleanFilterComponent {
10743
10422
  constructor(localization) {
@@ -11386,27 +11065,12 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
11386
11065
  * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11387
11066
  *
11388
11067
  * @example
11389
- * ```ts-preview
11390
- *
11391
- * _@Component({
11392
- * selector: 'my-app',
11393
- * template: `
11394
- * <kendo-grid [data]="data" [columnMenu]="true" [resizable]="true" #grid>
11395
- * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
11396
- * <kendo-grid-columnmenu-item icon="arrows-resizing" text="Fit column"
11397
- * (itemClick)="grid.autoFitColumn(column); service.close()">
11398
- * </kendo-grid-columnmenu-item>
11399
- * </ng-template>
11400
- * <kendo-grid-column field="Field1"></kendo-grid-column>
11401
- * <kendo-grid-column field="Field2"></kendo-grid-column>
11402
- * </kendo-grid>
11403
- * `
11404
- * })
11405
- *
11406
- * class AppComponent {
11407
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
11408
- * }
11409
- *
11068
+ * ```html
11069
+ * <kendo-grid [columnMenu]="true" ...>
11070
+ * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
11071
+ * <kendo-grid-columnmenu-item text="Fit column"></kendo-grid-columnmenu-item>
11072
+ * </ng-template>
11073
+ * </kendo-grid>
11410
11074
  * ```
11411
11075
  */
11412
11076
  class ColumnMenuItemComponent {
@@ -11563,34 +11227,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
11563
11227
  }] } });
11564
11228
 
11565
11229
  /**
11566
- * Represents a column-menu item that can be placed inside a
11567
- * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11568
- * Allows the user to lock or unlock the columns.
11230
+ * Represents the column-menu item for locking and unlocking columns in the Grid. [See example](slug:columnmenu_grid#toc-lock-and-unlock-items).
11569
11231
  *
11570
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11571
- * > the template to the service input of the `kendo-grid-columnmenu-lock` component.
11232
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11233
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11234
+ * the template to the service input of the `kendo-grid-columnmenu-lock` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
11572
11235
  *
11573
11236
  * @example
11574
- * ```ts-preview
11575
- *
11576
- * _@Component({
11577
- * selector: 'my-app',
11578
- * template: `
11579
- * <kendo-grid [data]="data" [columnMenu]="true">
11580
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
11581
- * <kendo-grid-columnmenu-lock [service]="service">
11582
- * </kendo-grid-columnmenu-lock>
11583
- * </ng-template>
11584
- * <kendo-grid-column field="Field1" [width]="100"></kendo-grid-column>
11585
- * <kendo-grid-column field="Field2" [width]="100"></kendo-grid-column>
11586
- * </kendo-grid>
11587
- * `
11588
- * })
11589
- *
11590
- * class AppComponent {
11591
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
11592
- * }
11593
- *
11237
+ * ```html
11238
+ * <kendo-grid [data]="data" [columnMenu]="true" ...>
11239
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
11240
+ * <kendo-grid-columnmenu-lock [service]="service">
11241
+ * </kendo-grid-columnmenu-lock>
11242
+ * </ng-template>
11243
+ * </kendo-grid>
11594
11244
  * ```
11595
11245
  */
11596
11246
  class ColumnMenuLockComponent extends ColumnMenuItemBase {
@@ -11670,33 +11320,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
11670
11320
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }, { type: ColumnInfoService }, { type: i0.ChangeDetectorRef }]; } });
11671
11321
 
11672
11322
  /**
11673
- * Represents a column-menu item that can be placed inside a
11674
- * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11675
- * Allows the user to stick or unstick the columns.
11323
+ * Represents the column-menu item that sticks or unsticks columns in the Grid.
11324
+ * [See example](slug:columnmenu_grid#toc-stick-and-unstick-items).
11676
11325
  *
11677
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11678
- * > the template to the service input of the `kendo-grid-columnmenu-stick` component.
11326
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11327
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11328
+ * the template to the service input of the `kendo-grid-columnmenu-lock` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
11679
11329
  *
11680
11330
  * @example
11681
- * ```ts-preview
11682
- *
11683
- * _@Component({
11684
- * selector: 'my-app',
11685
- * template: `
11686
- * <kendo-grid [data]="data" [columnMenu]="true">
11687
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
11688
- * <kendo-grid-columnmenu-stick [service]="service">
11689
- * </kendo-grid-columnmenu-stick>
11690
- * </ng-template>
11691
- * <kendo-grid-column field="Field1" [width]="100"></kendo-grid-column>
11692
- * <kendo-grid-column field="Field2" [width]="100"></kendo-grid-column>
11693
- * </kendo-grid>
11694
- * `
11695
- * })
11696
- *
11697
- * class AppComponent {
11698
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
11699
- * }
11331
+ * ```html
11332
+ * <kendo-grid [data]="data" [columnMenu]="true">
11333
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
11334
+ * <kendo-grid-columnmenu-stick [service]="service">
11335
+ * </kendo-grid-columnmenu-stick>
11336
+ * </ng-template>
11337
+ * </kendo-grid>
11700
11338
  *
11701
11339
  * ```
11702
11340
  */
@@ -11777,33 +11415,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
11777
11415
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }, { type: ColumnInfoService }, { type: i0.ChangeDetectorRef }]; } });
11778
11416
 
11779
11417
  /**
11780
- * Represents the component for editing column filters in the Grid that can be placed
11781
- * inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11418
+ * Represents the column-menu item which combines the lock and sticky column functionalities.
11782
11419
  *
11783
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11784
- * > the template to the service input of the `kendo-grid-columnmenu-filter` component.
11420
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11421
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11422
+ * the template to the service input of the `kendo-grid-columnmenu-filter` component. [See example](slug:columnmenu_grid#toc-set-column-position-item).
11785
11423
  *
11786
11424
  * @example
11787
- * ```ts-preview
11788
- *
11789
- * _@Component({
11790
- * selector: 'my-app',
11791
- * template: `
11792
- * <kendo-grid [kendoGridBinding]="data" [columnMenu]="true">
11793
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
11794
- * <kendo-grid-columnmenu-filter [service]="service">
11795
- * </kendo-grid-columnmenu-filter>
11796
- * </ng-template>
11797
- * <kendo-grid-column field="Field1"></kendo-grid-column>
11798
- * <kendo-grid-column field="Field2"></kendo-grid-column>
11799
- * </kendo-grid>
11800
- * `
11801
- * })
11802
- *
11803
- * class AppComponent {
11804
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
11805
- * }
11806
- *
11425
+ * ```html
11426
+ * <kendo-grid [data]="data" [columnMenu]="true" ...>
11427
+ * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
11428
+ * <kendo-grid-columnmenu-position [service]="service" [showLock]="true" [showStick]="true">
11429
+ * </kendo-grid-columnmenu-position>
11430
+ * </ng-template>
11431
+ * </kendo-grid>
11807
11432
  * ```
11808
11433
  */
11809
11434
  class ColumnMenuPositionComponent extends ColumnMenuItemBase {
@@ -11821,6 +11446,7 @@ class ColumnMenuPositionComponent extends ColumnMenuItemBase {
11821
11446
  this.collapse = new EventEmitter();
11822
11447
  /**
11823
11448
  * Specifies if the content is expanded.
11449
+ * @default false
11824
11450
  */
11825
11451
  this.expanded = false;
11826
11452
  /**
@@ -12152,33 +11778,19 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12152
11778
  }] } });
12153
11779
 
12154
11780
  /**
12155
- * Represents the component for selecting columns in the Grid that can be placed
12156
- * inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11781
+ * Represents the column-menu item for selecting columns in the Grid. [See example](slug:columnmenu_grid#toc-column-chooser-item).
12157
11782
  *
12158
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12159
- * > the template to the service input of the `kendo-grid-columnmenu-chooser` component.
11783
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11784
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11785
+ * the template to the service input of the `kendo-grid-columnmenu-chooser` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
12160
11786
  *
12161
11787
  * @example
12162
- * ```ts-preview
12163
- *
12164
- * _@Component({
12165
- * selector: 'my-app',
12166
- * template: `
12167
- * <kendo-grid [data]="data" [columnMenu]="true">
12168
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
12169
- * <kendo-grid-columnmenu-chooser [service]="service">
12170
- * </kendo-grid-columnmenu-chooser>
12171
- * </ng-template>
12172
- * <kendo-grid-column field="Field1"></kendo-grid-column>
12173
- * <kendo-grid-column field="Field2" [hidden]="true"></kendo-grid-column>
12174
- * </kendo-grid>
12175
- * `
12176
- * })
12177
- *
12178
- * class AppComponent {
12179
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
12180
- * }
12181
- *
11788
+ * ```html
11789
+ * <kendo-grid [columnMenu]="true" ...>
11790
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
11791
+ * <kendo-grid-columnmenu-chooser [service]="service"> </kendo-grid-columnmenu-chooser>
11792
+ * </ng-template>
11793
+ * </kendo-grid>
12182
11794
  * ```
12183
11795
  */
12184
11796
  class ColumnMenuChooserComponent extends ColumnMenuItemBase {
@@ -12198,6 +11810,7 @@ class ColumnMenuChooserComponent extends ColumnMenuItemBase {
12198
11810
  this.collapse = new EventEmitter();
12199
11811
  /**
12200
11812
  * Specifies if the content is expanded.
11813
+ * @default false
12201
11814
  */
12202
11815
  this.expanded = false;
12203
11816
  /**
@@ -12306,33 +11919,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12306
11919
  }] } });
12307
11920
 
12308
11921
  /**
12309
- * Represents the component for editing column filters in the Grid that can be placed
12310
- * inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11922
+ * Represents the column-menu item for editing column filters in the Grid. [See example](slug:columnmenu_grid#toc-filter-item).
12311
11923
  *
12312
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12313
- * > the template to the service input of the `kendo-grid-columnmenu-filter` component.
11924
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11925
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11926
+ * the template to the service input of the `kendo-grid-columnmenu-filter` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
12314
11927
  *
12315
11928
  * @example
12316
- * ```ts-preview
12317
- *
12318
- * _@Component({
12319
- * selector: 'my-app',
12320
- * template: `
12321
- * <kendo-grid [kendoGridBinding]="data" [columnMenu]="true">
12322
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
12323
- * <kendo-grid-columnmenu-filter [service]="service">
12324
- * </kendo-grid-columnmenu-filter>
12325
- * </ng-template>
12326
- * <kendo-grid-column field="Field1"></kendo-grid-column>
12327
- * <kendo-grid-column field="Field2"></kendo-grid-column>
12328
- * </kendo-grid>
12329
- * `
12330
- * })
12331
- *
12332
- * class AppComponent {
12333
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
12334
- * }
12335
- *
11929
+ * ```html
11930
+ * <kendo-grid [columnMenu]="true" ...>
11931
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
11932
+ * <kendo-grid-columnmenu-filter [service]="service">
11933
+ * </kendo-grid-columnmenu-filter>
11934
+ * </ng-template>
11935
+ * </kendo-grid>
12336
11936
  * ```
12337
11937
  */
12338
11938
  class ColumnMenuFilterComponent extends ColumnMenuItemBase {
@@ -12350,6 +11950,7 @@ class ColumnMenuFilterComponent extends ColumnMenuItemBase {
12350
11950
  this.collapse = new EventEmitter();
12351
11951
  /**
12352
11952
  * Specifies if the content is expanded.
11953
+ * @default false
12353
11954
  */
12354
11955
  this.expanded = false;
12355
11956
  /**
@@ -12569,34 +12170,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12569
12170
  }] } });
12570
12171
 
12571
12172
  /**
12572
- * Represents a column-menu item for sorting Grid columns that can be placed inside a
12573
- * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
12574
- * Allows the user to sort the column.
12173
+ * Represents the column-menu item for sorting Grid columns.
12174
+ * [See example](slug:columnmenu_grid#toc-sort-item).
12575
12175
  *
12576
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12577
- * > the template to the service input of the `kendo-grid-columnmenu-sort` component.
12176
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
12177
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12178
+ * the template to the service input of the `kendo-grid-columnmenu-sort` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
12578
12179
  *
12579
12180
  * @example
12580
- * ```ts-preview
12581
- *
12582
- * _@Component({
12583
- * selector: 'my-app',
12584
- * template: `
12585
- * <kendo-grid [kendoGridBinding]="data" [sortable]="true" [columnMenu]="true">
12586
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
12587
- * <kendo-grid-columnmenu-sort [service]="service">
12588
- * </kendo-grid-columnmenu-sort>
12589
- * </ng-template>
12590
- * <kendo-grid-column field="Field1" [width]="100"></kendo-grid-column>
12591
- * <kendo-grid-column field="Field2" [width]="100"></kendo-grid-column>
12592
- * </kendo-grid>
12593
- * `
12594
- * })
12595
- *
12596
- * class AppComponent {
12597
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }, { Field1: 'Foo1', Field2: 'Bar1' }];
12598
- * }
12599
- *
12181
+ * ```html
12182
+ * <kendo-grid [kendoGridBinding]="data" [sortable]="true" [columnMenu]="true">
12183
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
12184
+ * <kendo-grid-columnmenu-sort [service]="service">
12185
+ * </kendo-grid-columnmenu-sort>
12186
+ * </ng-template>
12187
+ * </kendo-grid>
12600
12188
  * ```
12601
12189
  */
12602
12190
  class ColumnMenuSortComponent extends ColumnMenuItemBase {
@@ -12680,36 +12268,22 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12680
12268
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }, { type: SortService }, { type: i0.Renderer2 }]; } });
12681
12269
 
12682
12270
  /**
12683
- * Represents the component for resizing the specified column to the minimum possible width so that it fits the header or cell content without wrapping.
12271
+ * 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.
12272
+ * [See example](slug:slug:columnmenu_grid#toc-autosize-column-item).
12684
12273
  * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
12274
+ * [See example](slug:columnmenu_grid#toc-customizing-the-content).
12685
12275
  *
12686
- * > To enable the autosize-column option, set the [`resizable`]({% slug api_grid_gridcomponent %}#toc-resizable)
12687
- * > property of the Grid to `true`.
12688
- *
12689
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) and `column` that are passed by
12690
- * > the template to the `service` and `column` input of the `kendo-grid-columnmenu-autosize-column` component.
12276
+ * You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) and `column` that are passed by
12277
+ * the template to the `service` and `column` input of the `kendo-grid-columnmenu-autosize-column` component.
12691
12278
  *
12692
12279
  * @example
12693
- * ```ts-preview
12694
- *
12695
- * _@Component({
12696
- * selector: 'my-app',
12697
- * template: `
12698
- * <kendo-grid [data]="data" [columnMenu]="true">
12699
- * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
12700
- * <kendo-grid-columnmenu-autosize-column [column]="column" [service]="service">
12701
- * </kendo-grid-columnmenu-autosize-column>
12702
- * </ng-template>
12703
- * <kendo-grid-column field="Field1"></kendo-grid-column>
12704
- * <kendo-grid-column field="Field2"></kendo-grid-column>
12705
- * </kendo-grid>
12706
- * `
12707
- * })
12708
- *
12709
- * class AppComponent {
12710
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
12711
- * }
12712
- *
12280
+ * ```html
12281
+ * <kendo-grid [columnMenu]="true" ...>
12282
+ * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
12283
+ * <kendo-grid-columnmenu-autosize-column [column]="column" [service]="service">
12284
+ * </kendo-grid-columnmenu-autosize-column>
12285
+ * </ng-template>
12286
+ * </kendo-grid>
12713
12287
  * ```
12714
12288
  */
12715
12289
  class ColumnMenuAutoSizeColumnComponent extends ColumnMenuItemBase {
@@ -12725,6 +12299,9 @@ class ColumnMenuAutoSizeColumnComponent extends ColumnMenuItemBase {
12725
12299
  console.warn(ColunnMenuErrorMessages.autoSizeColumn);
12726
12300
  }
12727
12301
  }
12302
+ /**
12303
+ * Resizes a specified column to the minimum possible width so that it fits the widest header or cell content without wrapping.
12304
+ */
12728
12305
  autoSizeColumn() {
12729
12306
  autoSizeColumn(this.ctx.grid, this.service, this.column);
12730
12307
  }
@@ -12760,36 +12337,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12760
12337
  }] } });
12761
12338
 
12762
12339
  /**
12763
- * Represents the component for resizing all columns to the minimum possible width so that they fit the widest header or cell content without wrapping.
12764
- * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
12765
- *
12766
- * > To enable the autosize-all-columns option, set the [`resizable`]({% slug api_grid_gridcomponent %}#toc-resizable)
12767
- * > property of the Grid to `true`.
12340
+ * 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.
12341
+ * [See example](slug:columnmenu_grid#toc-autosize-all-columns-item).
12768
12342
  *
12769
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12770
- * > the template to the `service` input of the `kendo-grid-columnmenu-autosize-all-columns` component.
12343
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
12344
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12345
+ * the template to the `service` input of the `kendo-grid-columnmenu-autosize-all-columns` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
12771
12346
  *
12772
12347
  * @example
12773
- * ```ts-preview
12774
- *
12775
- * _@Component({
12776
- * selector: 'my-app',
12777
- * template: `
12778
- * <kendo-grid [data]="data" [columnMenu]="true">
12779
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
12780
- * <kendo-grid-columnmenu-autosize-all-columns [service]="service">
12781
- * </kendo-grid-columnmenu-autosize-all-columns>
12782
- * </ng-template>
12783
- * <kendo-grid-column field="Field1"></kendo-grid-column>
12784
- * <kendo-grid-column field="Field2"></kendo-grid-column>
12785
- * </kendo-grid>
12786
- * `
12787
- * })
12788
- *
12789
- * class AppComponent {
12790
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
12791
- * }
12792
- *
12348
+ * ```html
12349
+ * <kendo-grid [columnMenu]="true" ...>
12350
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
12351
+ * <kendo-grid-columnmenu-autosize-all-columns [service]="service">
12352
+ * </kendo-grid-columnmenu-autosize-all-columns>
12353
+ * </ng-template>
12354
+ * </kendo-grid>
12793
12355
  * ```
12794
12356
  */
12795
12357
  class ColumnMenuAutoSizeAllColumnsComponent extends ColumnMenuItemBase {
@@ -12805,6 +12367,9 @@ class ColumnMenuAutoSizeAllColumnsComponent extends ColumnMenuItemBase {
12805
12367
  console.warn(ColunnMenuErrorMessages.autoSizeAllColumns);
12806
12368
  }
12807
12369
  }
12370
+ /**
12371
+ * Resizes all columns to the minimum possible width so that they fit the widest header or cell content without wrapping.
12372
+ */
12808
12373
  autoSizeAllColumns() {
12809
12374
  autoSizeColumn(this.ctx.grid, this.service);
12810
12375
  }
@@ -12837,7 +12402,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12837
12402
 
12838
12403
  const POPUP_CLASS = 'k-grid-columnmenu-popup';
12839
12404
  /**
12840
- * Represents the [column menu]({% slug columnmenu_grid %}) component.
12405
+ * Represents the [column menu](slug:columnmenu_grid#toc-customizing-the-position) component.
12406
+ *
12407
+ * <kendo-grid ...>
12408
+ * <kendo-grid-column field="ProductName" [columnMenu]="false">
12409
+ * <ng-template kendoGridHeaderTemplate let-column>
12410
+ * <kendo-grid-column-menu [column]="column"> </kendo-grid-column-menu>
12411
+ * </ng-template>
12412
+ * </kendo-grid-column>
12413
+ * </kendo-grid>
12841
12414
  */
12842
12415
  class ColumnMenuComponent {
12843
12416
  constructor(navigationService, popupService, localization, service, ctx) {
@@ -13188,6 +12761,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
13188
12761
 
13189
12762
  /**
13190
12763
  * Represents a component which accommodates the filter operators.
12764
+ *
12765
+ * @example
12766
+ * ```html
12767
+ * <kendo-grid [data]="gridData">
12768
+ * <kendo-grid-column field="ProductName">
12769
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
12770
+ * <input />
12771
+ * <kendo-grid-filter-cell-operators
12772
+ * [operators]="[{text: 'Equals', value: 'eq'}]">
12773
+ * </kendo-grid-filter-cell-operators>
12774
+ * </ng-template>
12775
+ * </kendo-grid-column>
12776
+ * <kendo-grid>
12777
+ * ```
13191
12778
  */
13192
12779
  class FilterCellOperatorsComponent {
13193
12780
  constructor(localization, sizing) {
@@ -13206,6 +12793,7 @@ class FilterCellOperatorsComponent {
13206
12793
  /**
13207
12794
  * Determines if the list of operators will be displayed.
13208
12795
  * @type {boolean}
12796
+ * @default true
13209
12797
  */
13210
12798
  this.showOperators = true;
13211
12799
  /**
@@ -13411,36 +12999,35 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
13411
12999
  }] } });
13412
13000
 
13413
13001
  /**
13414
- * Represents a string-filter cell component
13002
+ * Represents a string filter-cell component
13415
13003
  * ([see example]({% slug filter_row %}#toc-hiding-filter-operators)).
13416
13004
  *
13417
13005
  * @example
13418
- *
13419
- * ```html-no-run
13420
- * <kendo-grid-column field="ProductName" title="Product Name">
13421
- * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13422
- * <kendo-grid-string-filter-cell
13423
- * [showOperators]="false"
13424
- * [column]="column"
13425
- * [filter]="filter">
13426
- * </kendo-grid-string-filter-cell>
13427
- * </ng-template>
13428
- * </kendo-grid-column>
13429
- * ```
13006
+ * ```html
13007
+ * <kendo-grid-column field="ProductName" title="Product Name">
13008
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13009
+ * <kendo-grid-string-filter-cell
13010
+ * [column]="column"
13011
+ * [filter]="filter">
13012
+ * </kendo-grid-string-filter-cell>
13013
+ * </ng-template>
13014
+ * </kendo-grid-column>
13015
+ * ```
13430
13016
  */
13431
13017
  class StringFilterCellComponent extends StringFilterComponent {
13432
13018
  constructor(filterService, localization, sizingService) {
13433
13019
  super(filterService, localization);
13434
13020
  /**
13435
13021
  * Determines the delay time (in milliseconds) before the filter value is submitted.
13436
- * A value of `0` indicates no delay. The default value is `500`.
13022
+ * A value of `0` indicates no delay.
13437
13023
  * @type {boolean}
13024
+ * @default 500
13438
13025
  */
13439
13026
  this.filterDelay = 500;
13440
13027
  /**
13441
13028
  * Determines if the drop-down filter operators will be displayed.
13442
- * The default value is `true`.
13443
13029
  * @type {boolean}
13030
+ * @default true
13444
13031
  */
13445
13032
  this.showOperators = true;
13446
13033
  this.subs = sizingService.changes.subscribe((size) => this.size = size);
@@ -13506,19 +13093,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
13506
13093
  }] } });
13507
13094
 
13508
13095
  /**
13509
- * Represents a numeric filter cell.
13096
+ * Represents a numeric filter-cell component.
13097
+ * [See example](slug:filter_row#toc-built-in-filter-row-components).
13510
13098
  *
13511
13099
  * @example
13512
- * ```html-no-run
13513
- * <kendo-grid-column field="ProductName" title="Product Name">
13514
- * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13515
- * <kendo-grid-numeric-filter-cell
13516
- * [column]="column"
13517
- * [filter]="filter">
13518
- * </kendo-grid-numeric-filter-cell>
13519
- * </ng-template>
13520
- * </kendo-grid-column>
13521
- * ```
13100
+ * ```html
13101
+ * <kendo-grid-column field="UnitPrice">
13102
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13103
+ * <kendo-grid-numeric-filter-cell
13104
+ * [column]="column"
13105
+ * [filter]="filter">
13106
+ * </kendo-grid-numeric-filter-cell>
13107
+ * </ng-template>
13108
+ * </kendo-grid-column>
13109
+ * ```
13522
13110
  */
13523
13111
  class NumericFilterCellComponent extends NumericFilterComponent {
13524
13112
  constructor(filterService, localization, sizingService) {
@@ -13528,12 +13116,14 @@ class NumericFilterCellComponent extends NumericFilterComponent {
13528
13116
  * Determines the delay time (in milliseconds) before the filter value is submitted.
13529
13117
  * A value of `0` indicates no delay. The default value is `500`.
13530
13118
  * @type {boolean}
13119
+ * @default 500
13531
13120
  */
13532
13121
  this.filterDelay = 500;
13533
13122
  /**
13534
13123
  * Determines if the drop-down filter operators will be displayed.
13535
13124
  * The default value is `true`.
13536
13125
  * @type {boolean}
13126
+ * @default true
13537
13127
  */
13538
13128
  this.showOperators = true;
13539
13129
  this.subs = sizingService.changes.subscribe((size) => this.size = size);
@@ -13632,19 +13222,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
13632
13222
 
13633
13223
  /**
13634
13224
  * Represents a Boolean filter-cell component.
13225
+ * [See example](slug:filter_row#toc-built-in-filter-row-components).
13635
13226
  *
13636
13227
  * @example
13637
13228
  *
13638
- * ```html-no-run
13639
- * <kendo-grid-column field="ProductName" title="Product Name">
13640
- * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13641
- * <kendo-grid-boolean-filter-cell
13642
- * [column]="column"
13643
- * [filter]="filter">
13644
- * </kendo-grid-boolean-filter-cell>
13645
- * </ng-template>
13646
- * </kendo-grid-column>
13647
- * ```
13229
+ * ```html
13230
+ * <kendo-grid-column field="Discontinued">
13231
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13232
+ * <kendo-grid-boolean-filter-cell
13233
+ * [column]="column"
13234
+ * [filter]="filter">
13235
+ * </kendo-grid-boolean-filter-cell>
13236
+ * </ng-template>
13237
+ * </kendo-grid-column>
13238
+ * ```
13648
13239
  */
13649
13240
  class BooleanFilterCellComponent extends BooleanFilterComponent {
13650
13241
  constructor(filterService, localization, cd, sizingService) {
@@ -13723,29 +13314,42 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
13723
13314
  }], ctorParameters: function () { return [{ type: FilterService }, { type: i1.LocalizationService }, { type: i0.ChangeDetectorRef }, { type: SizingOptionsService }]; } });
13724
13315
 
13725
13316
  /**
13726
- * Represents a date-filter cell component.
13317
+ * Represents a [DatePicker](slug:overview_datepicker) filter-cell component.
13727
13318
  *
13728
13319
  * @example
13729
13320
  *
13730
- * ```html-no-run
13731
- * <kendo-grid-column field="OrderDate" title="Order Date">
13732
- * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13733
- * <kendo-grid-date-filter-cell
13734
- * [showOperators]="false"
13735
- * [column]="column"
13736
- * [filter]="filter">
13737
- * </kendo-grid-date-filter-cell>
13738
- * </ng-template>
13739
- * </kendo-grid-column>
13740
- * ```
13321
+ * ```html
13322
+ * <kendo-grid-column field="FirstOrderedOn">
13323
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13324
+ * <kendo-grid-date-filter-cell
13325
+ * [column]="column"
13326
+ * [filter]="filter">
13327
+ * </kendo-grid-date-filter-cell>
13328
+ * </ng-template>
13329
+ * </kendo-grid-column>
13330
+ * ```
13741
13331
  */
13742
13332
  class DateFilterCellComponent extends DateFilterComponent {
13743
13333
  constructor(filterService, localization, sizingService) {
13744
13334
  super(filterService, localization);
13745
13335
  this.localization = localization;
13746
13336
  /**
13747
- * Determines if the drop-down filter operators will be displayed. The default value is `true`.
13337
+ * Represents a [DatePicker](slug:overview_datepicker) filter-cell component.
13338
+ * [See example](slug:filter_row#toc-built-in-filter-row-components).
13339
+ * @example
13340
+ *
13341
+ * ```html
13342
+ * <kendo-grid-column field="Discontinued">
13343
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13344
+ * <kendo-grid-date-filter-cell
13345
+ * [column]="column"
13346
+ * [filter]="filter">
13347
+ * </kendo-grid-date-filter-cell>
13348
+ * </ng-template>
13349
+ * </kendo-grid-column>
13350
+ * ```
13748
13351
  * @type {boolean}
13352
+ * @default true
13749
13353
  */
13750
13354
  this.showOperators = true;
13751
13355
  this.subs = sizingService.changes.subscribe((size) => this.size = size);
@@ -15794,68 +15398,20 @@ const IGNORE_CONTAINER_CLASSES = 'k-grid k-grid-ignore-click';
15794
15398
 
15795
15399
  /**
15796
15400
  * Represents the command columns of the Grid. You have to define the content of the
15797
- * column inside an `<ng-template>` tag. The template context is set to the current
15798
- * data item. For more information and examples on using the passed fields
15799
- * and the command directives, refer to the article on
15800
- * [editing the Grid in Angular Reactive Forms]({% slug inline_editing_grid %}#toc-using-reactive-forms).
15801
- *
15802
- * The following additional fields are passed:
15803
- * - `columnIndex`&mdash;The current column index.
15804
- * - `rowIndex`&mdash;The current data row index. If inside a new item row, `rowIndex`is `-1`.
15805
- * - `dataItem`&mdash;The current data item.
15806
- * - `column`&mdash;The current column instance.
15807
- * - `isNew`&mdash;The state of the current item.
15808
- *
15809
- * Usually, the template contains CRUD command directives such as:
15810
- * - [EditCommandDirective]({% slug api_grid_editcommanddirective %})
15811
- * - [RemoveCommandDirective]({% slug api_grid_removecommanddirective %})
15812
- * - [CancelCommandDirective]({% slug api_grid_cancelcommanddirective %})
15813
- * - [SaveCommandDirective]({% slug api_grid_savecommanddirective %})
15401
+ * column inside an `<ng-template>` tag.
15402
+ * For more information and examples, refer to the [Command Column Directives](slug:editing_directives_grid#toc-command-column-directives) article.
15814
15403
  *
15815
15404
  * @example
15816
- * ```ts-preview
15817
- *
15818
- * _@Component({
15819
- * selector: 'my-app',
15820
- * template: `
15821
- * <kendo-grid [data]="gridData">
15822
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
15823
- * </kendo-grid-column>
15824
- * <kendo-grid-column field="ProductName" title="Product Name">
15825
- * </kendo-grid-column>
15826
- * <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
15827
- * </kendo-grid-column>
15828
- * <kendo-grid-command-column title="command" [width]="220">
15829
- * <ng-template kendoGridCellTemplate>
15830
- * <button kendoGridEditCommand class="k-primary">Edit</button>
15831
- * <button kendoGridRemoveCommand>Remove</button>
15832
- * </ng-template>
15833
- * </kendo-grid-command-column>
15834
- * </kendo-grid>
15835
- * `
15836
- * })
15837
- *
15838
- * class AppComponent {
15839
- * public gridData: any[];
15840
- *
15841
- * constructor() {
15842
- * this.gridData = products;
15843
- * }
15844
- * }
15845
- *
15846
- * const products = [{
15847
- * "ProductID": 1,
15848
- * "ProductName": "Chai",
15849
- * "UnitPrice": 18.0000,
15850
- * "Discontinued": true
15851
- * }, {
15852
- * "ProductID": 2,
15853
- * "ProductName": "Chang",
15854
- * "UnitPrice": 19.0000,
15855
- * "Discontinued": false
15856
- * }
15857
- * ];
15858
- *
15405
+ * ```html
15406
+ * <kendo-grid [data]="gridData">
15407
+ * <kendo-grid-column field="ProductID"></kendo-grid-column>
15408
+ * <kendo-grid-command-column title="command" [width]="220">
15409
+ * <ng-template kendoGridCellTemplate>
15410
+ * <button kendoGridEditCommand class="k-primary">Edit</button>
15411
+ * <button kendoGridRemoveCommand>Remove</button>
15412
+ * </ng-template>
15413
+ * </kendo-grid-command-column>
15414
+ * </kendo-grid>
15859
15415
  * ```
15860
15416
  */
15861
15417
  class CommandColumnComponent extends ColumnBase {
@@ -18899,33 +18455,11 @@ const handleExpandCollapseDetailsService = (service, expandEmitter, collapseEmit
18899
18455
  const isInEditedCell = (element, gridElement) => closest(element, matchesClasses('k-grid-edit-cell')) &&
18900
18456
  closest(element, matchesNodeName('kendo-grid')) === gridElement;
18901
18457
  /**
18902
- * Represents the Kendo UI Grid component for Angular.
18458
+ * Represents the Kendo UI for Angular Data Grid component.
18903
18459
  *
18904
18460
  * @example
18905
- * ```ts-preview
18906
- * _@Component({
18907
- * selector: 'my-app',
18908
- * template: `
18909
- * <kendo-grid [data]="gridData">
18910
- * </kendo-grid>
18911
- * `
18912
- * })
18913
- * class AppComponent {
18914
- * public gridData: any[] = products;
18915
- * }
18916
- *
18917
- * const products = [{
18918
- * "ProductID": 1,
18919
- * "ProductName": "Chai",
18920
- * "UnitPrice": 18.0000,
18921
- * "Discontinued": true
18922
- * }, {
18923
- * "ProductID": 2,
18924
- * "ProductName": "Chang",
18925
- * "UnitPrice": 19.0000,
18926
- * "Discontinued": false
18927
- * }
18928
- * ];
18461
+ * ```html
18462
+ * <kendo-grid [data]="gridData"></kendo-grid>
18929
18463
  * ```
18930
18464
  */
18931
18465
  class GridComponent {
@@ -18961,64 +18495,25 @@ class GridComponent {
18961
18495
  /**
18962
18496
  * Defines the scroll mode used by the Grid.
18963
18497
  *
18964
- * The available options are:
18965
- * - `none`&mdash;Renders no scrollbar.
18966
- * - `scrollable`&mdash;The default scroll mode. It requires the setting of the `height` option.
18967
- * - `virtual`&mdash;Displays no pager and renders a portion of the data (optimized rendering) while the user is scrolling the content.
18498
+ * @default 'scrollable'
18968
18499
  */
18969
18500
  this.scrollable = 'scrollable';
18970
18501
  /**
18971
- * Enables the single-row [selection]({% slug selection_grid %}) of the Grid.
18502
+ * Enables the [single-row selection](slug:grid_row_selection) of the Grid.
18503
+ *
18504
+ * @default false
18972
18505
  */
18973
18506
  this.selectable = false;
18974
18507
  /**
18975
18508
  * A function that defines how to track changes for the data rows.
18976
- *
18977
18509
  * By default, the Grid tracks changes by the index of the data item.
18978
18510
  * Edited rows are tracked by reference.
18979
- * In some cases, you might need to override the default behavior,
18980
- * for example, when you implement editing with immutable data items.
18981
- *
18982
- * The following example demonstrates how to track items only by index.
18983
- *
18984
- * @example
18985
- * ```ts
18986
- * import { Component } from '@angular/core';
18987
- * import { GridItem } from '@progress/kendo-angular-grid';
18988
- *
18989
- * _@Component({
18990
- * selector: 'my-app',
18991
- * template: `
18992
- * <kendo-grid [data]="gridData" [trackBy]="trackBy">
18993
- * </kendo-grid>
18994
- * `
18995
- * })
18996
- * class AppComponent {
18997
- * public gridData: any[] = products;
18998
- *
18999
- * public trackBy(index: number, item: GridItem): any {
19000
- * console.log(item);
19001
- * return index;
19002
- * }
19003
- * }
19004
- *
19005
- * const products = [{
19006
- * "ProductID": 1,
19007
- * "ProductName": "Chai",
19008
- * "UnitPrice": 18.0000,
19009
- * "Discontinued": true
19010
- * }, {
19011
- * "ProductID": 2,
19012
- * "ProductName": "Chang",
19013
- * "UnitPrice": 19.0000,
19014
- * "Discontinued": false
19015
- * }
19016
- * ];
19017
- * ```
18511
+ * [See exmpale](slug:track_changes_grid)
19018
18512
  */
19019
18513
  this.trackBy = defaultTrackBy;
19020
18514
  /**
19021
18515
  * If set to `true`, the grid will render only the columns in the current viewport.
18516
+ * @default false
19022
18517
  */
19023
18518
  this.virtualColumns = false;
19024
18519
  /**
@@ -19027,35 +18522,31 @@ class GridComponent {
19027
18522
  this.gridData = () => { return this.flatData; };
19028
18523
  /**
19029
18524
  * Enables the [filtering]({% slug filtering_grid %}) of the Grid columns that have their `field` option set.
18525
+ * @default false
19030
18526
  */
19031
18527
  this.filterable = false;
19032
18528
  /**
19033
18529
  * Enables the [sorting]({% slug sorting_grid %}) of the Grid columns that have their `field` option set.
18530
+ * @default false
19034
18531
  */
19035
18532
  this.sortable = false;
19036
18533
  /**
19037
- * Configures the pager of the Grid ([see example]({% slug paging_grid %})).
19038
- *
19039
- * The available options are:
19040
- * - `buttonCount: Number`&mdash;Sets the maximum numeric buttons count before the buttons are collapsed. Defaults to `10`.
19041
- * - `info: Boolean`&mdash;Toggles the information about the current page and the total number of records. Defaults to `true`.
19042
- * - `type: PagerType`&mdash;Accepts the `numeric` (buttons with numbers) and `input` (input for typing the page number) values. Defaults to `'numeric'`.
19043
- * - `pageSizes: Boolean` or `Array<number>`&mdash;Shows a menu for selecting the page size. Defaults to `false`.
19044
- * - `previousNext: Boolean`&mdash;Toggles the **Previous** and **Next** buttons. Defaults to `true`.
19045
- * - `responsive: Boolean`&mdash;Toggles the built-in responsive behavior of the Pager. Defaults to `true`.
18534
+ * Configures the pager of the Grid ([see example](slug:paging_grid_settings)).
18535
+ * @default false
19046
18536
  */
19047
18537
  this.pageable = false;
19048
18538
  /**
19049
- * If set to `true`, the user can group the Grid by dragging the column header cells.
19050
- * By default, grouping is disabled ([see example]({% slug grouping_grid %})).
18539
+ * If set to `true`, the user can group the Grid by dragging the column header cells ([see example]({% slug grouping_grid %})).
18540
+ * @default false
19051
18541
  */
19052
18542
  this.groupable = false;
19053
18543
  /**
19054
18544
  * Indicates whether the Grid columns will be resized during initialization so that
19055
- * they fit their headers and row content. Defaults to `false`.
18545
+ * they fit their headers and row content.
19056
18546
  * Columns with `autoSize` set to `false` are excluded.
19057
18547
  * To dynamically update the column width to match the new content,
19058
18548
  * refer to [this example]({% slug resizing_columns_grid %}).
18549
+ * @default false
19059
18550
  */
19060
18551
  this.autoSize = false;
19061
18552
  /**
@@ -19080,8 +18571,8 @@ class GridComponent {
19080
18571
  this.columnMenu = false;
19081
18572
  /**
19082
18573
  * Specifies if the header of the grid will be hidden. The header is visible by default.
19083
- *
19084
- * > The header includes column headers and the [filter row]({% slug filtering_grid %}#toc-filter-row).
18574
+ * The header includes column headers and the [filter row](slug:filter_row).
18575
+ * @default false
19085
18576
  */
19086
18577
  this.hideHeader = false;
19087
18578
  /**
@@ -19442,50 +18933,8 @@ class GridComponent {
19442
18933
  return this.navigable;
19443
18934
  }
19444
18935
  /**
19445
- * Defines a function that is executed for every data row in the component.
19446
- *
19447
- * @example
19448
- * ```ts
19449
- * import { Component, ViewEncapsulation } from '@angular/core';
19450
- * import { RowClassArgs } from '@progress/kendo-angular-grid';
19451
- *
19452
- * _@Component({
19453
- * selector: 'my-app',
19454
- * encapsulation: ViewEncapsulation.None,
19455
- * styles: [`
19456
- * .k-grid tr.even { background-color: #f45c42; }
19457
- * .k-grid tr.odd { background-color: #41f4df; }
19458
- * `],
19459
- * template: `
19460
- * <kendo-grid [data]="gridData" [rowClass]="rowCallback">
19461
- * </kendo-grid>
19462
- * `
19463
- * })
19464
- * class AppComponent {
19465
- * public gridData: any[] = products;
19466
- *
19467
- * public rowCallback(context: RowClassArgs) {
19468
- * const isEven = context.index % 2 === 0;
19469
- * return {
19470
- * even: isEven,
19471
- * odd: !isEven
19472
- * };
19473
- * }
19474
- * }
19475
- *
19476
- * const products = [{
19477
- * "ProductID": 1,
19478
- * "ProductName": "Chai",
19479
- * "UnitPrice": 18.0000,
19480
- * "Discontinued": true
19481
- * }, {
19482
- * "ProductID": 2,
19483
- * "ProductName": "Chang",
19484
- * "UnitPrice": 19.0000,
19485
- * "Discontinued": false
19486
- * }
19487
- * ];
19488
- * ```
18936
+ * Defines a function that is executed for every data row in the component
18937
+ * ([see example](slug:styling_grid_rows)).
19489
18938
  */
19490
18939
  set rowClass(fn) {
19491
18940
  if (isDevMode() && typeof fn !== 'function') {
@@ -19786,9 +19235,9 @@ class GridComponent {
19786
19235
  * This method is provided only for backwards-compatibility with legacy versions.
19787
19236
  * These versions tracked the expanded group state internally using the hierarchical group index.
19788
19237
  *
19789
- * > * When you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive,
19790
- * > the `expandGroup` method is not supported.
19791
- * > * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
19238
+ * The `expandGroup` method is not supported when you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive.
19239
+ *
19240
+ * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
19792
19241
  *
19793
19242
  * @param {string} index - The underscore separated hierarchical index of the group.
19794
19243
  */
@@ -19802,9 +19251,9 @@ class GridComponent {
19802
19251
  * This method is provided only for backwards-compatibility with legacy versions.
19803
19252
  * These versions tracked the expanded group state internally using the hierarchical group index.
19804
19253
  *
19805
- * > * When you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive,
19806
- * > the `collapseGroup` method is not supported.
19807
- * > * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
19254
+ * The `collapseGroup` method is not supported when you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive.
19255
+ *
19256
+ * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
19808
19257
  *
19809
19258
  * @param {string} index - The underscore separated hierarchical index of the group.
19810
19259
  */
@@ -20062,7 +19511,7 @@ class GridComponent {
20062
19511
  this.focusEditElement('.k-grid-add-row');
20063
19512
  }
20064
19513
  /**
20065
- * Puts the cell that is specified by the table row and column in edit mode.
19514
+ * Puts the cell that is specified by the table row and column in edit mode ([see example](slug:editing_incell_grid)).
20066
19515
  *
20067
19516
  * @param {number} rowIndex - The data row index that will be switched in the edit mode.
20068
19517
  * @param {number|string|any} column - The leaf column index, or the field name or the column instance that should be edited.
@@ -20117,7 +19566,7 @@ class GridComponent {
20117
19566
  * Exports the Grid element to a Drawing [Group]({% slug api_kendo-drawing_group %}) by using the `kendo-grid-pdf` component options.
20118
19567
  * ([see example]({% slug pdfexport_grid %}#toc-exporting-multiple-grids-to-the-same-pdf)).
20119
19568
  *
20120
- * @return {Promise} - A promise that will be resolved with the Drawing `Group`.
19569
+ * @return {Promise} A promise that will be resolved with the Drawing `Group`.
20121
19570
  */
20122
19571
  drawPDF() {
20123
19572
  const promise = createPromise();
@@ -20133,138 +19582,19 @@ class GridComponent {
20133
19582
  /**
20134
19583
  * Applies the minimum possible width for the specified column,
20135
19584
  * so that the whole text fits without wrapping. This method expects the Grid
20136
- * to be resizable (set `resizable` to `true`).
20137
- * Makes sense to execute this method only
19585
+ * to be [resizable](slug:resizing_columns_grid). The method must be executed
20138
19586
  * after the Grid is already populated with data.
20139
- *
20140
- * @example
20141
- * ```ts
20142
- * _@Component({
20143
- * selector: 'my-app',
20144
- * template: `
20145
- * <kendo-grid
20146
- * #grid
20147
- * [data]="gridData"
20148
- * [resizable]="true"
20149
- * style="height: 300px">
20150
- * <ng-template kendoGridToolbarTemplate>
20151
- * <button kendoButton (click)="grid.autoFitColumn(groupColumn)">
20152
- * Auto-fit the group column
20153
- * </button>
20154
- * </ng-template>
20155
- * <kendo-grid-column-group #groupColumn title="Product Info">
20156
- * <kendo-grid-column
20157
- * field="ProductID"
20158
- * [width]="50"
20159
- * [minResizableWidth]="30"
20160
- * title="ID">
20161
- * </kendo-grid-column>
20162
- *
20163
- * <kendo-grid-column
20164
- * field="ProductName"
20165
- * title="Product Name">
20166
- * </kendo-grid-column>
20167
- * </kendo-grid-column-group>
20168
- *
20169
- * <kendo-grid-column
20170
- * field="UnitPrice"
20171
- * title="Unit Price"
20172
- * [width]="180"
20173
- * filter="numeric"
20174
- * format="{0:c}">
20175
- * </kendo-grid-column>
20176
- * </kendo-grid>
20177
- * `
20178
- * })
20179
- * class AppComponent {
20180
- * public gridData: any[] = products;
20181
- * }
20182
- *
20183
- * const products = [{
20184
- * "ProductID": 1,
20185
- * "ProductName": "Chai",
20186
- * "UnitPrice": 18.0000,
20187
- * "Discontinued": true
20188
- * }, {
20189
- * "ProductID": 2,
20190
- * "ProductName": "Chang",
20191
- * "UnitPrice": 19.0000,
20192
- * "Discontinued": false
20193
- * }
20194
- * ];
20195
- * ```
19587
+ * [See example](slug:resizing_columns_grid#toc-auto-fitting-the-content)
20196
19588
  */
20197
19589
  autoFitColumn(column) {
20198
19590
  this.columnResizingService.autoFit(column);
20199
19591
  }
20200
19592
  /**
20201
19593
  * Adjusts the width of the specified columns to fit the entire content, including headers, without wrapping.
20202
- * If no columns are specified, `autoFitColumns` is applied to all columns.
20203
- *
20204
- * This method requires the Grid to be resizable (set `resizable` to `true`).
20205
- *
20206
- * @example
20207
- * ```ts
20208
- * _@Component({
20209
- * selector: 'my-app',
20210
- * template: `
20211
- * <kendo-grid
20212
- * #grid
20213
- * [data]="gridData"
20214
- * [resizable]="true"
20215
- * style="height: 300px">
20216
- * <ng-template kendoGridToolbarTemplate>
20217
- * <button kendoButton (click)="grid.autoFitColumns([firstColumn, lastColumn])">
20218
- * Auto-fit the first and last column
20219
- * </button>
20220
- * <button kendoButton (click)="grid.autoFitColumns()">
20221
- * Auto-fit all columns
20222
- * </button>
20223
- * </ng-template>
20224
- * <kendo-grid-column-group title="Product Info">
20225
- * <kendo-grid-column
20226
- * #firstColumn
20227
- * field="ProductID"
20228
- * [width]="50"
20229
- * [minResizableWidth]="30"
20230
- * title="ID">
20231
- * </kendo-grid-column>
20232
- *
20233
- * <kendo-grid-column
20234
- * field="ProductName"
20235
- * title="Product Name"
20236
- * >
20237
- * </kendo-grid-column>
20238
- * </kendo-grid-column-group>
20239
- *
20240
- * <kendo-grid-column
20241
- * #lastColumn
20242
- * field="UnitPrice"
20243
- * title="Unit Price"
20244
- * [width]="180"
20245
- * filter="numeric"
20246
- * format="{0:c}">
20247
- * </kendo-grid-column>
20248
- * </kendo-grid>
20249
- * `
20250
- * })
20251
- * class AppComponent {
20252
- * public gridData: any[] = products;
20253
- * }
19594
+ * If no columns are specified, `autoFitColumns` is applied to all columns.The method must be executed
19595
+ * after the Grid is already populated with data.
19596
+ * [See example](slug:resizing_columns_grid#toc-auto-fitting-the-content)
20254
19597
  *
20255
- * const products = [{
20256
- * "ProductID": 1,
20257
- * "ProductName": "Chai",
20258
- * "UnitPrice": 18.0000,
20259
- * "Discontinued": true
20260
- * }, {
20261
- * "ProductID": 2,
20262
- * "ProductName": "Chang",
20263
- * "UnitPrice": 19.0000,
20264
- * "Discontinued": false
20265
- * }
20266
- * ];
20267
- * ```
20268
19598
  */
20269
19599
  autoFitColumns(columns = this.columns) {
20270
19600
  let cols;
@@ -20325,10 +19655,10 @@ class GridComponent {
20325
19655
  /**
20326
19656
  * Focuses the cell with the specified row and column index.
20327
19657
  *
20328
- * The row index is based on the logical structure of the Grid and does not correspond to the data item index:
20329
- * * Header rows are included, starting at index 0.
20330
- * * Group headers and footers are included.
20331
- * * The row indexing is absolute and does not change with paging.
19658
+ * The row index is based on the logical structure of the Grid and does not correspond to the data item index.
19659
+ * Header rows are included, starting at index 0.
19660
+ * Group headers and footers are included.
19661
+ * The row indexing is absolute and does not change with paging.
20332
19662
  *
20333
19663
  * If the Grid is configured for scrolling, including virtual scrolling, the scroll position will be updated.
20334
19664
  * If the row is not present on the current page, the method will have no effect.
@@ -20379,67 +19709,6 @@ class GridComponent {
20379
19709
  * @param {number} destIndex - The new position of the column.
20380
19710
  * @param {ColumnReorderConfig} options - Additional options.
20381
19711
  *
20382
- * @example
20383
- * ```ts
20384
- * _@Component({
20385
- * selector: 'my-app',
20386
- * template: `
20387
- * <kendo-grid
20388
- * #grid
20389
- * [data]="gridData"
20390
- * [reorderable]="true"
20391
- * style="height: 300px">
20392
- * <ng-template kendoGridToolbarTemplate>
20393
- * <button kendoButton
20394
- * (click)="grid.reorderColumn(groupColumn, 2, { before: true })">
20395
- * Move the group column before the last one.
20396
- * </button>
20397
- * </ng-template>
20398
- * <kendo-grid-column-group #groupColumn title="Product Info">
20399
- * <kendo-grid-column
20400
- * field="ProductID"
20401
- * [width]="50"
20402
- * title="ID">
20403
- * </kendo-grid-column>
20404
- *
20405
- * <kendo-grid-column
20406
- * field="ProductName"
20407
- * title="Product Name">
20408
- * </kendo-grid-column>
20409
- * </kendo-grid-column-group>
20410
- *
20411
- * <kendo-grid-column
20412
- * field="UnitPrice"
20413
- * title="Unit Price"
20414
- * [width]="180"
20415
- * format="{0:c}">
20416
- * </kendo-grid-column>
20417
- *
20418
- * <kendo-grid-column
20419
- * field="Discontinued"
20420
- * title="Discontinued"
20421
- * [width]="100">
20422
- * </kendo-grid-column>
20423
- * </kendo-grid>
20424
- * `
20425
- * })
20426
- * class AppComponent {
20427
- * public gridData: any[] = products;
20428
- * }
20429
- *
20430
- * const products = [{
20431
- * "ProductID": 1,
20432
- * "ProductName": "Chai",
20433
- * "UnitPrice": 18.0000,
20434
- * "Discontinued": true
20435
- * }, {
20436
- * "ProductID": 2,
20437
- * "ProductName": "Chang",
20438
- * "UnitPrice": 19.0000,
20439
- * "Discontinued": false
20440
- * }
20441
- * ];
20442
- * ```
20443
19712
  */
20444
19713
  reorderColumn(source, destIndex, options = { before: false }) {
20445
19714
  const columnsForLevel = sortColumns(this.allColumnsForLevel(source.level));
@@ -22829,7 +22098,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
22829
22098
 
22830
22099
  /**
22831
22100
  * Custom component messages override default component messages
22832
- * ([see example]({% slug globalization_grid %}#toc-localization)).
22101
+ * ([see example](slug:globalization_grid#toc-custom-messages)).
22833
22102
  */
22834
22103
  class CustomMessagesComponent extends GridMessages {
22835
22104
  constructor(service) {
@@ -23027,11 +22296,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23027
22296
  }] });
23028
22297
 
23029
22298
  /**
23030
- * Represents the `Contains` (**Contains**) filter operator.
23031
- *
23032
- * For more information and examples, refer to:
23033
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23034
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22299
+ * Represents the `Contains` (**Contains**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
22300
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23035
22301
  */
23036
22302
  class ContainsFilterOperatorComponent extends FilterOperatorBase {
23037
22303
  constructor(localization) { super("contains", localization); }
@@ -23058,11 +22324,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23058
22324
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23059
22325
 
23060
22326
  /**
23061
- * Represents the `DoesNotContain` (**Does not contain**) filter operator.
22327
+ * Represents the `DoesNotContain` (**Does not contain**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23062
22328
  *
23063
- * For more information and examples, refer to:
23064
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23065
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22329
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23066
22330
  */
23067
22331
  class DoesNotContainFilterOperatorComponent extends FilterOperatorBase {
23068
22332
  constructor(localization) { super("doesnotcontain", localization); }
@@ -23089,11 +22353,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23089
22353
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23090
22354
 
23091
22355
  /**
23092
- * Represents the `EndsWith` (**Ends with**) string filter operator.
22356
+ * Represents the `EndsWith` (**Ends with**) string filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23093
22357
  *
23094
- * For more information and examples, refer to:
23095
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23096
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22358
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23097
22359
  */
23098
22360
  class EndsWithFilterOperatorComponent extends FilterOperatorBase {
23099
22361
  constructor(localization) { super("endswith", localization); }
@@ -23120,11 +22382,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23120
22382
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23121
22383
 
23122
22384
  /**
23123
- * Represents the `Equal` (**Is equal to**) filter operator.
22385
+ * Represents the `Equal` (**Is equal to**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23124
22386
  *
23125
- * For more information and examples, refer to:
23126
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23127
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22387
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23128
22388
  */
23129
22389
  class EqualFilterOperatorComponent extends FilterOperatorBase {
23130
22390
  constructor(localization) { super("eq", localization); }
@@ -23151,11 +22411,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23151
22411
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23152
22412
 
23153
22413
  /**
23154
- * Represents the `IsEmpty` (**Is empty**) filter operator.
22414
+ * Represents the `IsEmpty` (**Is empty**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23155
22415
  *
23156
- * For more information and examples, refer to:
23157
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23158
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22416
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23159
22417
  */
23160
22418
  class IsEmptyFilterOperatorComponent extends FilterOperatorBase {
23161
22419
  constructor(localization) { super("isempty", localization); }
@@ -23182,11 +22440,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23182
22440
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23183
22441
 
23184
22442
  /**
23185
- * Represents the `IsNotEmpty` (**Is not empty**) filter operator.
22443
+ * Represents the `IsNotEmpty` (**Is not empty**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23186
22444
  *
23187
- * For more information and examples, refer to:
23188
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23189
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22445
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23190
22446
  */
23191
22447
  class IsNotEmptyFilterOperatorComponent extends FilterOperatorBase {
23192
22448
  constructor(localization) { super("isnotempty", localization); }
@@ -23213,11 +22469,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23213
22469
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23214
22470
 
23215
22471
  /**
23216
- * Represents the `IsNotNull` (**Is not null**) filter operator.
22472
+ * Represents the `IsNotNull` (**Is not null**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23217
22473
  *
23218
- * For more information and examples, refer to:
23219
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23220
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22474
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23221
22475
  */
23222
22476
  class IsNotNullFilterOperatorComponent extends FilterOperatorBase {
23223
22477
  constructor(localization) { super("isnotnull", localization); }
@@ -23244,11 +22498,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23244
22498
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23245
22499
 
23246
22500
  /**
23247
- * Represents the `IsNull` (**Is null**) filter operator.
22501
+ * Represents the `IsNull` (**Is null**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23248
22502
  *
23249
- * For more information and examples, refer to:
23250
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23251
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22503
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23252
22504
  */
23253
22505
  class IsNullFilterOperatorComponent extends FilterOperatorBase {
23254
22506
  constructor(localization) { super("isnull", localization); }
@@ -23275,11 +22527,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23275
22527
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23276
22528
 
23277
22529
  /**
23278
- * Represents the `NotEqual` (**Is not equal to**) filter operator.
22530
+ * Represents the `NotEqual` (**Is not equal to**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23279
22531
  *
23280
- * For more information and examples, refer to:
23281
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23282
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22532
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23283
22533
  */
23284
22534
  class NotEqualFilterOperatorComponent extends FilterOperatorBase {
23285
22535
  constructor(localization) { super("neq", localization); }
@@ -23306,11 +22556,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23306
22556
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23307
22557
 
23308
22558
  /**
23309
- * Represents the `StartsWith` (**Starts with**) filter operator.
22559
+ * Represents the `StartsWith` (**Starts with**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23310
22560
  *
23311
- * For more information and examples, refer to:
23312
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23313
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22561
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23314
22562
  */
23315
22563
  class StartsWithFilterOperatorComponent extends FilterOperatorBase {
23316
22564
  constructor(localization) { super("startswith", localization); }
@@ -23336,12 +22584,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23336
22584
  }]
23337
22585
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23338
22586
 
23339
- /*
23340
- * Represents the `Greater` (**Is greater than**) numeric filter operator.
23341
- *
23342
- * For more information and examples, refer to:
23343
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23344
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22587
+ /**
22588
+ * Represents the `Greater` (**Is greater than**) [numeric filter](slug:filtering_grid#toc-numeric-filter) operator.
22589
+ * [See example](slug:filter_row#toc-default-filter-operator).
23345
22590
  */
23346
22591
  class GreaterFilterOperatorComponent extends FilterOperatorBase {
23347
22592
  constructor(localization) { super("gt", localization); }
@@ -23368,11 +22613,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23368
22613
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23369
22614
 
23370
22615
  /**
23371
- * Represents the `GreaterOrEqualTo` (**Is greater than or equal to**) numeric filter operator.
23372
- *
23373
- * For more information and examples, refer to:
23374
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23375
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22616
+ * Represents the `GreaterOrEqualTo` (**Is greater than or equal to**) [numeric filter](slug:filtering_grid#toc-numeric-filter) operator.
22617
+ * [See example](slug:filter_row#toc-default-filter-operator).
23376
22618
  */
23377
22619
  class GreaterOrEqualToFilterOperatorComponent extends FilterOperatorBase {
23378
22620
  constructor(localization) { super("gte", localization); }
@@ -23398,12 +22640,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23398
22640
  }]
23399
22641
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23400
22642
 
23401
- /*
23402
- * Represents the `Less` (**Is less than**) numeric filter operator.
22643
+ /**
22644
+ * Represents the `Less` (**Is less than**) [numeric filter](slug:filtering_grid#toc-numeric-filter) operator.
23403
22645
  *
23404
- * For more information and examples, refer to:
23405
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23406
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22646
+ * [See example](slug:filter_row#toc-default-filter-operator).
23407
22647
  */
23408
22648
  class LessFilterOperatorComponent extends FilterOperatorBase {
23409
22649
  constructor(localization) { super("lt", localization); }
@@ -23429,12 +22669,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23429
22669
  }]
23430
22670
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23431
22671
 
23432
- /*
23433
- * Represents the `LessOrEqualTo` (**Is less than or equal to**) numeric filter operator.
22672
+ /**
22673
+ * Represents the `LessOrEqualTo` (**Is less than or equal to**) [numeric filter](slug:filtering_grid#toc-numeric-filter) operator.
23434
22674
  *
23435
- * For more information and examples, refer to:
23436
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23437
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22675
+ * [See example](slug:filter_row#toc-default-filter-operator).
23438
22676
  */
23439
22677
  class LessOrEqualToFilterOperatorComponent extends FilterOperatorBase {
23440
22678
  constructor(localization) { super("lte", localization); }
@@ -23460,12 +22698,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23460
22698
  }]
23461
22699
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23462
22700
 
23463
- /*
23464
- * Represents the `Greater` (**Is after**) date filter operator.
23465
- *
23466
- * For more information and examples, refer to:
23467
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23468
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22701
+ /**
22702
+ * Represents the `Greater` (**Is after**) [date filter](slug:filtering_grid#toc-date-filter) operator.
22703
+ * [See example](slug:filter_row#toc-default-filter-operator).
23469
22704
  */
23470
22705
  class AfterFilterOperatorComponent extends FilterOperatorBase {
23471
22706
  constructor(localization) { super("after", localization); }
@@ -23500,12 +22735,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23500
22735
  }]
23501
22736
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23502
22737
 
23503
- /*
23504
- * Represents the `GreaterOrEqualTo` (**Is after or equal to**) date filter operator.
23505
- *
23506
- * For more information and examples, refer to:
23507
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23508
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22738
+ /**
22739
+ * Represents the `GreaterOrEqualTo` (**Is after or equal to**) [date filter](slug:filtering_grid#toc-date-filter) operator.
22740
+ * [See example](slug:filter_row#toc-default-filter-operator).
23509
22741
  */
23510
22742
  class AfterEqFilterOperatorComponent extends FilterOperatorBase {
23511
22743
  constructor(localization) { super("after-eq", localization); }
@@ -23540,12 +22772,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23540
22772
  }]
23541
22773
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23542
22774
 
23543
- /*
23544
- * Represents the `LessOrEqualTo` (**Is before or equal to**) date filter operator.
23545
- *
23546
- * For more information and examples, refer to:
23547
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23548
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22775
+ /**
22776
+ * Represents the `LessOrEqualTo` (**Is before or equal to**) [date filter](slug:filtering_grid#toc-date-filter) operator.
22777
+ * [See example](slug:filter_row#toc-default-filter-operator).
23549
22778
  */
23550
22779
  class BeforeEqFilterOperatorComponent extends FilterOperatorBase {
23551
22780
  constructor(localization) { super("before-eq", localization); }
@@ -23580,12 +22809,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23580
22809
  }]
23581
22810
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23582
22811
 
23583
- /*
23584
- * Represents the `Less then` (**Is before**) date filter operator.
23585
- *
23586
- * For more information and examples, refer to:
23587
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23588
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22812
+ /**
22813
+ * Represents the `Less than` (**Is before**) [date filter](slug:filtering_grid#toc-date-filter) operator.
22814
+ * [See example](slug:filter_row#toc-default-filter-operator).
23589
22815
  */
23590
22816
  class BeforeFilterOperatorComponent extends FilterOperatorBase {
23591
22817
  constructor(localization) { super("before", localization); }
@@ -24025,27 +23251,18 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
24025
23251
  }] });
24026
23252
 
24027
23253
  /**
24028
- * Represents the component for selecting columns in the Grid. To enable the user to show or hide columns,
24029
- * add the component inside a [ToolbarTemplate]({% slug api_grid_toolbartemplatedirective %}) directive.
23254
+ * Represents the component for toggling the visibility of the Grid columns. [See example](slug:columnmenu_grid#toc-using-standalone-column-chooser).
23255
+ * To show and hide the columns without including the column chooser item in the [Column Menu](slug:columnmenu_grid),
23256
+ * add the component inside the [ToolbarTemplate](slug:toolbartemplate_grid) directive.
24030
23257
  *
24031
23258
  * @example
24032
- * ```ts-preview
24033
- * _@Component({
24034
- * selector: 'my-app',
24035
- * template: `
24036
- * <kendo-grid [data]="data">
24037
- * <ng-template kendoGridToolbarTemplate>
24038
- * <kendo-grid-column-chooser></kendo-grid-column-chooser>
24039
- * </ng-template>
24040
- * <kendo-grid-column field="Field1"></kendo-grid-column>
24041
- * <kendo-grid-column field="Field2" [hidden]="true"></kendo-grid-column>
24042
- * </kendo-grid>
24043
- * `
24044
- * })
24045
- *
24046
- * class AppComponent {
24047
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
24048
- * }
23259
+ * ```html
23260
+ * <kendo-grid [data]="data">
23261
+ * <ng-template kendoGridToolbarTemplate>
23262
+ * <kendo-grid-column-chooser></kendo-grid-column-chooser>
23263
+ * </ng-template>
23264
+ * <kendo-grid-column field="ProductID"></kendo-grid-column>
23265
+ * </kendo-grid>
24049
23266
  * ```
24050
23267
  */
24051
23268
  class ColumnChooserComponent {
@@ -24062,10 +23279,14 @@ class ColumnChooserComponent {
24062
23279
  this.columnsIcon = columnsIcon;
24063
23280
  /**
24064
23281
  * Specifies if the changes in the visibility of the column will be immediately applied.
23282
+ *
23283
+ * @default false
24065
23284
  */
24066
23285
  this.autoSync = false;
24067
23286
  /**
24068
23287
  * Specifies if all columns can be hidden.
23288
+ *
23289
+ * @default true
24069
23290
  */
24070
23291
  this.allowHideAll = true;
24071
23292
  }
@@ -24324,65 +23545,14 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
24324
23545
  }] });
24325
23546
 
24326
23547
  /**
24327
- * Represents the checkbox for selecting columns in the Grid. If the column is
24328
- * defined as empty, it renders a default checkbox for row selection.
24329
- * You can also define the content of the column inside an `<ng-template>` tag.
24330
- * The input requires you to include the `SelectionCheckbox` option.
24331
- *
24332
- * The template context is set to the current data item and the following additional fields are passed:
24333
- * - `columnIndex`&mdash;The current column index.
24334
- * - `rowIndex`&mdash;The current data row index. If inside a new item row, it will be `-1`.
24335
- * - `dataItem`&mdash;The current data item.
24336
- * - `column`&mdash;The current column instance.
24337
- * - `isNew`&mdash;The state of the current item.
24338
- *
24339
- * For more examples, refer to:
24340
- * - [Selecting or deselecting all items on a page]({% slug selection_grid %}#toc-select-all-feature)
24341
- * - [Persisting the selection]({% slug selection_grid %}#toc-in-combination-with-the-select-all-feature)
23548
+ * Represents the checkbox column for selecting rows in the Grid. [See example](slug:grid_row_selection#toc-select-all-checkbox).
24342
23549
  *
24343
23550
  * @example
24344
- * ```ts-preview
24345
- *
24346
- * _@Component({
24347
- * selector: 'my-app',
24348
- * template: `
24349
- * <kendo-grid [data]="gridData" [selectable]="{enabled: true, checkboxOnly: true}">
24350
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
24351
- * </kendo-grid-column>
24352
- * <kendo-grid-column field="ProductName" title="Product Name">
24353
- * </kendo-grid-column>
24354
- * <kendo-grid-checkbox-column title="Default checkbox">
24355
- * </kendo-grid-checkbox-column>
24356
- * <kendo-grid-checkbox-column title="Custom checkbox">
24357
- * <ng-template kendoGridCellTemplate let-idx="rowIndex">
24358
- * Select row <input [kendoGridSelectionCheckbox]="idx" />
24359
- * </ng-template>
24360
- * </kendo-grid-checkbox-column>
24361
- * </kendo-grid>
24362
- * `
24363
- * })
24364
- *
24365
- * class AppComponent {
24366
- * public gridData: any[];
24367
- *
24368
- * constructor() {
24369
- * this.gridData = products;
24370
- * }
24371
- * }
24372
- *
24373
- * const products = [{
24374
- * "ProductID": 1,
24375
- * "ProductName": "Chai",
24376
- * "UnitPrice": 18.0000,
24377
- * "Discontinued": true
24378
- * }, {
24379
- * "ProductID": 2,
24380
- * "ProductName": "Chang",
24381
- * "UnitPrice": 19.0000,
24382
- * "Discontinued": false
24383
- * }
24384
- * ];
24385
- *
23551
+ * ```html
23552
+ * <kendo-grid [selectable]="{enabled: true, checkboxOnly: true}">
23553
+ * <kendo-grid-checkbox-column title="Default checkbox"></kendo-grid-checkbox-column>
23554
+ * <kendo-grid-column field="ProductID"></kendo-grid-column>
23555
+ * </kendo-grid>
24386
23556
  * ```
24387
23557
  */
24388
23558
  class CheckboxColumnComponent extends ColumnBase {
@@ -24439,10 +23609,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
24439
23609
  * [edit]({% slug api_grid_gridcomponent %}#toc-edit) event
24440
23610
  * is triggered ([see example]({% slug basics_editing_grid %})).
24441
23611
  *
24442
- * > When the row is in the edit mode, the button with `kendoGridEditCommand` is automatically hidden.
23612
+ * When the row is in the `edit` mode, the button with `kendoGridEditCommand` is automatically hidden.
24443
23613
  *
24444
23614
  * @example
24445
- * ```html-no-run
23615
+ * ```html
24446
23616
  * <kendo-grid>
24447
23617
  * <kendo-grid-command-column title="command">
24448
23618
  * <ng-template kendoGridCellTemplate>
@@ -24889,7 +24059,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
24889
24059
  }] } });
24890
24060
 
24891
24061
  /**
24892
- * Represents the drag handle for reordering rows in the Grid.
24062
+ * Represents the drag handle for reordering rows in the Grid ([see example](slug:reordering_rows_grid))
24893
24063
  */
24894
24064
  class RowReorderColumnComponent extends ColumnBase {
24895
24065
  constructor(parent, idService) {
@@ -25898,6 +25068,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
25898
25068
  }]
25899
25069
  }] });
25900
25070
 
25071
+ /**
25072
+ * Represents the Kendo UI PDFMargin component for Angular.
25073
+ * The supported units are:
25074
+ * `"mm"`
25075
+ * `"cm"`
25076
+ * `"in"`
25077
+ * `"pt"` (default).
25078
+ * Numbers are considered to be points (`"pt"`).
25079
+ */
25901
25080
  class PDFMarginComponent extends PDFExportMarginComponent {
25902
25081
  }
25903
25082
  PDFMarginComponent.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "13.3.12", ngImport: i0, type: PDFMarginComponent, deps: null, target: i0.ɵɵFactoryTarget.Component });