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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (147) hide show
  1. package/column-menu/column-chooser.component.d.ts +14 -19
  2. package/column-menu/column-menu-autosize-all.component.d.ts +12 -27
  3. package/column-menu/column-menu-autosize.component.d.ts +12 -26
  4. package/column-menu/column-menu-chooser.component.d.ts +11 -24
  5. package/column-menu/column-menu-expandable-item.interface.d.ts +0 -1
  6. package/column-menu/column-menu-filter.component.d.ts +12 -24
  7. package/column-menu/column-menu-item.component.d.ts +6 -21
  8. package/column-menu/column-menu-lock.component.d.ts +11 -25
  9. package/column-menu/column-menu-position.component.d.ts +12 -24
  10. package/column-menu/column-menu-settings.interface.d.ts +3 -24
  11. package/column-menu/column-menu-sort.component.d.ts +12 -25
  12. package/column-menu/column-menu-stick.component.d.ts +12 -24
  13. package/column-menu/column-menu.component.d.ts +9 -1
  14. package/column-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-event-args.interface.d.ts +1 -1
  30. package/editing/remove-event-args.interface.d.ts +1 -1
  31. package/editing/save-event-args.interface.d.ts +1 -1
  32. package/editing-directives/edit-service.interface.d.ts +1 -1
  33. package/esm2020/column-menu/column-chooser.component.mjs +14 -19
  34. package/esm2020/column-menu/column-menu-autosize-all.component.mjs +12 -27
  35. package/esm2020/column-menu/column-menu-autosize.component.mjs +12 -26
  36. package/esm2020/column-menu/column-menu-chooser.component.mjs +11 -24
  37. package/esm2020/column-menu/column-menu-filter.component.mjs +12 -24
  38. package/esm2020/column-menu/column-menu-item.component.mjs +6 -21
  39. package/esm2020/column-menu/column-menu-lock.component.mjs +11 -25
  40. package/esm2020/column-menu/column-menu-position.component.mjs +12 -24
  41. package/esm2020/column-menu/column-menu-sort.component.mjs +12 -25
  42. package/esm2020/column-menu/column-menu-stick.component.mjs +12 -24
  43. package/esm2020/column-menu/column-menu.component.mjs +9 -1
  44. package/esm2020/columns/checkbox-column.component.mjs +6 -57
  45. package/esm2020/columns/column-base.mjs +1 -0
  46. package/esm2020/columns/column-group.component.mjs +9 -48
  47. package/esm2020/columns/column.component.mjs +22 -79
  48. package/esm2020/columns/command-column.component.mjs +12 -60
  49. package/esm2020/columns/reorder-column.component.mjs +1 -1
  50. package/esm2020/columns/span-column.component.mjs +12 -123
  51. package/esm2020/filtering/cell/boolean-filter-cell.component.mjs +11 -10
  52. package/esm2020/filtering/cell/date-filter-cell.component.mjs +26 -13
  53. package/esm2020/filtering/cell/filter-cell-operators.component.mjs +15 -0
  54. package/esm2020/filtering/cell/numeric-filter-cell.component.mjs +14 -11
  55. package/esm2020/filtering/cell/string-filter-cell.component.mjs +14 -15
  56. package/esm2020/filtering/date-filter.component.mjs +6 -2
  57. package/esm2020/filtering/menu/boolean-filter-menu.component.mjs +13 -13
  58. package/esm2020/filtering/menu/date-filter-menu.component.mjs +13 -13
  59. package/esm2020/filtering/menu/numeric-filter-menu.component.mjs +13 -13
  60. package/esm2020/filtering/menu/string-filter-menu.component.mjs +15 -2
  61. package/esm2020/filtering/numeric-filter.component.mjs +4 -1
  62. package/esm2020/filtering/operators/after-eq-filter-operator.component.mjs +3 -6
  63. package/esm2020/filtering/operators/after-filter-operator.component.mjs +3 -6
  64. package/esm2020/filtering/operators/before-eq-filter-operator.component.mjs +3 -6
  65. package/esm2020/filtering/operators/before-filter-operator.component.mjs +3 -6
  66. package/esm2020/filtering/operators/contains-filter-operator.component.mjs +2 -5
  67. package/esm2020/filtering/operators/ends-with-filter-operator.component.mjs +2 -4
  68. package/esm2020/filtering/operators/eq-filter-operator.component.mjs +2 -4
  69. package/esm2020/filtering/operators/gt-filter-operator.component.mjs +3 -6
  70. package/esm2020/filtering/operators/gte-filter-operator.component.mjs +2 -5
  71. package/esm2020/filtering/operators/is-empty-filter-operator.component.mjs +2 -4
  72. package/esm2020/filtering/operators/is-not-empty-filter-operator.component.mjs +2 -4
  73. package/esm2020/filtering/operators/is-not-null-filter-operator.component.mjs +2 -4
  74. package/esm2020/filtering/operators/isnull-filter-operator.component.mjs +2 -4
  75. package/esm2020/filtering/operators/lt-filter-operator.component.mjs +3 -5
  76. package/esm2020/filtering/operators/lte-filter-operator.component.mjs +3 -5
  77. package/esm2020/filtering/operators/neq-filter-operator.component.mjs +2 -4
  78. package/esm2020/filtering/operators/not-contains-filter-operator.component.mjs +2 -4
  79. package/esm2020/filtering/operators/starts-with-filter-operator.component.mjs +2 -4
  80. package/esm2020/filtering/string-filter.component.mjs +2 -1
  81. package/esm2020/grid.component.mjs +38 -324
  82. package/esm2020/localization/custom-messages.component.mjs +1 -1
  83. package/esm2020/package-metadata.mjs +2 -2
  84. package/esm2020/pager/pager-info.component.mjs +1 -1
  85. package/esm2020/pager/pager-input.component.mjs +1 -48
  86. package/esm2020/pager/pager-next-buttons.component.mjs +1 -1
  87. package/esm2020/pager/pager-numeric-buttons.component.mjs +1 -1
  88. package/esm2020/pager/pager-page-sizes.component.mjs +3 -92
  89. package/esm2020/pager/pager-prev-buttons.component.mjs +1 -1
  90. package/esm2020/pdf/pdf-margin.component.mjs +9 -0
  91. package/esm2020/rendering/common/spacer.component.mjs +2 -1
  92. package/excel/excel.component.d.ts +2 -7
  93. package/fesm2015/progress-kendo-angular-grid.mjs +435 -1260
  94. package/fesm2020/progress-kendo-angular-grid.mjs +435 -1260
  95. package/filtering/cell/boolean-filter-cell.component.d.ts +11 -10
  96. package/filtering/cell/date-filter-cell.component.d.ts +26 -13
  97. package/filtering/cell/filter-cell-operators.component.d.ts +15 -0
  98. package/filtering/cell/numeric-filter-cell.component.d.ts +14 -11
  99. package/filtering/cell/string-filter-cell.component.d.ts +14 -15
  100. package/filtering/date-filter.component.d.ts +8 -12
  101. package/filtering/menu/boolean-filter-menu.component.d.ts +13 -13
  102. package/filtering/menu/date-filter-menu.component.d.ts +13 -13
  103. package/filtering/menu/numeric-filter-menu.component.d.ts +13 -13
  104. package/filtering/menu/string-filter-menu.component.d.ts +15 -2
  105. package/filtering/numeric-filter.component.d.ts +4 -1
  106. package/filtering/operators/after-eq-filter-operator.component.d.ts +4 -0
  107. package/filtering/operators/after-filter-operator.component.d.ts +4 -0
  108. package/filtering/operators/before-eq-filter-operator.component.d.ts +4 -0
  109. package/filtering/operators/before-filter-operator.component.d.ts +4 -0
  110. package/filtering/operators/contains-filter-operator.component.d.ts +2 -5
  111. package/filtering/operators/ends-with-filter-operator.component.d.ts +2 -4
  112. package/filtering/operators/eq-filter-operator.component.d.ts +2 -4
  113. package/filtering/operators/gt-filter-operator.component.d.ts +4 -0
  114. package/filtering/operators/gte-filter-operator.component.d.ts +2 -5
  115. package/filtering/operators/is-empty-filter-operator.component.d.ts +2 -4
  116. package/filtering/operators/is-not-empty-filter-operator.component.d.ts +2 -4
  117. package/filtering/operators/is-not-null-filter-operator.component.d.ts +2 -4
  118. package/filtering/operators/isnull-filter-operator.component.d.ts +2 -4
  119. package/filtering/operators/lt-filter-operator.component.d.ts +5 -0
  120. package/filtering/operators/lte-filter-operator.component.d.ts +5 -0
  121. package/filtering/operators/neq-filter-operator.component.d.ts +2 -4
  122. package/filtering/operators/not-contains-filter-operator.component.d.ts +2 -4
  123. package/filtering/operators/starts-with-filter-operator.component.d.ts +2 -4
  124. package/filtering/string-filter.component.d.ts +2 -1
  125. package/grid.component.d.ts +42 -326
  126. package/grouping/group-key.interface.d.ts +1 -13
  127. package/grouping/group-rows-args.interface.d.ts +1 -1
  128. package/localization/custom-messages.component.d.ts +1 -1
  129. package/localization/messages.d.ts +35 -98
  130. package/navigation/navigation-cell.interface.d.ts +2 -5
  131. package/navigation/navigation-row.interface.d.ts +2 -5
  132. package/package.json +19 -19
  133. package/pager/pager-info.component.d.ts +1 -1
  134. package/pager/pager-input.component.d.ts +1 -48
  135. package/pager/pager-next-buttons.component.d.ts +1 -1
  136. package/pager/pager-numeric-buttons.component.d.ts +1 -1
  137. package/pager/pager-page-sizes.component.d.ts +3 -92
  138. package/pager/pager-prev-buttons.component.d.ts +1 -1
  139. package/pager/pager-settings.d.ts +1 -26
  140. package/pdf/pdf-margin.component.d.ts +9 -0
  141. package/pdf/pdf-margin.interface.d.ts +0 -5
  142. package/rendering/common/spacer.component.d.ts +2 -1
  143. package/row-reordering/types.d.ts +1 -1
  144. package/schematics/ngAdd/index.js +2 -2
  145. package/scrolling/content-scroll-event.d.ts +1 -1
  146. package/scrolling/scroll-request.service.d.ts +2 -1
  147. 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() {
@@ -2832,8 +2833,8 @@ const packageMetadata = {
2832
2833
  name: '@progress/kendo-angular-grid',
2833
2834
  productName: 'Kendo UI for Angular',
2834
2835
  productCodes: ['KENDOUIANGULAR', 'KENDOUICOMPLETE'],
2835
- publishDate: 1682434440,
2836
- version: '12.0.0',
2836
+ publishDate: 1683028339,
2837
+ version: '12.0.1-develop.1',
2837
2838
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
2838
2839
  };
2839
2840
 
@@ -3237,6 +3238,7 @@ class ColumnBase {
3237
3238
  this.reorderable = true;
3238
3239
  /**
3239
3240
  * The width (in pixels) below which the user is not able to resize the column by using the UI ([see example]({% slug resizing_columns_grid %}#toc-limiting-the-resizing)).
3241
+ * The `autoFitColumn` and `autoFitColumns` methods have higher priority.
3240
3242
  * @default 10
3241
3243
  */
3242
3244
  this.minResizableWidth = 10;
@@ -3495,113 +3497,56 @@ function isColumnComponent(column) {
3495
3497
  return isPresent(column.field);
3496
3498
  }
3497
3499
  /**
3498
- * Represents the columns of the [Angular Data Grid]({% slug overview_grid %}).
3500
+ * Represents the column of the Grid. [See example](slug:columns_config#toc-using-the-column-component)
3499
3501
  *
3500
3502
  * @example
3501
- * ```ts-preview
3502
- *
3503
- * _@Component({
3504
- * selector: 'my-app',
3505
- * template: `
3506
- * <kendo-grid [data]="gridData">
3507
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
3508
- * </kendo-grid-column>
3509
- * <kendo-grid-column field="ProductName" title="Product Name">
3510
- * </kendo-grid-column>
3511
- * <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
3512
- * </kendo-grid-column>
3513
- * <kendo-grid-column field="Discontinued" [width]="120">
3514
- * <ng-template kendoGridCellTemplate let-dataItem>
3515
- * <input type="checkbox" [checked]="dataItem.Discontinued" disabled/>
3516
- * </ng-template>
3517
- * </kendo-grid-column>
3518
- * </kendo-grid>
3519
- * `
3520
- * })
3521
- *
3522
- * class AppComponent {
3523
- * public gridData: any[];
3524
- *
3525
- * constructor() {
3526
- * this.gridData = products;
3527
- * }
3528
- * }
3529
- *
3530
- * const products = [{
3531
- * "ProductID": 1,
3532
- * "ProductName": "Chai",
3533
- * "UnitPrice": 18.0000,
3534
- * "Discontinued": true
3535
- * }, {
3536
- * "ProductID": 2,
3537
- * "ProductName": "Chang",
3538
- * "UnitPrice": 19.0000,
3539
- * "Discontinued": false
3540
- * }
3541
- * ];
3542
- *
3503
+ * ```html
3504
+ * <kendo-grid [data]="gridData">
3505
+ * <kendo-grid-column field="ProductID" title="Product ID"></kendo-grid-column>
3506
+ * <kendo-grid-column field="ProductName" title="Product Name"></kendo-grid-column>
3507
+ * <kendo-grid-column field="UnitPrice" title="Unit Price"></kendo-grid-column>
3508
+ * </kendo-grid>
3543
3509
  * ```
3544
3510
  */
3545
3511
  class ColumnComponent extends ColumnBase {
3546
3512
  constructor(parent, idService) {
3547
3513
  super(parent, idService);
3548
3514
  /**
3549
- * Allows the column headers to be clicked and the `sortChange` event emitted.
3550
- * You have to handle the `sortChange` event yourself and sort the data.
3515
+ * Allows the user to click the column headers and emits the `sortChange` event. [See example](slug:sorting_grid).
3516
+ *
3517
+ * @default true
3551
3518
  */
3552
3519
  this.sortable = true;
3553
3520
  /**
3554
- * Determines if the column can be dragged to the group panel. The default value is `true`.
3521
+ * Determines if the column can be dragged to the group panel.
3555
3522
  * If set to `false`, you can group the columns by the column field by using the API of the Grid.
3523
+ *
3524
+ * @default true
3556
3525
  */
3557
3526
  this.groupable = true;
3558
3527
  /**
3559
- * Defines the editor type ([see example]({% slug inline_editing_grid %}#toc-using-reactive-forms)).
3560
- * Used when the column enters the edit mode. The default value is `text`.
3528
+ * Defines the editor type. [See example](slug:inline_editing_grid#toc-using-reactive-forms).
3529
+ * Used when the column enters the edit mode.
3561
3530
  *
3562
- * @example
3563
- * ```html-no-run
3564
- * <kendo-grid>
3565
- * <kendo-grid-column field="UnitPrice" editor="numeric">
3566
- * </kendo-grid-column>
3567
- * </kendo-grid>
3568
- * ```
3531
+ * @default 'text'
3569
3532
  */
3570
3533
  this.editor = 'text';
3571
3534
  /**
3572
- * Defines the filter type that is displayed inside the filter row. The default value is `text`.
3535
+ * Defines the filter type that is displayed inside the filter row. [See example](slug:filtering_grid#toc-filter-data-types).
3573
3536
  *
3574
- * @example
3575
- * ```html-no-run
3576
- * <kendo-grid>
3577
- * <kendo-grid-column field="UnitPrice" filter="numeric">
3578
- * </kendo-grid-column>
3579
- * </kendo-grid>
3580
- * ```
3537
+ * @default 'text'
3581
3538
  */
3582
3539
  this.filter = 'text';
3583
3540
  /**
3584
- * Defines if a filter UI will be displayed for this column. The default value is `true`.
3541
+ * Defines if a filter UI will be displayed for this column. [See example](slug:filtering_grid).
3585
3542
  *
3586
- * @example
3587
- * ```html-no-run
3588
- * <kendo-grid>
3589
- * <kendo-grid-column field="UnitPrice" [filterable]="false">
3590
- * </kendo-grid-column>
3591
- * </kendo-grid>
3592
- * ```
3543
+ * @default true
3593
3544
  */
3594
3545
  this.filterable = true;
3595
3546
  /**
3596
- * Defines whether the column is editable. The default value is `true`.
3547
+ * Defines whether the column is editable. [See example](slug:make_fields_uneditable_grid).
3597
3548
  *
3598
- * @example
3599
- * ```html-no-run
3600
- * <kendo-grid>
3601
- * <kendo-grid-column field="UnitPrice" [editable]="false">
3602
- * </kendo-grid-column>
3603
- * </kendo-grid>
3604
- * ```
3549
+ * @default true
3605
3550
  */
3606
3551
  this.editable = true;
3607
3552
  }
@@ -3712,62 +3657,15 @@ function isSpanColumnComponent(column) {
3712
3657
  * [grouping]({% slug grouping_grid %}). Wrap the columns that will be
3713
3658
  * merged inside the `<kendo-grid-span-column>` tag.
3714
3659
  *
3715
- * @example
3716
- * ```ts-preview
3717
- *
3718
- * _@Component({
3719
- * selector: 'my-app',
3720
- * template: `
3721
- * <kendo-grid
3722
- * [sortable]="true"
3723
- * [filterable]="true"
3724
- * [kendoGridBinding]="products">
3725
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
3726
- * </kendo-grid-column>
3727
- * <kendo-grid-span-column>
3728
- * <kendo-grid-column field="ProductName" title="Product Name">
3729
- * </kendo-grid-column>
3730
- * <kendo-grid-column field="UnitPrice" title="Unit Price" filter="numeric" [width]="180" format="{0:c}">
3731
- * </kendo-grid-column>
3732
- * </kendo-grid-span-column>
3733
- * <kendo-grid-column field="Discontinued" [width]="120" filter="boolean">
3734
- * <ng-template kendoGridCellTemplate let-dataItem>
3735
- * <input type="checkbox" [checked]="dataItem.Discontinued" disabled/>
3736
- * </ng-template>
3737
- * </kendo-grid-column>
3738
- * </kendo-grid>
3739
- * `
3740
- * })
3741
- *
3742
- * class AppComponent {
3743
- * public products = [{
3744
- * "ProductID": 1,
3745
- * "ProductName": "Chai",
3746
- * "UnitPrice": 18.0000,
3747
- * "Discontinued": true
3748
- * }, {
3749
- * "ProductID": 2,
3750
- * "ProductName": "Chang",
3751
- * "UnitPrice": 19.0000,
3752
- * "Discontinued": false
3753
- * }
3754
- * ];
3755
- * }
3756
- *
3757
- * ```
3758
- *
3759
- * By default, the data cell displays the data for the specified fields. To further customize
3760
- * the span-column functionality, use a [cell template]({% slug api_grid_celltemplatedirective %}).
3761
- *
3762
- * ```html-no-run
3660
+ * ```html
3763
3661
  * <kendo-grid-span-column>
3764
- * <kendo-grid-column field="field1" title="Field 1"></kendo-grid-column>
3765
- * <kendo-grid-column field="field2" title="Field 2"></kendo-grid-column>
3766
- * <ng-template kendoGridCellTemplate let-dataItem>
3767
- * <h5>{{ dataItem.field1 }}</h5>
3768
- * <p>{{ dataItem.field2 }}</p>
3769
- * </ng-template>
3770
- * </kendo-grid-span-column>
3662
+ * <kendo-grid-column field="field1"></kendo-grid-column>
3663
+ * <kendo-grid-column field="field2"></kendo-grid-column>
3664
+ * <ng-template kendoGridCellTemplate let-dataItem>
3665
+ * <h5>{{ dataItem.field1 }}</h5>
3666
+ * <p>{{ dataItem.field2 }}</p>
3667
+ * </ng-template>
3668
+ * </kendo-grid-span-column>
3771
3669
  * ```
3772
3670
  */
3773
3671
  class SpanColumnComponent extends ColumnBase {
@@ -3793,24 +3691,9 @@ class SpanColumnComponent extends ColumnBase {
3793
3691
  }
3794
3692
  }
3795
3693
  /**
3796
- * Defines whether the edit template of the column will be rendered. The default value is `false`.
3797
- *
3798
- * > To enable the editing functionality for a spanned column, set an edit template for it.
3799
- *
3800
- * @example
3801
- * ```html-no-run
3802
- * <kendo-grid>
3803
- * <kendo-grid-span-column [editable]="false">
3804
- * <kendo-grid-column field="UnitPrice">
3805
- * </kendo-grid-column>
3806
- * <kendo-grid-column field="ProductName">
3807
- * </kendo-grid-column>
3808
- * <ng-template kendoGridEditTemplate>
3809
- * .....
3810
- * </ng-template>
3811
- * </kendo-grid-span-column>
3812
- * </kendo-grid>
3813
- * ```
3694
+ * Defines whether the edit template of the column will be rendered.
3695
+ * To enable the editing functionality for a spanned column, set an edit template for it ([see exmaple](slug:custom_reactive_editing_grid)).
3696
+ * @default false
3814
3697
  */
3815
3698
  set editable(value) {
3816
3699
  this._editable = value;
@@ -3854,57 +3737,8 @@ class SpanColumnComponent extends ColumnBase {
3854
3737
  return this.childColumns.filter(c => c.isVisible).length;
3855
3738
  }
3856
3739
  /**
3857
- * Toggles the locked (frozen) state of the columns. Locked columns are visible
3858
- * at all times during the horizontal scrolling of the Grid.
3859
- *
3860
- * For the option to work properly, make sure that:
3861
- * - Scrolling is enabled.
3862
- * - The `height` option of the Grid is set.
3863
- * - The widths of all Grid columns are explicitly set in pixels. In this way,
3864
- * the Grid adjusts the layout of the locked and unlocked columns.
3865
- *
3740
+ * Toggles the locked (frozen) state of the columns ([see example](slug:locked_columns_grid)).
3866
3741
  * @default false
3867
- *
3868
- * @example
3869
- * ```ts
3870
- * _@Component({
3871
- * selector: 'my-app',
3872
- * template: `
3873
- * <kendo-grid [data]="gridData" [scrollable]="scrollable" style="height: 200px">
3874
- * <kendo-grid-span-column [locked]="true">
3875
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
3876
- * </kendo-grid-column>
3877
- * <kendo-grid-column field="ProductName" title="Product Name" [width]="200">
3878
- * </kendo-grid-column>
3879
- * </kendo-grid-span-column>
3880
- * <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
3881
- * </kendo-grid-column>
3882
- * </kendo-grid>
3883
- * `
3884
- * })
3885
- *
3886
- * class AppComponent {
3887
- * public gridData: any[];
3888
- *
3889
- * constructor() {
3890
- * this.gridData = products;
3891
- * }
3892
- * }
3893
- *
3894
- * const products = [{
3895
- * "ProductID": 1,
3896
- * "ProductName": "Chai",
3897
- * "UnitPrice": 18.0000,
3898
- * "Discontinued": true
3899
- * }, {
3900
- * "ProductID": 2,
3901
- * "ProductName": "Chang",
3902
- * "UnitPrice": 19.0000,
3903
- * "Discontinued": false
3904
- * }
3905
- * ];
3906
- *
3907
- * ```
3908
3742
  */
3909
3743
  set locked(value) {
3910
3744
  this._locked = value;
@@ -4038,56 +3872,17 @@ function isColumnGroupComponent(column) {
4038
3872
  }
4039
3873
  /**
4040
3874
  * Represents the column group header of the Grid
4041
- * ([more information and examples]({% slug multicolumnheaders_columns_grid %})).
3875
+ * ([more information and examples](slug:multicolumnheaders_columns_grid)).
4042
3876
  *
4043
3877
  * @example
4044
- * ```ts-preview
4045
- *
4046
- * _@Component({
4047
- * selector: 'my-app',
4048
- * template: `
4049
- * <kendo-grid [data]="gridData">
4050
- * <kendo-grid-column-group title="Product Info">
4051
- * <ng-template kendoGridHeaderTemplate let-columnIndex="columnIndex" let-column="column">
4052
- * Column index: {{columnIndex}} / column title: {{column.title}}
4053
- * </ng-template>
4054
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
4055
- * </kendo-grid-column>
4056
- * <kendo-grid-column field="ProductName" title="Product Name">
4057
- * </kendo-grid-column>
4058
- * </kendo-grid-column-group>
4059
- * <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
4060
- * </kendo-grid-column>
4061
- * <kendo-grid-column field="Discontinued" [width]="120">
4062
- * <ng-template kendoGridCellTemplate let-dataItem>
4063
- * <input type="checkbox" [checked]="dataItem.Discontinued" disabled/>
4064
- * </ng-template>
4065
- * </kendo-grid-column>
4066
- * </kendo-grid>
4067
- * `
4068
- * })
4069
- *
4070
- * class AppComponent {
4071
- * public gridData: any[];
4072
- *
4073
- * constructor() {
4074
- * this.gridData = products;
4075
- * }
4076
- * }
4077
- *
4078
- * const products = [{
4079
- * "ProductID": 1,
4080
- * "ProductName": "Chai",
4081
- * "UnitPrice": 18.0000,
4082
- * "Discontinued": true
4083
- * }, {
4084
- * "ProductID": 2,
4085
- * "ProductName": "Chang",
4086
- * "UnitPrice": 19.0000,
4087
- * "Discontinued": false
4088
- * }
4089
- * ];
4090
- *
3878
+ * ```html
3879
+ * <kendo-grid [data]="gridData">
3880
+ * <kendo-grid-column-group title="Product Info">
3881
+ * <kendo-grid-column field="ProductID"></kendo-grid-column>
3882
+ * <kendo-grid-column field="ProductName"></kendo-grid-column>
3883
+ * </kendo-grid-column-group>
3884
+ * <kendo-grid-column field="UnitPrice"></kendo-grid-column>
3885
+ * </kendo-grid>
4091
3886
  * ```
4092
3887
  */
4093
3888
  class ColumnGroupComponent extends ColumnBase {
@@ -6955,7 +6750,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
6955
6750
  }] } });
