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