@progress/kendo-angular-grid 12.0.0-develop.9 → 12.0.1-develop.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/column-menu/column-chooser.component.d.ts +14 -19
- package/column-menu/column-menu-autosize-all.component.d.ts +12 -27
- package/column-menu/column-menu-autosize.component.d.ts +12 -26
- package/column-menu/column-menu-chooser.component.d.ts +11 -24
- package/column-menu/column-menu-expandable-item.interface.d.ts +0 -1
- package/column-menu/column-menu-filter.component.d.ts +12 -24
- package/column-menu/column-menu-item.component.d.ts +6 -21
- package/column-menu/column-menu-lock.component.d.ts +11 -25
- package/column-menu/column-menu-position.component.d.ts +12 -24
- package/column-menu/column-menu-settings.interface.d.ts +3 -24
- package/column-menu/column-menu-sort.component.d.ts +12 -25
- package/column-menu/column-menu-stick.component.d.ts +12 -24
- package/column-menu/column-menu.component.d.ts +9 -1
- package/column-menu/column-menu.service.d.ts +9 -21
- package/column-resizing/column-resize.interface.d.ts +1 -1
- package/columns/checkbox-column.component.d.ts +6 -57
- package/columns/column-base.d.ts +16 -369
- package/columns/column-group.component.d.ts +9 -48
- package/columns/column.component.d.ts +23 -109
- package/columns/command-column.component.d.ts +12 -60
- package/columns/reorder-column.component.d.ts +1 -1
- package/columns/sort-settings.d.ts +24 -12
- package/columns/span-column.component.d.ts +12 -123
- package/common/cell-click-event-args.interface.d.ts +1 -1
- package/common/fetch-data-callback.d.ts +1 -1
- package/common/preventable-event.d.ts +1 -1
- package/common/single-popup.service.d.ts +1 -1
- package/common/size-options.d.ts +1 -2
- package/data/change-event-args.interface.d.ts +2 -2
- package/data/data.collection.d.ts +1 -1
- package/data/grid-item.interface.d.ts +6 -3
- package/dragdrop/column-reorder-config.d.ts +1 -1
- package/editing/add-event-args.interface.d.ts +1 -1
- package/editing/cancel-event-args.interface.d.ts +1 -1
- package/editing/edit-event-args.interface.d.ts +1 -1
- package/editing/remove-event-args.interface.d.ts +1 -1
- package/editing/save-event-args.interface.d.ts +1 -1
- package/editing-directives/edit-service.interface.d.ts +1 -1
- package/esm2020/column-menu/column-chooser.component.mjs +14 -19
- package/esm2020/column-menu/column-menu-autosize-all.component.mjs +12 -27
- package/esm2020/column-menu/column-menu-autosize.component.mjs +12 -26
- package/esm2020/column-menu/column-menu-chooser.component.mjs +11 -24
- package/esm2020/column-menu/column-menu-filter.component.mjs +12 -24
- package/esm2020/column-menu/column-menu-item.component.mjs +6 -21
- package/esm2020/column-menu/column-menu-lock.component.mjs +11 -25
- package/esm2020/column-menu/column-menu-position.component.mjs +12 -24
- package/esm2020/column-menu/column-menu-sort.component.mjs +12 -25
- package/esm2020/column-menu/column-menu-stick.component.mjs +12 -24
- package/esm2020/column-menu/column-menu.component.mjs +9 -1
- package/esm2020/column-menu/column-menu.service.mjs +9 -21
- package/esm2020/columns/checkbox-column.component.mjs +6 -57
- package/esm2020/columns/column-base.mjs +7 -40
- package/esm2020/columns/column-group.component.mjs +9 -48
- package/esm2020/columns/column.component.mjs +22 -79
- package/esm2020/columns/command-column.component.mjs +12 -60
- package/esm2020/columns/reorder-column.component.mjs +1 -1
- package/esm2020/columns/span-column.component.mjs +12 -123
- package/esm2020/common/preventable-event.mjs +1 -1
- package/esm2020/common/single-popup.service.mjs +1 -1
- package/esm2020/excel/excel.module.mjs +5 -15
- package/esm2020/filtering/cell/boolean-filter-cell.component.mjs +11 -10
- package/esm2020/filtering/cell/date-filter-cell.component.mjs +26 -13
- package/esm2020/filtering/cell/filter-cell-operators.component.mjs +15 -0
- package/esm2020/filtering/cell/numeric-filter-cell.component.mjs +14 -11
- package/esm2020/filtering/cell/string-filter-cell.component.mjs +14 -15
- package/esm2020/filtering/date-filter.component.mjs +6 -2
- package/esm2020/filtering/menu/boolean-filter-menu.component.mjs +13 -13
- package/esm2020/filtering/menu/date-filter-menu.component.mjs +13 -13
- package/esm2020/filtering/menu/numeric-filter-menu.component.mjs +13 -13
- package/esm2020/filtering/menu/string-filter-menu.component.mjs +15 -2
- package/esm2020/filtering/numeric-filter.component.mjs +4 -1
- package/esm2020/filtering/operators/after-eq-filter-operator.component.mjs +3 -6
- package/esm2020/filtering/operators/after-filter-operator.component.mjs +3 -6
- package/esm2020/filtering/operators/before-eq-filter-operator.component.mjs +3 -6
- package/esm2020/filtering/operators/before-filter-operator.component.mjs +3 -6
- package/esm2020/filtering/operators/contains-filter-operator.component.mjs +2 -5
- package/esm2020/filtering/operators/ends-with-filter-operator.component.mjs +2 -4
- package/esm2020/filtering/operators/eq-filter-operator.component.mjs +2 -4
- package/esm2020/filtering/operators/gt-filter-operator.component.mjs +3 -6
- package/esm2020/filtering/operators/gte-filter-operator.component.mjs +2 -5
- package/esm2020/filtering/operators/is-empty-filter-operator.component.mjs +2 -4
- package/esm2020/filtering/operators/is-not-empty-filter-operator.component.mjs +2 -4
- package/esm2020/filtering/operators/is-not-null-filter-operator.component.mjs +2 -4
- package/esm2020/filtering/operators/isnull-filter-operator.component.mjs +2 -4
- package/esm2020/filtering/operators/lt-filter-operator.component.mjs +3 -5
- package/esm2020/filtering/operators/lte-filter-operator.component.mjs +3 -5
- package/esm2020/filtering/operators/neq-filter-operator.component.mjs +2 -4
- package/esm2020/filtering/operators/not-contains-filter-operator.component.mjs +2 -4
- package/esm2020/filtering/operators/starts-with-filter-operator.component.mjs +2 -4
- package/esm2020/filtering/string-filter.component.mjs +2 -1
- package/esm2020/grid.component.mjs +39 -325
- package/esm2020/grid.module.mjs +6 -16
- package/esm2020/layout/sizing-options.service.mjs +3 -0
- package/esm2020/localization/custom-messages.component.mjs +1 -1
- package/esm2020/package-metadata.mjs +2 -2
- package/esm2020/pager/pager-info.component.mjs +1 -1
- package/esm2020/pager/pager-input.component.mjs +1 -48
- package/esm2020/pager/pager-next-buttons.component.mjs +1 -1
- package/esm2020/pager/pager-numeric-buttons.component.mjs +1 -1
- package/esm2020/pager/pager-page-sizes.component.mjs +3 -92
- package/esm2020/pager/pager-prev-buttons.component.mjs +1 -1
- package/esm2020/pdf/pdf-margin.component.mjs +9 -0
- package/esm2020/pdf/pdf.module.mjs +7 -16
- package/esm2020/rendering/common/spacer.component.mjs +2 -1
- package/esm2020/rendering/toolbar/toolbar-position.mjs +17 -0
- package/esm2020/row-reordering/row-reorder.service.mjs +2 -1
- package/excel/excel.component.d.ts +2 -7
- package/excel/excel.module.d.ts +5 -15
- package/fesm2015/progress-kendo-angular-grid.mjs +476 -1372
- package/fesm2020/progress-kendo-angular-grid.mjs +476 -1372
- package/filtering/cell/boolean-filter-cell.component.d.ts +11 -10
- package/filtering/cell/date-filter-cell.component.d.ts +26 -13
- package/filtering/cell/filter-cell-operators.component.d.ts +15 -0
- package/filtering/cell/numeric-filter-cell.component.d.ts +14 -11
- package/filtering/cell/string-filter-cell.component.d.ts +14 -15
- package/filtering/date-filter.component.d.ts +8 -12
- package/filtering/filterable.d.ts +10 -0
- package/filtering/menu/boolean-filter-menu.component.d.ts +13 -13
- package/filtering/menu/date-filter-menu.component.d.ts +13 -13
- package/filtering/menu/numeric-filter-menu.component.d.ts +13 -13
- package/filtering/menu/string-filter-menu.component.d.ts +15 -2
- package/filtering/numeric-filter.component.d.ts +4 -1
- package/filtering/operators/after-eq-filter-operator.component.d.ts +4 -0
- package/filtering/operators/after-filter-operator.component.d.ts +4 -0
- package/filtering/operators/before-eq-filter-operator.component.d.ts +4 -0
- package/filtering/operators/before-filter-operator.component.d.ts +4 -0
- package/filtering/operators/contains-filter-operator.component.d.ts +2 -5
- package/filtering/operators/ends-with-filter-operator.component.d.ts +2 -4
- package/filtering/operators/eq-filter-operator.component.d.ts +2 -4
- package/filtering/operators/gt-filter-operator.component.d.ts +4 -0
- package/filtering/operators/gte-filter-operator.component.d.ts +2 -5
- package/filtering/operators/is-empty-filter-operator.component.d.ts +2 -4
- package/filtering/operators/is-not-empty-filter-operator.component.d.ts +2 -4
- package/filtering/operators/is-not-null-filter-operator.component.d.ts +2 -4
- package/filtering/operators/isnull-filter-operator.component.d.ts +2 -4
- package/filtering/operators/lt-filter-operator.component.d.ts +5 -0
- package/filtering/operators/lte-filter-operator.component.d.ts +5 -0
- package/filtering/operators/neq-filter-operator.component.d.ts +2 -4
- package/filtering/operators/not-contains-filter-operator.component.d.ts +2 -4
- package/filtering/operators/starts-with-filter-operator.component.d.ts +2 -4
- package/filtering/string-filter.component.d.ts +2 -1
- package/grid.component.d.ts +43 -327
- package/grid.module.d.ts +6 -16
- package/grouping/group-key.interface.d.ts +1 -13
- package/grouping/group-rows-args.interface.d.ts +1 -1
- package/layout/sizing-options.service.d.ts +3 -0
- package/localization/custom-messages.component.d.ts +1 -1
- package/localization/messages.d.ts +35 -98
- package/navigation/navigable-settings.d.ts +15 -1
- package/navigation/navigation-cell.interface.d.ts +2 -5
- package/navigation/navigation-row.interface.d.ts +2 -5
- package/package.json +19 -19
- package/pager/pager-info.component.d.ts +1 -1
- package/pager/pager-input.component.d.ts +1 -48
- package/pager/pager-next-buttons.component.d.ts +1 -1
- package/pager/pager-numeric-buttons.component.d.ts +1 -1
- package/pager/pager-page-sizes.component.d.ts +3 -92
- package/pager/pager-prev-buttons.component.d.ts +1 -1
- package/pager/pager-settings.d.ts +9 -38
- package/pdf/pdf-margin.component.d.ts +9 -0
- package/pdf/pdf-margin.interface.d.ts +0 -5
- package/pdf/pdf.module.d.ts +7 -16
- package/rendering/common/row-class.d.ts +4 -4
- package/rendering/common/spacer.component.d.ts +2 -1
- package/rendering/toolbar/toolbar-position.d.ts +18 -1
- package/row-reordering/row-reorder.service.d.ts +1 -0
- package/row-reordering/types.d.ts +1 -1
- package/schematics/ngAdd/index.js +2 -2
- package/scrolling/content-scroll-event.d.ts +1 -1
- package/scrolling/scroll-request.service.d.ts +2 -1
- package/scrolling/scrollmode.d.ts +4 -4
- package/selection/types.d.ts +31 -48
|
@@ -19,51 +19,15 @@ import * as i0 from "@angular/core";
|
|
|
19
19
|
*/
|
|
20
20
|
export declare function isColumnComponent(column: any): column is ColumnComponent;
|
|
21
21
|
/**
|
|
22
|
-
* Represents the
|
|
22
|
+
* Represents the column of the Grid. [See example](slug:columns_config#toc-using-the-column-component)
|
|
23
23
|
*
|
|
24
24
|
* @example
|
|
25
|
-
* ```
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
|
|
32
|
-
* </kendo-grid-column>
|
|
33
|
-
* <kendo-grid-column field="ProductName" title="Product Name">
|
|
34
|
-
* </kendo-grid-column>
|
|
35
|
-
* <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
|
|
36
|
-
* </kendo-grid-column>
|
|
37
|
-
* <kendo-grid-column field="Discontinued" [width]="120">
|
|
38
|
-
* <ng-template kendoGridCellTemplate let-dataItem>
|
|
39
|
-
* <input type="checkbox" [checked]="dataItem.Discontinued" disabled/>
|
|
40
|
-
* </ng-template>
|
|
41
|
-
* </kendo-grid-column>
|
|
42
|
-
* </kendo-grid>
|
|
43
|
-
* `
|
|
44
|
-
* })
|
|
45
|
-
*
|
|
46
|
-
* class AppComponent {
|
|
47
|
-
* public gridData: any[];
|
|
48
|
-
*
|
|
49
|
-
* constructor() {
|
|
50
|
-
* this.gridData = products;
|
|
51
|
-
* }
|
|
52
|
-
* }
|
|
53
|
-
*
|
|
54
|
-
* const products = [{
|
|
55
|
-
* "ProductID": 1,
|
|
56
|
-
* "ProductName": "Chai",
|
|
57
|
-
* "UnitPrice": 18.0000,
|
|
58
|
-
* "Discontinued": true
|
|
59
|
-
* }, {
|
|
60
|
-
* "ProductID": 2,
|
|
61
|
-
* "ProductName": "Chang",
|
|
62
|
-
* "UnitPrice": 19.0000,
|
|
63
|
-
* "Discontinued": false
|
|
64
|
-
* }
|
|
65
|
-
* ];
|
|
66
|
-
*
|
|
25
|
+
* ```html
|
|
26
|
+
* <kendo-grid [data]="gridData">
|
|
27
|
+
* <kendo-grid-column field="ProductID" title="Product ID"></kendo-grid-column>
|
|
28
|
+
* <kendo-grid-column field="ProductName" title="Product Name"></kendo-grid-column>
|
|
29
|
+
* <kendo-grid-column field="UnitPrice" title="Unit Price"></kendo-grid-column>
|
|
30
|
+
* </kendo-grid>
|
|
67
31
|
* ```
|
|
68
32
|
*/
|
|
69
33
|
export declare class ColumnComponent extends ColumnBase {
|
|
@@ -72,96 +36,46 @@ export declare class ColumnComponent extends ColumnBase {
|
|
|
72
36
|
*/
|
|
73
37
|
field: string;
|
|
74
38
|
/**
|
|
75
|
-
* The format that is applied to the value before it is displayed.
|
|
76
|
-
* Takes the `{0:format}` form where `format` is a standard number format, a custom number format,
|
|
77
|
-
* a standard date format, a custom date format or a format object. For more information on the supported date and number formats,
|
|
39
|
+
* The format that is applied to the value before it is displayed. [See example](slug:filtering_grid#toc-date-filter). For more information on the supported date and number formats,
|
|
78
40
|
* refer to the [kendo-intl](https://github.com/telerik/kendo-intl/blob/develop/docs/index.md) documentation.
|
|
79
|
-
*
|
|
80
|
-
* Standard format:
|
|
81
|
-
* @example
|
|
82
|
-
* ```html-no-run
|
|
83
|
-
* <kendo-grid>
|
|
84
|
-
* <kendo-grid-column field="UnitPrice" format="{0:c}">
|
|
85
|
-
* </kendo-grid-column>
|
|
86
|
-
* </kendo-grid>
|
|
87
|
-
* ```
|
|
88
|
-
*
|
|
89
|
-
* Format object for currency:
|
|
90
|
-
* @example
|
|
91
|
-
* ```html-no-run
|
|
92
|
-
* <kendo-grid>
|
|
93
|
-
* <kendo-grid-column field="UnitPrice" [format]="{ style: 'currency', currency: 'EUR' }">
|
|
94
|
-
* </kendo-grid-column>
|
|
95
|
-
* </kendo-grid>
|
|
96
|
-
* ```
|
|
97
|
-
*
|
|
98
|
-
* Format object for dates:
|
|
99
|
-
* @example
|
|
100
|
-
* ```html-no-run
|
|
101
|
-
* <kendo-grid>
|
|
102
|
-
* <kendo-grid-column field="FirstOrderedOn" [format]="{ date: 'short' }">
|
|
103
|
-
* </kendo-grid-column>
|
|
104
|
-
* </kendo-grid>
|
|
105
|
-
* ```
|
|
106
41
|
*/
|
|
107
42
|
format: any;
|
|
108
43
|
/**
|
|
109
|
-
* Allows the
|
|
110
|
-
*
|
|
44
|
+
* Allows the user to click the column headers and emits the `sortChange` event. [See example](slug:sorting_grid).
|
|
45
|
+
*
|
|
46
|
+
* @default true
|
|
111
47
|
*/
|
|
112
48
|
sortable: boolean | ColumnSortSettings;
|
|
113
49
|
/**
|
|
114
|
-
* Determines if the column can be dragged to the group panel.
|
|
50
|
+
* Determines if the column can be dragged to the group panel.
|
|
115
51
|
* If set to `false`, you can group the columns by the column field by using the API of the Grid.
|
|
52
|
+
*
|
|
53
|
+
* @default true
|
|
116
54
|
*/
|
|
117
55
|
groupable: boolean;
|
|
118
56
|
/**
|
|
119
|
-
* Defines the editor type
|
|
120
|
-
* Used when the column enters the edit mode.
|
|
57
|
+
* Defines the editor type. [See example](slug:inline_editing_grid#toc-using-reactive-forms).
|
|
58
|
+
* Used when the column enters the edit mode.
|
|
121
59
|
*
|
|
122
|
-
* @
|
|
123
|
-
* ```html-no-run
|
|
124
|
-
* <kendo-grid>
|
|
125
|
-
* <kendo-grid-column field="UnitPrice" editor="numeric">
|
|
126
|
-
* </kendo-grid-column>
|
|
127
|
-
* </kendo-grid>
|
|
128
|
-
* ```
|
|
60
|
+
* @default 'text'
|
|
129
61
|
*/
|
|
130
62
|
editor: 'text' | 'numeric' | 'date' | 'boolean';
|
|
131
63
|
/**
|
|
132
|
-
* Defines the filter type that is displayed inside the filter row.
|
|
64
|
+
* Defines the filter type that is displayed inside the filter row. [See example](slug:filtering_grid#toc-filter-data-types).
|
|
133
65
|
*
|
|
134
|
-
* @
|
|
135
|
-
* ```html-no-run
|
|
136
|
-
* <kendo-grid>
|
|
137
|
-
* <kendo-grid-column field="UnitPrice" filter="numeric">
|
|
138
|
-
* </kendo-grid-column>
|
|
139
|
-
* </kendo-grid>
|
|
140
|
-
* ```
|
|
66
|
+
* @default 'text'
|
|
141
67
|
*/
|
|
142
68
|
filter: 'text' | 'numeric' | 'boolean' | 'date';
|
|
143
69
|
/**
|
|
144
|
-
* Defines if a filter UI will be displayed for this column.
|
|
70
|
+
* Defines if a filter UI will be displayed for this column. [See example](slug:filtering_grid).
|
|
145
71
|
*
|
|
146
|
-
* @
|
|
147
|
-
* ```html-no-run
|
|
148
|
-
* <kendo-grid>
|
|
149
|
-
* <kendo-grid-column field="UnitPrice" [filterable]="false">
|
|
150
|
-
* </kendo-grid-column>
|
|
151
|
-
* </kendo-grid>
|
|
152
|
-
* ```
|
|
72
|
+
* @default true
|
|
153
73
|
*/
|
|
154
74
|
filterable: boolean;
|
|
155
75
|
/**
|
|
156
|
-
* Defines whether the column is editable.
|
|
76
|
+
* Defines whether the column is editable. [See example](slug:make_fields_uneditable_grid).
|
|
157
77
|
*
|
|
158
|
-
* @
|
|
159
|
-
* ```html-no-run
|
|
160
|
-
* <kendo-grid>
|
|
161
|
-
* <kendo-grid-column field="UnitPrice" [editable]="false">
|
|
162
|
-
* </kendo-grid-column>
|
|
163
|
-
* </kendo-grid>
|
|
164
|
-
* ```
|
|
78
|
+
* @default true
|
|
165
79
|
*/
|
|
166
80
|
editable: boolean;
|
|
167
81
|
template: CellTemplateDirective;
|
|
@@ -9,68 +9,20 @@ import { IdService } from '../common/id.service';
|
|
|
9
9
|
import * as i0 from "@angular/core";
|
|
10
10
|
/**
|
|
11
11
|
* Represents the command columns of the Grid. You have to define the content of the
|
|
12
|
-
* column inside an `<ng-template>` tag.
|
|
13
|
-
*
|
|
14
|
-
* and the command directives, refer to the article on
|
|
15
|
-
* [editing the Grid in Angular Reactive Forms]({% slug inline_editing_grid %}#toc-using-reactive-forms).
|
|
16
|
-
*
|
|
17
|
-
* The following additional fields are passed:
|
|
18
|
-
* - `columnIndex`—The current column index.
|
|
19
|
-
* - `rowIndex`—The current data row index. If inside a new item row, `rowIndex`is `-1`.
|
|
20
|
-
* - `dataItem`—The current data item.
|
|
21
|
-
* - `column`—The current column instance.
|
|
22
|
-
* - `isNew`—The state of the current item.
|
|
23
|
-
*
|
|
24
|
-
* Usually, the template contains CRUD command directives such as:
|
|
25
|
-
* - [EditCommandDirective]({% slug api_grid_editcommanddirective %})
|
|
26
|
-
* - [RemoveCommandDirective]({% slug api_grid_removecommanddirective %})
|
|
27
|
-
* - [CancelCommandDirective]({% slug api_grid_cancelcommanddirective %})
|
|
28
|
-
* - [SaveCommandDirective]({% slug api_grid_savecommanddirective %})
|
|
12
|
+
* column inside an `<ng-template>` tag.
|
|
13
|
+
* For more information and examples, refer to the [Command Column Directives](slug:editing_directives_grid#toc-command-column-directives) article.
|
|
29
14
|
*
|
|
30
15
|
* @example
|
|
31
|
-
* ```
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
* <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
|
|
42
|
-
* </kendo-grid-column>
|
|
43
|
-
* <kendo-grid-command-column title="command" [width]="220">
|
|
44
|
-
* <ng-template kendoGridCellTemplate>
|
|
45
|
-
* <button kendoGridEditCommand class="k-primary">Edit</button>
|
|
46
|
-
* <button kendoGridRemoveCommand>Remove</button>
|
|
47
|
-
* </ng-template>
|
|
48
|
-
* </kendo-grid-command-column>
|
|
49
|
-
* </kendo-grid>
|
|
50
|
-
* `
|
|
51
|
-
* })
|
|
52
|
-
*
|
|
53
|
-
* class AppComponent {
|
|
54
|
-
* public gridData: any[];
|
|
55
|
-
*
|
|
56
|
-
* constructor() {
|
|
57
|
-
* this.gridData = products;
|
|
58
|
-
* }
|
|
59
|
-
* }
|
|
60
|
-
*
|
|
61
|
-
* const products = [{
|
|
62
|
-
* "ProductID": 1,
|
|
63
|
-
* "ProductName": "Chai",
|
|
64
|
-
* "UnitPrice": 18.0000,
|
|
65
|
-
* "Discontinued": true
|
|
66
|
-
* }, {
|
|
67
|
-
* "ProductID": 2,
|
|
68
|
-
* "ProductName": "Chang",
|
|
69
|
-
* "UnitPrice": 19.0000,
|
|
70
|
-
* "Discontinued": false
|
|
71
|
-
* }
|
|
72
|
-
* ];
|
|
73
|
-
*
|
|
16
|
+
* ```html
|
|
17
|
+
* <kendo-grid [data]="gridData">
|
|
18
|
+
* <kendo-grid-column field="ProductID"></kendo-grid-column>
|
|
19
|
+
* <kendo-grid-command-column title="command" [width]="220">
|
|
20
|
+
* <ng-template kendoGridCellTemplate>
|
|
21
|
+
* <button kendoGridEditCommand class="k-primary">Edit</button>
|
|
22
|
+
* <button kendoGridRemoveCommand>Remove</button>
|
|
23
|
+
* </ng-template>
|
|
24
|
+
* </kendo-grid-command-column>
|
|
25
|
+
* </kendo-grid>
|
|
74
26
|
* ```
|
|
75
27
|
*/
|
|
76
28
|
export declare class CommandColumnComponent extends ColumnBase {
|
|
@@ -7,7 +7,7 @@ import { IdService } from '../common/id.service';
|
|
|
7
7
|
import { SVGIcon } from '@progress/kendo-svg-icons';
|
|
8
8
|
import * as i0 from "@angular/core";
|
|
9
9
|
/**
|
|
10
|
-
* Represents the drag handle for reordering rows in the Grid
|
|
10
|
+
* Represents the drag handle for reordering rows in the Grid ([see example](slug:reordering_rows_grid))
|
|
11
11
|
*/
|
|
12
12
|
export declare class RowReorderColumnComponent extends ColumnBase {
|
|
13
13
|
parent?: ColumnBase;
|
|
@@ -13,9 +13,7 @@ export interface ColumnSortSettings {
|
|
|
13
13
|
/**
|
|
14
14
|
* Determines the initial (from the unsorted to the sorted state) sort direction.
|
|
15
15
|
*
|
|
16
|
-
* The available values for setting the initial sort direction
|
|
17
|
-
* - `asc` (default)
|
|
18
|
-
* - `desc`
|
|
16
|
+
* The available values for setting the initial sort direction.
|
|
19
17
|
*/
|
|
20
18
|
initialDirection?: 'asc' | 'desc';
|
|
21
19
|
}
|
|
@@ -29,11 +27,19 @@ export interface SingleSortSettings extends ColumnSortSettings {
|
|
|
29
27
|
mode?: 'single';
|
|
30
28
|
}
|
|
31
29
|
/**
|
|
32
|
-
* Specifies a modifier key.
|
|
30
|
+
* Specifies a modifier key when multiple sort. [See example](slug:multi_sort_grid#toc-sort-key-modifier).
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* ```html
|
|
34
|
+
* <kendo-grid [sortable]="{ mode: 'multiple', multiSortKey: 'shift' }">
|
|
35
|
+
* <kendo-grid-column field="ProductID"></kendo-grid-column>
|
|
36
|
+
* ...
|
|
37
|
+
* </kendo-grid>
|
|
38
|
+
* ```
|
|
33
39
|
*/
|
|
34
40
|
export declare type ModifierKey = 'none' | 'ctrl' | 'shift' | 'alt';
|
|
35
41
|
/**
|
|
36
|
-
* Specifies settings for sorting by multiple columns.
|
|
42
|
+
* Specifies settings for sorting by multiple columns. [See example](slug:multi_sort_grid).
|
|
37
43
|
*/
|
|
38
44
|
export interface MultipleSortSettings extends ColumnSortSettings {
|
|
39
45
|
/**
|
|
@@ -47,22 +53,28 @@ export interface MultipleSortSettings extends ColumnSortSettings {
|
|
|
47
53
|
/**
|
|
48
54
|
* Specifies the modifier key for sorting by 2nd or more columns.
|
|
49
55
|
*
|
|
50
|
-
*
|
|
56
|
+
* By default, clicking a column adds it to the sort order (corresponds to `'none'`).
|
|
51
57
|
* Selecting a key modifier along with the click will remove sorting from all other columns.
|
|
52
58
|
*
|
|
53
59
|
* If the key is set to 'ctrl', 'shift' or 'alt', clicking a column will remove sorting from all other columns.
|
|
54
60
|
* The specified key must be pressed to add the column to the sort order instead.
|
|
61
|
+
* The `ctrl` value corresponds to the `Command` key in a macOS environment. [See example](slug:multi_sort_grid#toc-sort-key-modifier).
|
|
55
62
|
*
|
|
56
|
-
* > The `ctrl` value corresponds to the `Command` key in a macOS environment.
|
|
57
|
-
*
|
|
58
|
-
* @default 'none'
|
|
59
63
|
*/
|
|
60
64
|
multiSortKey?: ModifierKey;
|
|
61
65
|
}
|
|
62
66
|
/**
|
|
63
|
-
* Defines the settings for sorting the Grid.
|
|
64
|
-
*
|
|
65
|
-
*
|
|
67
|
+
* Defines the settings for sorting the Grid. [See example](slug:multi_sort_grid).
|
|
68
|
+
*
|
|
69
|
+
* The available options are:
|
|
70
|
+
* * `boolean`
|
|
71
|
+
* * [SingleSortSettings]({% slug api_grid_singlesortsettings %})
|
|
72
|
+
* * [MultipleSortSettings]({% slug api_grid_multiplesortsettings %})
|
|
73
|
+
*
|
|
74
|
+
* @example
|
|
75
|
+
* ```html
|
|
76
|
+
* <kendo-grid [sorting]="true"></kendo-grid>
|
|
77
|
+
* ```
|
|
66
78
|
*/
|
|
67
79
|
export declare type SortSettings = boolean | SingleSortSettings | MultipleSortSettings;
|
|
68
80
|
/**
|
|
@@ -21,62 +21,15 @@ export declare function isSpanColumnComponent(column: any): column is SpanColumn
|
|
|
21
21
|
* [grouping]({% slug grouping_grid %}). Wrap the columns that will be
|
|
22
22
|
* merged inside the `<kendo-grid-span-column>` tag.
|
|
23
23
|
*
|
|
24
|
-
*
|
|
25
|
-
* ```ts-preview
|
|
26
|
-
*
|
|
27
|
-
* _@Component({
|
|
28
|
-
* selector: 'my-app',
|
|
29
|
-
* template: `
|
|
30
|
-
* <kendo-grid
|
|
31
|
-
* [sortable]="true"
|
|
32
|
-
* [filterable]="true"
|
|
33
|
-
* [kendoGridBinding]="products">
|
|
34
|
-
* <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
|
|
35
|
-
* </kendo-grid-column>
|
|
36
|
-
* <kendo-grid-span-column>
|
|
37
|
-
* <kendo-grid-column field="ProductName" title="Product Name">
|
|
38
|
-
* </kendo-grid-column>
|
|
39
|
-
* <kendo-grid-column field="UnitPrice" title="Unit Price" filter="numeric" [width]="180" format="{0:c}">
|
|
40
|
-
* </kendo-grid-column>
|
|
41
|
-
* </kendo-grid-span-column>
|
|
42
|
-
* <kendo-grid-column field="Discontinued" [width]="120" filter="boolean">
|
|
43
|
-
* <ng-template kendoGridCellTemplate let-dataItem>
|
|
44
|
-
* <input type="checkbox" [checked]="dataItem.Discontinued" disabled/>
|
|
45
|
-
* </ng-template>
|
|
46
|
-
* </kendo-grid-column>
|
|
47
|
-
* </kendo-grid>
|
|
48
|
-
* `
|
|
49
|
-
* })
|
|
50
|
-
*
|
|
51
|
-
* class AppComponent {
|
|
52
|
-
* public products = [{
|
|
53
|
-
* "ProductID": 1,
|
|
54
|
-
* "ProductName": "Chai",
|
|
55
|
-
* "UnitPrice": 18.0000,
|
|
56
|
-
* "Discontinued": true
|
|
57
|
-
* }, {
|
|
58
|
-
* "ProductID": 2,
|
|
59
|
-
* "ProductName": "Chang",
|
|
60
|
-
* "UnitPrice": 19.0000,
|
|
61
|
-
* "Discontinued": false
|
|
62
|
-
* }
|
|
63
|
-
* ];
|
|
64
|
-
* }
|
|
65
|
-
*
|
|
66
|
-
* ```
|
|
67
|
-
*
|
|
68
|
-
* By default, the data cell displays the data for the specified fields. To further customize
|
|
69
|
-
* the span-column functionality, use a [cell template]({% slug api_grid_celltemplatedirective %}).
|
|
70
|
-
*
|
|
71
|
-
* ```html-no-run
|
|
24
|
+
* ```html
|
|
72
25
|
* <kendo-grid-span-column>
|
|
73
|
-
*
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
*
|
|
79
|
-
*
|
|
26
|
+
* <kendo-grid-column field="field1"></kendo-grid-column>
|
|
27
|
+
* <kendo-grid-column field="field2"></kendo-grid-column>
|
|
28
|
+
* <ng-template kendoGridCellTemplate let-dataItem>
|
|
29
|
+
* <h5>{{ dataItem.field1 }}</h5>
|
|
30
|
+
* <p>{{ dataItem.field2 }}</p>
|
|
31
|
+
* </ng-template>
|
|
32
|
+
* </kendo-grid-span-column>
|
|
80
33
|
* ```
|
|
81
34
|
*/
|
|
82
35
|
export declare class SpanColumnComponent extends ColumnBase {
|
|
@@ -120,24 +73,9 @@ export declare class SpanColumnComponent extends ColumnBase {
|
|
|
120
73
|
*/
|
|
121
74
|
includeInChooser: boolean;
|
|
122
75
|
/**
|
|
123
|
-
* Defines whether the edit template of the column will be rendered.
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
* @example
|
|
128
|
-
* ```html-no-run
|
|
129
|
-
* <kendo-grid>
|
|
130
|
-
* <kendo-grid-span-column [editable]="false">
|
|
131
|
-
* <kendo-grid-column field="UnitPrice">
|
|
132
|
-
* </kendo-grid-column>
|
|
133
|
-
* <kendo-grid-column field="ProductName">
|
|
134
|
-
* </kendo-grid-column>
|
|
135
|
-
* <ng-template kendoGridEditTemplate>
|
|
136
|
-
* .....
|
|
137
|
-
* </ng-template>
|
|
138
|
-
* </kendo-grid-span-column>
|
|
139
|
-
* </kendo-grid>
|
|
140
|
-
* ```
|
|
76
|
+
* Defines whether the edit template of the column will be rendered.
|
|
77
|
+
* To enable the editing functionality for a spanned column, set an edit template for it ([see exmaple](slug:custom_reactive_editing_grid)).
|
|
78
|
+
* @default false
|
|
141
79
|
*/
|
|
142
80
|
set editable(value: boolean);
|
|
143
81
|
get editable(): boolean;
|
|
@@ -166,57 +104,8 @@ export declare class SpanColumnComponent extends ColumnBase {
|
|
|
166
104
|
*/
|
|
167
105
|
get colspan(): number;
|
|
168
106
|
/**
|
|
169
|
-
* Toggles the locked (frozen) state of the columns
|
|
170
|
-
* at all times during the horizontal scrolling of the Grid.
|
|
171
|
-
*
|
|
172
|
-
* For the option to work properly, make sure that:
|
|
173
|
-
* - Scrolling is enabled.
|
|
174
|
-
* - The `height` option of the Grid is set.
|
|
175
|
-
* - The widths of all Grid columns are explicitly set in pixels. In this way,
|
|
176
|
-
* the Grid adjusts the layout of the locked and unlocked columns.
|
|
177
|
-
*
|
|
107
|
+
* Toggles the locked (frozen) state of the columns ([see example](slug:locked_columns_grid)).
|
|
178
108
|
* @default false
|
|
179
|
-
*
|
|
180
|
-
* @example
|
|
181
|
-
* ```ts
|
|
182
|
-
* _@Component({
|
|
183
|
-
* selector: 'my-app',
|
|
184
|
-
* template: `
|
|
185
|
-
* <kendo-grid [data]="gridData" [scrollable]="scrollable" style="height: 200px">
|
|
186
|
-
* <kendo-grid-span-column [locked]="true">
|
|
187
|
-
* <kendo-grid-column field="ProductID" title="Product ID" [width]="120">
|
|
188
|
-
* </kendo-grid-column>
|
|
189
|
-
* <kendo-grid-column field="ProductName" title="Product Name" [width]="200">
|
|
190
|
-
* </kendo-grid-column>
|
|
191
|
-
* </kendo-grid-span-column>
|
|
192
|
-
* <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
|
|
193
|
-
* </kendo-grid-column>
|
|
194
|
-
* </kendo-grid>
|
|
195
|
-
* `
|
|
196
|
-
* })
|
|
197
|
-
*
|
|
198
|
-
* class AppComponent {
|
|
199
|
-
* public gridData: any[];
|
|
200
|
-
*
|
|
201
|
-
* constructor() {
|
|
202
|
-
* this.gridData = products;
|
|
203
|
-
* }
|
|
204
|
-
* }
|
|
205
|
-
*
|
|
206
|
-
* const products = [{
|
|
207
|
-
* "ProductID": 1,
|
|
208
|
-
* "ProductName": "Chai",
|
|
209
|
-
* "UnitPrice": 18.0000,
|
|
210
|
-
* "Discontinued": true
|
|
211
|
-
* }, {
|
|
212
|
-
* "ProductID": 2,
|
|
213
|
-
* "ProductName": "Chang",
|
|
214
|
-
* "UnitPrice": 19.0000,
|
|
215
|
-
* "Discontinued": false
|
|
216
|
-
* }
|
|
217
|
-
* ];
|
|
218
|
-
*
|
|
219
|
-
* ```
|
|
220
109
|
*/
|
|
221
110
|
set locked(value: boolean);
|
|
222
111
|
get locked(): boolean;
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
*-------------------------------------------------------------------------------------------*/
|
|
5
5
|
import { GridComponent } from "../grid.component";
|
|
6
6
|
/**
|
|
7
|
-
* Arguments for the `cellClick` event([see example]({% slug editing_incell_grid %}#toc-basic-concepts)).
|
|
7
|
+
* Arguments for the [`cellClick`](slug:api_grid_gridcomponent#toc-cellclick) event ([see example]({% slug editing_incell_grid %}#toc-basic-concepts)).
|
|
8
8
|
*/
|
|
9
9
|
export interface CellClickEvent {
|
|
10
10
|
/**
|
|
@@ -7,6 +7,6 @@ import { Observable } from "rxjs";
|
|
|
7
7
|
import { GridComponent } from "../grid.component";
|
|
8
8
|
/**
|
|
9
9
|
* The function that is used to get the exported data options. By default, uses the current data and group of the Grid.
|
|
10
|
-
* To export data that is different from the current Grid data, provide a custom function.
|
|
10
|
+
* To export data that is different from the current Grid data, provide a custom function. [See example](slug:excelexport_grid#toc-exporting-specific-data)
|
|
11
11
|
*/
|
|
12
12
|
export declare type FetchDataCallback = (component: GridComponent) => ExcelExportData | Promise<ExcelExportData> | Observable<ExcelExportData>;
|
|
@@ -14,7 +14,7 @@ export declare abstract class PreventableEvent {
|
|
|
14
14
|
*/
|
|
15
15
|
preventDefault(): void;
|
|
16
16
|
/**
|
|
17
|
-
* Returns
|
|
17
|
+
* Returns a respective boolean if the event was prevented
|
|
18
18
|
* by any of its subscribers.
|
|
19
19
|
*
|
|
20
20
|
* @returns `true` if the default action was prevented.
|
|
@@ -21,7 +21,7 @@ export declare class PopupCloseEvent extends PreventableEvent {
|
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
23
|
* The service that is used for the popups of the filter and column menus
|
|
24
|
-
* ([see example]({% slug filter_menu %}#toc-
|
|
24
|
+
* ([see example]({% slug filter_menu %}#toc-filter-menu-with-popup)).
|
|
25
25
|
*/
|
|
26
26
|
export declare class SinglePopupService implements OnDestroy {
|
|
27
27
|
private popupService;
|
package/common/size-options.d.ts
CHANGED
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
* Licensed under commercial license. See LICENSE.md in the project root for more information
|
|
4
4
|
*-------------------------------------------------------------------------------------------*/
|
|
5
5
|
/**
|
|
6
|
-
* Represents the possible size options of the Grid.
|
|
7
|
-
* @default `medium`
|
|
6
|
+
* Represents the possible size options of the Grid. [See example](slug:sizing_grid).
|
|
8
7
|
*/
|
|
9
8
|
export declare type GridSize = 'small' | 'medium' | 'none';
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
*-------------------------------------------------------------------------------------------*/
|
|
5
5
|
import { SortDescriptor, GroupDescriptor, CompositeFilterDescriptor } from '@progress/kendo-data-query';
|
|
6
6
|
/**
|
|
7
|
-
* Arguments for the `pageChange` event.
|
|
7
|
+
* Arguments for the `pageChange` event. [See example](slug:manual_paging_grid#toc-paging-local-data).
|
|
8
8
|
*/
|
|
9
9
|
export interface PageChangeEvent {
|
|
10
10
|
/**
|
|
@@ -18,7 +18,7 @@ export interface PageChangeEvent {
|
|
|
18
18
|
}
|
|
19
19
|
/**
|
|
20
20
|
* Arguments for the `dataStateChange` event
|
|
21
|
-
* ([more information and examples](
|
|
21
|
+
* ([more information and examples](slug:data_operations_grid#toc-handling-multiple-data-operations)).
|
|
22
22
|
*/
|
|
23
23
|
export interface DataStateChangeEvent {
|
|
24
24
|
/**
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
*-------------------------------------------------------------------------------------------*/
|
|
5
5
|
import { DataResult } from '@progress/kendo-data-query';
|
|
6
6
|
/**
|
|
7
|
-
* The data type that is expected by the Grid.
|
|
7
|
+
* The data type that is expected by the Grid. [See example](slug:local_data_grid#toc-binding-to-a-griddataresult-object).
|
|
8
8
|
*/
|
|
9
9
|
export interface GridDataResult extends DataResult {
|
|
10
10
|
}
|
|
@@ -6,8 +6,11 @@ import { DataItem } from './data-item.interface';
|
|
|
6
6
|
import { GroupItem } from './group-item.interface';
|
|
7
7
|
import { GroupFooterItem } from './group-footer-item.interface';
|
|
8
8
|
/**
|
|
9
|
-
* Represents
|
|
10
|
-
*
|
|
11
|
-
*
|
|
9
|
+
* Represents the item by which the Grid tracks changes. [See example](slug:track_changes_grid).
|
|
10
|
+
*
|
|
11
|
+
* The possible values are:
|
|
12
|
+
* * [`DataItem`]({% slug api_grid_dataitem %}).
|
|
13
|
+
* * [`GroupItem`]({% slug api_grid_groupitem %}).
|
|
14
|
+
* * [`GroupFooterItem`]({% slug api_grid_groupfooteritem %}).
|
|
12
15
|
*/
|
|
13
16
|
export declare type GridItem = DataItem | GroupItem | GroupFooterItem;
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Licensed under commercial license. See LICENSE.md in the project root for more information
|
|
4
4
|
*-------------------------------------------------------------------------------------------*/
|
|
5
5
|
/**
|
|
6
|
-
* Additional configuration for the `reorderColumn` method.
|
|
6
|
+
* Additional configuration for the [`reorderColumn`](slug:api_grid_gridcomponent#toc-reordercolumn) method.
|
|
7
7
|
*/
|
|
8
8
|
export interface ColumnReorderConfig {
|
|
9
9
|
/**
|
|
@@ -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
|
}
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
*-------------------------------------------------------------------------------------------*/
|
|
5
5
|
import type { GridComponent } from "../grid.component";
|
|
6
6
|
/**
|
|
7
|
-
* Arguments for the `
|
|
7
|
+
* Arguments for the [`edit`](slug:api_grid_gridcomponent#toc-edit) event.
|
|
8
8
|
*/
|
|
9
9
|
export interface EditEvent {
|
|
10
10
|
/**
|
|
@@ -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](
|
|
7
|
+
* [editing directives](slug:editing_directives_grid#toc-custom-editing-service) of the Grid.
|
|
8
8
|
*/
|
|
9
9
|
export interface EditService {
|
|
10
10
|
/**
|