6956
6751
 
6957
6752
  /**
6958
- * Displays buttons for navigating to the first and to the previous page ([see example]({% slug paging_grid %}#toc-pager-templates)).
6753
+ * Displays buttons for navigating to the first and to the previous page ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
6959
6754
  */
6960
6755
  class PagerPrevButtonsComponent extends PagerElementComponent {
6961
6756
  constructor(localization, pagerContext, cd, navigationService) {
@@ -7057,7 +6852,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
7057
6852
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }, { type: PagerContextService }, { type: i0.ChangeDetectorRef }, { type: NavigationService }]; } });
7058
6853
 
7059
6854
  /**
7060
- * Displays numeric buttons to enable navigation between the pages.
6855
+ * Displays numeric buttons to enable navigation between the pages ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
7061
6856
  */
7062
6857
  class PagerNumericButtonsComponent extends PagerElementComponent {
7063
6858
  constructor(localization, cd, pagerContext) {
@@ -7313,54 +7108,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
7313
7108
  }], ctorParameters: function () { return [{ type: i3.NumericTextBoxComponent }, { type: i0.Renderer2 }]; } });
7314
7109
 
7315
7110
  /**
7316
- * Displays an input element which allows the typing and rendering of page numbers.
7317
- *
7318
- * @example
7319
- * ```ts-preview
7320
- *
7321
- * _@Component({
7322
- * selector: 'my-app',
7323
- * template: `
7324
- * <kendo-grid
7325
- * [kendoGridBinding]="gridData"
7326
- * [pageSize]="1"
7327
- * [pageable]="true"
7328
- * >
7329
- * <kendo-grid-column field="ProductID" title="ID" [width]="40">
7330
- * </kendo-grid-column>
7331
- * <kendo-grid-column field="ProductName" title="Name" [width]="250">
7332
- * </kendo-grid-column>
7333
- * <kendo-grid-column field="UnitPrice" title="Price" [width]="80" format="{0:c}">
7334
- * </kendo-grid-column>
7335
- *
7336
- * <ng-template kendoPagerTemplate let-totalPages="totalPages" let-currentPage="currentPage">
7337
- * <kendo-pager-prev-buttons></kendo-pager-prev-buttons>
7338
- * <kendo-pager-numeric-buttons [buttonCount]="10"></kendo-pager-numeric-buttons>
7339
- * <kendo-pager-next-buttons></kendo-pager-next-buttons>
7340
- * <kendo-pager-input></kendo-pager-input>
7341
- * <kendo-pager-info></kendo-pager-info>
7342
- * </ng-template>
7343
- *
7344
- * </kendo-grid>
7345
- * `
7346
- * })
7347
- *
7348
- * class AppComponent {
7349
- * public gridData = [{
7350
- * "ProductID": 1,
7351
- * "ProductName": "Chai",
7352
- * "UnitPrice": 18.0000,
7353
- * "Discontinued": false
7354
- * }, {
7355
- * "ProductID": 2,
7356
- * "ProductName": "Chang",
7357
- * "UnitPrice": 19.0000,
7358
- * "Discontinued": true
7359
- * }
7360
- * ];
7361
- * }
7362
- *
7363
- * ```
7111
+ * Displays an input element which allows the typing and rendering of page numbers ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
7364
7112
  */
