@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
@@ -10,27 +10,18 @@ import { SVGIcon } from '@progress/kendo-svg-icons';
10
10
  import { Button } from '@progress/kendo-angular-buttons';
11
11
  import * as i0 from "@angular/core";
12
12
  /**
13
- * Represents the component for selecting columns in the Grid. To enable the user to show or hide columns,
14
- * add the component inside a [ToolbarTemplate]({% slug api_grid_toolbartemplatedirective %}) directive.
13
+ * Represents the component for toggling the visibility of the Grid columns. [See example](slug:columnmenu_grid#toc-using-standalone-column-chooser).
14
+ * To show and hide the columns without including the column chooser item in the [Column Menu](slug:columnmenu_grid),
15
+ * add the component inside the [ToolbarTemplate](slug:toolbartemplate_grid) directive.
15
16
  *
16
17
  * @example
17
- * ```ts-preview
18
- * _@Component({
19
- * selector: 'my-app',
20
- * template: `
21
- * <kendo-grid [data]="data">
22
- * <ng-template kendoGridToolbarTemplate>
23
- * <kendo-grid-column-chooser></kendo-grid-column-chooser>
24
- * </ng-template>
25
- * <kendo-grid-column field="Field1"></kendo-grid-column>
26
- * <kendo-grid-column field="Field2" [hidden]="true"></kendo-grid-column>
27
- * </kendo-grid>
28
- * `
29
- * })
30
- *
31
- * class AppComponent {
32
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
33
- * }
18
+ * ```html
19
+ * <kendo-grid [data]="data">
20
+ * <ng-template kendoGridToolbarTemplate>
21
+ * <kendo-grid-column-chooser></kendo-grid-column-chooser>
22
+ * </ng-template>
23
+ * <kendo-grid-column field="ProductID"></kendo-grid-column>
24
+ * </kendo-grid>
34
25
  * ```
35
26
  */
