@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
@@ -4,7 +4,7 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { EditEvent } from "./edit-event-args.interface";
6
6
  /**
7
- * Arguments for the `add` event.
7
+ * Arguments for the [`add`](slug:api_grid_gridcomponent#toc-add) event. [See example](slug:inline_editing_grid#toc-adding-records).
8
8
  */
9
9
  export interface AddEvent extends EditEvent {
10
10
  }
@@ -4,7 +4,7 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { SaveEvent } from "./save-event-args.interface";
6
6
  /**
7
- * Arguments for the `cancel` event.
7
+ * Arguments for the [`cancel`](slug:api_grid_gridcomponent#toc-cancel) event. [See example](slug:inline_editing_grid#toc-canceling-editing).
8
8
  */
9
9
  export interface CancelEvent extends SaveEvent {
10
10
  }
@@ -15,10 +15,10 @@ import * as i0 from "@angular/core";
15
15
  * [edit]({% slug api_grid_gridcomponent %}#toc-edit) event
16
16
  * is triggered ([see example]({% slug basics_editing_grid %})).
17
17
  *
18
- * > When the row is in the edit mode, the button with `kendoGridEditCommand` is automatically hidden.
18
+ * When the row is in the `edit` mode, the button with `kendoGridEditCommand` is automatically hidden.
19
19
  *
20
20
  * @example
21
- * ```html-no-run
21
+ * ```html
22
22
  * <kendo-grid>
23
23
  * <kendo-grid-command-column title="command">
24
24
  * <ng-template kendoGridCellTemplate>
@@ -4,7 +4,7 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import type { GridComponent } from "../grid.component";
6
6
  /**
7
- * Arguments for the `remove` event.
7
+ * Arguments for the [`edit`](slug:api_grid_gridcomponent#toc-edit) event.
8
8
  */
9
9
  export interface EditEvent {
10
10
  /**
@@ -10,8 +10,7 @@ import * as i0 from "@angular/core";
10
10
  * tag with the `kendoGridEditTemplate` directive inside a `<kendo-grid-column>` tag.
11
11
  *
12
12
  * The template context is set to the current form group and the following additional fields are passed:
13
- * - `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`.
14
- * If you use the Grid inside [Template-Driven Forms](link:site.data.urls.angular['forms']), it will be `undefined`.
13
+ * - `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`.
15
14
  * - `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.
16
15
  * - `dataItem`&mdash;The current data item. Use it as an alias for a template variable by utilizing the `let-dataItem="dataItem"` syntax.
17
16
  * - `column`&mdash;The current column instance. Use it as an alias for a template variable by utilizing the `let-column="column"` syntax.
@@ -4,7 +4,7 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { EditEvent } from "./edit-event-args.interface";
6
6
  /**
7
- * Arguments for the `remove` event.
7
+ * Arguments for the `remove` event. [See example](slug:inline_editing_grid#toc-removing-records).
8
8
  */
9
9
  export interface RemoveEvent extends EditEvent {
10
10
  }
@@ -5,7 +5,7 @@
5
5
  import { EditEvent } from "./edit-event-args.interface";
6
6
  import { FormGroup } from "@angular/forms";
7
7
  /**
8
- * Arguments for the `save` event.
8
+ * Arguments for the `save` event. [See example](slug:inline_editing_grid#toc-saving-records).
9
9
  */
10
10
  export interface SaveEvent extends EditEvent {
11
11
  /**
@@ -4,7 +4,7 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
6
  * The interface of the `editService` that can be set to the
7
- * [editing directives]({% slug editing_directives_grid %}#toc-custom-service) of the Grid.
7
+ * [editing directives](slug:editing_directives_grid#toc-custom-editing-service) of the Grid.
8
8
  */
9
9
  export interface EditService {
10
10
  /**
@@ -16,27 +16,18 @@ import * as i3 from "@progress/kendo-angular-popup";
16
16
  import * as i4 from "@progress/kendo-angular-buttons";
17
17
  import * as i5 from "./column-list.component";
18
18
  /**
19
- * Represents the component for selecting columns in the Grid. To enable the user to show or hide columns,
20
- * add the component inside a [ToolbarTemplate]({% slug api_grid_toolbartemplatedirective %}) directive.
19
+ * Represents the component for toggling the visibility of the Grid columns. [See example](slug:columnmenu_grid#toc-using-standalone-column-chooser).
20
+ * To show and hide the columns without including the column chooser item in the [Column Menu](slug:columnmenu_grid),
21
+ * add the component inside the [ToolbarTemplate](slug:toolbartemplate_grid) directive.
21
22
  *
22
23
  * @example
23
- * ```ts-preview
24
- * _@Component({
25
- * selector: 'my-app',
26
- * template: `
27
- * <kendo-grid [data]="data">
28
- * <ng-template kendoGridToolbarTemplate>
29
- * <kendo-grid-column-chooser></kendo-grid-column-chooser>
30
- * </ng-template>
31
- * <kendo-grid-column field="Field1"></kendo-grid-column>
32
- * <kendo-grid-column field="Field2" [hidden]="true"></kendo-grid-column>
33
- * </kendo-grid>
34
- * `
35
- * })
36
- *
37
- * class AppComponent {
38
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
39
- * }
24
+ * ```html
25
+ * <kendo-grid [data]="data">
26
+ * <ng-template kendoGridToolbarTemplate>
27
+ * <kendo-grid-column-chooser></kendo-grid-column-chooser>
28
+ * </ng-template>
29
+ * <kendo-grid-column field="ProductID"></kendo-grid-column>
30
+ * </kendo-grid>
40
31
  * ```
41
32
  */
42
33
  export class ColumnChooserComponent {
@@ -53,10 +44,14 @@ export class ColumnChooserComponent {
53
44
  this.columnsIcon = columnsIcon;
54
45
  /**
55
46
  * Specifies if the changes in the visibility of the column will be immediately applied.
47
+ *
48
+ * @default false
56
49
  */
57
50
  this.autoSync = false;
58
51
  /**
59
52
  * Specifies if all columns can be hidden.
53
+ *
54
+ * @default true
60
55
  */
61
56
  this.allowHideAll = true;
62
57
  }
@@ -15,36 +15,21 @@ import * as i2 from "../common/provider.service";
15
15
  import * as i3 from "./column-menu-item.component";
16
16
  import * as i4 from "@angular/common";
17
17
  /**
18
- * Represents the component for resizing all columns to the minimum possible width so that they fit the widest header or cell content without wrapping.
19
- * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
20
- *
21
- * > To enable the autosize-all-columns option, set the [`resizable`]({% slug api_grid_gridcomponent %}#toc-resizable)
22
- * > property of the Grid to `true`.
18
+ * 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.
19
+ * [See example](slug:columnmenu_grid#toc-autosize-all-columns-item).
23
20
  *
24
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
25
- * > the template to the `service` input of the `kendo-grid-columnmenu-autosize-all-columns` component.
21
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
22
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
23
+ * the template to the `service` input of the `kendo-grid-columnmenu-autosize-all-columns` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
26
24
  *
27
25
  * @example
28
- * ```ts-preview
29
- *
30
- * _@Component({
31
- * selector: 'my-app',
32
- * template: `
33
- * <kendo-grid [data]="data" [columnMenu]="true">
34
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
35
- * <kendo-grid-columnmenu-autosize-all-columns [service]="service">
36
- * </kendo-grid-columnmenu-autosize-all-columns>
37
- * </ng-template>
38
- * <kendo-grid-column field="Field1"></kendo-grid-column>
39
- * <kendo-grid-column field="Field2"></kendo-grid-column>
40
- * </kendo-grid>
41
- * `
42
- * })
43
- *
44
- * class AppComponent {
45
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
46
- * }
47
- *
26
+ * ```html
27
+ * <kendo-grid [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>
48
33
  * ```
49
34
  */
50
35
  export class ColumnMenuAutoSizeAllColumnsComponent extends ColumnMenuItemBase {
@@ -60,6 +45,9 @@ export class ColumnMenuAutoSizeAllColumnsComponent extends ColumnMenuItemBase {
60
45
  console.warn(ColunnMenuErrorMessages.autoSizeAllColumns);
61
46
  }
62
47
  }
48
+ /**
49
+ * Resizes all columns to the minimum possible width so that they fit the widest header or cell content without wrapping.
50
+ */
63
51
  autoSizeAllColumns() {
64
52
  autoSizeColumn(this.ctx.grid, this.service);
65
53
  }
@@ -15,36 +15,22 @@ import * as i2 from "../common/provider.service";
15
15
  import * as i3 from "./column-menu-item.component";
16
16
  import * as i4 from "@angular/common";
17
17
  /**
18
- * Represents the component for resizing the specified column to the minimum possible width so that it fits the header or cell content without wrapping.
18
+ * 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.
19
+ * [See example](slug:slug:columnmenu_grid#toc-autosize-column-item).
19
20
  * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
21
+ * [See example](slug:columnmenu_grid#toc-customizing-the-content).
20
22
  *
21
- * > To enable the autosize-column option, set the [`resizable`]({% slug api_grid_gridcomponent %}#toc-resizable)
22
- * > property of the Grid to `true`.
23
- *
24
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) and `column` that are passed by
25
- * > the template to the `service` and `column` input of the `kendo-grid-columnmenu-autosize-column` component.
23
+ * You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) and `column` that are passed by
24
+ * the template to the `service` and `column` input of the `kendo-grid-columnmenu-autosize-column` component.
26
25
  *
27
26
  * @example
28
- * ```ts-preview
29
- *
30
- * _@Component({
31
- * selector: 'my-app',
32
- * template: `
33
- * <kendo-grid [data]="data" [columnMenu]="true">
34
- * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
35
- * <kendo-grid-columnmenu-autosize-column [column]="column" [service]="service">
36
- * </kendo-grid-columnmenu-autosize-column>
37
- * </ng-template>
38
- * <kendo-grid-column field="Field1"></kendo-grid-column>
39
- * <kendo-grid-column field="Field2"></kendo-grid-column>
40
- * </kendo-grid>
41
- * `
42
- * })
43
- *
44
- * class AppComponent {
45
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
46
- * }
47
- *
27
+ * ```html
28
+ * <kendo-grid [columnMenu]="true" ...>
29
+ * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
30
+ * <kendo-grid-columnmenu-autosize-column [column]="column" [service]="service">
31
+ * </kendo-grid-columnmenu-autosize-column>
32
+ * </ng-template>
33
+ * </kendo-grid>
48
34
  * ```
49
35
  */
50
36
  export class ColumnMenuAutoSizeColumnComponent extends ColumnMenuItemBase {
@@ -60,6 +46,9 @@ export class ColumnMenuAutoSizeColumnComponent extends ColumnMenuItemBase {
60
46
  console.warn(ColunnMenuErrorMessages.autoSizeColumn);
61
47
  }
62
48
  }
49
+ /**
50
+ * Resizes a specified column to the minimum possible width so that it fits the widest header or cell content without wrapping.
51
+ */
63
52
  autoSizeColumn() {
64
53
  autoSizeColumn(this.ctx.grid, this.service, this.column);
65
54
  }
@@ -14,33 +14,19 @@ import * as i3 from "./column-menu-item.component";
14
14
  import * as i4 from "./column-list.component";
15
15
  import * as i5 from "./column-menu-item-content-template.directive";
16
16
  /**
17
- * Represents the component for selecting columns in the Grid that can be placed
18
- * inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
17
+ * Represents the column-menu item for selecting columns in the Grid. [See example](slug:columnmenu_grid#toc-column-chooser-item).
19
18
  *
20
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
21
- * > the template to the service input of the `kendo-grid-columnmenu-chooser` component.
19
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
20
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
21
+ * the template to the service input of the `kendo-grid-columnmenu-chooser` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
22
22
  *
23
23
  * @example
24
- * ```ts-preview
25
- *
26
- * _@Component({
27
- * selector: 'my-app',
28
- * template: `
29
- * <kendo-grid [data]="data" [columnMenu]="true">
30
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
31
- * <kendo-grid-columnmenu-chooser [service]="service">
32
- * </kendo-grid-columnmenu-chooser>
33
- * </ng-template>
34
- * <kendo-grid-column field="Field1"></kendo-grid-column>
35
- * <kendo-grid-column field="Field2" [hidden]="true"></kendo-grid-column>
36
- * </kendo-grid>
37
- * `
38
- * })
39
- *
40
- * class AppComponent {
41
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
42
- * }
43
- *
24
+ * ```html
25
+ * <kendo-grid [columnMenu]="true" ...>
26
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
27
+ * <kendo-grid-columnmenu-chooser [service]="service"> </kendo-grid-columnmenu-chooser>
28
+ * </ng-template>
29
+ * </kendo-grid>
44
30
  * ```
45
31
  */
46
32
  export class ColumnMenuChooserComponent extends ColumnMenuItemBase {
@@ -60,6 +46,7 @@ export class ColumnMenuChooserComponent extends ColumnMenuItemBase {
60
46
  this.collapse = new EventEmitter();
61
47
  /**
62
48
  * Specifies if the content is expanded.
49
+ * @default false
63
50
  */
64
51
  this.expanded = false;
65
52
  /**
@@ -12,33 +12,20 @@ import * as i2 from "./column-menu-item.component";
12
12
  import * as i3 from "../filtering/menu/filter-menu-container.component";
13
13
  import * as i4 from "./column-menu-item-content-template.directive";
14
14
  /**
15
- * Represents the component for editing column filters in the Grid that can be placed
16
- * inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
15
+ * Represents the column-menu item for editing column filters in the Grid. [See example](slug:columnmenu_grid#toc-filter-item).
17
16
  *
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-filter` component.
17
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
18
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
19
+ * the template to the service input of the `kendo-grid-columnmenu-filter` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
20
20
  *
21
21
  * @example
22
- * ```ts-preview
23
- *
24
- * _@Component({
25
- * selector: 'my-app',
26
- * template: `
27
- * <kendo-grid [kendoGridBinding]="data" [columnMenu]="true">
28
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
29
- * <kendo-grid-columnmenu-filter [service]="service">
30
- * </kendo-grid-columnmenu-filter>
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
- *
22
+ * ```html
23
+ * <kendo-grid [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>
42
29
  * ```
43
30
  */
44
31
  export class ColumnMenuFilterComponent extends ColumnMenuItemBase {
@@ -56,6 +43,7 @@ export class ColumnMenuFilterComponent extends ColumnMenuItemBase {
56
43
  this.collapse = new EventEmitter();
57
44
  /**
58
45
  * Specifies if the content is expanded.
46
+ * @default false
59
47
  */
60
48
  this.expanded = false;
61
49
  /**
@@ -13,27 +13,12 @@ import * as i2 from "@angular/common";
13
13
  * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
14
14
  *
15
15
  * @example
16
- * ```ts-preview
17
- *
18
- * _@Component({
19
- * selector: 'my-app',
20
- * template: `
21
- * <kendo-grid [data]="data" [columnMenu]="true" [resizable]="true" #grid>
22
- * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
23
- * <kendo-grid-columnmenu-item icon="arrows-resizing" text="Fit column"
24
- * (itemClick)="grid.autoFitColumn(column); service.close()">
25
- * </kendo-grid-columnmenu-item>
26
- * </ng-template>
27
- * <kendo-grid-column field="Field1"></kendo-grid-column>
28
- * <kendo-grid-column field="Field2"></kendo-grid-column>
29
- * </kendo-grid>
30
- * `
31
- * })
32
- *
33
- * class AppComponent {
34
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
35
- * }
36
- *
16
+ * ```html
17
+ * <kendo-grid [columnMenu]="true" ...>
18
+ * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
19
+ * <kendo-grid-columnmenu-item text="Fit column"></kendo-grid-columnmenu-item>
20
+ * </ng-template>
21
+ * </kendo-grid>
37
22
  * ```
38
23
  */
39
24
  export class ColumnMenuItemComponent {
@@ -12,34 +12,20 @@ import * as i1 from "@progress/kendo-angular-l10n";
12
12
  import * as i2 from "../common/column-info.service";
13
13
  import * as i3 from "./column-menu-item.component";
14
14
  /**
15
- * Represents a column-menu item that can be placed inside a
16
- * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
17
- * Allows the user to lock or unlock the columns.
15
+ * Represents the column-menu item for locking and unlocking columns in the Grid. [See example](slug:columnmenu_grid#toc-lock-and-unlock-items).
18
16
  *
19
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
20
- * > the template to the service input of the `kendo-grid-columnmenu-lock` component.
17
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
18
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
19
+ * the template to the service input of the `kendo-grid-columnmenu-lock` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
21
20
  *
22
21
  * @example
23
- * ```ts-preview
24
- *
25
- * _@Component({
26
- * selector: 'my-app',
27
- * template: `
28
- * <kendo-grid [data]="data" [columnMenu]="true">
29
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
30
- * <kendo-grid-columnmenu-lock [service]="service">
31
- * </kendo-grid-columnmenu-lock>
32
- * </ng-template>
33
- * <kendo-grid-column field="Field1" [width]="100"></kendo-grid-column>
34
- * <kendo-grid-column field="Field2" [width]="100"></kendo-grid-column>
35
- * </kendo-grid>
36
- * `
37
- * })
38
- *
39
- * class AppComponent {
40
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
41
- * }
42
- *
22
+ * ```html
23
+ * <kendo-grid [data]="data" [columnMenu]="true" ...>
24
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
25
+ * <kendo-grid-columnmenu-lock [service]="service">
26
+ * </kendo-grid-columnmenu-lock>
27
+ * </ng-template>
28
+ * </kendo-grid>
43
29
  * ```
44
30
  */
45
31
  export class ColumnMenuLockComponent extends ColumnMenuItemBase {
@@ -14,33 +14,20 @@ import * as i4 from "./column-menu-stick.component";
14
14
  import * as i5 from "./column-menu-item-content-template.directive";
15
15
  import * as i6 from "@angular/common";
16
16
  /**
17
- * Represents the component for editing column filters in the Grid that can be placed
18
- * inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
17
+ * Represents the column-menu item which combines the lock and sticky column functionalities.
19
18
  *
20
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
21
- * > the template to the service input of the `kendo-grid-columnmenu-filter` component.
19
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
20
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
21
+ * the template to the service input of the `kendo-grid-columnmenu-filter` component. [See example](slug:columnmenu_grid#toc-set-column-position-item).
22
22
  *
23
23
  * @example
24
- * ```ts-preview
25
- *
26
- * _@Component({
27
- * selector: 'my-app',
28
- * template: `
29
- * <kendo-grid [kendoGridBinding]="data" [columnMenu]="true">
30
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
31
- * <kendo-grid-columnmenu-filter [service]="service">
32
- * </kendo-grid-columnmenu-filter>
33
- * </ng-template>
34
- * <kendo-grid-column field="Field1"></kendo-grid-column>
35
- * <kendo-grid-column field="Field2"></kendo-grid-column>
36
- * </kendo-grid>
37
- * `
38
- * })
39
- *
40
- * class AppComponent {
41
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
42
- * }
43
- *
24
+ * ```html
25
+ * <kendo-grid [data]="data" [columnMenu]="true" ...>
26
+ * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
27
+ * <kendo-grid-columnmenu-position [service]="service" [showLock]="true" [showStick]="true">
28
+ * </kendo-grid-columnmenu-position>
29
+ * </ng-template>
30
+ * </kendo-grid>
44
31
  * ```
45
32
  */
46
33
  export class ColumnMenuPositionComponent extends ColumnMenuItemBase {
@@ -58,6 +45,7 @@ export class ColumnMenuPositionComponent extends ColumnMenuItemBase {
58
45
  this.collapse = new EventEmitter();
59
46
  /**
60
47
  * Specifies if the content is expanded.
48
+ * @default false
61
49
  */
62
50
  this.expanded = false;
63
51
  /**
@@ -13,34 +13,21 @@ import * as i1 from "@progress/kendo-angular-l10n";
13
13
  import * as i2 from "../common/sort.service";
14
14
  import * as i3 from "./column-menu-item.component";
15
15
  /**
16
- * Represents a column-menu item for sorting Grid columns that can be placed inside a
17
- * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
18
- * Allows the user to sort the column.
16
+ * Represents the column-menu item for sorting Grid columns.
17
+ * [See example](slug:columnmenu_grid#toc-sort-item).
19
18
  *
20
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
21
- * > the template to the service input of the `kendo-grid-columnmenu-sort` component.
19
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
20
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
21
+ * the template to the service input of the `kendo-grid-columnmenu-sort` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
22
22
  *
23
23
  * @example
24
- * ```ts-preview
25
- *
26
- * _@Component({
27
- * selector: 'my-app',
28
- * template: `
29
- * <kendo-grid [kendoGridBinding]="data" [sortable]="true" [columnMenu]="true">
30
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
31
- * <kendo-grid-columnmenu-sort [service]="service">
32
- * </kendo-grid-columnmenu-sort>
33
- * </ng-template>
34
- * <kendo-grid-column field="Field1" [width]="100"></kendo-grid-column>
35
- * <kendo-grid-column field="Field2" [width]="100"></kendo-grid-column>
36
- * </kendo-grid>
37
- * `
38
- * })
39
- *
40
- * class AppComponent {
41
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }, { Field1: 'Foo1', Field2: 'Bar1' }];
42
- * }
43
- *
24
+ * ```html
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>
44
31
  * ```
45
32
  */
46
33
  export class ColumnMenuSortComponent extends ColumnMenuItemBase {
@@ -12,33 +12,21 @@ import * as i1 from "@progress/kendo-angular-l10n";
12
12
  import * as i2 from "../common/column-info.service";
13
13
  import * as i3 from "./column-menu-item.component";
14
14
  /**
15
- * Represents a column-menu item that can be placed inside a
16
- * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
17
- * Allows the user to stick or unstick the columns.
15
+ * Represents the column-menu item that sticks or unsticks columns in the Grid.
16
+ * [See example](slug:columnmenu_grid#toc-stick-and-unstick-items).
18
17
  *
19
- * > You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
20
- * > the template to the service input of the `kendo-grid-columnmenu-stick` component.
18
+ * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
19
+ * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
20
+ * the template to the service input of the `kendo-grid-columnmenu-lock` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
21
21
  *
22
22
  * @example
23
- * ```ts-preview
24
- *
25
- * _@Component({
26
- * selector: 'my-app',
27
- * template: `
28
- * <kendo-grid [data]="data" [columnMenu]="true">
29
- * <ng-template kendoGridColumnMenuTemplate let-service="service">
30
- * <kendo-grid-columnmenu-stick [service]="service">
31
- * </kendo-grid-columnmenu-stick>
32
- * </ng-template>
33
- * <kendo-grid-column field="Field1" [width]="100"></kendo-grid-column>
34
- * <kendo-grid-column field="Field2" [width]="100"></kendo-grid-column>
35
- * </kendo-grid>
36
- * `
37
- * })
38
- *
39
- * class AppComponent {
40
- * public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
41
- * }
23
+ * ```html
24
+ * <kendo-grid [data]="data" [columnMenu]="true">
25
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
26
+ * <kendo-grid-columnmenu-stick [service]="service">
27
+ * </kendo-grid-columnmenu-stick>
28
+ * </ng-template>
29
+ * </kendo-grid>
42
30
  *
43
31
  * ```
44
32
  */
@@ -34,7 +34,15 @@ import * as i16 from "@angular/common";
34
34
  import * as i17 from "./column-menu-item.directive";
35
35
  const POPUP_CLASS = 'k-grid-columnmenu-popup';
36
36
  /**
37
- * Represents the [column menu]({% slug columnmenu_grid %}) component.
37
+ * Represents the [column menu](slug:columnmenu_grid#toc-customizing-the-position) component.
38
+ *
39
+ * <kendo-grid ...>
40
+ * <kendo-grid-column field="ProductName" [columnMenu]="false">
41
+ * <ng-template kendoGridHeaderTemplate let-column>
42
+ * <kendo-grid-column-menu [column]="column"> </kendo-grid-column-menu>
43
+ * </ng-template>
44
+ * </kendo-grid-column>
45
+ * </kendo-grid>
38
46
  */
39
47
  export class ColumnMenuComponent {
40
48
  constructor(navigationService, popupService, localization, service, ctx) {