7365
7113
  class PagerInputComponent extends PagerElementComponent {
7366
7114
  constructor(localization, pagerContext, zone, navigationService, cd) {
@@ -7484,7 +7232,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
7484
7232
  }] } });
7485
7233
 
7486
7234
  /**
7487
- * Displays buttons for navigating to the next and to the last page ([see example]({% slug paging_grid %}#toc-pager-template)).
7235
+ * Displays buttons for navigating to the next and to the last page ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
7488
7236
  */
7489
7237
  class PagerNextButtonsComponent extends PagerElementComponent {
7490
7238
  constructor(localization, pagerContext, cd, navigationService) {
@@ -7585,7 +7333,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
7585
7333
 
7586
7334
  // eslint-disable no-access-missing-member
7587
7335
  /**
7588
- * Displays information about the current page and the total number of records ([see example]({% slug paging_grid %}#toc-pager-templates)).
7336
+ * Displays information about the current page and the total number of records ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
7589
7337
  */
7590
7338
  class PagerInfoComponent extends PagerElementComponent {
7591
7339
  constructor(localization, cd, pagerContext) {
@@ -7677,7 +7425,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
7677
7425
  }], ctorParameters: function () { return [{ type: i1$4.DropDownListComponent }]; } });
7678
7426
 
7679
7427
  /**
7680
- * Displays a drop-down list for the page size selection ([see example]({% slug paging_grid %}#toc-pager-templates)).
7428
+ * Displays a drop-down list for the page size selection ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
7681
7429
  */
7682
7430
  class PagerPageSizesComponent extends PagerElementComponent {
7683
7431
  constructor(localization, cd, pagerContext, navigationService) {
@@ -7687,97 +7435,8 @@ class PagerPageSizesComponent extends PagerElementComponent {
7687
7435
  this._pageSizes = [];
7688
7436
  }
7689
7437
  /**
7690
- * The page sizes collection. Can be an Array of numbers and/or PageSizeItem objects.
7691
- *
7692
- * @example
7693
- * ```ts-preview
7694
- * _@Component({
7695
- * selector: 'my-app',
7696
- * template: `
7697
- * <kendo-grid [kendoGridBinding]="gridData" [height]="200"
7698
- * [pageable]="true"
7699
- * [pageSize]="pageSize">
7700
- * <ng-template kendoPagerTemplate let-totalPages="totalPages" let-currentPage="currentPage">
7701
- * <kendo-pager-page-sizes [pageSizes]="pagesizes"></kendo-pager-page-sizes>
7702
- * </ng-template>
7703
- * </kendo-grid>
7704
- * `
7705
- * })
7706
- * class AppComponent {
7707
- * public gridData: any[] = products;
7708
- * public pageSize = 2;
7709
- * public pagesizes = [{text: 'One', value: 1}, {text: 'Two', value: 2}, {text: 'All', value : 'all'}];
7710
- * }
7711
- *
7712
- * const products = [{
7713
- * 'ProductID' : 1,
7714
- * 'ProductName' : "Chai",
7715
- * 'SupplierID' : 1,
7716
- * 'CategoryID' : 1,
7717
- * 'QuantityPerUnit' : "10 boxes x 20 bags",
7718
- * 'UnitPrice' : 18.0000,
7719
- * 'UnitsInStock' : 39,
7720
- * 'UnitsOnOrder' : 0,
7721
- * 'ReorderLevel' : 10,
7722
- * 'Discontinued' : false
7723
- *
7724
- * }, {
7725
- * 'ProductID' : 2,
7726
- * 'ProductName' : "Chang",
7727
- * 'SupplierID' : 1,
7728
- * 'CategoryID' : 1,
7729
- * 'QuantityPerUnit' : "24 - 12 oz bottles",
7730
- * 'UnitPrice' : 19.0000,
7731
- * 'UnitsInStock' : 17,
7732
- * 'UnitsOnOrder' : 40,
7733
- * 'ReorderLevel' : 25,
7734
- * 'Discontinued' : false
7735
- * }, {
7736
- * 'ProductID' : 3,
7737
- * 'ProductName' : "Aniseed Syrup",
7738
- * 'SupplierID' : 1,
7739
- * 'CategoryID' : 2,
7740
- * 'QuantityPerUnit' : "12 - 550 ml bottles",
7741
- * 'UnitPrice' : 10.0000,
7742
- * 'UnitsInStock' : 13,
7743
- * 'UnitsOnOrder' : 70,
7744
- * 'ReorderLevel' : 25,
7745
- * 'Discontinued' : false
7746
- * }, {
7747
- * 'ProductID' : 4,
7748
- * 'ProductName' : "Chef Anton\'s Cajun Seasoning",
7749
- * 'SupplierID' : 2,
7750
- * 'CategoryID' : 2,
7751
- * 'QuantityPerUnit' : "48 - 6 oz jars",
7752
- * 'UnitPrice' : 22.0000,
7753
- * 'UnitsInStock' : 53,
7754
- * 'UnitsOnOrder' : 0,
7755
- * 'ReorderLevel' : 0,
7756
- * 'Discontinued' : false
7757
- * }, {
7758
- * 'ProductID' : 5,
7759
- * 'ProductName' : "Chef Anton\'s Gumbo Mix",
7760
- * 'SupplierID' : 2,
7761
- * 'CategoryID' : 2,
7762
- * 'QuantityPerUnit' : "36 boxes",
7763
- * 'UnitPrice' : 21.3500,
7764
- * 'UnitsInStock' : 0,
7765
- * 'UnitsOnOrder' : 0,
7766
- * 'ReorderLevel' : 0,
7767
- * 'Discontinued' : true
7768
- * }, {
7769
- * 'ProductID' : 6,
7770
- * 'ProductName' : "Grandma\'s Boysenberry Spread",
7771
- * 'SupplierID' : 3,
7772
- * 'CategoryID' : 2,
7773
- * 'QuantityPerUnit' : "12 - 8 oz jars",
7774
- * 'UnitPrice' : 25.0000,
7775
- * 'UnitsInStock' : 120,
7776
- * 'UnitsOnOrder' : 0,
7777
- * 'ReorderLevel' : 25,
7778
- * 'Discontinued' : false
7779
- * }];
7780
- * ```
7438
+ * The page sizes collection. Can be an Array of numbers and/or [`PageSizeItem`](slug:api_grid_pagesizeitem) objects
7439
+ * ([see example]({% slug paging_grid %}#toc-pager-templates))
7781
7440
  */
7782
7441
  set pageSizes(pageSizes) {
7783
7442
  let normalizedItems = [];
@@ -9208,8 +8867,9 @@ class StringFilterComponent extends BaseFilterCellComponent {
9208
8867
  super(filterService);
9209
8868
  this.localization = localization;
9210
8869
  /**
9211
- * The default filter operator. Defaults to `contains`.
8870
+ * The default filter operator.
9212
8871
  * @type {string}
8872
+ * @default 'contains'
9213
8873
  */
9214
8874
  this.operator = "contains";
9215
8875
  }
@@ -9675,8 +9335,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
9675
9335
  }] } });
9676
9336
 
9677
9337
  /**
9678
- * Represents a string-filter menu component.
9679
- * ([see example]({% slug filter_menu %}#toc-built-in-filter-menu-components)).
9338
+ * Represents a string-filter menu component
9339
+ * ([see example](slug:filter_menu#toc-built-in-filter-menu-components)).
9340
+ *
9341
+ * ```html
9342
+ * <kendo-grid-column field="ProductName">
9343
+ * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
9344
+ * <kendo-grid-string-filter-menu
9345
+ * [column]="column"
9346
+ * [filter]="filter"
9347
+ * [filterService]="filterService">
9348
+ * </kendo-grid-string-filter-menu>
9349
+ * </ng-template>
9350
+ * </kendo-grid-column>
9351
+ * ```
9680
9352
  */
9681
9353
  class StringFilterMenuComponent extends StringFilterComponent {
9682
9354
  constructor(localization) {
@@ -9689,6 +9361,7 @@ class StringFilterMenuComponent extends StringFilterComponent {
9689
9361
  this.filter = { filters: [], logic: "and" };
9690
9362
  /**
9691
9363
  * Determines if the inputs of second criteria will displayed.
9364
+ * @default true
9692
9365
  */
9693
9366
  this.extra = true;
9694
9367
  }
@@ -9819,18 +9492,21 @@ class NumericFilterComponent extends BaseFilterCellComponent {
9819
9492
  super(filterService);
9820
9493
  this.localization = localization;
9821
9494
  /**
9822
- * The default filter operator. Defaults to `eq`.
9495
+ * The default filter operator.
9823
9496
  * @type {string}
9497
+ * @default 'eq'
9824
9498
  */
9825
9499
  this.operator = "eq";
9826
9500
  /**
9827
9501
  * Specifies the value that is used to increment or decrement the component value.
9828
9502
  * @type {numeric}
9503
+ * @default 1
9829
9504
  */
9830
9505
  this.step = 1;
9831
9506
  /**
9832
9507
  * Specifies whether the **Up** and **Down** spin buttons will be rendered.
9833
9508
  * @type {boolean}
9509
+ * @default true
9834
9510
  */
9835
9511
  this.spinners = true;
9836
9512
  this.defaultOperators = numericOperators(this.localization);
@@ -10043,21 +9719,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
10043
9719
  }] } });
10044
9720
 
10045
9721
  /**
10046
- * Represents a numeric-filter menu component.
9722
+ * Represents a numeric filter-menu component.
10047
9723
  *
10048
9724
  * @example
10049
- * ```html-no-run
10050
- * <kendo-grid-column field="UnitPrice" title="Unit Price">
10051
- * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
10052
- * <kendo-grid-numeric-filter-menu
10053
- * [column]="column"
10054
- * [filter]="filter"
10055
- * [filterService]="filterService"
10056
- * >
10057
- * </kendo-grid-numeric-filter-menu>
10058
- * </ng-template>
10059
- * </kendo-grid-column>
10060
- * ```
9725
+ * ```html
9726
+ * <kendo-grid-column field="UnitPrice">
9727
+ * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
9728
+ * <kendo-grid-numeric-filter-menu
9729
+ * [column]="column"
9730
+ * [filter]="filter"
9731
+ * [filterService]="filterService">
9732
+ * </kendo-grid-numeric-filter-menu>
9733
+ * </ng-template>
9734
+ * </kendo-grid-column>
9735
+ * ```
10061
9736
  */
10062
9737
  class NumericFilterMenuComponent extends NumericFilterComponent {
10063
9738
  constructor(localization) {
@@ -10070,6 +9745,7 @@ class NumericFilterMenuComponent extends NumericFilterComponent {
10070
9745
  this.filter = { filters: [], logic: "and" };
10071
9746
  /**
10072
9747
  * Determines if the inputs of second criteria will displayed.
9748
+ * @default true
10073
9749
  */
10074
9750
  this.extra = true;
10075
9751
  /**
@@ -10242,25 +9918,29 @@ class DateFilterComponent extends BaseFilterCellComponent {
10242
9918
  /**
10243
9919
  * The default filter operator. Defaults to `contains`.
10244
9920
  * @type {string}
9921
+ * @default 'gte'
10245
9922
  */
10246
9923
  this.operator = "gte";
10247
9924
  /**
10248
9925
  * Defines the active view that the calendar initially renders.
10249
9926
  * By default, the active view is `month`.
10250
- *
10251
- * > You have to set `activeView` within the `topView`-`bottomView` range.
9927
+ * You have to set `activeView` within the `topView`-`bottomView` range.
9928
+ * @default 'month'
10252
9929
  */
10253
9930
  this.activeView = "month";
10254
9931
  /**
10255
9932
  * Defines the bottommost calendar view, to which the user can navigate.
9933
+ * @default 'month'
10256
9934
  */
10257
9935
  this.bottomView = "month";
10258
9936
  /**
10259
9937
  * Defines the topmost calendar view, to which the user can navigate.
9938
+ * @default 'century'
10260
9939
  */
10261
9940
  this.topView = "century";
10262
9941
  /**
10263
9942
  * Determines whether to display a week number column in the `month` view of the Calendar.
9943
+ * @default false
10264
9944
  */
10265
9945
  this.weekNumber = false;
10266
9946
  this.defaultOperators = dateOperators(this.localization);
@@ -10495,21 +10175,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
10495
10175
  }] } });
10496
10176
 
10497
10177
  /**
10498
- * Represents a date-filter menu component.
10178
+ * Represents a date filter-menu component.
10499
10179
  *
10500
10180
  * @example
10501
- * ```html-no-run
10502
- * <kendo-grid-column field="OrderDate" title="Order Date">
10503
- * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
10504
- * <kendo-grid-date-filter-menu
10505
- * [column]="column"
10506
- * [filter]="filter"
10507
- * [filterService]="filterService"
10508
- * >
10509
- * </kendo-grid-date-filter-menu>
10510
- * </ng-template>
10511
- * </kendo-grid-column>
10512
- * ```
10181
+ * ```html
10182
+ * <kendo-grid-column field="FirstOrderedOn">
10183
+ * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
10184
+ * <kendo-grid-date-filter-menu
10185
+ * [column]="column"
10186
+ * [filter]="filter"
10187
+ * [filterService]="filterService">
10188
+ * </kendo-grid-date-filter-menu>
10189
+ * </ng-template>
10190
+ * </kendo-grid-column>
10191
+ * ```
10513
10192
  */