36
27
  export declare class ColumnChooserComponent implements OnDestroy {
@@ -46,10 +37,14 @@ export declare class ColumnChooserComponent implements OnDestroy {
46
37
  columnsIcon: SVGIcon;
47
38
  /**
48
39
  * Specifies if the changes in the visibility of the column will be immediately applied.
40
+ *
41
+ * @default false
49
42
  */
50
43
  autoSync: boolean;
51
44
  /**
52
45
  * Specifies if all columns can be hidden.
46
+ *
47
+ * @default true
53
48
  */
54
49
  allowHideAll: boolean;
55
50
  get columns(): any[];
@@ -9,36 +9,21 @@ import { ContextService } from '../common/provider.service';
9
9
  import { ColumnMenuItemBase } from './column-menu-item-base';
10
10
  import * as i0 from "@angular/core";
11
11
  /**
12
- * Represents the component for resizing all columns to the minimum possible width so that they fit the widest header or cell content without wrapping.
13
- * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
14
- *
15
- * > To enable the autosize-all-columns option, set the [`resizable`]({% slug api_grid_gridcomponent %}#toc-resizable)
16
- * > property of the Grid to `true`.
12
+ * 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.
13
+ * [See example](slug:columnmenu_grid#toc-autosize-all-columns-item).
17
14
  *
18
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
19
- * > the template to the `service` input of the `kendo-grid-columnmenu-autosize-all-columns` component.
15
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
16
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
17
+ * the template to the `service` input of the `kendo-grid-columnmenu-autosize-all-columns` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
20
18
  *
21
19
  * @example
22
- * ```ts-preview
23
- *
24
- * _@Component({
25
- * selector: 'my-app',
26
- * template: `
27
- * <kendo-grid [data]="data" [columnMenu]="true">
28
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
29
- * <kendo-grid-columnmenu-autosize-all-columns [service]="service">
30
- * </kendo-grid-columnmenu-autosize-all-columns>
31
- * </ng-template>
32
- * <kendo-grid-column field="Field1"></kendo-grid-column>
33
- * <kendo-grid-column field="Field2"></kendo-grid-column>
34
- * </kendo-grid>
35
- * `
36
- * })
37
- *
38
- * class AppComponent {
39
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
40
- * }
41
- *
20
+ * ```html
21
+ * <kendo-grid [columnMenu]="true" ...>
22
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
23
+ * <kendo-grid-columnmenu-autosize-all-columns [service]="service">
24
+ * </kendo-grid-columnmenu-autosize-all-columns>
25
+ * </ng-template>
26
+ * </kendo-grid>
42
27
  * ```
43
28
  */
44
29
  export declare class ColumnMenuAutoSizeAllColumnsComponent extends ColumnMenuItemBase implements OnInit {
@@ -47,6 +32,9 @@ export declare class ColumnMenuAutoSizeAllColumnsComponent extends ColumnMenuIte
47
32
  displayInlineBlockIcon: SVGIcon;
48
33
  constructor(localization: LocalizationService, ctx: ContextService);
49
34
  ngOnInit(): void;
35
+ /**
36
+ * Resizes all columns to the minimum possible width so that they fit the widest header or cell content without wrapping.
37
+ */
50
38
  autoSizeAllColumns(): void;
51
39
  static ɵfac: i0.ɵɵFactoryDeclaration<ColumnMenuAutoSizeAllColumnsComponent, never>;
52
40
  static ɵcmp: i0.ɵɵComponentDeclaration<ColumnMenuAutoSizeAllColumnsComponent, "kendo-grid-columnmenu-autosize-all-columns", never, {}, {}, never, never>;
@@ -9,36 +9,22 @@ import { ContextService } from '../common/provider.service';
9
9
  import { ColumnMenuItemBase } from './column-menu-item-base';
10
10
  import * as i0 from "@angular/core";
11
11
  /**
12
- * Represents the component for resizing the specified column to the minimum possible width so that it fits the header or cell content without wrapping.
12
+ * 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.
13
+ * [See example](slug:slug:columnmenu_grid#toc-autosize-column-item).
13
14
  * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
15
+ * [See example](slug:columnmenu_grid#toc-customizing-the-content).
14
16
  *
15
- * > To enable the autosize-column option, set the [`resizable`]({% slug api_grid_gridcomponent %}#toc-resizable)
16
- * > property of the Grid to `true`.
17
- *
18
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) and `column` that are passed by
19
- * > the template to the `service` and `column` input of the `kendo-grid-columnmenu-autosize-column` component.
17
+ * You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) and `column` that are passed by
18
+ * the template to the `service` and `column` input of the `kendo-grid-columnmenu-autosize-column` component.
20
19
  *
21
20
  * @example
22
- * ```ts-preview
23
- *
24
- * _@Component({
25
- * selector: 'my-app',
26
- * template: `
27
- * <kendo-grid [data]="data" [columnMenu]="true">
28
- * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
29
- * <kendo-grid-columnmenu-autosize-column [column]="column" [service]="service">
30
- * </kendo-grid-columnmenu-autosize-column>
31
- * </ng-template>
32
- * <kendo-grid-column field="Field1"></kendo-grid-column>
33
- * <kendo-grid-column field="Field2"></kendo-grid-column>
34
- * </kendo-grid>
35
- * `
36
- * })
37
- *
38
- * class AppComponent {
39
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
40
- * }
41
- *
21
+ * ```html
22
+ * <kendo-grid [columnMenu]="true" ...>
23
+ * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
24
+ * <kendo-grid-columnmenu-autosize-column [column]="column" [service]="service">
25
+ * </kendo-grid-columnmenu-autosize-column>
26
+ * </ng-template>
27
+ * </kendo-grid>
42
28
  * ```
43
29
  */
44
30
  export declare class ColumnMenuAutoSizeColumnComponent extends ColumnMenuItemBase implements OnInit {
@@ -51,6 +37,9 @@ export declare class ColumnMenuAutoSizeColumnComponent extends ColumnMenuItemBas
51
37
  maxWidthIcon: SVGIcon;
52
38
  constructor(localization: LocalizationService, ctx: ContextService);
53
39
  ngOnInit(): void;
40
+ /**
41
+ * Resizes a specified column to the minimum possible width so that it fits the widest header or cell content without wrapping.
42
+ */
54
43
  autoSizeColumn(): void;
55
44
  static ɵfac: i0.ɵɵFactoryDeclaration<ColumnMenuAutoSizeColumnComponent, never>;
56
45
  static ɵcmp: i0.ɵɵComponentDeclaration<ColumnMenuAutoSizeColumnComponent, "kendo-grid-columnmenu-autosize-column", never, { "column": "column"; }, {}, never, never>;
@@ -9,33 +9,19 @@ import { ColumnMenuItemBase } from './column-menu-item-base';
9
9
  import { SVGIcon } from '@progress/kendo-svg-icons';
10
10
  import * as i0 from "@angular/core";
11
11
  /**
12
- * Represents the component for selecting columns in the Grid that can be placed
13
- * inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
12
+ * Represents the column-menu item for selecting columns in the Grid. [See example](slug:columnmenu_grid#toc-column-chooser-item).
14
13
  *
15
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
16
- * > the template to the service input of the `kendo-grid-columnmenu-chooser` component.
14
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
15
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
16
+ * the template to the service input of the `kendo-grid-columnmenu-chooser` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
17
17
  *
18
18
  * @example
19
- * ```ts-preview
20
- *
21
- * _@Component({
22
- * selector: 'my-app',
23
- * template: `
24
- * <kendo-grid [data]="data" [columnMenu]="true">
25
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
26
- * <kendo-grid-columnmenu-chooser [service]="service">
27
- * </kendo-grid-columnmenu-chooser>
28
- * </ng-template>
29
- * <kendo-grid-column field="Field1"></kendo-grid-column>
30
- * <kendo-grid-column field="Field2" [hidden]="true"></kendo-grid-column>
31
- * </kendo-grid>
32
- * `
33
- * })
34
- *
35
- * class AppComponent {
36
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
37
- * }
38
- *
19
+ * ```html
20
+ * <kendo-grid [columnMenu]="true" ...>
21
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
22
+ * <kendo-grid-columnmenu-chooser [service]="service"> </kendo-grid-columnmenu-chooser>
23
+ * </ng-template>
24
+ * </kendo-grid>
39
25
  * ```
40
26
  */
41
27
  export declare class ColumnMenuChooserComponent extends ColumnMenuItemBase {
@@ -53,6 +39,7 @@ export declare class ColumnMenuChooserComponent extends ColumnMenuItemBase {
53
39
  collapse: EventEmitter<any>;
54
40
  /**
55
41
  * Specifies if the content is expanded.
42
+ * @default false
56
43
  */
57
44
  expanded: boolean;
58
45
  /**
@@ -9,7 +9,6 @@
9
9
  export interface ExpandableColumnMenuItem {
10
10
  /**
11
11
  * Used to determine whether an expandable column menu item is initially expanded.
12
- * @default false
13
12
  */
14
13
  expanded: boolean;
15
14
  }
@@ -8,33 +8,20 @@ import { SVGIcon } from '@progress/kendo-svg-icons';
8
8
  import { ColumnMenuItemBase } from './column-menu-item-base';
9
9
  import * as i0 from "@angular/core";
10
10
  /**
11
- * Represents the component for editing column filters in the Grid that can be placed
12
- * inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11
+ * Represents the column-menu item for editing column filters in the Grid. [See example](slug:columnmenu_grid#toc-filter-item).
13
12
  *
14
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
15
- * > the template to the service input of the `kendo-grid-columnmenu-filter` component.
13
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
14
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
15
+ * the template to the service input of the `kendo-grid-columnmenu-filter` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
16
16
  *
17
17
  * @example
18
- * ```ts-preview
19
- *
20
- * _@Component({
21
- * selector: 'my-app',
22
- * template: `
23
- * <kendo-grid [kendoGridBinding]="data" [columnMenu]="true">
24
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
25
- * <kendo-grid-columnmenu-filter [service]="service">
26
- * </kendo-grid-columnmenu-filter>
27
- * </ng-template>
28
- * <kendo-grid-column field="Field1"></kendo-grid-column>
29
- * <kendo-grid-column field="Field2"></kendo-grid-column>
30
- * </kendo-grid>
31
- * `
32
- * })
33
- *
34
- * class AppComponent {
35
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
36
- * }
37
- *
18
+ * ```html
19
+ * <kendo-grid [columnMenu]="true" ...>
20
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
21
+ * <kendo-grid-columnmenu-filter [service]="service">
22
+ * </kendo-grid-columnmenu-filter>
23
+ * </ng-template>
24
+ * </kendo-grid>
38
25
  * ```
39
26
  */
40
27
  export declare class ColumnMenuFilterComponent extends ColumnMenuItemBase {
@@ -50,6 +37,7 @@ export declare class ColumnMenuFilterComponent extends ColumnMenuItemBase {
50
37
  collapse: EventEmitter<any>;
51
38
  /**
52
39
  * Specifies if the content is expanded.
40
+ * @default false
53
41
  */
54
42
  expanded: boolean;
55
43
  /**
@@ -11,27 +11,12 @@ import * as i0 from "@angular/core";
11
11
  * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
12
12
  *
13
13
  * @example
14
- * ```ts-preview
15
- *
16
- * _@Component({
17
- * selector: 'my-app',
18
- * template: `
19
- * <kendo-grid [data]="data" [columnMenu]="true" [resizable]="true" #grid>
20
- * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
21
- * <kendo-grid-columnmenu-item icon="arrows-resizing" text="Fit column"
22
- * (itemClick)="grid.autoFitColumn(column); service.close()">
23
- * </kendo-grid-columnmenu-item>
24
- * </ng-template>
25
- * <kendo-grid-column field="Field1"></kendo-grid-column>
26
- * <kendo-grid-column field="Field2"></kendo-grid-column>
27
- * </kendo-grid>
28
- * `
29
- * })
30
- *
31
- * class AppComponent {
32
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
33
- * }
34
- *
14
+ * ```html
15
+ * <kendo-grid [columnMenu]="true" ...>
16
+ * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
17
+ * <kendo-grid-columnmenu-item text="Fit column"></kendo-grid-columnmenu-item>
18
+ * </ng-template>
19
+ * </kendo-grid>
35
20
  * ```
36
21
  */
37
22
  export declare class ColumnMenuItemComponent implements OnChanges {
@@ -9,34 +9,20 @@ import { ColumnInfoService } from '../common/column-info.service';
9
9
  import { ColumnMenuItemBase } from './column-menu-item-base';
10
10
  import * as i0 from "@angular/core";
11
11
  /**
12
- * Represents a column-menu item that can be placed inside a
13
- * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
14
- * Allows the user to lock or unlock the columns.
12
+ * Represents the column-menu item for locking and unlocking columns in the Grid. [See example](slug:columnmenu_grid#toc-lock-and-unlock-items).
15
13
  *
16
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
17
- * > the template to the service input of the `kendo-grid-columnmenu-lock` component.
14
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
15
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
16
+ * the template to the service input of the `kendo-grid-columnmenu-lock` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
18
17
  *
19
18
  * @example
20
- * ```ts-preview
21
- *
22
- * _@Component({
23
- * selector: 'my-app',
24
- * template: `
25
- * <kendo-grid [data]="data" [columnMenu]="true">
26
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
27
- * <kendo-grid-columnmenu-lock [service]="service">
28
- * </kendo-grid-columnmenu-lock>
29
- * </ng-template>
30
- * <kendo-grid-column field="Field1" [width]="100"></kendo-grid-column>
31
- * <kendo-grid-column field="Field2" [width]="100"></kendo-grid-column>
32
- * </kendo-grid>
33
- * `
34
- * })
35
- *
36
- * class AppComponent {
37
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
38
- * }
39
- *
19
+ * ```html
20
+ * <kendo-grid [data]="data" [columnMenu]="true" ...>
21
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
22
+ * <kendo-grid-columnmenu-lock [service]="service">
23
+ * </kendo-grid-columnmenu-lock>
24
+ * </ng-template>
25
+ * </kendo-grid>
40
26
  * ```
41
27
  */
42
28
  export declare class ColumnMenuLockComponent extends ColumnMenuItemBase {
@@ -8,33 +8,20 @@ import { SVGIcon } from '@progress/kendo-svg-icons';
8
8
  import { ColumnMenuItemBase } from './column-menu-item-base';
9
9
  import * as i0 from "@angular/core";
10
10
  /**
11
- * Represents the component for editing column filters in the Grid that can be placed
12
- * inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
11
+ * Represents the column-menu item which combines the lock and sticky column functionalities.
13
12
  *
14
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
15
- * > the template to the service input of the `kendo-grid-columnmenu-filter` component.
13
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
14
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
15
+ * the template to the service input of the `kendo-grid-columnmenu-filter` component. [See example](slug:columnmenu_grid#toc-set-column-position-item).
16
16
  *
17
17
  * @example
18
- * ```ts-preview
19
- *
20
- * _@Component({
21
- * selector: 'my-app',
22
- * template: `
23
- * <kendo-grid [kendoGridBinding]="data" [columnMenu]="true">
24
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
25
- * <kendo-grid-columnmenu-filter [service]="service">
26
- * </kendo-grid-columnmenu-filter>
27
- * </ng-template>
28
- * <kendo-grid-column field="Field1"></kendo-grid-column>
29
- * <kendo-grid-column field="Field2"></kendo-grid-column>
30
- * </kendo-grid>
31
- * `
32
- * })
33
- *
34
- * class AppComponent {
35
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
36
- * }
37
- *
18
+ * ```html
19
+ * <kendo-grid [data]="data" [columnMenu]="true" ...>
20
+ * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
21
+ * <kendo-grid-columnmenu-position [service]="service" [showLock]="true" [showStick]="true">
22
+ * </kendo-grid-columnmenu-position>
23
+ * </ng-template>
24
+ * </kendo-grid>
38
25
  * ```
39
26
  */
40
27
  export declare class ColumnMenuPositionComponent extends ColumnMenuItemBase {
@@ -50,6 +37,7 @@ export declare class ColumnMenuPositionComponent extends ColumnMenuItemBase {
50
37
  collapse: EventEmitter<any>;
51
38
  /**
52
39
  * Specifies if the content is expanded.
40
+ * @default false
53
41
  */
54
42
  expanded: boolean;
55
43
  /**
@@ -7,67 +7,46 @@ import { ExpandableColumnMenuItem } from "./column-menu-expandable-item.interfac
7
7
  * The settings of the column menu in the Grid component.
8
8
  *
9
9
  * @example
10
- * ```ts-preview
11
- *
12
- * _@Component({
13
- * selector: 'my-app',
14
- * template: `
15
- * <kendo-grid [data]="data" [filterable]="true" [columnMenu]="{ lock: true, filter: false }">
16
- * <kendo-grid-column field="Field1" [width]="100"></kendo-grid-column>
17
- * <kendo-grid-column field="Field2" [width]="100"></kendo-grid-column>
18
- * </kendo-grid>
19
- * `
20
- * })
21
- *
22
- * class AppComponent {
23
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
24
- * }
25
- *
10
+ * ```html
11
+ * <kendo-grid [columnMenu]="{ lock: true, filter: false }">
12
+ * </kendo-grid>
26
13
  * ```
27
14
  */
28
15
  export interface ColumnMenuSettings {
29
16
  /**
30
17
  * Specifies if the columns can be sorted in the column menu.
31
18
  * If [sorting]({% slug api_grid_gridcomponent %}#toc-sortable) is enabled, defaults to `true`.
32
- * @default true
33
19
  */
34
20
  sort?: boolean;
35
21
  /**
36
22
  * Specifies if the columns can be filtered in the column menu.
37
23
  * If [filtering]({% slug api_grid_gridcomponent %}#toc-filterable) is enabled, defaults to `true`.
38
- * @default true
39
24
  */
40
25
  filter?: boolean | ExpandableColumnMenuItem;
41
26
  /**
42
27
  * Specifies if the item for column selection will be displayed in the column menu.
43
- * @default true
44
28
  */
45
29
  columnChooser?: boolean | ExpandableColumnMenuItem;
46
30
  /**
47
31
  * Specifies if the columns can be locked and unlocked from the column menu.
48
32
  * This option follows the prerequisites and limitations of the [locked columns]({% slug locked_columns_grid %}).
49
- * @default false
50
33
  */
51
34
  lock?: boolean;
52
35
  /**
53
36
  * Specifies if the columns can be stuck and unstuck from the column menu.
54
37
  * This option follows the prerequisites and limitations of the [sticky columns]({% slug sticky_columns_grid %}).
55
- * @default false
56
38
  */
57
39
  stick?: boolean;
58
40
  /**
59
41
  * Specifies whether the stick and lock items will be displayed in an expandable sub-menu or as standalone root-level menu items.
60
- * @default false
61
42
  */
62
43
  setColumnPosition?: boolean | ExpandableColumnMenuItem;
63
44
  /**
64
45
  * Applies the minimum possible width for the specified column, so that the whole text fits without wrapping.
65
- * @default false
66
46
  */
67
47
  autoSizeColumn?: boolean;
68
48
  /**
69
49
  * Adjusts the width of all columns to fit their entire content, including headers, without wrapping.
70
- * @default false
71
50
  */
72
51
  autoSizeAllColumns?: boolean;
73
52
  }
@@ -9,34 +9,21 @@ import { ColumnMenuItemBase } from './column-menu-item-base';
9
9
  import { SVGIcon } from '@progress/kendo-svg-icons';
10
10
  import * as i0 from "@angular/core";
11
11
  /**
12
- * Represents a column-menu item for sorting Grid columns that can be placed inside a
13
- * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
14
- * Allows the user to sort the column.
12
+ * Represents the column-menu item for sorting Grid columns.
13
+ * [See example](slug:columnmenu_grid#toc-sort-item).
15
14
  *
16
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
17
- * > the template to the service input of the `kendo-grid-columnmenu-sort` component.
15
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
16
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
17
+ * the template to the service input of the `kendo-grid-columnmenu-sort` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
18
18
  *
19
19
  * @example
20
- * ```ts-preview
21
- *
22
- * _@Component({
23
- * selector: 'my-app',
24
- * template: `
25
- * <kendo-grid [kendoGridBinding]="data" [sortable]="true" [columnMenu]="true">
26
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
27
- * <kendo-grid-columnmenu-sort [service]="service">
28
- * </kendo-grid-columnmenu-sort>
29
- * </ng-template>
30
- * <kendo-grid-column field="Field1" [width]="100"></kendo-grid-column>
31
- * <kendo-grid-column field="Field2" [width]="100"></kendo-grid-column>
32
- * </kendo-grid>
33
- * `
34
- * })
35
- *
36
- * class AppComponent {
37
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }, { Field1: 'Foo1', Field2: 'Bar1' }];
38
- * }
39
- *
20
+ * ```html
21
+ * <kendo-grid [kendoGridBinding]="data" [sortable]="true" [columnMenu]="true">
22
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
23
+ * <kendo-grid-columnmenu-sort [service]="service">
24
+ * </kendo-grid-columnmenu-sort>
25
+ * </ng-template>
26
+ * </kendo-grid>
40
27
  * ```
41
28
  */
42
29
  export declare class ColumnMenuSortComponent extends ColumnMenuItemBase {
@@ -9,33 +9,21 @@ import { ColumnInfoService } from '../common/column-info.service';
9
9
  import { ColumnMenuItemBase } from './column-menu-item-base';
10
10
  import * as i0 from "@angular/core";
11
11
  /**
12
- * Represents a column-menu item that can be placed inside a
13
- * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
14
- * Allows the user to stick or unstick the columns.
12
+ * Represents the column-menu item that sticks or unsticks columns in the Grid.
13
+ * [See example](slug:columnmenu_grid#toc-stick-and-unstick-items).
15
14
  *
16
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
17
- * > the template to the service input of the `kendo-grid-columnmenu-stick` component.
15
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
16
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
17
+ * the template to the service input of the `kendo-grid-columnmenu-lock` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
18
18
  *
19
19
  * @example
20
- * ```ts-preview
21
- *
22
- * _@Component({
23
- * selector: 'my-app',
24
- * template: `
25
- * <kendo-grid [data]="data" [columnMenu]="true">
26
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
27
- * <kendo-grid-columnmenu-stick [service]="service">
28
- * </kendo-grid-columnmenu-stick>
29
- * </ng-template>
30
- * <kendo-grid-column field="Field1" [width]="100"></kendo-grid-column>
31
- * <kendo-grid-column field="Field2" [width]="100"></kendo-grid-column>
32
- * </kendo-grid>
33
- * `
34
- * })
35
- *
36
- * class AppComponent {
37
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
38
- * }
20
+ * ```html
21
+ * <kendo-grid [data]="data" [columnMenu]="true">
22
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
23
+ * <kendo-grid-columnmenu-stick [service]="service">
24
+ * </kendo-grid-columnmenu-stick>
25
+ * </ng-template>
26
+ * </kendo-grid>
39
27
  *
40
28
  * ```
41
29
  */
@@ -12,7 +12,15 @@ import { ContextService } from '../common/provider.service';
12
12
  import { SVGIcon } from '@progress/kendo-svg-icons';
13
13
  import * as i0 from "@angular/core";
14
14
  /**
15
- * Represents the [column menu]({% slug columnmenu_grid %}) component.
15
+ * Represents the [column menu](slug:columnmenu_grid#toc-customizing-the-position) component.
16
+ *
17
+ * <kendo-grid ...>
18
+ * <kendo-grid-column field="ProductName" [columnMenu]="false">
19
+ * <ng-template kendoGridHeaderTemplate let-column>
20
+ * <kendo-grid-column-menu [column]="column"> </kendo-grid-column-menu>
21
+ * </ng-template>
22
+ * </kendo-grid-column>
23
+ * </kendo-grid>
16
24
  */
17
25
  export declare class ColumnMenuComponent implements AfterViewInit, OnChanges, OnDestroy {
18
26
  protected navigationService: NavigationService;
@@ -5,7 +5,7 @@
5
5
  import { Observable } from 'rxjs';
6
6
  import { ColumnBase } from '../columns/column-base';
7
7
  /**
8
- * The returned type of the `columnResize` event.
8
+ * The returned type of the [`columnResize`](slug:api_grid_gridcomponent#toc-columnresize) event.
9
9
  */
10
10
  export interface ColumnResizeArgs {
11
11
  /**