@syncfusion/ej2-treegrid 28.2.4 → 29.1.33
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/README.md +2 -2
- package/dist/ej2-treegrid.min.js +2 -2
- package/dist/ej2-treegrid.umd.min.js +2 -2
- package/dist/ej2-treegrid.umd.min.js.map +1 -1
- package/dist/es6/ej2-treegrid.es2015.js +1275 -519
- package/dist/es6/ej2-treegrid.es2015.js.map +1 -1
- package/dist/es6/ej2-treegrid.es5.js +1277 -519
- package/dist/es6/ej2-treegrid.es5.js.map +1 -1
- package/dist/global/ej2-treegrid.min.js +2 -2
- package/dist/global/ej2-treegrid.min.js.map +1 -1
- package/dist/global/index.d.ts +1 -1
- package/package.json +10 -10
- package/src/treegrid/actions/batch-edit.js +12 -5
- package/src/treegrid/actions/edit.js +12 -12
- package/src/treegrid/actions/page.js +1 -1
- package/src/treegrid/actions/rowdragdrop.d.ts +21 -1
- package/src/treegrid/actions/rowdragdrop.js +248 -48
- package/src/treegrid/actions/summary.js +1 -1
- package/src/treegrid/actions/virtual-scroll.d.ts +34 -1
- package/src/treegrid/actions/virtual-scroll.js +58 -11
- package/src/treegrid/base/constant.d.ts +0 -4
- package/src/treegrid/base/constant.js +0 -4
- package/src/treegrid/base/data.js +48 -47
- package/src/treegrid/base/treegrid-model.d.ts +195 -208
- package/src/treegrid/base/treegrid.d.ts +598 -411
- package/src/treegrid/base/treegrid.js +523 -306
- package/src/treegrid/enum.d.ts +77 -80
- package/src/treegrid/enum.js +2 -2
- package/src/treegrid/models/column.d.ts +122 -177
- package/src/treegrid/models/column.js +14 -26
- package/src/treegrid/models/edit-settings-model.d.ts +24 -25
- package/src/treegrid/models/edit-settings.d.ts +25 -26
- package/src/treegrid/models/edit-settings.js +1 -1
- package/src/treegrid/models/filter-settings-model.d.ts +41 -49
- package/src/treegrid/models/filter-settings.d.ts +43 -51
- package/src/treegrid/models/filter-settings.js +2 -2
- package/src/treegrid/models/infinite-scroll-settings-model.d.ts +4 -4
- package/src/treegrid/models/infinite-scroll-settings.d.ts +4 -4
- package/src/treegrid/models/infinite-scroll-settings.js +1 -1
- package/src/treegrid/models/loading-indicator-model.d.ts +3 -4
- package/src/treegrid/models/loading-indicator.d.ts +4 -4
- package/src/treegrid/models/loading-indicator.js +1 -1
- package/src/treegrid/models/page-settings-model.d.ts +10 -13
- package/src/treegrid/models/page-settings.d.ts +11 -14
- package/src/treegrid/models/page-settings.js +1 -1
- package/src/treegrid/models/rowdrop-settings-model.d.ts +1 -1
- package/src/treegrid/models/rowdrop-settings.d.ts +13 -6
- package/src/treegrid/models/rowdrop-settings.js +1 -1
- package/src/treegrid/models/search-settings-model.d.ts +13 -11
- package/src/treegrid/models/search-settings.d.ts +14 -12
- package/src/treegrid/models/search-settings.js +1 -1
- package/src/treegrid/models/selection-settings-model.d.ts +18 -29
- package/src/treegrid/models/selection-settings.d.ts +18 -29
- package/src/treegrid/models/sort-settings-model.d.ts +8 -5
- package/src/treegrid/models/sort-settings.d.ts +10 -7
- package/src/treegrid/models/sort-settings.js +2 -2
- package/src/treegrid/models/summary-model.d.ts +28 -29
- package/src/treegrid/models/summary.d.ts +32 -30
- package/src/treegrid/models/summary.js +4 -1
- package/src/treegrid/models/textwrap-settings-model.d.ts +7 -4
- package/src/treegrid/models/textwrap-settings.d.ts +8 -5
- package/src/treegrid/models/textwrap-settings.js +1 -1
- package/src/treegrid/renderer/render.js +11 -5
- package/src/treegrid/renderer/virtual-row-model-generator.js +5 -4
- package/src/treegrid/renderer/virtual-tree-content-render.d.ts +277 -0
- package/src/treegrid/renderer/virtual-tree-content-render.js +328 -35
- package/src/treegrid/utils.d.ts +1 -1
- package/styles/bootstrap-lite.css +0 -12
- package/styles/bootstrap.css +0 -12
- package/styles/bootstrap5-dark-lite.css +1 -1
- package/styles/bootstrap5-dark.css +1 -1
- package/styles/treegrid/_layout.scss +0 -1
- package/styles/treegrid/_material-dark-definition.scss +2 -2
- package/styles/treegrid/_material-definition.scss +2 -2
- package/styles/treegrid/bootstrap.css +0 -12
- package/styles/treegrid/bootstrap5-dark.css +1 -1
- package/styles/treegrid/icons/_bootstrap.scss +0 -17
- package/styles/treegrid/icons/_bootstrap5.scss +1 -1
- package/styles/treegrid/icons/_fabric-dark.scss +1 -1
- package/styles/treegrid/icons/_fabric.scss +1 -1
- package/styles/treegrid/icons/_fluent2.scss +1 -1
- package/styles/treegrid/icons/_fusionnew.scss +1 -0
- package/styles/treegrid/icons/_highcontrast-light.scss +1 -1
- package/styles/treegrid/icons/_tailwind-dark.scss +2 -2
|
@@ -6,16 +6,18 @@ import { Property, ChildProperty } from '@syncfusion/ej2-base';import { FilterHi
|
|
|
6
6
|
export interface SearchSettingsModel {
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
|
-
* Specifies the columns to be searched
|
|
9
|
+
* Specifies the columns to be searched upon the initial rendering of the TreeGrid.
|
|
10
|
+
* You can also retrieve the list of columns that are currently searched.
|
|
10
11
|
*
|
|
11
12
|
* @default []
|
|
12
13
|
*/
|
|
13
14
|
fields?: string[];
|
|
14
15
|
|
|
15
16
|
/**
|
|
16
|
-
*
|
|
17
|
+
* When set to true, the search operation ignores case sensitivity,
|
|
18
|
+
* including diacritic characters or accents while filtering.
|
|
17
19
|
*
|
|
18
|
-
* > Check the [`Diacritics`](../../treegrid/filtering
|
|
20
|
+
* > Check the [`Diacritics`](../../treegrid/filtering/filtering#diacritics) filtering.
|
|
19
21
|
*
|
|
20
22
|
* @default false
|
|
21
23
|
*/
|
|
@@ -55,18 +57,18 @@ export interface SearchSettingsModel {
|
|
|
55
57
|
operator?: string;
|
|
56
58
|
|
|
57
59
|
/**
|
|
58
|
-
* A
|
|
60
|
+
* A keyword used for searching within the TreeGrid content.
|
|
61
|
+
*
|
|
59
62
|
*/
|
|
60
63
|
key?: string;
|
|
61
64
|
|
|
62
65
|
/**
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
* * Parent
|
|
66
|
-
* * Child
|
|
67
|
-
* * Both
|
|
68
|
-
* * None
|
|
69
|
-
* ```
|
|
66
|
+
* Defines the search hierarchy modes dictating which parts of the tree should be included in search results.
|
|
67
|
+
* The available options are:
|
|
68
|
+
* * `Parent`: Shows the searched record along with its parent record.
|
|
69
|
+
* * `Child`: Shows the searched record along with its child record.
|
|
70
|
+
* * `Both`: Shows the searched record with both its parent and child records.
|
|
71
|
+
* * `None`: Shows only the searched record.
|
|
70
72
|
*
|
|
71
73
|
* @default Parent
|
|
72
74
|
* @isEnumeration true
|
|
@@ -1,19 +1,21 @@
|
|
|
1
1
|
import { ChildProperty } from '@syncfusion/ej2-base';
|
|
2
2
|
import { FilterHierarchyMode } from '../enum';
|
|
3
3
|
/**
|
|
4
|
-
* Configures the
|
|
4
|
+
* Configures the searching behavior of the TreeGrid.
|
|
5
5
|
*/
|
|
6
6
|
export declare class SearchSettings extends ChildProperty<SearchSettings> {
|
|
7
7
|
/**
|
|
8
|
-
* Specifies the columns to be searched
|
|
8
|
+
* Specifies the columns to be searched upon the initial rendering of the TreeGrid.
|
|
9
|
+
* You can also retrieve the list of columns that are currently searched.
|
|
9
10
|
*
|
|
10
11
|
* @default []
|
|
11
12
|
*/
|
|
12
13
|
fields: string[];
|
|
13
14
|
/**
|
|
14
|
-
*
|
|
15
|
+
* When set to true, the search operation ignores case sensitivity,
|
|
16
|
+
* including diacritic characters or accents while filtering.
|
|
15
17
|
*
|
|
16
|
-
* > Check the [`Diacritics`](../../treegrid/filtering
|
|
18
|
+
* > Check the [`Diacritics`](../../treegrid/filtering/filtering#diacritics) filtering.
|
|
17
19
|
*
|
|
18
20
|
* @default false
|
|
19
21
|
*/
|
|
@@ -51,17 +53,17 @@ export declare class SearchSettings extends ChildProperty<SearchSettings> {
|
|
|
51
53
|
*/
|
|
52
54
|
operator: string;
|
|
53
55
|
/**
|
|
54
|
-
* A
|
|
56
|
+
* A keyword used for searching within the TreeGrid content.
|
|
57
|
+
*
|
|
55
58
|
*/
|
|
56
59
|
key: string;
|
|
57
60
|
/**
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
* * Parent
|
|
61
|
-
* * Child
|
|
62
|
-
* * Both
|
|
63
|
-
* * None
|
|
64
|
-
* ```
|
|
61
|
+
* Defines the search hierarchy modes dictating which parts of the tree should be included in search results.
|
|
62
|
+
* The available options are:
|
|
63
|
+
* * `Parent`: Shows the searched record along with its parent record.
|
|
64
|
+
* * `Child`: Shows the searched record along with its child record.
|
|
65
|
+
* * `Both`: Shows the searched record with both its parent and child records.
|
|
66
|
+
* * `None`: Shows only the searched record.
|
|
65
67
|
*
|
|
66
68
|
* @default Parent
|
|
67
69
|
* @isEnumeration true
|
|
@@ -19,7 +19,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
|
|
|
19
19
|
};
|
|
20
20
|
import { Property, ChildProperty } from '@syncfusion/ej2-base';
|
|
21
21
|
/**
|
|
22
|
-
* Configures the
|
|
22
|
+
* Configures the searching behavior of the TreeGrid.
|
|
23
23
|
*/
|
|
24
24
|
var SearchSettings = /** @class */ (function (_super) {
|
|
25
25
|
__extends(SearchSettings, _super);
|
|
@@ -6,12 +6,10 @@ import { Property, ChildProperty } from '@syncfusion/ej2-base';import { Selectio
|
|
|
6
6
|
export interface SelectionSettingsModel {
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
|
-
* TreeGrid supports row, cell, and both (row and cell) selection
|
|
10
|
-
*
|
|
11
|
-
* *
|
|
12
|
-
* *
|
|
13
|
-
* * Both :- Selects the entire row and its cell.
|
|
14
|
-
* ```
|
|
9
|
+
* Specifies the selection mode for the TreeGrid, which supports row, cell, and both (row and cell) selection modes.
|
|
10
|
+
* * `Row`: Selects the entire row.
|
|
11
|
+
* * `Cell`: Selects a single cell.
|
|
12
|
+
* * `Both`: Selects the entire row and its cells.
|
|
15
13
|
*
|
|
16
14
|
* @default Syncfusion.EJ2.Grids.SelectionMode.Row
|
|
17
15
|
* @isEnumeration true
|
|
@@ -20,12 +18,10 @@ export interface SelectionSettingsModel {
|
|
|
20
18
|
mode?: SelectionMode;
|
|
21
19
|
|
|
22
20
|
/**
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
* *
|
|
27
|
-
* * Box :- Selects the range of cells within the start and end column indexes that includes in between cells of rows within the range.
|
|
28
|
-
* ```
|
|
21
|
+
* Determines the mode for cell selection, available options are flow and box.
|
|
22
|
+
* Requires the selection `mode` to be either cell or both.
|
|
23
|
+
* * `Flow`: Selects the range between start and end indexes, including other cells of selected rows.
|
|
24
|
+
* * `Box`: Selects cells within the start and end column indexes within the selected rows.
|
|
29
25
|
*
|
|
30
26
|
* @default Syncfusion.EJ2.Grids.CellSelectionMode.Flow
|
|
31
27
|
* @isEnumeration true
|
|
@@ -34,11 +30,9 @@ export interface SelectionSettingsModel {
|
|
|
34
30
|
cellSelectionMode?: CellSelectionMode;
|
|
35
31
|
|
|
36
32
|
/**
|
|
37
|
-
* Defines
|
|
38
|
-
*
|
|
39
|
-
* *
|
|
40
|
-
* * Multiple :- Allows selection of multiple rows or cells.
|
|
41
|
-
* ```
|
|
33
|
+
* Defines the selection type, specifying whether single or multiple selections are allowed.
|
|
34
|
+
* * `Single`: Allows selection of only a single row or cell.
|
|
35
|
+
* * `Multiple`: Allows selection of multiple rows or cells.
|
|
42
36
|
*
|
|
43
37
|
* @default Syncfusion.EJ2.Grids.SelectionType.Single
|
|
44
38
|
* @isEnumeration true
|
|
@@ -47,20 +41,17 @@ export interface SelectionSettingsModel {
|
|
|
47
41
|
type?: SelectionType;
|
|
48
42
|
|
|
49
43
|
/**
|
|
50
|
-
*
|
|
51
|
-
*
|
|
44
|
+
* When set to true, the TreeGrid selection persists even during various grid operations such as sorting or paging.
|
|
45
|
+
* Requires at least one column to be configured as the primary key for persistence.
|
|
52
46
|
*
|
|
53
47
|
* @default false
|
|
54
48
|
*/
|
|
55
49
|
persistSelection?: boolean;
|
|
56
50
|
|
|
57
51
|
/**
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
* *
|
|
61
|
-
* * ResetOnRowClick :- In ResetOnRowClick mode, on clicking a row it will reset previously selected row and also multiple.
|
|
62
|
-
* ```
|
|
63
|
-
* rows can be selected by using CTRL or SHIFT key.
|
|
52
|
+
* Specifies the mode for checkbox selection:
|
|
53
|
+
* * `Default`: Allows selection of multiple rows by clicking on each row individually.
|
|
54
|
+
* * `ResetOnRowClick`: Resets prior selection when a new row is clicked. Multiple rows can be selected using CTRL or SHIFT keys.
|
|
64
55
|
*
|
|
65
56
|
* @default Syncfusion.EJ2.Grids.CheckboxSelectionType.Default
|
|
66
57
|
* @isEnumeration true
|
|
@@ -69,16 +60,14 @@ export interface SelectionSettingsModel {
|
|
|
69
60
|
checkboxMode?: CheckboxSelectionType;
|
|
70
61
|
|
|
71
62
|
/**
|
|
72
|
-
* If
|
|
73
|
-
*
|
|
74
|
-
* > To enable checkboxOnly selection, should specify the column type as `checkbox`.
|
|
63
|
+
* If set to true, TreeGrid selection is allowed only through checkboxes. Ensure the column type is set to `checkbox` to enable this mode.
|
|
75
64
|
*
|
|
76
65
|
* @default false
|
|
77
66
|
*/
|
|
78
67
|
checkboxOnly?: boolean;
|
|
79
68
|
|
|
80
69
|
/**
|
|
81
|
-
*
|
|
70
|
+
* Enables toggling of the selected row. When true, users can toggle the selection of a row.
|
|
82
71
|
*
|
|
83
72
|
* @default true
|
|
84
73
|
*/
|
|
@@ -5,12 +5,10 @@ import { SelectionMode, CellSelectionMode, SelectionType, CheckboxSelectionType
|
|
|
5
5
|
*/
|
|
6
6
|
export declare class SelectionSettings extends ChildProperty<SelectionSettings> {
|
|
7
7
|
/**
|
|
8
|
-
* TreeGrid supports row, cell, and both (row and cell) selection
|
|
9
|
-
*
|
|
10
|
-
* *
|
|
11
|
-
* *
|
|
12
|
-
* * Both :- Selects the entire row and its cell.
|
|
13
|
-
* ```
|
|
8
|
+
* Specifies the selection mode for the TreeGrid, which supports row, cell, and both (row and cell) selection modes.
|
|
9
|
+
* * `Row`: Selects the entire row.
|
|
10
|
+
* * `Cell`: Selects a single cell.
|
|
11
|
+
* * `Both`: Selects the entire row and its cells.
|
|
14
12
|
*
|
|
15
13
|
* @default Syncfusion.EJ2.Grids.SelectionMode.Row
|
|
16
14
|
* @isEnumeration true
|
|
@@ -18,12 +16,10 @@ export declare class SelectionSettings extends ChildProperty<SelectionSettings>
|
|
|
18
16
|
*/
|
|
19
17
|
mode: SelectionMode;
|
|
20
18
|
/**
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
* *
|
|
25
|
-
* * Box :- Selects the range of cells within the start and end column indexes that includes in between cells of rows within the range.
|
|
26
|
-
* ```
|
|
19
|
+
* Determines the mode for cell selection, available options are flow and box.
|
|
20
|
+
* Requires the selection `mode` to be either cell or both.
|
|
21
|
+
* * `Flow`: Selects the range between start and end indexes, including other cells of selected rows.
|
|
22
|
+
* * `Box`: Selects cells within the start and end column indexes within the selected rows.
|
|
27
23
|
*
|
|
28
24
|
* @default Syncfusion.EJ2.Grids.CellSelectionMode.Flow
|
|
29
25
|
* @isEnumeration true
|
|
@@ -31,11 +27,9 @@ export declare class SelectionSettings extends ChildProperty<SelectionSettings>
|
|
|
31
27
|
*/
|
|
32
28
|
cellSelectionMode: CellSelectionMode;
|
|
33
29
|
/**
|
|
34
|
-
* Defines
|
|
35
|
-
*
|
|
36
|
-
* *
|
|
37
|
-
* * Multiple :- Allows selection of multiple rows or cells.
|
|
38
|
-
* ```
|
|
30
|
+
* Defines the selection type, specifying whether single or multiple selections are allowed.
|
|
31
|
+
* * `Single`: Allows selection of only a single row or cell.
|
|
32
|
+
* * `Multiple`: Allows selection of multiple rows or cells.
|
|
39
33
|
*
|
|
40
34
|
* @default Syncfusion.EJ2.Grids.SelectionType.Single
|
|
41
35
|
* @isEnumeration true
|
|
@@ -43,19 +37,16 @@ export declare class SelectionSettings extends ChildProperty<SelectionSettings>
|
|
|
43
37
|
*/
|
|
44
38
|
type: SelectionType;
|
|
45
39
|
/**
|
|
46
|
-
*
|
|
47
|
-
*
|
|
40
|
+
* When set to true, the TreeGrid selection persists even during various grid operations such as sorting or paging.
|
|
41
|
+
* Requires at least one column to be configured as the primary key for persistence.
|
|
48
42
|
*
|
|
49
43
|
* @default false
|
|
50
44
|
*/
|
|
51
45
|
persistSelection: boolean;
|
|
52
46
|
/**
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
* *
|
|
56
|
-
* * ResetOnRowClick :- In ResetOnRowClick mode, on clicking a row it will reset previously selected row and also multiple.
|
|
57
|
-
* ```
|
|
58
|
-
* rows can be selected by using CTRL or SHIFT key.
|
|
47
|
+
* Specifies the mode for checkbox selection:
|
|
48
|
+
* * `Default`: Allows selection of multiple rows by clicking on each row individually.
|
|
49
|
+
* * `ResetOnRowClick`: Resets prior selection when a new row is clicked. Multiple rows can be selected using CTRL or SHIFT keys.
|
|
59
50
|
*
|
|
60
51
|
* @default Syncfusion.EJ2.Grids.CheckboxSelectionType.Default
|
|
61
52
|
* @isEnumeration true
|
|
@@ -63,15 +54,13 @@ export declare class SelectionSettings extends ChildProperty<SelectionSettings>
|
|
|
63
54
|
*/
|
|
64
55
|
checkboxMode: CheckboxSelectionType;
|
|
65
56
|
/**
|
|
66
|
-
* If
|
|
67
|
-
*
|
|
68
|
-
* > To enable checkboxOnly selection, should specify the column type as `checkbox`.
|
|
57
|
+
* If set to true, TreeGrid selection is allowed only through checkboxes. Ensure the column type is set to `checkbox` to enable this mode.
|
|
69
58
|
*
|
|
70
59
|
* @default false
|
|
71
60
|
*/
|
|
72
61
|
checkboxOnly: boolean;
|
|
73
62
|
/**
|
|
74
|
-
*
|
|
63
|
+
* Enables toggling of the selected row. When true, users can toggle the selection of a row.
|
|
75
64
|
*
|
|
76
65
|
* @default true
|
|
77
66
|
*/
|
|
@@ -6,14 +6,16 @@ import { ChildProperty, Property, Collection } from '@syncfusion/ej2-base';impor
|
|
|
6
6
|
export interface SortDescriptorModel {
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Specifies the field name of the column to be sorted.
|
|
10
10
|
*
|
|
11
11
|
* @default ''
|
|
12
12
|
*/
|
|
13
13
|
field?: string;
|
|
14
14
|
|
|
15
15
|
/**
|
|
16
|
-
*
|
|
16
|
+
* Specifies the direction of sorting for the column. The available options are:
|
|
17
|
+
* * `Ascending`: Sorts the column in ascending order.
|
|
18
|
+
* * `Descending`: Sorts the column in descending order.
|
|
17
19
|
*
|
|
18
20
|
* @default ''
|
|
19
21
|
* @isEnumeration true
|
|
@@ -29,15 +31,16 @@ export interface SortDescriptorModel {
|
|
|
29
31
|
export interface SortSettingsModel {
|
|
30
32
|
|
|
31
33
|
/**
|
|
32
|
-
* Specifies the columns to
|
|
33
|
-
*
|
|
34
|
+
* Specifies the columns to be sorted at initial rendering of the TreeGrid.
|
|
35
|
+
* This property can also be used to get or modify the currently sorted columns at runtime.
|
|
34
36
|
*
|
|
35
37
|
* @default []
|
|
36
38
|
*/
|
|
37
39
|
columns?: SortDescriptorModel[];
|
|
38
40
|
|
|
39
41
|
/**
|
|
40
|
-
* If
|
|
42
|
+
* If set to false, the user cannot reset the TreeGrid to an unsorted state by clicking on the sorted column header.
|
|
43
|
+
* When true, clicking an already sorted column header will toggle the sort direction or remove sorting.
|
|
41
44
|
*
|
|
42
45
|
* @default true
|
|
43
46
|
*/
|
|
@@ -2,17 +2,19 @@ import { ChildProperty } from '@syncfusion/ej2-base';
|
|
|
2
2
|
import { SortDirection } from '@syncfusion/ej2-grids';
|
|
3
3
|
import { SortDescriptorModel } from './sort-settings-model';
|
|
4
4
|
/**
|
|
5
|
-
* Represents the field name and direction of sort column.
|
|
5
|
+
* Represents the field name and direction of a sort column in the TreeGrid.
|
|
6
6
|
*/
|
|
7
7
|
export declare class SortDescriptor extends ChildProperty<SortDescriptor> {
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Specifies the field name of the column to be sorted.
|
|
10
10
|
*
|
|
11
11
|
* @default ''
|
|
12
12
|
*/
|
|
13
13
|
field: string;
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* Specifies the direction of sorting for the column. The available options are:
|
|
16
|
+
* * `Ascending`: Sorts the column in ascending order.
|
|
17
|
+
* * `Descending`: Sorts the column in descending order.
|
|
16
18
|
*
|
|
17
19
|
* @default ''
|
|
18
20
|
* @isEnumeration true
|
|
@@ -21,18 +23,19 @@ export declare class SortDescriptor extends ChildProperty<SortDescriptor> {
|
|
|
21
23
|
direction: SortDirection;
|
|
22
24
|
}
|
|
23
25
|
/**
|
|
24
|
-
* Configures the sorting behavior of TreeGrid.
|
|
26
|
+
* Configures the sorting behavior of the TreeGrid.
|
|
25
27
|
*/
|
|
26
28
|
export declare class SortSettings extends ChildProperty<SortSettings> {
|
|
27
29
|
/**
|
|
28
|
-
* Specifies the columns to
|
|
29
|
-
*
|
|
30
|
+
* Specifies the columns to be sorted at initial rendering of the TreeGrid.
|
|
31
|
+
* This property can also be used to get or modify the currently sorted columns at runtime.
|
|
30
32
|
*
|
|
31
33
|
* @default []
|
|
32
34
|
*/
|
|
33
35
|
columns: SortDescriptorModel[];
|
|
34
36
|
/**
|
|
35
|
-
* If
|
|
37
|
+
* If set to false, the user cannot reset the TreeGrid to an unsorted state by clicking on the sorted column header.
|
|
38
|
+
* When true, clicking an already sorted column header will toggle the sort direction or remove sorting.
|
|
36
39
|
*
|
|
37
40
|
* @default true
|
|
38
41
|
*/
|
|
@@ -19,7 +19,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
|
|
|
19
19
|
};
|
|
20
20
|
import { ChildProperty, Property, Collection } from '@syncfusion/ej2-base';
|
|
21
21
|
/**
|
|
22
|
-
* Represents the field name and direction of sort column.
|
|
22
|
+
* Represents the field name and direction of a sort column in the TreeGrid.
|
|
23
23
|
*/
|
|
24
24
|
var SortDescriptor = /** @class */ (function (_super) {
|
|
25
25
|
__extends(SortDescriptor, _super);
|
|
@@ -36,7 +36,7 @@ var SortDescriptor = /** @class */ (function (_super) {
|
|
|
36
36
|
}(ChildProperty));
|
|
37
37
|
export { SortDescriptor };
|
|
38
38
|
/**
|
|
39
|
-
* Configures the sorting behavior of TreeGrid.
|
|
39
|
+
* Configures the sorting behavior of the TreeGrid.
|
|
40
40
|
*/
|
|
41
41
|
var SortSettings = /** @class */ (function (_super) {
|
|
42
42
|
__extends(SortSettings, _super);
|
|
@@ -6,18 +6,19 @@ import { Property, ChildProperty, Collection, getEnumValue, compile, DateFormatO
|
|
|
6
6
|
export interface AggregateColumnModel {
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
|
-
* Defines the aggregate type
|
|
10
|
-
* To
|
|
11
|
-
*
|
|
12
|
-
* * sum
|
|
13
|
-
* * average
|
|
14
|
-
* * max
|
|
15
|
-
* * min
|
|
16
|
-
* * count
|
|
17
|
-
* * falsecount
|
|
18
|
-
* * truecount
|
|
19
|
-
* * custom
|
|
20
|
-
*
|
|
9
|
+
* Defines the aggregate type(s) for a particular column.
|
|
10
|
+
* To apply multiple aggregates to a single column, specify the `type` as an array.
|
|
11
|
+
* Available aggregate types include:
|
|
12
|
+
* * `sum`: Calculates the sum of all values in a column.
|
|
13
|
+
* * `average`: Computes the average of the column values.
|
|
14
|
+
* * `max`: Finds the maximum value in a column.
|
|
15
|
+
* * `min`: Finds the minimum value in a column.
|
|
16
|
+
* * `count`: Counts the number of records.
|
|
17
|
+
* * `falsecount`: Counts the number of false values.
|
|
18
|
+
* * `truecount`: Counts the number of true values.
|
|
19
|
+
* * `custom`: Allows for a custom aggregate function.
|
|
20
|
+
*
|
|
21
|
+
* Use `custom` to specify a custom aggregation.
|
|
21
22
|
*
|
|
22
23
|
* @aspType string
|
|
23
24
|
* @default null
|
|
@@ -25,10 +26,8 @@ export interface AggregateColumnModel {
|
|
|
25
26
|
type?: AggregateType | AggregateType[] | string;
|
|
26
27
|
|
|
27
28
|
/**
|
|
28
|
-
* Defines the footer cell
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* {% codeBlock src="grid/footer-template-api/index.ts" %}{% endcodeBlock %}
|
|
29
|
+
* Defines a template for the footer cell of the aggregate column.
|
|
30
|
+
* Use the aggregate `type` names within the template to access aggregate values.
|
|
32
31
|
*
|
|
33
32
|
* @default null
|
|
34
33
|
* @aspType string
|
|
@@ -37,17 +36,17 @@ export interface AggregateColumnModel {
|
|
|
37
36
|
footerTemplate?: string | Function;
|
|
38
37
|
|
|
39
38
|
/**
|
|
40
|
-
*
|
|
39
|
+
* Specifies the column name on which to perform the aggregation.
|
|
41
40
|
*
|
|
42
41
|
* @default null
|
|
43
42
|
*/
|
|
44
43
|
field?: string;
|
|
45
44
|
|
|
46
45
|
/**
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
* [
|
|
50
|
-
* and [
|
|
46
|
+
* Specifies the format to be applied to the calculated aggregate value before display.
|
|
47
|
+
* Supports both standard and custom formats for numbers and dates.
|
|
48
|
+
* Refer to the Syncfusion documentation for [number](https://ej2.syncfusion.com/documentation/common/internationalization/#supported-format-string)
|
|
49
|
+
* and [date](https://ej2.syncfusion.com/documentation/common/internationalization#date-formatting) formats.
|
|
51
50
|
*
|
|
52
51
|
* @aspType string
|
|
53
52
|
* @default null
|
|
@@ -55,18 +54,17 @@ export interface AggregateColumnModel {
|
|
|
55
54
|
format?: string | NumberFormatOptions | DateFormatOptions;
|
|
56
55
|
|
|
57
56
|
/**
|
|
58
|
-
*
|
|
59
|
-
* then `field` name value will be assigned to the `columnName` property.
|
|
57
|
+
* Specifies the column name to display the aggregate value. If not defined, the `field` name is used by default.
|
|
60
58
|
*
|
|
61
59
|
* @default null
|
|
62
60
|
*/
|
|
63
61
|
columnName?: string;
|
|
64
62
|
|
|
65
63
|
/**
|
|
66
|
-
* Defines a function to calculate
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
64
|
+
* Defines a custom function to calculate the aggregate value. The `type` must be set to `custom`.
|
|
65
|
+
* Use the custom value as `${custom}` in templates.
|
|
66
|
+
* * `Total aggregation`: The custom function is called with the entire dataset and the current `AggregateColumn` object.
|
|
67
|
+
* * `Group aggregation`: It is called with the current group details and the `AggregateColumn` object.
|
|
70
68
|
*
|
|
71
69
|
* @default null
|
|
72
70
|
*/
|
|
@@ -80,14 +78,15 @@ export interface AggregateColumnModel {
|
|
|
80
78
|
export interface AggregateRowModel {
|
|
81
79
|
|
|
82
80
|
/**
|
|
83
|
-
* Configures the aggregate columns.
|
|
81
|
+
* Configures the collection of aggregate columns.
|
|
84
82
|
*
|
|
85
83
|
* @default []
|
|
86
84
|
*/
|
|
87
85
|
columns?: AggregateColumnModel[];
|
|
88
86
|
|
|
89
87
|
/**
|
|
90
|
-
*
|
|
88
|
+
* Determines whether to display child summaries for each parent row.
|
|
89
|
+
*
|
|
91
90
|
*/
|
|
92
91
|
showChildSummary?: boolean;
|
|
93
92
|
|
|
@@ -2,35 +2,34 @@ import { ChildProperty, DateFormatOptions, NumberFormatOptions } from '@syncfusi
|
|
|
2
2
|
import { AggregateColumnModel } from './summary-model';
|
|
3
3
|
import { CustomSummaryType, AggregateType, CellType } from '@syncfusion/ej2-grids';
|
|
4
4
|
/**
|
|
5
|
-
* Configures the
|
|
5
|
+
* Configures the aggregate column for the TreeGrid.
|
|
6
6
|
*/
|
|
7
7
|
export declare class AggregateColumn extends ChildProperty<AggregateColumn> {
|
|
8
8
|
private formatFn;
|
|
9
9
|
private intl;
|
|
10
10
|
private templateFn;
|
|
11
11
|
/**
|
|
12
|
-
* Defines the aggregate type
|
|
13
|
-
* To
|
|
14
|
-
*
|
|
15
|
-
* * sum
|
|
16
|
-
* * average
|
|
17
|
-
* * max
|
|
18
|
-
* * min
|
|
19
|
-
* * count
|
|
20
|
-
* * falsecount
|
|
21
|
-
* * truecount
|
|
22
|
-
* * custom
|
|
23
|
-
*
|
|
12
|
+
* Defines the aggregate type(s) for a particular column.
|
|
13
|
+
* To apply multiple aggregates to a single column, specify the `type` as an array.
|
|
14
|
+
* Available aggregate types include:
|
|
15
|
+
* * `sum`: Calculates the sum of all values in a column.
|
|
16
|
+
* * `average`: Computes the average of the column values.
|
|
17
|
+
* * `max`: Finds the maximum value in a column.
|
|
18
|
+
* * `min`: Finds the minimum value in a column.
|
|
19
|
+
* * `count`: Counts the number of records.
|
|
20
|
+
* * `falsecount`: Counts the number of false values.
|
|
21
|
+
* * `truecount`: Counts the number of true values.
|
|
22
|
+
* * `custom`: Allows for a custom aggregate function.
|
|
23
|
+
*
|
|
24
|
+
* Use `custom` to specify a custom aggregation.
|
|
24
25
|
*
|
|
25
26
|
* @aspType string
|
|
26
27
|
* @default null
|
|
27
28
|
*/
|
|
28
29
|
type: AggregateType | AggregateType[] | string;
|
|
29
30
|
/**
|
|
30
|
-
* Defines the footer cell
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* {% codeBlock src="grid/footer-template-api/index.ts" %}{% endcodeBlock %}
|
|
31
|
+
* Defines a template for the footer cell of the aggregate column.
|
|
32
|
+
* Use the aggregate `type` names within the template to access aggregate values.
|
|
34
33
|
*
|
|
35
34
|
* @default null
|
|
36
35
|
* @aspType string
|
|
@@ -38,33 +37,32 @@ export declare class AggregateColumn extends ChildProperty<AggregateColumn> {
|
|
|
38
37
|
*/
|
|
39
38
|
footerTemplate: string | Function;
|
|
40
39
|
/**
|
|
41
|
-
*
|
|
40
|
+
* Specifies the column name on which to perform the aggregation.
|
|
42
41
|
*
|
|
43
42
|
* @default null
|
|
44
43
|
*/
|
|
45
44
|
field: string;
|
|
46
45
|
/**
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
* [
|
|
50
|
-
* and [
|
|
46
|
+
* Specifies the format to be applied to the calculated aggregate value before display.
|
|
47
|
+
* Supports both standard and custom formats for numbers and dates.
|
|
48
|
+
* Refer to the Syncfusion documentation for [number](https://ej2.syncfusion.com/documentation/common/internationalization/#supported-format-string)
|
|
49
|
+
* and [date](https://ej2.syncfusion.com/documentation/common/internationalization#date-formatting) formats.
|
|
51
50
|
*
|
|
52
51
|
* @aspType string
|
|
53
52
|
* @default null
|
|
54
53
|
*/
|
|
55
54
|
format: string | NumberFormatOptions | DateFormatOptions;
|
|
56
55
|
/**
|
|
57
|
-
*
|
|
58
|
-
* then `field` name value will be assigned to the `columnName` property.
|
|
56
|
+
* Specifies the column name to display the aggregate value. If not defined, the `field` name is used by default.
|
|
59
57
|
*
|
|
60
58
|
* @default null
|
|
61
59
|
*/
|
|
62
60
|
columnName: string;
|
|
63
61
|
/**
|
|
64
|
-
* Defines a function to calculate
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
62
|
+
* Defines a custom function to calculate the aggregate value. The `type` must be set to `custom`.
|
|
63
|
+
* Use the custom value as `${custom}` in templates.
|
|
64
|
+
* * `Total aggregation`: The custom function is called with the entire dataset and the current `AggregateColumn` object.
|
|
65
|
+
* * `Group aggregation`: It is called with the current group details and the `AggregateColumn` object.
|
|
68
66
|
*
|
|
69
67
|
* @default null
|
|
70
68
|
*/
|
|
@@ -110,15 +108,19 @@ export declare class AggregateColumn extends ChildProperty<AggregateColumn> {
|
|
|
110
108
|
*/
|
|
111
109
|
setPropertiesSilent(prop: Object): void;
|
|
112
110
|
}
|
|
111
|
+
/**
|
|
112
|
+
* Configures the aggregate rows in the TreeGrid.
|
|
113
|
+
*/
|
|
113
114
|
export declare class AggregateRow extends ChildProperty<AggregateRow> {
|
|
114
115
|
/**
|
|
115
|
-
* Configures the aggregate columns.
|
|
116
|
+
* Configures the collection of aggregate columns.
|
|
116
117
|
*
|
|
117
118
|
* @default []
|
|
118
119
|
*/
|
|
119
120
|
columns: AggregateColumnModel[];
|
|
120
121
|
/**
|
|
121
|
-
*
|
|
122
|
+
* Determines whether to display child summaries for each parent row.
|
|
123
|
+
*
|
|
122
124
|
*/
|
|
123
125
|
showChildSummary: boolean;
|
|
124
126
|
}
|