10514
10193
  class DateFilterMenuComponent extends DateFilterComponent {
10515
10194
  constructor(localization) {
@@ -10522,6 +10201,7 @@ class DateFilterMenuComponent extends DateFilterComponent {
10522
10201
  this.filter = { filters: [], logic: "and" };
10523
10202
  /**
10524
10203
  * Determines if the inputs of second criteria will be displayed.
10204
+ * @default true
10525
10205
  */
10526
10206
  this.extra = true;
10527
10207
  }
@@ -10778,21 +10458,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
10778
10458
  }] } });
10779
10459
 
10780
10460
  /**
10781
- * Represents a Boolean-filter menu component.
10461
+ * Represents a Boolean-filter menu component. [See example](slug:filter_menu#toc-built-in-filter-menu-components)
10782
10462
  *
10783
10463
  * @example
10784
- * ```html-no-run
10785
- * <kendo-grid-column field="Discontinued" title="Discontinued">
10786
- * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
10787
- * <kendo-grid-boolean-filter-menu
10788
- * [column]="column"
10789
- * [filter]="filter"
10790
- * [filterService]="filterService"
10791
- * >
10792
- * </kendo-grid-boolean-filter-menu>
10793
- * </ng-template>
10794
- * </kendo-grid-column>
10795
- * ```
10464
+ *
10465
+ * ```html
10466
+ * <kendo-grid-column field="Discontinued" title="Discontinued">
10467
+ * <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
10468
+ * <kendo-grid-boolean-filter-menu
10469
+ * [column]="column"
10470
+ * [filter]="filter"
10471
+ * [filterService]="filterService">
10472
+ * </kendo-grid-boolean-filter-menu>
10473
+ * </ng-template>
10474
+ * </kendo-grid-column>
10475
+ * ```
10796
10476
  */
10797
10477
  class BooleanFilterMenuComponent extends BooleanFilterComponent {
10798
10478
  constructor(localization) {
@@ -11445,27 +11125,12 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
11445
11125
  * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11446
11126
  *
11447
11127
  * @example
11448
- * ```ts-preview
11449
- *
11450
- * _@Component({
11451
- * selector: 'my-app',
11452
- * template: `
11453
- * <kendo-grid [data]="data" [columnMenu]="true" [resizable]="true" #grid>
11454
- * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
11455
- * <kendo-grid-columnmenu-item icon="arrows-resizing" text="Fit column"
11456
- * (itemClick)="grid.autoFitColumn(column); service.close()">
11457
- * </kendo-grid-columnmenu-item>
11458
- * </ng-template>
11459
- * <kendo-grid-column field="Field1"></kendo-grid-column>
11460
- * <kendo-grid-column field="Field2"></kendo-grid-column>
11461
- * </kendo-grid>
11462
- * `
11463
- * })
11464
- *
11465
- * class AppComponent {
11466
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
11467
- * }
11468
- *
11128
+ * ```html
11129
+ * <kendo-grid [columnMenu]="true" ...>
11130
+ * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
11131
+ * <kendo-grid-columnmenu-item text="Fit column"></kendo-grid-columnmenu-item>
11132
+ * </ng-template>
11133
+ * </kendo-grid>
11469
11134
  * ```
11470
11135
  */
11471
11136
  class ColumnMenuItemComponent {
@@ -11622,34 +11287,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
11622
11287
  }] } });
11623
11288
 
11624
11289
  /**
11625
- * Represents a column-menu item that can be placed inside a
11626
- * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11627
- * Allows the user to lock or unlock the columns.
11290
+ * Represents the column-menu item for locking and unlocking columns in the Grid. [See example](slug:columnmenu_grid#toc-lock-and-unlock-items).
11628
11291
  *
11629
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11630
- * > the template to the service input of the `kendo-grid-columnmenu-lock` component.
11292
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11293
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11294
+ * the template to the service input of the `kendo-grid-columnmenu-lock` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
11631
11295
  *
11632
11296
  * @example
11633
- * ```ts-preview
11634
- *
11635
- * _@Component({
11636
- * selector: 'my-app',
11637
- * template: `
11638
- * <kendo-grid [data]="data" [columnMenu]="true">
11639
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
11640
- * <kendo-grid-columnmenu-lock [service]="service">
11641
- * </kendo-grid-columnmenu-lock>
11642
- * </ng-template>
11643
- * <kendo-grid-column field="Field1" [width]="100"></kendo-grid-column>
11644
- * <kendo-grid-column field="Field2" [width]="100"></kendo-grid-column>
11645
- * </kendo-grid>
11646
- * `
11647
- * })
11648
- *
11649
- * class AppComponent {
11650
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
11651
- * }
11652
- *
11297
+ * ```html
11298
+ * <kendo-grid [data]="data" [columnMenu]="true" ...>
11299
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
11300
+ * <kendo-grid-columnmenu-lock [service]="service">
11301
+ * </kendo-grid-columnmenu-lock>
11302
+ * </ng-template>
11303
+ * </kendo-grid>
11653
11304
  * ```
11654
11305
  */
11655
11306
  class ColumnMenuLockComponent extends ColumnMenuItemBase {
@@ -11729,33 +11380,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
11729
11380
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }, { type: ColumnInfoService }, { type: i0.ChangeDetectorRef }]; } });
11730
11381
 
11731
11382
  /**
11732
- * Represents a column-menu item that can be placed inside a
11733
- * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11734
- * Allows the user to stick or unstick the columns.
11383
+ * Represents the column-menu item that sticks or unsticks columns in the Grid.
11384
+ * [See example](slug:columnmenu_grid#toc-stick-and-unstick-items).
11735
11385
  *
11736
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11737
- * > the template to the service input of the `kendo-grid-columnmenu-stick` component.
11386
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11387
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11388
+ * the template to the service input of the `kendo-grid-columnmenu-lock` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
11738
11389
  *
11739
11390
  * @example
11740
- * ```ts-preview
11741
- *
11742
- * _@Component({
11743
- * selector: 'my-app',
11744
- * template: `
11745
- * <kendo-grid [data]="data" [columnMenu]="true">
11746
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
11747
- * <kendo-grid-columnmenu-stick [service]="service">
11748
- * </kendo-grid-columnmenu-stick>
11749
- * </ng-template>
11750
- * <kendo-grid-column field="Field1" [width]="100"></kendo-grid-column>
11751
- * <kendo-grid-column field="Field2" [width]="100"></kendo-grid-column>
11752
- * </kendo-grid>
11753
- * `
11754
- * })
11755
- *
11756
- * class AppComponent {
11757
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
11758
- * }
11391
+ * ```html
11392
+ * <kendo-grid [data]="data" [columnMenu]="true">
11393
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
11394
+ * <kendo-grid-columnmenu-stick [service]="service">
11395
+ * </kendo-grid-columnmenu-stick>
11396
+ * </ng-template>
11397
+ * </kendo-grid>
11759
11398
  *
11760
11399
  * ```
11761
11400
  */
@@ -11836,33 +11475,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
11836
11475
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }, { type: ColumnInfoService }, { type: i0.ChangeDetectorRef }]; } });
11837
11476
 
11838
11477
  /**
11839
- * Represents the component for editing column filters in the Grid that can be placed
11840
- * inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11478
+ * Represents the column-menu item which combines the lock and sticky column functionalities.
11841
11479
  *
11842
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11843
- * > the template to the service input of the `kendo-grid-columnmenu-filter` component.
11480
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11481
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11482
+ * the template to the service input of the `kendo-grid-columnmenu-filter` component. [See example](slug:columnmenu_grid#toc-set-column-position-item).
11844
11483
  *
11845
11484
  * @example
11846
- * ```ts-preview
11847
- *
11848
- * _@Component({
11849
- * selector: 'my-app',
11850
- * template: `
11851
- * <kendo-grid [kendoGridBinding]="data" [columnMenu]="true">
11852
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
11853
- * <kendo-grid-columnmenu-filter [service]="service">
11854
- * </kendo-grid-columnmenu-filter>
11855
- * </ng-template>
11856
- * <kendo-grid-column field="Field1"></kendo-grid-column>
11857
- * <kendo-grid-column field="Field2"></kendo-grid-column>
11858
- * </kendo-grid>
11859
- * `
11860
- * })
11861
- *
11862
- * class AppComponent {
11863
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
11864
- * }
11865
- *
11485
+ * ```html
11486
+ * <kendo-grid [data]="data" [columnMenu]="true" ...>
11487
+ * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
11488
+ * <kendo-grid-columnmenu-position [service]="service" [showLock]="true" [showStick]="true">
11489
+ * </kendo-grid-columnmenu-position>
11490
+ * </ng-template>
11491
+ * </kendo-grid>
11866
11492
  * ```
11867
11493
  */
11868
11494
  class ColumnMenuPositionComponent extends ColumnMenuItemBase {
@@ -11880,6 +11506,7 @@ class ColumnMenuPositionComponent extends ColumnMenuItemBase {
11880
11506
  this.collapse = new EventEmitter();
11881
11507
  /**
11882
11508
  * Specifies if the content is expanded.
11509
+ * @default false
11883
11510
  */
11884
11511
  this.expanded = false;
11885
11512
  /**
@@ -12211,33 +11838,19 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12211
11838
  }] } });
12212
11839
 
12213
11840
  /**
12214
- * Represents the component for selecting columns in the Grid that can be placed
12215
- * inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11841
+ * Represents the column-menu item for selecting columns in the Grid. [See example](slug:columnmenu_grid#toc-column-chooser-item).
12216
11842
  *
12217
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12218
- * > the template to the service input of the `kendo-grid-columnmenu-chooser` component.
11843
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11844
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11845
+ * the template to the service input of the `kendo-grid-columnmenu-chooser` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
12219
11846
  *
12220
11847
  * @example
12221
- * ```ts-preview
12222
- *
12223
- * _@Component({
12224
- * selector: 'my-app',
12225
- * template: `
12226
- * <kendo-grid [data]="data" [columnMenu]="true">
12227
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
12228
- * <kendo-grid-columnmenu-chooser [service]="service">
12229
- * </kendo-grid-columnmenu-chooser>
12230
- * </ng-template>
12231
- * <kendo-grid-column field="Field1"></kendo-grid-column>
12232
- * <kendo-grid-column field="Field2" [hidden]="true"></kendo-grid-column>
12233
- * </kendo-grid>
12234
- * `
12235
- * })
12236
- *
12237
- * class AppComponent {
12238
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
12239
- * }
12240
- *
11848
+ * ```html
11849
+ * <kendo-grid [columnMenu]="true" ...>
11850
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
11851
+ * <kendo-grid-columnmenu-chooser [service]="service"> </kendo-grid-columnmenu-chooser>
11852
+ * </ng-template>
11853
+ * </kendo-grid>
12241
11854
  * ```
12242
11855
  */
12243
11856
  class ColumnMenuChooserComponent extends ColumnMenuItemBase {
@@ -12257,6 +11870,7 @@ class ColumnMenuChooserComponent extends ColumnMenuItemBase {
12257
11870
  this.collapse = new EventEmitter();
12258
11871
  /**
12259
11872
  * Specifies if the content is expanded.
11873
+ * @default false
12260
11874
  */
12261
11875
  this.expanded = false;
12262
11876
  /**
@@ -12365,33 +11979,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12365
11979
  }] } });
12366
11980
 
12367
11981
  /**
12368
- * Represents the component for editing column filters in the Grid that can be placed
12369
- * inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11982
+ * Represents the column-menu item for editing column filters in the Grid. [See example](slug:columnmenu_grid#toc-filter-item).
12370
11983
  *
12371
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12372
- * > the template to the service input of the `kendo-grid-columnmenu-filter` component.
11984
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11985
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
11986
+ * the template to the service input of the `kendo-grid-columnmenu-filter` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
12373
11987
  *
12374
11988
  * @example
12375
- * ```ts-preview
12376
- *
12377
- * _@Component({
12378
- * selector: 'my-app',
12379
- * template: `
12380
- * <kendo-grid [kendoGridBinding]="data" [columnMenu]="true">
12381
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
12382
- * <kendo-grid-columnmenu-filter [service]="service">
12383
- * </kendo-grid-columnmenu-filter>
12384
- * </ng-template>
12385
- * <kendo-grid-column field="Field1"></kendo-grid-column>
12386
- * <kendo-grid-column field="Field2"></kendo-grid-column>
12387
- * </kendo-grid>
12388
- * `
12389
- * })
12390
- *
12391
- * class AppComponent {
12392
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
12393
- * }
12394
- *
11989
+ * ```html
11990
+ * <kendo-grid [columnMenu]="true" ...>
11991
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
11992
+ * <kendo-grid-columnmenu-filter [service]="service">
11993
+ * </kendo-grid-columnmenu-filter>
11994
+ * </ng-template>
11995
+ * </kendo-grid>
12395
11996
  * ```
12396
11997
  */
12397
11998
  class ColumnMenuFilterComponent extends ColumnMenuItemBase {
@@ -12409,6 +12010,7 @@ class ColumnMenuFilterComponent extends ColumnMenuItemBase {
12409
12010
  this.collapse = new EventEmitter();
12410
12011
  /**
12411
12012
  * Specifies if the content is expanded.
12013
+ * @default false
12412
12014
  */
12413
12015
  this.expanded = false;
12414
12016
  /**
@@ -12628,34 +12230,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12628
12230
  }] } });
12629
12231
 
12630
12232
  /**
12631
- * Represents a column-menu item for sorting Grid columns that can be placed inside a
12632
- * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
12633
- * Allows the user to sort the column.
12233
+ * Represents the column-menu item for sorting Grid columns.
12234
+ * [See example](slug:columnmenu_grid#toc-sort-item).
12634
12235
  *
12635
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12636
- * > the template to the service input of the `kendo-grid-columnmenu-sort` component.
12236
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
12237
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12238
+ * the template to the service input of the `kendo-grid-columnmenu-sort` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
12637
12239
  *
12638
12240
  * @example
12639
- * ```ts-preview
12640
- *
12641
- * _@Component({
12642
- * selector: 'my-app',
12643
- * template: `
12644
- * <kendo-grid [kendoGridBinding]="data" [sortable]="true" [columnMenu]="true">
12645
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
12646
- * <kendo-grid-columnmenu-sort [service]="service">
12647
- * </kendo-grid-columnmenu-sort>
12648
- * </ng-template>
12649
- * <kendo-grid-column field="Field1" [width]="100"></kendo-grid-column>
12650
- * <kendo-grid-column field="Field2" [width]="100"></kendo-grid-column>
12651
- * </kendo-grid>
12652
- * `
12653
- * })
12654
- *
12655
- * class AppComponent {
12656
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }, { Field1: 'Foo1', Field2: 'Bar1' }];
12657
- * }
12658
- *
12241
+ * ```html
12242
+ * <kendo-grid [kendoGridBinding]="data" [sortable]="true" [columnMenu]="true">
12243
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
12244
+ * <kendo-grid-columnmenu-sort [service]="service">
12245
+ * </kendo-grid-columnmenu-sort>
12246
+ * </ng-template>
12247
+ * </kendo-grid>
12659
12248
  * ```
12660
12249
  */
12661
12250
  class ColumnMenuSortComponent extends ColumnMenuItemBase {
@@ -12739,36 +12328,22 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12739
12328
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }, { type: SortService }, { type: i0.Renderer2 }]; } });
12740
12329
 
12741
12330
  /**
12742
- * Represents the component for resizing the specified column to the minimum possible width so that it fits the header or cell content without wrapping.
12331
+ * Represents the column-menu item for resizing the specified column to the minimum possible width so that it fits the header or cell content without wrapping.
12332
+ * [See example](slug:slug:columnmenu_grid#toc-autosize-column-item).
12743
12333
  * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
12334
+ * [See example](slug:columnmenu_grid#toc-customizing-the-content).
12744
12335
  *
12745
- * > To enable the autosize-column option, set the [`resizable`]({% slug api_grid_gridcomponent %}#toc-resizable)
12746
- * > property of the Grid to `true`.
12747
- *
12748
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) and `column` that are passed by
12749
- * > the template to the `service` and `column` input of the `kendo-grid-columnmenu-autosize-column` component.
12336
+ * You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) and `column` that are passed by
12337
+ * the template to the `service` and `column` input of the `kendo-grid-columnmenu-autosize-column` component.
12750
12338
  *
12751
12339
  * @example
12752
- * ```ts-preview
12753
- *
12754
- * _@Component({
12755
- * selector: 'my-app',
12756
- * template: `
12757
- * <kendo-grid [data]="data" [columnMenu]="true">
12758
- * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
12759
- * <kendo-grid-columnmenu-autosize-column [column]="column" [service]="service">
12760
- * </kendo-grid-columnmenu-autosize-column>
12761
- * </ng-template>
12762
- * <kendo-grid-column field="Field1"></kendo-grid-column>
12763
- * <kendo-grid-column field="Field2"></kendo-grid-column>
12764
- * </kendo-grid>
12765
- * `
12766
- * })
12767
- *
12768
- * class AppComponent {
12769
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
12770
- * }
12771
- *
12340
+ * ```html
12341
+ * <kendo-grid [columnMenu]="true" ...>
12342
+ * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
12343
+ * <kendo-grid-columnmenu-autosize-column [column]="column" [service]="service">
12344
+ * </kendo-grid-columnmenu-autosize-column>
12345
+ * </ng-template>
12346
+ * </kendo-grid>
12772
12347
  * ```
12773
12348
  */
12774
12349
  class ColumnMenuAutoSizeColumnComponent extends ColumnMenuItemBase {
@@ -12819,36 +12394,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12819
12394
  }] } });
