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

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