12820
12395
 
12821
12396
  /**
12822
- * Represents the component for resizing all columns to the minimum possible width so that they fit the widest header or cell content without wrapping.
12823
- * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
12397
+ * Represents the column-menu item for resizing all columns to the minimum possible width so that they fit the widest header or cell content without wrapping.
12398
+ * [See example](slug:columnmenu_grid#toc-autosize-all-columns-item).
12824
12399
  *
12825
- * > To enable the autosize-all-columns option, set the [`resizable`]({% slug api_grid_gridcomponent %}#toc-resizable)
12826
- * > property of the Grid to `true`.
12827
- *
12828
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12829
- * > the template to the `service` input of the `kendo-grid-columnmenu-autosize-all-columns` component.
12400
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
12401
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
12402
+ * the template to the `service` input of the `kendo-grid-columnmenu-autosize-all-columns` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
12830
12403
  *
12831
12404
  * @example
12832
- * ```ts-preview
12833
- *
12834
- * _@Component({
12835
- * selector: 'my-app',
12836
- * template: `
12837
- * <kendo-grid [data]="data" [columnMenu]="true">
12838
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
12839
- * <kendo-grid-columnmenu-autosize-all-columns [service]="service">
12840
- * </kendo-grid-columnmenu-autosize-all-columns>
12841
- * </ng-template>
12842
- * <kendo-grid-column field="Field1"></kendo-grid-column>
12843
- * <kendo-grid-column field="Field2"></kendo-grid-column>
12844
- * </kendo-grid>
12845
- * `
12846
- * })
12847
- *
12848
- * class AppComponent {
12849
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
12850
- * }
12851
- *
12405
+ * ```html
12406
+ * <kendo-grid [columnMenu]="true" ...>
12407
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
12408
+ * <kendo-grid-columnmenu-autosize-all-columns [service]="service">
12409
+ * </kendo-grid-columnmenu-autosize-all-columns>
12410
+ * </ng-template>
12411
+ * </kendo-grid>
12852
12412
  * ```
12853
12413
  */
12854
12414
  class ColumnMenuAutoSizeAllColumnsComponent extends ColumnMenuItemBase {
@@ -12896,7 +12456,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
12896
12456
 
12897
12457
  const POPUP_CLASS = 'k-grid-columnmenu-popup';
12898
12458
  /**
12899
- * Represents the [column menu]({% slug columnmenu_grid %}) component.
12459
+ * Represents the [column menu](slug:columnmenu_grid#toc-customizing-the-position) component.
12460
+ *
12461
+ * <kendo-grid ...>
12462
+ * <kendo-grid-column field="ProductName" [columnMenu]="false">
12463
+ * <ng-template kendoGridHeaderTemplate let-column>
12464
+ * <kendo-grid-column-menu [column]="column"> </kendo-grid-column-menu>
12465
+ * </ng-template>
12466
+ * </kendo-grid-column>
12467
+ * </kendo-grid>
12900
12468
  */
12901
12469
  class ColumnMenuComponent {
12902
12470
  constructor(navigationService, popupService, localization, service, ctx) {
@@ -13247,6 +12815,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
13247
12815
 
13248
12816
  /**
13249
12817
  * Represents a component which accommodates the filter operators.
12818
+ *
12819
+ * @example
12820
+ * ```html
12821
+ * <kendo-grid [data]="gridData">
12822
+ * <kendo-grid-column field="ProductName">
12823
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
12824
+ * <input />
12825
+ * <kendo-grid-filter-cell-operators
12826
+ * [operators]="[{text: 'Equals', value: 'eq'}]">
12827
+ * </kendo-grid-filter-cell-operators>
12828
+ * </ng-template>
12829
+ * </kendo-grid-column>
12830
+ * <kendo-grid>
12831
+ * ```
13250
12832
  */
13251
12833
  class FilterCellOperatorsComponent {
13252
12834
  constructor(localization, sizing) {
@@ -13265,6 +12847,7 @@ class FilterCellOperatorsComponent {
13265
12847
  /**
13266
12848
  * Determines if the list of operators will be displayed.
13267
12849
  * @type {boolean}
12850
+ * @default true
13268
12851
  */
13269
12852
  this.showOperators = true;
13270
12853
  /**
@@ -13470,36 +13053,35 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
13470
13053
  }] } });
13471
13054
 
13472
13055
  /**
13473
- * Represents a string-filter cell component
13056
+ * Represents a string filter-cell component
13474
13057
  * ([see example]({% slug filter_row %}#toc-hiding-filter-operators)).
13475
13058
  *
13476
13059
  * @example
13477
- *
13478
- * ```html-no-run
13479
- * <kendo-grid-column field="ProductName" title="Product Name">
13480
- * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13481
- * <kendo-grid-string-filter-cell
13482
- * [showOperators]="false"
13483
- * [column]="column"
13484
- * [filter]="filter">
13485
- * </kendo-grid-string-filter-cell>
13486
- * </ng-template>
13487
- * </kendo-grid-column>
13488
- * ```
13060
+ * ```html
13061
+ * <kendo-grid-column field="ProductName" title="Product Name">
13062
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13063
+ * <kendo-grid-string-filter-cell
13064
+ * [column]="column"
13065
+ * [filter]="filter">
13066
+ * </kendo-grid-string-filter-cell>
13067
+ * </ng-template>
13068
+ * </kendo-grid-column>
13069
+ * ```
13489
13070
  */
13490
13071
  class StringFilterCellComponent extends StringFilterComponent {
13491
13072
  constructor(filterService, localization, sizingService) {
13492
13073
  super(filterService, localization);
13493
13074
  /**
13494
13075
  * Determines the delay time (in milliseconds) before the filter value is submitted.
13495
- * A value of `0` indicates no delay. The default value is `500`.
13076
+ * A value of `0` indicates no delay.
13496
13077
  * @type {boolean}
13078
+ * @default 500
13497
13079
  */
13498
13080
  this.filterDelay = 500;
13499
13081
  /**
13500
13082
  * Determines if the drop-down filter operators will be displayed.
13501
- * The default value is `true`.
13502
13083
  * @type {boolean}
13084
+ * @default true
13503
13085
  */
13504
13086
  this.showOperators = true;
13505
13087
  this.subs = sizingService.changes.subscribe((size) => this.size = size);
@@ -13565,19 +13147,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
13565
13147
  }] } });
13566
13148
 
13567
13149
  /**
13568
- * Represents a numeric filter cell.
13150
+ * Represents a numeric filter-cell component.
13151
+ * [See example](slug:filter_row#toc-built-in-filter-row-components).
13569
13152
  *
13570
13153
  * @example
13571
- * ```html-no-run
13572
- * <kendo-grid-column field="ProductName" title="Product Name">
13573
- * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13574
- * <kendo-grid-numeric-filter-cell
13575
- * [column]="column"
13576
- * [filter]="filter">
13577
- * </kendo-grid-numeric-filter-cell>
13578
- * </ng-template>
13579
- * </kendo-grid-column>
13580
- * ```
13154
+ * ```html
13155
+ * <kendo-grid-column field="UnitPrice">
13156
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13157
+ * <kendo-grid-numeric-filter-cell
13158
+ * [column]="column"
13159
+ * [filter]="filter">
13160
+ * </kendo-grid-numeric-filter-cell>
13161
+ * </ng-template>
13162
+ * </kendo-grid-column>
13163
+ * ```
13581
13164
  */
13582
13165
  class NumericFilterCellComponent extends NumericFilterComponent {
13583
13166
  constructor(filterService, localization, sizingService) {
@@ -13587,12 +13170,14 @@ class NumericFilterCellComponent extends NumericFilterComponent {
13587
13170
  * Determines the delay time (in milliseconds) before the filter value is submitted.
13588
13171
  * A value of `0` indicates no delay. The default value is `500`.
13589
13172
  * @type {boolean}
13173
+ * @default 500
13590
13174
  */
13591
13175
  this.filterDelay = 500;
13592
13176
  /**
13593
13177
  * Determines if the drop-down filter operators will be displayed.
13594
13178
  * The default value is `true`.
13595
13179
  * @type {boolean}
13180
+ * @default true
13596
13181
  */
13597
13182
  this.showOperators = true;
13598
13183
  this.subs = sizingService.changes.subscribe((size) => this.size = size);
@@ -13691,19 +13276,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
13691
13276
 
13692
13277
  /**
13693
13278
  * Represents a Boolean filter-cell component.
13279
+ * [See example](slug:filter_row#toc-built-in-filter-row-components).
13694
13280
  *
13695
13281
  * @example
13696
13282
  *
13697
- * ```html-no-run
13698
- * <kendo-grid-column field="ProductName" title="Product Name">
13699
- * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13700
- * <kendo-grid-boolean-filter-cell
13701
- * [column]="column"
13702
- * [filter]="filter">
13703
- * </kendo-grid-boolean-filter-cell>
13704
- * </ng-template>
13705
- * </kendo-grid-column>
13706
- * ```
13283
+ * ```html
13284
+ * <kendo-grid-column field="Discontinued">
13285
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13286
+ * <kendo-grid-boolean-filter-cell
13287
+ * [column]="column"
13288
+ * [filter]="filter">
13289
+ * </kendo-grid-boolean-filter-cell>
13290
+ * </ng-template>
13291
+ * </kendo-grid-column>
13292
+ * ```
13707
13293
  */
13708
13294
  class BooleanFilterCellComponent extends BooleanFilterComponent {
13709
13295
  constructor(filterService, localization, cd, sizingService) {
@@ -13782,29 +13368,42 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
13782
13368
  }], ctorParameters: function () { return [{ type: FilterService }, { type: i1.LocalizationService }, { type: i0.ChangeDetectorRef }, { type: SizingOptionsService }]; } });
13783
13369
 
13784
13370
  /**
13785
- * Represents a date-filter cell component.
13371
+ * Represents a [DatePicker](slug:overview_datepicker) filter-cell component.
13786
13372
  *
13787
13373
  * @example
13788
13374
  *
13789
- * ```html-no-run
13790
- * <kendo-grid-column field="OrderDate" title="Order Date">
13791
- * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13792
- * <kendo-grid-date-filter-cell
13793
- * [showOperators]="false"
13794
- * [column]="column"
13795
- * [filter]="filter">
13796
- * </kendo-grid-date-filter-cell>
13797
- * </ng-template>
13798
- * </kendo-grid-column>
13799
- * ```
13375
+ * ```html
13376
+ * <kendo-grid-column field="FirstOrderedOn">
13377
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13378
+ * <kendo-grid-date-filter-cell
13379
+ * [column]="column"
13380
+ * [filter]="filter">
13381
+ * </kendo-grid-date-filter-cell>
13382
+ * </ng-template>
13383
+ * </kendo-grid-column>
13384
+ * ```
13800
13385
  */
13801
13386
  class DateFilterCellComponent extends DateFilterComponent {
13802
13387
  constructor(filterService, localization, sizingService) {
13803
13388
  super(filterService, localization);
13804
13389
  this.localization = localization;
13805
13390
  /**
13806
- * Determines if the drop-down filter operators will be displayed. The default value is `true`.
13391
+ * Represents a [DatePicker](slug:overview_datepicker) filter-cell component.
13392
+ * [See example](slug:filter_row#toc-built-in-filter-row-components).
13393
+ * @example
13394
+ *
13395
+ * ```html
13396
+ * <kendo-grid-column field="Discontinued">
13397
+ * <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
13398
+ * <kendo-grid-date-filter-cell
13399
+ * [column]="column"
13400
+ * [filter]="filter">
13401
+ * </kendo-grid-date-filter-cell>
13402
+ * </ng-template>
13403
+ * </kendo-grid-column>
13404
+ * ```
13807
13405
  * @type {boolean}
13406
+ * @default true
13808
13407
  */
13809
13408
  this.showOperators = true;
13810
13409
  this.subs = sizingService.changes.subscribe((size) => this.size = size);
@@ -15857,68 +15456,20 @@ const IGNORE_CONTAINER_CLASSES = 'k-grid k-grid-ignore-click';
15857
15456
 
15858
15457
  /**
15859
15458
  * Represents the command columns of the Grid. You have to define the content of the
15860
- * column inside an `<ng-template>` tag. The template context is set to the current
15861
- * data item. For more information and examples on using the passed fields
15862
- * and the command directives, refer to the article on
15863
- * [editing the Grid in Angular Reactive Forms]({% slug inline_editing_grid %}#toc-using-reactive-forms).
15864
- *
15865
- * The following additional fields are passed:
15866
- * - `columnIndex`&mdash;The current column index.
15867
- * - `rowIndex`&mdash;The current data row index. If inside a new item row, `rowIndex`is `-1`.
15868
- * - `dataItem`&mdash;The current data item.
15869
- * - `column`&mdash;The current column instance.
15870
- * - `isNew`&mdash;The state of the current item.
15871
- *
15872
- * Usually, the template contains CRUD command directives such as:
15873
- * - [EditCommandDirective]({% slug api_grid_editcommanddirective %})
15874
- * - [RemoveCommandDirective]({% slug api_grid_removecommanddirective %})
15875
- * - [CancelCommandDirective]({% slug api_grid_cancelcommanddirective %})
15876
- * - [SaveCommandDirective]({% slug api_grid_savecommanddirective %})
15459
+ * column inside an `<ng-template>` tag.
15460
+ * For more information and examples, refer to the [Command Column Directives](slug:editing_directives_grid#toc-command-column-directives) article.
15877
15461
  *
15878
15462
  * @example
15879
- * ```ts-preview
15880
- *
15881
- * _@Component({
15882
- * selector: 'my-app',
15883
- * template: `
15884
- * <kendo-grid [data]="gridData">
15885
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
15886
- * </kendo-grid-column>
15887
- * <kendo-grid-column field="ProductName" title="Product Name">
15888
- * </kendo-grid-column>
15889
- * <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
15890
- * </kendo-grid-column>
15891
- * <kendo-grid-command-column title="command" [width]="220">
15892
- * <ng-template kendoGridCellTemplate>
15893
- * <button kendoGridEditCommand class="k-primary">Edit</button>
15894
- * <button kendoGridRemoveCommand>Remove</button>
15895
- * </ng-template>
15896
- * </kendo-grid-command-column>
15897
- * </kendo-grid>
15898
- * `
15899
- * })
15900
- *
15901
- * class AppComponent {
15902
- * public gridData: any[];
15903
- *
15904
- * constructor() {
15905
- * this.gridData = products;
15906
- * }
15907
- * }
15908
- *
15909
- * const products = [{
15910
- * "ProductID": 1,
15911
- * "ProductName": "Chai",
15912
- * "UnitPrice": 18.0000,
15913
- * "Discontinued": true
15914
- * }, {
15915
- * "ProductID": 2,
15916
- * "ProductName": "Chang",
15917
- * "UnitPrice": 19.0000,
15918
- * "Discontinued": false
15919
- * }
15920
- * ];
15921
- *
15463
+ * ```html
15464
+ * <kendo-grid [data]="gridData">
15465
+ * <kendo-grid-column field="ProductID"></kendo-grid-column>
15466
+ * <kendo-grid-command-column title="command" [width]="220">
15467
+ * <ng-template kendoGridCellTemplate>
15468
+ * <button kendoGridEditCommand class="k-primary">Edit</button>
15469
+ * <button kendoGridRemoveCommand>Remove</button>
15470
+ * </ng-template>
15471
+ * </kendo-grid-command-column>
15472
+ * </kendo-grid>
15922
15473
  * ```
15923
15474
  */
15924
15475
  class CommandColumnComponent extends ColumnBase {
@@ -18968,33 +18519,11 @@ const handleExpandCollapseDetailsService = (service, expandEmitter, collapseEmit
18968
18519
  const isInEditedCell = (element, gridElement) => closest(element, matchesClasses('k-grid-edit-cell')) &&
18969
18520
  closest(element, matchesNodeName('kendo-grid')) === gridElement;
18970
18521
  /**
18971
- * Represents the Kendo UI Grid component for Angular.
18522
+ * Represents the Kendo UI for Angular Data Grid component.
18972
18523
  *
18973
18524
  * @example
18974
- * ```ts-preview
18975
- * _@Component({
18976
- * selector: 'my-app',
18977
- * template: `
18978
- * <kendo-grid [data]="gridData">
18979
- * </kendo-grid>
18980
- * `
18981
- * })
18982
- * class AppComponent {
18983
- * public gridData: any[] = products;
18984
- * }
18985
- *
18986
- * const products = [{
18987
- * "ProductID": 1,
18988
- * "ProductName": "Chai",
18989
- * "UnitPrice": 18.0000,
18990
- * "Discontinued": true
18991
- * }, {
18992
- * "ProductID": 2,
18993
- * "ProductName": "Chang",
18994
- * "UnitPrice": 19.0000,
18995
- * "Discontinued": false
18996
- * }
18997
- * ];
18525
+ * ```html
18526
+ * <kendo-grid [data]="gridData"></kendo-grid>
18998
18527
  * ```
18999
18528
  */
19000
18529
  class GridComponent {
@@ -19030,64 +18559,25 @@ class GridComponent {
19030
18559
  /**
19031
18560
  * Defines the scroll mode used by the Grid.
19032
18561
  *
19033
- * The available options are:
19034
- * - `none`&mdash;Renders no scrollbar.
19035
- * - `scrollable`&mdash;The default scroll mode. It requires the setting of the `height` option.
19036
- * - `virtual`&mdash;Displays no pager and renders a portion of the data (optimized rendering) while the user is scrolling the content.
18562
+ * @default 'scrollable'
19037
18563
  */
19038
18564
  this.scrollable = 'scrollable';
19039
18565
  /**
19040
- * Enables the single-row [selection]({% slug selection_grid %}) of the Grid.
18566
+ * Enables the [single-row selection](slug:grid_row_selection) of the Grid.
18567
+ *
18568
+ * @default false
19041
18569
  */
19042
18570
  this.selectable = false;
19043
18571
  /**
19044
18572
  * A function that defines how to track changes for the data rows.
19045
- *
19046
18573
  * By default, the Grid tracks changes by the index of the data item.
19047
18574
  * Edited rows are tracked by reference.
19048
- * In some cases, you might need to override the default behavior,
19049
- * for example, when you implement editing with immutable data items.
19050
- *
19051
- * The following example demonstrates how to track items only by index.
19052
- *
19053
- * @example
19054
- * ```ts
19055
- * import { Component } from '@angular/core';
19056
- * import { GridItem } from '@progress/kendo-angular-grid';
19057
- *
19058
- * _@Component({
19059
- * selector: 'my-app',
19060
- * template: `
19061
- * <kendo-grid [data]="gridData" [trackBy]="trackBy">
19062
- * </kendo-grid>
19063
- * `
19064
- * })
19065
- * class AppComponent {
19066
- * public gridData: any[] = products;
19067
- *
19068
- * public trackBy(index: number, item: GridItem): any {
19069
- * console.log(item);
19070
- * return index;
19071
- * }
19072
- * }
19073
- *
19074
- * const products = [{
19075
- * "ProductID": 1,
19076
- * "ProductName": "Chai",
19077
- * "UnitPrice": 18.0000,
19078
- * "Discontinued": true
19079
- * }, {
19080
- * "ProductID": 2,
19081
- * "ProductName": "Chang",
19082
- * "UnitPrice": 19.0000,
19083
- * "Discontinued": false
19084
- * }
19085
- * ];
19086
- * ```
18575
+ * [See exmpale](slug:track_changes_grid)
19087
18576
  */
19088
18577
  this.trackBy = defaultTrackBy;
19089
18578
  /**
19090
18579
  * If set to `true`, the grid will render only the columns in the current viewport.
18580
+ * @default false
19091
18581
  */
19092
18582
  this.virtualColumns = false;
19093
18583
  /**
@@ -19096,35 +18586,31 @@ class GridComponent {
19096
18586
  this.gridData = () => { return this.flatData; };
19097
18587
  /**
19098
18588
  * Enables the [filtering]({% slug filtering_grid %}) of the Grid columns that have their `field` option set.
18589
+ * @default false
19099
18590
  */
19100
18591
  this.filterable = false;
19101
18592
  /**
19102
18593
  * Enables the [sorting]({% slug sorting_grid %}) of the Grid columns that have their `field` option set.
18594
+ * @default false
19103
18595
  */
19104
18596
  this.sortable = false;
19105
18597
  /**
19106
- * Configures the pager of the Grid ([see example]({% slug paging_grid %})).
19107
- *
19108
- * The available options are:
19109
- * - `buttonCount: Number`&mdash;Sets the maximum numeric buttons count before the buttons are collapsed. Defaults to `10`.
19110
- * - `info: Boolean`&mdash;Toggles the information about the current page and the total number of records. Defaults to `true`.
19111
- * - `type: PagerType`&mdash;Accepts the `numeric` (buttons with numbers) and `input` (input for typing the page number) values. Defaults to `'numeric'`.
19112
- * - `pageSizes: Boolean` or `Array<number>`&mdash;Shows a menu for selecting the page size. Defaults to `false`.
19113
- * - `previousNext: Boolean`&mdash;Toggles the **Previous** and **Next** buttons. Defaults to `true`.
19114
- * - `responsive: Boolean`&mdash;Toggles the built-in responsive behavior of the Pager. Defaults to `true`.
18598
+ * Configures the pager of the Grid ([see example](slug:paging_grid_settings)).
18599
+ * @default false
19115
18600
  */
19116
18601
  this.pageable = false;
19117
18602
  /**
19118
- * If set to `true`, the user can group the Grid by dragging the column header cells.
19119
- * By default, grouping is disabled ([see example]({% slug grouping_grid %})).
18603
+ * If set to `true`, the user can group the Grid by dragging the column header cells ([see example]({% slug grouping_grid %})).
18604
+ * @default false
19120
18605
  */
19121
18606
  this.groupable = false;
19122
18607
  /**
19123
18608
  * Indicates whether the Grid columns will be resized during initialization so that
19124
- * they fit their headers and row content. Defaults to `false`.
18609
+ * they fit their headers and row content.
19125
18610
  * Columns with `autoSize` set to `false` are excluded.
19126
18611
  * To dynamically update the column width to match the new content,
19127
18612
  * refer to [this example]({% slug resizing_columns_grid %}).
18613
+ * @default false
19128
18614
  */
19129
18615
  this.autoSize = false;
19130
18616
  /**
@@ -19149,8 +18635,8 @@ class GridComponent {
19149
18635
  this.columnMenu = false;
19150
18636
  /**
19151
18637
  * Specifies if the header of the grid will be hidden. The header is visible by default.
19152
- *
19153
- * > The header includes column headers and the [filter row]({% slug filtering_grid %}#toc-filter-row).
18638
+ * The header includes column headers and the [filter row](slug:filter_row).
18639
+ * @default false
19154
18640
  */
19155
18641
  this.hideHeader = false;
19156
18642
  /**
@@ -19512,49 +18998,8 @@ class GridComponent {
19512
18998
  return this.navigable;
19513
18999
  }
19514
19000
  /**
19515
- * Defines a function that is executed for every data row in the component.
19516
- *
19517
- * @example
19518
- * ```ts
19519
- * import { Component, ViewEncapsulation } from '@angular/core';
19520
- * import { RowClassArgs } from '@progress/kendo-angular-grid';
19521
- *
19522
- * _@Component({
19523
- * selector: 'my-app',
19524
- * encapsulation: ViewEncapsulation.None,
19525
- * styles: [`
19526
- * .k-grid tr.even { background-color: #f45c42; }
19527
- * .k-grid tr.odd { background-color: #41f4df; }
19528
- * `],
19529
- * template: `
19530
- * <kendo-grid [data]="gridData" [rowClass]="rowCallback">
19531
- * </kendo-grid>
19532
- * `
19533
- * })
19534
- * class AppComponent {
19535
- * public gridData: any[] = products;
19536
- *
19537
- * public rowCallback(context: RowClassArgs) {
19538
- * const isEven = context.index % 2 === 0;
19539
- * return {
19540
- * even: isEven,
19541
- * odd: !isEven
19542
- * };
19543
- * }
19544
- * }
19545
- *
19546
- * const products = [{
19547
- * "ProductID": 1,
19548
- * "ProductName": "Chai",
19549
- * "UnitPrice": 18.0000,
19550
- * "Discontinued": true
19551
- * }, {
19552
- * "ProductID": 2,
19553
- * "ProductName": "Chang",
19554
- * "UnitPrice": 19.0000,
19555
- * "Discontinued": false
19556
- * }
19557
- * ];
19001
+ * Defines a function that is executed for every data row in the component
19002
+ * ([see example](slug:styling_grid_rows)).
19558
19003
  * ```
19559
19004
  */
19560
19005
  set rowClass(fn) {
@@ -19856,9 +19301,9 @@ class GridComponent {
19856
19301
  * This method is provided only for backwards-compatibility with legacy versions.
19857
19302
  * These versions tracked the expanded group state internally using the hierarchical group index.
19858
19303
  *
19859
- * > * When you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive,
19860
- * > the `expandGroup` method is not supported.
19861
- * > * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
19304
+ * The `expandGroup` method is not supported when you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive.
19305
+ *
19306
+ * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
19862
19307
  *
19863
19308
  * @param {string} index - The underscore separated hierarchical index of the group.
19864
19309
  */
@@ -19872,9 +19317,9 @@ class GridComponent {
19872
19317
  * This method is provided only for backwards-compatibility with legacy versions.
19873
19318
  * These versions tracked the expanded group state internally using the hierarchical group index.
19874
19319
  *
19875
- * > * When you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive,
19876
- * > the `collapseGroup` method is not supported.
19877
- * > * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
19320
+ * The `collapseGroup` method is not supported when you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive.
19321
+ *
19322
+ * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
19878
19323
  *
19879
19324
  * @param {string} index - The underscore separated hierarchical index of the group.
19880
19325
  */
@@ -20133,7 +19578,7 @@ class GridComponent {
20133
19578
  this.focusEditElement('.k-grid-add-row');
20134
19579
  }
20135
19580
  /**
20136
- * Puts the cell that is specified by the table row and column in edit mode.
19581
+ * Puts the cell that is specified by the table row and column in edit mode ([see example](slug:editing_incell_grid)).
20137
19582
  *
20138
19583
  * @param {number} rowIndex - The data row index that will be switched in the edit mode.
20139
19584
  * @param {number|string|any} column - The leaf column index, or the field name or the column instance that should be edited.
@@ -20188,7 +19633,7 @@ class GridComponent {
20188
19633
  * Exports the Grid element to a Drawing [Group]({% slug api_kendo-drawing_group %}) by using the `kendo-grid-pdf` component options.
20189
19634
  * ([see example]({% slug pdfexport_grid %}#toc-exporting-multiple-grids-to-the-same-pdf)).
20190
19635
  *
20191
- * @return {Promise} - A promise that will be resolved with the Drawing `Group`.
19636
+ * @return {Promise} A promise that will be resolved with the Drawing `Group`.
20192
19637
  */
20193
19638
  drawPDF() {
20194
19639
  const promise = createPromise();
@@ -20204,138 +19649,19 @@ class GridComponent {
20204
19649
  /**
20205
19650
  * Applies the minimum possible width for the specified column,
20206
19651
  * so that the whole text fits without wrapping. This method expects the Grid
20207
- * to be resizable (set `resizable` to `true`).
20208
- * Makes sense to execute this method only
19652
+ * to be [resizable](slug:resizing_columns_grid). The method must be executed
20209
19653
  * after the Grid is already populated with data.
20210
- *
20211
- * @example
20212
- * ```ts
20213
- * _@Component({
20214
- * selector: 'my-app',
20215
- * template: `
20216
- * <kendo-grid
20217
- * #grid
20218
- * [data]="gridData"
20219
- * [resizable]="true"
20220
- * style="height: 300px">
20221
- * <ng-template kendoGridToolbarTemplate>
20222
- * <button kendoButton (click)="grid.autoFitColumn(groupColumn)">
20223
- * Auto-fit the group column
20224
- * </button>
20225
- * </ng-template>
20226
- * <kendo-grid-column-group #groupColumn title="Product Info">
20227
- * <kendo-grid-column
20228
- * field="ProductID"
20229
- * [width]="50"
20230
- * [minResizableWidth]="30"
20231
- * title="ID">
20232
- * </kendo-grid-column>
20233
- *
20234
- * <kendo-grid-column
20235
- * field="ProductName"
20236
- * title="Product Name">
20237
- * </kendo-grid-column>
20238
- * </kendo-grid-column-group>
20239
- *
20240
- * <kendo-grid-column
20241
- * field="UnitPrice"
20242
- * title="Unit Price"
20243
- * [width]="180"
20244
- * filter="numeric"
20245
- * format="{0:c}">
20246
- * </kendo-grid-column>
20247
- * </kendo-grid>
20248
- * `
20249
- * })
20250
- * class AppComponent {
20251
- * public gridData: any[] = products;
20252
- * }
20253
- *
20254
- * const products = [{
20255
- * "ProductID": 1,
20256
- * "ProductName": "Chai",
20257
- * "UnitPrice": 18.0000,
20258
- * "Discontinued": true
20259
- * }, {
20260
- * "ProductID": 2,
20261
- * "ProductName": "Chang",
20262
- * "UnitPrice": 19.0000,
20263
- * "Discontinued": false
20264
- * }
20265
- * ];
20266
- * ```
19654
+ * [See example](slug:resizing_columns_grid#toc-auto-fitting-the-content)
20267
19655
  */
20268
19656
  autoFitColumn(column) {
20269
19657
  this.columnResizingService.autoFit(column);
20270
19658
  }
20271
19659
  /**
20272
19660
  * Adjusts the width of the specified columns to fit the entire content, including headers, without wrapping.
20273
- * If no columns are specified, `autoFitColumns` is applied to all columns.
20274
- *
20275
- * This method requires the Grid to be resizable (set `resizable` to `true`).
20276
- *
20277
- * @example
20278
- * ```ts
20279
- * _@Component({
20280
- * selector: 'my-app',
20281
- * template: `
20282
- * <kendo-grid
20283
- * #grid
20284
- * [data]="gridData"
20285
- * [resizable]="true"
20286
- * style="height: 300px">
20287
- * <ng-template kendoGridToolbarTemplate>
20288
- * <button kendoButton (click)="grid.autoFitColumns([firstColumn, lastColumn])">
20289
- * Auto-fit the first and last column
20290
- * </button>
20291
- * <button kendoButton (click)="grid.autoFitColumns()">
20292
- * Auto-fit all columns
20293
- * </button>
20294
- * </ng-template>
20295
- * <kendo-grid-column-group title="Product Info">
20296
- * <kendo-grid-column
20297
- * #firstColumn
20298
- * field="ProductID"
20299
- * [width]="50"
20300
- * [minResizableWidth]="30"
20301
- * title="ID">
20302
- * </kendo-grid-column>
20303
- *
20304
- * <kendo-grid-column
20305
- * field="ProductName"
20306
- * title="Product Name"
20307
- * >
20308
- * </kendo-grid-column>
20309
- * </kendo-grid-column-group>
20310
- *
20311
- * <kendo-grid-column
20312
- * #lastColumn
20313
- * field="UnitPrice"
20314
- * title="Unit Price"
20315
- * [width]="180"
20316
- * filter="numeric"
20317
- * format="{0:c}">
20318
- * </kendo-grid-column>
20319
- * </kendo-grid>
20320
- * `
20321
- * })
20322
- * class AppComponent {
20323
- * public gridData: any[] = products;
20324
- * }
19661
+ * If no columns are specified, `autoFitColumns` is applied to all columns.The method must be executed
19662
+ * after the Grid is already populated with data.
19663
+ * [See example](slug:resizing_columns_grid#toc-auto-fitting-the-content)
20325
19664
  *
20326
- * const products = [{
20327
- * "ProductID": 1,
20328
- * "ProductName": "Chai",
20329
- * "UnitPrice": 18.0000,
20330
- * "Discontinued": true
20331
- * }, {
20332
- * "ProductID": 2,
20333
- * "ProductName": "Chang",
20334
- * "UnitPrice": 19.0000,
20335
- * "Discontinued": false
20336
- * }
20337
- * ];
20338
- * ```
20339
19665
  */
20340
19666
  autoFitColumns(columns = this.columns) {
20341
19667
  let cols;
@@ -20396,10 +19722,10 @@ class GridComponent {
20396
19722
  /**
20397
19723
  * Focuses the cell with the specified row and column index.
20398
19724
  *
20399
- * The row index is based on the logical structure of the Grid and does not correspond to the data item index:
20400
- * * Header rows are included, starting at index 0.
20401
- * * Group headers and footers are included.
20402
- * * The row indexing is absolute and does not change with paging.
19725
+ * The row index is based on the logical structure of the Grid and does not correspond to the data item index.
19726
+ * Header rows are included, starting at index 0.
19727
+ * Group headers and footers are included.
19728
+ * The row indexing is absolute and does not change with paging.
20403
19729
  *
20404
19730
  * If the Grid is configured for scrolling, including virtual scrolling, the scroll position will be updated.
20405
19731
  * If the row is not present on the current page, the method will have no effect.
@@ -20450,67 +19776,6 @@ class GridComponent {
20450
19776
  * @param {number} destIndex - The new position of the column.
20451
19777
  * @param {ColumnReorderConfig} options - Additional options.
20452
19778
  *
20453
- * @example
20454
- * ```ts
20455
- * _@Component({
20456
- * selector: 'my-app',
20457
- * template: `
20458
- * <kendo-grid
20459
- * #grid
20460
- * [data]="gridData"
20461
- * [reorderable]="true"
20462
- * style="height: 300px">
20463
- * <ng-template kendoGridToolbarTemplate>
20464
- * <button kendoButton
20465
- * (click)="grid.reorderColumn(groupColumn, 2, { before: true })">
20466
- * Move the group column before the last one.
20467
- * </button>
20468
- * </ng-template>
20469
- * <kendo-grid-column-group #groupColumn title="Product Info">
20470
- * <kendo-grid-column
20471
- * field="ProductID"
20472
- * [width]="50"
20473
- * title="ID">
20474
- * </kendo-grid-column>
20475
- *
20476
- * <kendo-grid-column
20477
- * field="ProductName"
20478
- * title="Product Name">
20479
- * </kendo-grid-column>
20480
- * </kendo-grid-column-group>
20481
- *
20482
- * <kendo-grid-column
20483
- * field="UnitPrice"
20484
- * title="Unit Price"
20485
- * [width]="180"
20486
- * format="{0:c}">
20487
- * </kendo-grid-column>
20488
- *
20489
- * <kendo-grid-column
20490
- * field="Discontinued"
20491
- * title="Discontinued"
20492
- * [width]="100">
20493
- * </kendo-grid-column>
20494
- * </kendo-grid>
20495
- * `
20496
- * })
20497
- * class AppComponent {
20498
- * public gridData: any[] = products;
20499
- * }
20500
- *
20501
- * const products = [{
20502
- * "ProductID": 1,
20503
- * "ProductName": "Chai",
20504
- * "UnitPrice": 18.0000,
20505
- * "Discontinued": true
20506
- * }, {
20507
- * "ProductID": 2,
20508
- * "ProductName": "Chang",
20509
- * "UnitPrice": 19.0000,
20510
- * "Discontinued": false
20511
- * }
20512
- * ];
20513
- * ```
20514
19779
  */
20515
19780
  reorderColumn(source, destIndex, options = { before: false }) {
20516
19781
  const columnsForLevel = sortColumns(this.allColumnsForLevel(source.level));
@@ -22901,7 +22166,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
22901
22166
 
22902
22167
  /**
22903
22168
  * Custom component messages override default component messages
22904
- * ([see example]({% slug globalization_grid %}#toc-localization)).
22169
+ * ([see example](slug:globalization_grid#toc-custom-messages)).
22905
22170
  */
22906
22171
  class CustomMessagesComponent extends GridMessages {
22907
22172
  constructor(service) {
@@ -23099,11 +22364,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23099
22364
  }] });
23100
22365
 
23101
22366
  /**
23102
- * Represents the `Contains` (**Contains**) filter operator.
23103
- *
23104
- * For more information and examples, refer to:
23105
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23106
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22367
+ * Represents the `Contains` (**Contains**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
22368
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23107
22369
  */
23108
22370
  class ContainsFilterOperatorComponent extends FilterOperatorBase {
23109
22371
  constructor(localization) { super("contains", localization); }
@@ -23130,11 +22392,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23130
22392
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23131
22393
 
23132
22394
  /**
23133
- * Represents the `DoesNotContain` (**Does not contain**) filter operator.
22395
+ * Represents the `DoesNotContain` (**Does not contain**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23134
22396
  *
23135
- * For more information and examples, refer to:
23136
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23137
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22397
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23138
22398
  */
23139
22399
  class DoesNotContainFilterOperatorComponent extends FilterOperatorBase {
23140
22400
  constructor(localization) { super("doesnotcontain", localization); }
@@ -23161,11 +22421,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23161
22421
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23162
22422
 
23163
22423
  /**
23164
- * Represents the `EndsWith` (**Ends with**) string filter operator.
22424
+ * Represents the `EndsWith` (**Ends with**) string filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23165
22425
  *
23166
- * For more information and examples, refer to:
23167
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23168
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22426
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23169
22427
  */
23170
22428
  class EndsWithFilterOperatorComponent extends FilterOperatorBase {
23171
22429
  constructor(localization) { super("endswith", localization); }
@@ -23192,11 +22450,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23192
22450
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23193
22451
 
23194
22452
  /**
23195
- * Represents the `Equal` (**Is equal to**) filter operator.
22453
+ * Represents the `Equal` (**Is equal to**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23196
22454
  *
23197
- * For more information and examples, refer to:
23198
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23199
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22455
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23200
22456
  */
23201
22457
  class EqualFilterOperatorComponent extends FilterOperatorBase {
23202
22458
  constructor(localization) { super("eq", localization); }
@@ -23223,11 +22479,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23223
22479
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23224
22480
 
23225
22481
  /**
23226
- * Represents the `IsEmpty` (**Is empty**) filter operator.
22482
+ * Represents the `IsEmpty` (**Is empty**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23227
22483
  *
23228
- * For more information and examples, refer to:
23229
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23230
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22484
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23231
22485
  */
23232
22486
  class IsEmptyFilterOperatorComponent extends FilterOperatorBase {
23233
22487
  constructor(localization) { super("isempty", localization); }
@@ -23254,11 +22508,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23254
22508
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23255
22509
 
23256
22510
  /**
23257
- * Represents the `IsNotEmpty` (**Is not empty**) filter operator.
22511
+ * Represents the `IsNotEmpty` (**Is not empty**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23258
22512
  *
23259
- * For more information and examples, refer to:
23260
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23261
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22513
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23262
22514
  */
23263
22515
  class IsNotEmptyFilterOperatorComponent extends FilterOperatorBase {
23264
22516
  constructor(localization) { super("isnotempty", localization); }
@@ -23285,11 +22537,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23285
22537
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23286
22538
 
23287
22539
  /**
23288
- * Represents the `IsNotNull` (**Is not null**) filter operator.
22540
+ * Represents the `IsNotNull` (**Is not null**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23289
22541
  *
23290
- * For more information and examples, refer to:
23291
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23292
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22542
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23293
22543
  */
23294
22544
  class IsNotNullFilterOperatorComponent extends FilterOperatorBase {
23295
22545
  constructor(localization) { super("isnotnull", localization); }
@@ -23316,11 +22566,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23316
22566
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23317
22567
 
23318
22568
  /**
23319
- * Represents the `IsNull` (**Is null**) filter operator.
22569
+ * Represents the `IsNull` (**Is null**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23320
22570
  *
23321
- * For more information and examples, refer to:
23322
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23323
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22571
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23324
22572
  */
23325
22573
  class IsNullFilterOperatorComponent extends FilterOperatorBase {
23326
22574
  constructor(localization) { super("isnull", localization); }
@@ -23347,11 +22595,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23347
22595
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23348
22596
 
23349
22597
  /**
23350
- * Represents the `NotEqual` (**Is not equal to**) filter operator.
22598
+ * Represents the `NotEqual` (**Is not equal to**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23351
22599
  *
23352
- * For more information and examples, refer to:
23353
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23354
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22600
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23355
22601
  */
23356
22602
  class NotEqualFilterOperatorComponent extends FilterOperatorBase {
23357
22603
  constructor(localization) { super("neq", localization); }
@@ -23378,11 +22624,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23378
22624
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23379
22625
 
23380
22626
  /**
23381
- * Represents the `StartsWith` (**Starts with**) filter operator.
22627
+ * Represents the `StartsWith` (**Starts with**) filter operator. [See exmaple](slug:filtering_grid#toc-using-the-built-in-directive).
23382
22628
  *
23383
- * For more information and examples, refer to:
23384
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23385
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22629
+ * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
23386
22630
  */
23387
22631
  class StartsWithFilterOperatorComponent extends FilterOperatorBase {
23388
22632
  constructor(localization) { super("startswith", localization); }
@@ -23408,12 +22652,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23408
22652
  }]
23409
22653
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23410
22654
 
23411
- /*
23412
- * Represents the `Greater` (**Is greater than**) numeric filter operator.
23413
- *
23414
- * For more information and examples, refer to:
23415
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23416
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22655
+ /**
22656
+ * Represents the `Greater` (**Is greater than**) [numeric filter](slug:filtering_grid#toc-numeric-filter) operator.
22657
+ * [See example](slug:filter_row#toc-default-filter-operator).
23417
22658
  */
23418
22659
  class GreaterFilterOperatorComponent extends FilterOperatorBase {
23419
22660
  constructor(localization) { super("gt", localization); }
@@ -23440,11 +22681,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23440
22681
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23441
22682
 
23442
22683
  /**
23443
- * Represents the `GreaterOrEqualTo` (**Is greater than or equal to**) numeric filter operator.
23444
- *
23445
- * For more information and examples, refer to:
23446
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23447
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22684
+ * Represents the `GreaterOrEqualTo` (**Is greater than or equal to**) [numeric filter](slug:filtering_grid#toc-numeric-filter) operator.
22685
+ * [See example](slug:filter_row#toc-default-filter-operator).
23448
22686
  */
23449
22687
  class GreaterOrEqualToFilterOperatorComponent extends FilterOperatorBase {
23450
22688
  constructor(localization) { super("gte", localization); }
@@ -23470,12 +22708,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23470
22708
  }]
23471
22709
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23472
22710
 
23473
- /*
23474
- * Represents the `Less` (**Is less than**) numeric filter operator.
22711
+ /**
22712
+ * Represents the `Less` (**Is less than**) [numeric filter](slug:filtering_grid#toc-numeric-filter) operator.
23475
22713
  *
23476
- * For more information and examples, refer to:
23477
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23478
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22714
+ * [See example](slug:filter_row#toc-default-filter-operator).
23479
22715
  */
23480
22716
  class LessFilterOperatorComponent extends FilterOperatorBase {
23481
22717
  constructor(localization) { super("lt", localization); }
@@ -23501,12 +22737,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23501
22737
  }]
23502
22738
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23503
22739
 
23504
- /*
23505
- * Represents the `LessOrEqualTo` (**Is less than or equal to**) numeric filter operator.
22740
+ /**
22741
+ * Represents the `LessOrEqualTo` (**Is less than or equal to**) [numeric filter](slug:filtering_grid#toc-numeric-filter) operator.
23506
22742
  *
23507
- * For more information and examples, refer to:
23508
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23509
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22743
+ * [See example](slug:filter_row#toc-default-filter-operator).
23510
22744
  */
23511
22745
  class LessOrEqualToFilterOperatorComponent extends FilterOperatorBase {
23512
22746
  constructor(localization) { super("lte", localization); }
@@ -23532,12 +22766,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23532
22766
  }]
23533
22767
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23534
22768
 
23535
- /*
23536
- * Represents the `Greater` (**Is after**) date filter operator.
23537
- *
23538
- * For more information and examples, refer to:
23539
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23540
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22769
+ /**
22770
+ * Represents the `Greater` (**Is after**) [date filter](slug:filtering_grid#toc-date-filter) operator.
22771
+ * [See example](slug:filter_row#toc-default-filter-operator).
23541
22772
  */
23542
22773
  class AfterFilterOperatorComponent extends FilterOperatorBase {
23543
22774
  constructor(localization) { super("after", localization); }
@@ -23572,12 +22803,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23572
22803
  }]
23573
22804
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23574
22805
 
23575
- /*
23576
- * Represents the `GreaterOrEqualTo` (**Is after or equal to**) date filter operator.
23577
- *
23578
- * For more information and examples, refer to:
23579
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23580
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22806
+ /**
22807
+ * Represents the `GreaterOrEqualTo` (**Is after or equal to**) [date filter](slug:filtering_grid#toc-date-filter) operator.
22808
+ * [See example](slug:filter_row#toc-default-filter-operator).
23581
22809
  */
23582
22810
  class AfterEqFilterOperatorComponent extends FilterOperatorBase {
23583
22811
  constructor(localization) { super("after-eq", localization); }
@@ -23612,12 +22840,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23612
22840
  }]
23613
22841
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23614
22842
 
23615
- /*
23616
- * Represents the `LessOrEqualTo` (**Is before or equal to**) date filter operator.
23617
- *
23618
- * For more information and examples, refer to:
23619
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23620
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22843
+ /**
22844
+ * Represents the `LessOrEqualTo` (**Is before or equal to**) [date filter](slug:filtering_grid#toc-date-filter) operator.
22845
+ * [See example](slug:filter_row#toc-default-filter-operator).
23621
22846
  */
23622
22847
  class BeforeEqFilterOperatorComponent extends FilterOperatorBase {
23623
22848
  constructor(localization) { super("before-eq", localization); }
@@ -23652,12 +22877,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
23652
22877
  }]
23653
22878
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
23654
22879
 
23655
- /*
23656
- * Represents the `Less then` (**Is before**) date filter operator.
23657
- *
23658
- * For more information and examples, refer to:
23659
- * * [Setting the default filter operators]({% slug filter_menu %}#toc-default-filter-operator)
23660
- * * [Setting the order of the filter operators]({% slug filter_menu %}#toc-order-of-filter-operators)
22880
+ /**
22881
+ * Represents the `Less than` (**Is before**) [date filter](slug:filtering_grid#toc-date-filter) operator.
22882
+ * [See example](slug:filter_row#toc-default-filter-operator).
23661
22883
  */
23662
22884
  class BeforeFilterOperatorComponent extends FilterOperatorBase {
23663
22885
  constructor(localization) { super("before", localization); }
@@ -24097,27 +23319,18 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
24097
23319
  }] });
24098
23320
 
24099
23321
  /**
24100
- * Represents the component for selecting columns in the Grid. To enable the user to show or hide columns,
24101
- * add the component inside a [ToolbarTemplate]({% slug api_grid_toolbartemplatedirective %}) directive.
23322
+ * Represents the component for toggling the visibility of the Grid columns. [See example](slug:columnmenu_grid#toc-using-standalone-column-chooser).
23323
+ * To show and hide the columns without including the column chooser item in the [Column Menu](slug:columnmenu_grid),
23324
+ * add the component inside the [ToolbarTemplate](slug:toolbartemplate_grid) directive.
24102
23325
  *
24103
23326
  * @example
24104
- * ```ts-preview
24105
- * _@Component({
24106
- * selector: 'my-app',
24107
- * template: `
24108
- * <kendo-grid [data]="data">
24109
- * <ng-template kendoGridToolbarTemplate>
24110
- * <kendo-grid-column-chooser></kendo-grid-column-chooser>
24111
- * </ng-template>
24112
- * <kendo-grid-column field="Field1"></kendo-grid-column>
24113
- * <kendo-grid-column field="Field2" [hidden]="true"></kendo-grid-column>
24114
- * </kendo-grid>
24115
- * `
24116
- * })
24117
- *
24118
- * class AppComponent {
24119
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
24120
- * }
23327
+ * ```html
23328
+ * <kendo-grid [data]="data">
23329
+ * <ng-template kendoGridToolbarTemplate>
23330
+ * <kendo-grid-column-chooser></kendo-grid-column-chooser>
23331
+ * </ng-template>
23332
+ * <kendo-grid-column field="ProductID"></kendo-grid-column>
23333
+ * </kendo-grid>
24121
23334
  * ```
24122
23335
  */
24123
23336
  class ColumnChooserComponent {
@@ -24134,10 +23347,14 @@ class ColumnChooserComponent {
24134
23347
  this.columnsIcon = columnsIcon;
24135
23348
  /**
24136
23349
  * Specifies if the changes in the visibility of the column will be immediately applied.
23350
+ *
23351
+ * @default false
24137
23352
  */
24138
23353
  this.autoSync = false;
24139
23354
  /**
24140
23355
  * Specifies if all columns can be hidden.
23356
+ *
23357
+ * @default true
24141
23358
  */
24142
23359
  this.allowHideAll = true;
24143
23360
  }
@@ -24396,65 +23613,14 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
24396
23613
  }] });
24397
23614
 
24398
23615
  /**
24399
- * Represents the checkbox for selecting columns in the Grid. If the column is
24400
- * defined as empty, it renders a default checkbox for row selection.
24401
- * You can also define the content of the column inside an `<ng-template>` tag.
24402
- * The input requires you to include the `SelectionCheckbox` option.
24403
- *
24404
- * The template context is set to the current data item and the following additional fields are passed:
24405
- * - `columnIndex`&mdash;The current column index.
24406
- * - `rowIndex`&mdash;The current data row index. If inside a new item row, it will be `-1`.
24407
- * - `dataItem`&mdash;The current data item.
24408
- * - `column`&mdash;The current column instance.
24409
- * - `isNew`&mdash;The state of the current item.
24410
- *
24411
- * For more examples, refer to:
24412
- * - [Selecting or deselecting all items on a page]({% slug selection_grid %}#toc-select-all-feature)
24413
- * - [Persisting the selection]({% slug selection_grid %}#toc-in-combination-with-the-select-all-feature)
23616
+ * Represents the checkbox column for selecting rows in the Grid. [See example](slug:grid_row_selection#toc-select-all-checkbox).
24414
23617
  *
24415
23618
  * @example
24416
- * ```ts-preview
24417
- *
24418
- * _@Component({
24419
- * selector: 'my-app',
24420
- * template: `
24421
- * <kendo-grid [data]="gridData" [selectable]="{enabled: true, checkboxOnly: true}">
24422
- * <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
24423
- * </kendo-grid-column>
24424
- * <kendo-grid-column field="ProductName" title="Product Name">
24425
- * </kendo-grid-column>
24426
- * <kendo-grid-checkbox-column title="Default checkbox">
24427
- * </kendo-grid-checkbox-column>
24428
- * <kendo-grid-checkbox-column title="Custom checkbox">
24429
- * <ng-template kendoGridCellTemplate let-idx="rowIndex">
24430
- * Select row <input [kendoGridSelectionCheckbox]="idx" />
24431
- * </ng-template>
24432
- * </kendo-grid-checkbox-column>
24433
- * </kendo-grid>
24434
- * `
24435
- * })
24436
- *
24437
- * class AppComponent {
24438
- * public gridData: any[];
24439
- *
24440
- * constructor() {
24441
- * this.gridData = products;
24442
- * }
24443
- * }
24444
- *
24445
- * const products = [{
24446
- * "ProductID": 1,
24447
- * "ProductName": "Chai",
24448
- * "UnitPrice": 18.0000,
24449
- * "Discontinued": true
24450
- * }, {
24451
- * "ProductID": 2,
24452
- * "ProductName": "Chang",
24453
- * "UnitPrice": 19.0000,
24454
- * "Discontinued": false
24455
- * }
24456
- * ];
24457
- *
23619
+ * ```hmtl
23620
+ * <kendo-grid [selectable]="{enabled: true, checkboxOnly: true}">
23621
+ * <kendo-grid-checkbox-column title="Default checkbox"></kendo-grid-checkbox-column>
23622
+ * <kendo-grid-column field="ProductID"></kendo-grid-column>
23623
+ * </kendo-grid>
24458
23624
  * ```
24459
23625
  */
24460
23626
  class CheckboxColumnComponent extends ColumnBase {
@@ -24971,7 +24137,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
24971
24137
  }] } });
24972
24138
 
24973
24139
  /**
24974
- * Represents the drag handle for reordering rows in the Grid.
24140
+ * Represents the drag handle for reordering rows in the Grid ([see example](slug:reordering_rows_grid))
24975
24141
  */
24976
24142
  class RowReorderColumnComponent extends ColumnBase {
24977
24143
  constructor(parent, idService) {
@@ -25984,6 +25150,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
25984
25150
  }]
25985
25151
  }] });
25986
25152
 
25153
+ /**
25154
+ * Represents the Kendo UI PDFMargin component for Angular.
25155
+ * The supported units are:
25156
+ * `"mm"`
25157
+ * `"cm"`
25158
+ * `"in"`
25159
+ * `"pt"` (default).
25160
+ * Numbers are considered to be points (`"pt"`).
25161
+ */
25987
25162
  class PDFMarginComponent extends PDFExportMarginComponent {
25988
25163
  }
25989
25164
  PDFMarginComponent.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "13.3.12", ngImport: i0, type: PDFMarginComponent, deps: null, target: i0.ɵɵFactoryTarget.Component });