@syncfusion/ej2-treegrid 25.2.6 → 26.1.35-760834
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/.eslintrc.json +243 -259
- package/README.md +83 -83
- package/dist/ej2-treegrid.min.js +1 -10
- package/dist/ej2-treegrid.umd.min.js +1 -10
- package/dist/ej2-treegrid.umd.min.js.map +1 -1
- package/dist/es6/ej2-treegrid.es2015.js +842 -553
- package/dist/es6/ej2-treegrid.es2015.js.map +1 -1
- package/dist/es6/ej2-treegrid.es5.js +1361 -1069
- package/dist/es6/ej2-treegrid.es5.js.map +1 -1
- package/dist/global/ej2-treegrid.min.js +1 -10
- package/dist/global/ej2-treegrid.min.js.map +1 -1
- package/dist/global/index.d.ts +0 -9
- package/dist/ts/undefined +73 -0
- package/license +9 -9
- package/package.json +70 -70
- package/src/treegrid/actions/clipboard.js +13 -13
- package/src/treegrid/actions/crud-actions.js +1 -1
- package/src/treegrid/actions/edit.js +11 -9
- package/src/treegrid/actions/excel-export.js +16 -4
- package/src/treegrid/actions/logger.js +13 -13
- package/src/treegrid/actions/page.js +4 -0
- package/src/treegrid/actions/rowdragdrop.js +27 -16
- package/src/treegrid/actions/selection.js +13 -1
- package/src/treegrid/actions/virtual-scroll.d.ts +2 -0
- package/src/treegrid/actions/virtual-scroll.js +26 -14
- package/src/treegrid/base/constant.d.ts +2 -0
- package/src/treegrid/base/constant.js +2 -0
- package/src/treegrid/base/data.js +22 -4
- package/src/treegrid/base/interface.js +0 -1
- package/src/treegrid/base/treegrid-model.d.ts +875 -875
- package/src/treegrid/base/treegrid.d.ts +45 -41
- package/src/treegrid/base/treegrid.js +338 -101
- package/src/treegrid/models/column-model.d.ts +6 -6
- package/src/treegrid/models/column.js +19 -19
- package/src/treegrid/models/edit-settings-model.d.ts +72 -72
- package/src/treegrid/models/edit-settings.js +19 -19
- package/src/treegrid/models/filter-settings-model.d.ts +206 -206
- package/src/treegrid/models/filter-settings.js +19 -19
- package/src/treegrid/models/infinite-scroll-settings-model.d.ts +16 -16
- package/src/treegrid/models/infinite-scroll-settings.js +19 -19
- package/src/treegrid/models/loading-indicator.js +19 -19
- package/src/treegrid/models/page-settings-model.d.ts +46 -46
- package/src/treegrid/models/page-settings.js +19 -19
- package/src/treegrid/models/rowdrop-settings-model.d.ts +6 -6
- package/src/treegrid/models/rowdrop-settings.js +19 -19
- package/src/treegrid/models/search-settings-model.d.ts +60 -60
- package/src/treegrid/models/search-settings.js +19 -19
- package/src/treegrid/models/selection-settings-model.d.ts +66 -66
- package/src/treegrid/models/selection-settings.js +19 -19
- package/src/treegrid/models/sort-settings-model.d.ts +24 -24
- package/src/treegrid/models/sort-settings.js +19 -19
- package/src/treegrid/models/summary-model.d.ts +64 -64
- package/src/treegrid/models/summary.js +19 -19
- package/src/treegrid/models/textwrap-settings-model.d.ts +9 -9
- package/src/treegrid/models/textwrap-settings.js +19 -19
- package/src/treegrid/renderer/virtual-row-model-generator.js +15 -15
- package/src/treegrid/renderer/virtual-tree-content-render.js +26 -20
- package/styles/bds-lite.css +745 -0
- package/styles/bds-lite.scss +18 -0
- package/styles/bds.css +765 -0
- package/styles/bds.scss +19 -0
- package/styles/bootstrap-dark-lite.css +506 -0
- package/styles/bootstrap-dark-lite.scss +18 -0
- package/styles/bootstrap-dark.css +187 -117
- package/styles/bootstrap-dark.scss +19 -1
- package/styles/bootstrap-lite.css +509 -0
- package/styles/bootstrap-lite.scss +18 -0
- package/styles/bootstrap.css +190 -121
- package/styles/bootstrap.scss +19 -1
- package/styles/bootstrap4-lite.css +550 -0
- package/styles/bootstrap4-lite.scss +18 -0
- package/styles/bootstrap4.css +194 -133
- package/styles/bootstrap4.scss +19 -1
- package/styles/bootstrap5-dark-lite.css +545 -0
- package/styles/bootstrap5-dark-lite.scss +18 -0
- package/styles/bootstrap5-dark.css +189 -123
- package/styles/bootstrap5-dark.scss +19 -1
- package/styles/bootstrap5-lite.css +545 -0
- package/styles/bootstrap5-lite.scss +18 -0
- package/styles/bootstrap5.3-lite.css +549 -0
- package/styles/bootstrap5.3-lite.scss +18 -0
- package/styles/bootstrap5.3.css +569 -0
- package/styles/bootstrap5.3.scss +19 -0
- package/styles/bootstrap5.css +188 -122
- package/styles/bootstrap5.scss +19 -1
- package/styles/fabric-dark-lite.css +485 -0
- package/styles/fabric-dark-lite.scss +18 -0
- package/styles/fabric-dark.css +188 -118
- package/styles/fabric-dark.scss +19 -1
- package/styles/fabric-lite.css +485 -0
- package/styles/fabric-lite.scss +18 -0
- package/styles/fabric.css +188 -111
- package/styles/fabric.scss +19 -1
- package/styles/fluent-dark-lite.css +548 -0
- package/styles/fluent-dark-lite.scss +18 -0
- package/styles/fluent-dark.css +195 -116
- package/styles/fluent-dark.scss +19 -1
- package/styles/fluent-lite.css +548 -0
- package/styles/fluent-lite.scss +18 -0
- package/styles/fluent.css +195 -116
- package/styles/fluent.scss +19 -1
- package/styles/fluent2-lite.css +735 -0
- package/styles/fluent2-lite.scss +18 -0
- package/styles/fluent2.css +758 -0
- package/styles/fluent2.scss +19 -0
- package/styles/highcontrast-light-lite.css +491 -0
- package/styles/highcontrast-light-lite.scss +18 -0
- package/styles/highcontrast-light.css +185 -103
- package/styles/highcontrast-light.scss +19 -1
- package/styles/highcontrast-lite.css +498 -0
- package/styles/highcontrast-lite.scss +18 -0
- package/styles/highcontrast.css +196 -107
- package/styles/highcontrast.scss +19 -1
- package/styles/material-dark-lite.css +567 -0
- package/styles/material-dark-lite.scss +18 -0
- package/styles/material-dark.css +220 -105
- package/styles/material-dark.scss +19 -1
- package/styles/material-lite.css +591 -0
- package/styles/material-lite.scss +18 -0
- package/styles/material.css +234 -129
- package/styles/material.scss +19 -1
- package/styles/material3-dark-lite.css +578 -0
- package/styles/material3-dark-lite.scss +18 -0
- package/styles/material3-dark.css +220 -185
- package/styles/material3-dark.scss +19 -1
- package/styles/material3-lite.css +580 -0
- package/styles/material3-lite.scss +18 -0
- package/styles/material3.css +221 -240
- package/styles/material3.scss +19 -1
- package/styles/tailwind-dark-lite.css +518 -0
- package/styles/tailwind-dark-lite.scss +18 -0
- package/styles/tailwind-dark.css +196 -103
- package/styles/tailwind-dark.scss +19 -1
- package/styles/tailwind-lite.css +518 -0
- package/styles/tailwind-lite.scss +18 -0
- package/styles/tailwind.css +196 -103
- package/styles/tailwind.scss +19 -1
- package/styles/tailwind3-lite.css +561 -0
- package/styles/tailwind3-lite.scss +18 -0
- package/styles/tailwind3.css +581 -0
- package/styles/tailwind3.scss +19 -0
- package/styles/treegrid/_all.scss +2 -2
- package/styles/treegrid/_bds-definition.scss +24 -28
- package/styles/treegrid/_bigger.scss +66 -0
- package/styles/treegrid/_bootstrap-dark-definition.scss +29 -30
- package/styles/treegrid/_bootstrap-definition.scss +29 -30
- package/styles/treegrid/_bootstrap4-definition.scss +29 -30
- package/styles/treegrid/_bootstrap5-definition.scss +24 -28
- package/styles/treegrid/_bootstrap5.3-definition.scss +24 -0
- package/styles/treegrid/_fabric-dark-definition.scss +29 -30
- package/styles/treegrid/_fabric-definition.scss +29 -30
- package/styles/treegrid/_fluent-definition.scss +25 -29
- package/styles/treegrid/_fluent2-definition.scss +24 -0
- package/styles/treegrid/_fusionnew-definition.scss +24 -28
- package/styles/treegrid/_highcontrast-definition.scss +29 -30
- package/styles/treegrid/_highcontrast-light-definition.scss +29 -30
- package/styles/treegrid/_icons.scss +47 -37
- package/styles/treegrid/_layout.scss +530 -455
- package/styles/treegrid/_material-dark-definition.scss +29 -30
- package/styles/treegrid/_material-definition.scss +29 -30
- package/styles/treegrid/_material3-definition.scss +24 -28
- package/styles/treegrid/_tailwind-definition.scss +24 -28
- package/styles/treegrid/_tailwind3-definition.scss +24 -0
- package/styles/treegrid/_theme.scss +1 -1
- package/styles/treegrid/bds.css +765 -0
- package/styles/treegrid/bds.scss +19 -0
- package/styles/treegrid/bootstrap-dark.css +187 -117
- package/styles/treegrid/bootstrap-dark.scss +1 -0
- package/styles/treegrid/bootstrap.css +190 -121
- package/styles/treegrid/bootstrap.scss +1 -0
- package/styles/treegrid/bootstrap4.css +194 -133
- package/styles/treegrid/bootstrap4.scss +1 -0
- package/styles/treegrid/bootstrap5-dark.css +189 -123
- package/styles/treegrid/bootstrap5-dark.scss +1 -0
- package/styles/treegrid/bootstrap5.3.css +569 -0
- package/styles/treegrid/bootstrap5.3.scss +19 -0
- package/styles/treegrid/bootstrap5.css +188 -122
- package/styles/treegrid/bootstrap5.scss +1 -0
- package/styles/treegrid/fabric-dark.css +188 -118
- package/styles/treegrid/fabric-dark.scss +1 -0
- package/styles/treegrid/fabric.css +188 -111
- package/styles/treegrid/fabric.scss +1 -0
- package/styles/treegrid/fluent-dark.css +195 -116
- package/styles/treegrid/fluent-dark.scss +1 -0
- package/styles/treegrid/fluent.css +195 -116
- package/styles/treegrid/fluent.scss +1 -0
- package/styles/treegrid/fluent2.css +758 -0
- package/styles/treegrid/fluent2.scss +19 -0
- package/styles/treegrid/highcontrast-light.css +185 -103
- package/styles/treegrid/highcontrast-light.scss +1 -0
- package/styles/treegrid/highcontrast.css +196 -107
- package/styles/treegrid/highcontrast.scss +1 -0
- package/styles/treegrid/icons/_bds.scss +37 -37
- package/styles/treegrid/icons/_bootstrap-dark.scss +47 -37
- package/styles/treegrid/icons/_bootstrap.scss +47 -37
- package/styles/treegrid/icons/_bootstrap4.scss +47 -37
- package/styles/treegrid/icons/_bootstrap5.3.scss +47 -0
- package/styles/treegrid/icons/_bootstrap5.scss +47 -37
- package/styles/treegrid/icons/_fabric-dark.scss +47 -37
- package/styles/treegrid/icons/_fabric.scss +47 -37
- package/styles/treegrid/icons/_fluent.scss +47 -37
- package/styles/treegrid/icons/_fluent2.scss +47 -0
- package/styles/treegrid/icons/_fusionnew.scss +30 -26
- package/styles/treegrid/icons/_highcontrast-light.scss +47 -37
- package/styles/treegrid/icons/_highcontrast.scss +47 -37
- package/styles/treegrid/icons/_material-dark.scss +47 -37
- package/styles/treegrid/icons/_material.scss +47 -37
- package/styles/treegrid/icons/_material3.scss +47 -37
- package/styles/treegrid/icons/_tailwind-dark.scss +47 -37
- package/styles/treegrid/icons/_tailwind.scss +47 -37
- package/styles/treegrid/icons/_tailwind3.scss +47 -0
- package/styles/treegrid/material-dark.css +220 -105
- package/styles/treegrid/material-dark.scss +1 -0
- package/styles/treegrid/material.css +234 -129
- package/styles/treegrid/material.scss +1 -0
- package/styles/treegrid/material3-dark.css +220 -185
- package/styles/treegrid/material3-dark.scss +2 -1
- package/styles/treegrid/material3.css +221 -240
- package/styles/treegrid/material3.scss +2 -1
- package/styles/treegrid/tailwind-dark.css +196 -103
- package/styles/treegrid/tailwind-dark.scss +1 -0
- package/styles/treegrid/tailwind.css +196 -103
- package/styles/treegrid/tailwind.scss +1 -0
- package/styles/treegrid/tailwind3.css +581 -0
- package/styles/treegrid/tailwind3.scss +19 -0
- package/CHANGELOG.md +0 -264
- package/helpers/e2e/index.d.ts +0 -1
- package/helpers/e2e/index.js +0 -8
- package/helpers/e2e/treegridhelper.d.ts +0 -21
- package/helpers/e2e/treegridhelper.js +0 -83
- package/tslint.json +0 -111
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Component, addClass, createElement, EventHandler, isNullOrUndefined,
|
|
1
|
+
import { Component, addClass, createElement, EventHandler, isNullOrUndefined, ModuleDeclaration, extend, merge, SanitizeHtmlHelper} from '@syncfusion/ej2-base';
|
|
2
2
|
import {ComponentModel} from '@syncfusion/ej2-base';
|
|
3
3
|
|
|
4
4
|
/**
|
|
@@ -7,1067 +7,1067 @@ import {ComponentModel} from '@syncfusion/ej2-base';
|
|
|
7
7
|
export interface TreeGridModel extends ComponentModel{
|
|
8
8
|
|
|
9
9
|
/**
|
|
10
|
-
* Gets or sets the number of frozen rows.
|
|
11
|
-
*
|
|
12
|
-
* @default 0
|
|
13
|
-
*/
|
|
14
|
-
frozenRows?: number;
|
|
10
|
+
* Gets or sets the number of frozen rows.
|
|
11
|
+
*
|
|
12
|
+
* @default 0
|
|
13
|
+
*/
|
|
14
|
+
frozenRows?: number;
|
|
15
15
|
|
|
16
16
|
/**
|
|
17
|
-
* Gets or sets the number of frozen columns.
|
|
18
|
-
*
|
|
19
|
-
* @default 0
|
|
20
|
-
*/
|
|
21
|
-
frozenColumns?: number;
|
|
17
|
+
* Gets or sets the number of frozen columns.
|
|
18
|
+
*
|
|
19
|
+
* @default 0
|
|
20
|
+
*/
|
|
21
|
+
frozenColumns?: number;
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
|
-
* Defines the mode of clip. The available modes are,
|
|
25
|
-
* ```props
|
|
26
|
-
* * Clip :- Truncates the cell content when it overflows its area.
|
|
27
|
-
* * Ellipsis :- Displays ellipsis when the cell content overflows its area.
|
|
28
|
-
* * EllipsisWithTooltip :- Displays ellipsis when the cell content overflows its area,
|
|
29
|
-
* ```
|
|
30
|
-
* also it will display the tooltip while hover on ellipsis is applied.
|
|
31
|
-
*
|
|
32
|
-
* @default Syncfusion.EJ2.Grids.ClipMode.Ellipsis
|
|
33
|
-
* @aspType Syncfusion.EJ2.Grids.ClipMode
|
|
34
|
-
* @isEnumeration true
|
|
35
|
-
*/
|
|
36
|
-
clipMode?: ClipMode;
|
|
24
|
+
* Defines the mode of clip. The available modes are,
|
|
25
|
+
* ```props
|
|
26
|
+
* * Clip :- Truncates the cell content when it overflows its area.
|
|
27
|
+
* * Ellipsis :- Displays ellipsis when the cell content overflows its area.
|
|
28
|
+
* * EllipsisWithTooltip :- Displays ellipsis when the cell content overflows its area,
|
|
29
|
+
* ```
|
|
30
|
+
* also it will display the tooltip while hover on ellipsis is applied.
|
|
31
|
+
*
|
|
32
|
+
* @default Syncfusion.EJ2.Grids.ClipMode.Ellipsis
|
|
33
|
+
* @aspType Syncfusion.EJ2.Grids.ClipMode
|
|
34
|
+
* @isEnumeration true
|
|
35
|
+
*/
|
|
36
|
+
clipMode?: ClipMode;
|
|
37
37
|
|
|
38
38
|
/**
|
|
39
|
-
* Defines the schema of dataSource.
|
|
40
|
-
* If the `columns` declaration is empty or undefined then the `columns` are automatically generated from data source.
|
|
41
|
-
* {% codeBlock src='treegrid/columns/index.md' %}{% endcodeBlock %}
|
|
42
|
-
*
|
|
43
|
-
* @default []
|
|
44
|
-
*/
|
|
45
|
-
columns?: ColumnModel[] | string[] | Column[];
|
|
39
|
+
* Defines the schema of dataSource.
|
|
40
|
+
* If the `columns` declaration is empty or undefined then the `columns` are automatically generated from data source.
|
|
41
|
+
* {% codeBlock src='treegrid/columns/index.md' %}{% endcodeBlock %}
|
|
42
|
+
*
|
|
43
|
+
* @default []
|
|
44
|
+
*/
|
|
45
|
+
columns?: ColumnModel[] | string[] | Column[];
|
|
46
46
|
|
|
47
|
-
/**
|
|
48
|
-
* Specifies the mapping property path for child records in data source
|
|
49
|
-
* {% codeBlock src='treegrid/childMapping/index.md' %}{% endcodeBlock %}
|
|
50
|
-
*
|
|
51
|
-
* @default null
|
|
52
|
-
*/
|
|
53
|
-
childMapping?: string;
|
|
47
|
+
/**
|
|
48
|
+
* Specifies the mapping property path for child records in data source
|
|
49
|
+
* {% codeBlock src='treegrid/childMapping/index.md' %}{% endcodeBlock %}
|
|
50
|
+
*
|
|
51
|
+
* @default null
|
|
52
|
+
*/
|
|
53
|
+
childMapping?: string;
|
|
54
54
|
|
|
55
55
|
/**
|
|
56
|
-
* Specifies whether record is parent or not for the remote data binding
|
|
57
|
-
*
|
|
58
|
-
* @default null
|
|
59
|
-
*/
|
|
60
|
-
hasChildMapping?: string;
|
|
56
|
+
* Specifies whether record is parent or not for the remote data binding
|
|
57
|
+
*
|
|
58
|
+
* @default null
|
|
59
|
+
*/
|
|
60
|
+
hasChildMapping?: string;
|
|
61
61
|
|
|
62
62
|
/**
|
|
63
|
-
* Specifies the index of the column that needs to have the expander button.
|
|
64
|
-
*
|
|
65
|
-
* @default 0
|
|
66
|
-
*/
|
|
67
|
-
treeColumnIndex?: number;
|
|
63
|
+
* Specifies the index of the column that needs to have the expander button.
|
|
64
|
+
*
|
|
65
|
+
* @default 0
|
|
66
|
+
*/
|
|
67
|
+
treeColumnIndex?: number;
|
|
68
68
|
|
|
69
69
|
/**
|
|
70
|
-
* Specifies the name of the field in the dataSource, which contains the id of that row.
|
|
71
|
-
* {% codeBlock src='treegrid/idMapping/index.md' %}{% endcodeBlock %}
|
|
72
|
-
*
|
|
73
|
-
* @default null
|
|
74
|
-
*/
|
|
75
|
-
idMapping?: string;
|
|
70
|
+
* Specifies the name of the field in the dataSource, which contains the id of that row.
|
|
71
|
+
* {% codeBlock src='treegrid/idMapping/index.md' %}{% endcodeBlock %}
|
|
72
|
+
*
|
|
73
|
+
* @default null
|
|
74
|
+
*/
|
|
75
|
+
idMapping?: string;
|
|
76
76
|
|
|
77
77
|
/**
|
|
78
|
-
* Specifies the name of the field in the dataSource, which contains the parent’s id
|
|
79
|
-
* {% codeBlock src='treegrid/parentIdMapping/index.md' %}{% endcodeBlock %}
|
|
80
|
-
*
|
|
81
|
-
* @default null
|
|
82
|
-
*/
|
|
83
|
-
parentIdMapping?: string;
|
|
78
|
+
* Specifies the name of the field in the dataSource, which contains the parent’s id
|
|
79
|
+
* {% codeBlock src='treegrid/parentIdMapping/index.md' %}{% endcodeBlock %}
|
|
80
|
+
*
|
|
81
|
+
* @default null
|
|
82
|
+
*/
|
|
83
|
+
parentIdMapping?: string;
|
|
84
84
|
|
|
85
85
|
/**
|
|
86
|
-
* Specifies whether to load all the rows in collapsed state when the TreeGrid is rendered for the first time.
|
|
87
|
-
*
|
|
88
|
-
* @default false
|
|
89
|
-
*/
|
|
90
|
-
enableCollapseAll?: boolean;
|
|
86
|
+
* Specifies whether to load all the rows in collapsed state when the TreeGrid is rendered for the first time.
|
|
87
|
+
*
|
|
88
|
+
* @default false
|
|
89
|
+
*/
|
|
90
|
+
enableCollapseAll?: boolean;
|
|
91
91
|
|
|
92
92
|
/**
|
|
93
|
-
* Specifies the mapping property path for the expand status of a record in data source.
|
|
94
|
-
*
|
|
95
|
-
* @default null
|
|
96
|
-
*/
|
|
97
|
-
expandStateMapping?: string;
|
|
93
|
+
* Specifies the mapping property path for the expand status of a record in data source.
|
|
94
|
+
*
|
|
95
|
+
* @default null
|
|
96
|
+
*/
|
|
97
|
+
expandStateMapping?: string;
|
|
98
98
|
|
|
99
99
|
/**
|
|
100
|
-
* If `allowRowDragAndDrop` is set to true, you can drag and drop treegrid rows at another treegrid.
|
|
101
|
-
*
|
|
102
|
-
* @default false
|
|
103
|
-
*/
|
|
104
|
-
allowRowDragAndDrop?: boolean;
|
|
100
|
+
* If `allowRowDragAndDrop` is set to true, you can drag and drop treegrid rows at another treegrid.
|
|
101
|
+
*
|
|
102
|
+
* @default false
|
|
103
|
+
*/
|
|
104
|
+
allowRowDragAndDrop?: boolean;
|
|
105
105
|
|
|
106
106
|
/**
|
|
107
|
-
* It is used to render TreeGrid table rows.
|
|
108
|
-
* {% codeBlock src='treegrid/dataSource/index.md' %}{% endcodeBlock %}
|
|
109
|
-
*
|
|
110
|
-
* @default []
|
|
111
|
-
* @isGenericType true
|
|
112
|
-
* @isDataSource true
|
|
113
|
-
*/
|
|
114
|
-
dataSource?: Object | DataManager;
|
|
107
|
+
* It is used to render TreeGrid table rows.
|
|
108
|
+
* {% codeBlock src='treegrid/dataSource/index.md' %}{% endcodeBlock %}
|
|
109
|
+
*
|
|
110
|
+
* @default []
|
|
111
|
+
* @isGenericType true
|
|
112
|
+
* @isDataSource true
|
|
113
|
+
*/
|
|
114
|
+
dataSource?: Object | DataManager;
|
|
115
115
|
|
|
116
116
|
/**
|
|
117
|
-
* Defines the external [`Query`](https://ej2.syncfusion.com/documentation/data/api-query.html)
|
|
118
|
-
* that will be executed along with data processing.
|
|
119
|
-
*
|
|
120
|
-
* @default null
|
|
121
|
-
*/
|
|
122
|
-
query?: Query;
|
|
117
|
+
* Defines the external [`Query`](https://ej2.syncfusion.com/documentation/data/api-query.html)
|
|
118
|
+
* that will be executed along with data processing.
|
|
119
|
+
*
|
|
120
|
+
* @default null
|
|
121
|
+
*/
|
|
122
|
+
query?: Query;
|
|
123
123
|
|
|
124
124
|
/**
|
|
125
|
-
* @hidden
|
|
126
|
-
*/
|
|
127
|
-
cloneQuery?: Query;
|
|
125
|
+
* @hidden
|
|
126
|
+
*/
|
|
127
|
+
cloneQuery?: Query;
|
|
128
128
|
|
|
129
129
|
/**
|
|
130
|
-
* Defines the print modes. The available print modes are
|
|
131
|
-
* ```props
|
|
132
|
-
* * AllPages :- Prints all pages of the TreeGrid.
|
|
133
|
-
* * CurrentPage :- Prints the current page of the TreeGrid.
|
|
134
|
-
* ```
|
|
135
|
-
*
|
|
136
|
-
* @default Syncfusion.EJ2.Grids.PrintMode.AllPages
|
|
137
|
-
* @isEnumeration true
|
|
138
|
-
* @aspType Syncfusion.EJ2.Grids.PrintMode
|
|
139
|
-
*/
|
|
140
|
-
printMode?: PrintMode;
|
|
130
|
+
* Defines the print modes. The available print modes are
|
|
131
|
+
* ```props
|
|
132
|
+
* * AllPages :- Prints all pages of the TreeGrid.
|
|
133
|
+
* * CurrentPage :- Prints the current page of the TreeGrid.
|
|
134
|
+
* ```
|
|
135
|
+
*
|
|
136
|
+
* @default Syncfusion.EJ2.Grids.PrintMode.AllPages
|
|
137
|
+
* @isEnumeration true
|
|
138
|
+
* @aspType Syncfusion.EJ2.Grids.PrintMode
|
|
139
|
+
*/
|
|
140
|
+
printMode?: PrintMode;
|
|
141
141
|
|
|
142
142
|
/**
|
|
143
|
-
* If `allowPaging` is set to true, pager renders.
|
|
144
|
-
*
|
|
145
|
-
* @default false
|
|
146
|
-
*/
|
|
147
|
-
allowPaging?: boolean;
|
|
143
|
+
* If `allowPaging` is set to true, pager renders.
|
|
144
|
+
*
|
|
145
|
+
* @default false
|
|
146
|
+
*/
|
|
147
|
+
allowPaging?: boolean;
|
|
148
148
|
|
|
149
149
|
/**
|
|
150
|
-
* If `loadChildOnDemand` is enabled, parent records are render in expanded state.
|
|
151
|
-
*
|
|
152
|
-
* @default false
|
|
153
|
-
*/
|
|
154
|
-
loadChildOnDemand?: boolean;
|
|
150
|
+
* If `loadChildOnDemand` is enabled, parent records are render in expanded state.
|
|
151
|
+
*
|
|
152
|
+
* @default false
|
|
153
|
+
*/
|
|
154
|
+
loadChildOnDemand?: boolean;
|
|
155
155
|
|
|
156
156
|
/**
|
|
157
|
-
* If `allowTextWrap` set to true,
|
|
158
|
-
* then text content will wrap to the next line when its text content exceeds the width of the Column Cells.
|
|
159
|
-
*
|
|
160
|
-
* @default false
|
|
161
|
-
*/
|
|
162
|
-
allowTextWrap?: boolean;
|
|
157
|
+
* If `allowTextWrap` set to true,
|
|
158
|
+
* then text content will wrap to the next line when its text content exceeds the width of the Column Cells.
|
|
159
|
+
*
|
|
160
|
+
* @default false
|
|
161
|
+
*/
|
|
162
|
+
allowTextWrap?: boolean;
|
|
163
163
|
|
|
164
164
|
/**
|
|
165
|
-
* Configures the text wrap in the TreeGrid.
|
|
166
|
-
*
|
|
167
|
-
* @default {wrapMode:"Both"}
|
|
168
|
-
*/
|
|
169
|
-
textWrapSettings?: TextWrapSettingsModel;
|
|
165
|
+
* Configures the text wrap in the TreeGrid.
|
|
166
|
+
*
|
|
167
|
+
* @default {wrapMode:"Both"}
|
|
168
|
+
*/
|
|
169
|
+
textWrapSettings?: TextWrapSettingsModel;
|
|
170
170
|
|
|
171
171
|
/**
|
|
172
|
-
* If `allowReordering` is set to true, TreeGrid columns can be reordered.
|
|
173
|
-
* Reordering can be done by drag and drop of a particular column from one index to another index.
|
|
174
|
-
* > If TreeGrid is rendered with stacked headers, reordering is allowed only at the same level as the column headers.
|
|
175
|
-
*
|
|
176
|
-
* @default false
|
|
177
|
-
*/
|
|
178
|
-
allowReordering?: boolean;
|
|
172
|
+
* If `allowReordering` is set to true, TreeGrid columns can be reordered.
|
|
173
|
+
* Reordering can be done by drag and drop of a particular column from one index to another index.
|
|
174
|
+
* > If TreeGrid is rendered with stacked headers, reordering is allowed only at the same level as the column headers.
|
|
175
|
+
*
|
|
176
|
+
* @default false
|
|
177
|
+
*/
|
|
178
|
+
allowReordering?: boolean;
|
|
179
179
|
|
|
180
180
|
/**
|
|
181
|
-
* If `allowResizing` is set to true, TreeGrid columns can be resized.
|
|
182
|
-
*
|
|
183
|
-
* @default false
|
|
184
|
-
*/
|
|
185
|
-
allowResizing?: boolean;
|
|
181
|
+
* If `allowResizing` is set to true, TreeGrid columns can be resized.
|
|
182
|
+
*
|
|
183
|
+
* @default false
|
|
184
|
+
*/
|
|
185
|
+
allowResizing?: boolean;
|
|
186
186
|
|
|
187
187
|
/**
|
|
188
|
-
* If `autoCheckHierarchy` is set to true, hierarchy checkbox selection is enabled in TreeGrid.
|
|
189
|
-
*
|
|
190
|
-
* @default false
|
|
191
|
-
*/
|
|
192
|
-
autoCheckHierarchy?: boolean;
|
|
188
|
+
* If `autoCheckHierarchy` is set to true, hierarchy checkbox selection is enabled in TreeGrid.
|
|
189
|
+
*
|
|
190
|
+
* @default false
|
|
191
|
+
*/
|
|
192
|
+
autoCheckHierarchy?: boolean;
|
|
193
193
|
|
|
194
194
|
/**
|
|
195
|
-
* Configures the pager in the TreeGrid.
|
|
196
|
-
*
|
|
197
|
-
* @default {currentPage: 1, pageSize: 12, pageCount: 8, enableQueryString: false, pageSizes: false, template: null}
|
|
198
|
-
*/
|
|
199
|
-
pageSettings?: PageSettingsModel;
|
|
195
|
+
* Configures the pager in the TreeGrid.
|
|
196
|
+
*
|
|
197
|
+
* @default {currentPage: 1, pageSize: 12, pageCount: 8, enableQueryString: false, pageSizes: false, template: null}
|
|
198
|
+
*/
|
|
199
|
+
pageSettings?: PageSettingsModel;
|
|
200
200
|
|
|
201
201
|
/**
|
|
202
|
-
* Configures the row drop settings of the TreeGrid.
|
|
203
|
-
*/
|
|
204
|
-
rowDropSettings?: RowDropSettingsModel;
|
|
202
|
+
* Configures the row drop settings of the TreeGrid.
|
|
203
|
+
*/
|
|
204
|
+
rowDropSettings?: RowDropSettingsModel;
|
|
205
205
|
|
|
206
206
|
/**
|
|
207
|
-
* Defines the currencyCode format of the Tree Grid columns
|
|
208
|
-
*
|
|
209
|
-
* @private
|
|
210
|
-
*/
|
|
211
|
-
currencyCode?: string;
|
|
207
|
+
* Defines the currencyCode format of the Tree Grid columns
|
|
208
|
+
*
|
|
209
|
+
* @private
|
|
210
|
+
*/
|
|
211
|
+
currencyCode?: string;
|
|
212
212
|
|
|
213
213
|
/**
|
|
214
|
-
* @hidden
|
|
215
|
-
* It used to render pager template
|
|
216
|
-
* @default null
|
|
217
|
-
* @aspType string
|
|
218
|
-
*/
|
|
219
|
-
pagerTemplate?: string | Function;
|
|
214
|
+
* @hidden
|
|
215
|
+
* It used to render pager template
|
|
216
|
+
* @default null
|
|
217
|
+
* @aspType string
|
|
218
|
+
*/
|
|
219
|
+
pagerTemplate?: string | Function;
|
|
220
220
|
|
|
221
221
|
/**
|
|
222
|
-
* If `showColumnMenu` set to true, then it will enable the column menu options in each columns.
|
|
223
|
-
*
|
|
224
|
-
* > Check the [`Column menu`](../../treegrid/columns/#column-menu/) for its configuration.
|
|
225
|
-
*
|
|
226
|
-
* @default false
|
|
227
|
-
*/
|
|
228
|
-
showColumnMenu?: boolean;
|
|
229
|
-
|
|
230
|
-
/**
|
|
231
|
-
* If `showColumnChooser` is set to true, it allows you to dynamically show or hide columns.
|
|
232
|
-
*
|
|
233
|
-
* @default false
|
|
234
|
-
*/
|
|
235
|
-
showColumnChooser?: boolean;
|
|
222
|
+
* If `showColumnMenu` set to true, then it will enable the column menu options in each columns.
|
|
223
|
+
*
|
|
224
|
+
* > Check the [`Column menu`](../../treegrid/columns/#column-menu/) for its configuration.
|
|
225
|
+
*
|
|
226
|
+
* @default false
|
|
227
|
+
*/
|
|
228
|
+
showColumnMenu?: boolean;
|
|
229
|
+
|
|
230
|
+
/**
|
|
231
|
+
* If `showColumnChooser` is set to true, it allows you to dynamically show or hide columns.
|
|
232
|
+
*
|
|
233
|
+
* @default false
|
|
234
|
+
*/
|
|
235
|
+
showColumnChooser?: boolean;
|
|
236
236
|
|
|
237
237
|
/**
|
|
238
|
-
* If `allowSorting` is set to true, it allows sorting of treegrid records when column header is clicked.
|
|
239
|
-
*
|
|
240
|
-
* @default false
|
|
241
|
-
*/
|
|
242
|
-
allowSorting?: boolean;
|
|
243
|
-
|
|
244
|
-
/**
|
|
245
|
-
* If `allowMultiSorting` set to true, then it will allow the user to sort multiple column in the treegrid.
|
|
246
|
-
* > `allowSorting` should be true.
|
|
247
|
-
*
|
|
248
|
-
* @default true
|
|
249
|
-
*/
|
|
250
|
-
allowMultiSorting?: boolean;
|
|
251
|
-
|
|
252
|
-
/**
|
|
253
|
-
* Configures the sort settings of the TreeGrid.
|
|
254
|
-
*
|
|
255
|
-
* @default {columns:[]}
|
|
256
|
-
*/
|
|
257
|
-
sortSettings?: SortSettingsModel;
|
|
258
|
-
|
|
259
|
-
/**
|
|
260
|
-
* Configures the TreeGrid aggregate rows.
|
|
261
|
-
* > Check the [`Aggregates`](../../treegrid/aggregates/aggregates) for its configuration.
|
|
262
|
-
*
|
|
263
|
-
* @default []
|
|
264
|
-
*/
|
|
265
|
-
aggregates?: AggregateRowModel[];
|
|
266
|
-
|
|
267
|
-
/**
|
|
268
|
-
* Configures the edit settings.
|
|
269
|
-
*
|
|
270
|
-
* @default { allowAdding: false, allowEditing: false, allowDeleting: false, mode:'Normal',
|
|
271
|
-
* allowEditOnDblClick: true, showConfirmDialog: true, showDeleteConfirmDialog: false }
|
|
272
|
-
*/
|
|
273
|
-
editSettings?: EditSettingsModel;
|
|
274
|
-
|
|
275
|
-
/**
|
|
276
|
-
* If `allowFiltering` is set to true the filter bar will be displayed.
|
|
277
|
-
* If set to false the filter bar will not be displayed.
|
|
278
|
-
* Filter bar allows the user to filter tree grid records with required criteria.
|
|
279
|
-
*
|
|
280
|
-
* @default false
|
|
281
|
-
*/
|
|
282
|
-
allowFiltering?: boolean;
|
|
283
|
-
|
|
284
|
-
/**
|
|
285
|
-
* The detail template allows you to show or hide additional information about a particular row.
|
|
286
|
-
*
|
|
287
|
-
* > It accepts either the [template string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals)
|
|
288
|
-
* or the HTML element ID.
|
|
289
|
-
*
|
|
290
|
-
* @aspType string
|
|
291
|
-
*/
|
|
292
|
-
detailTemplate?: string | Function;
|
|
293
|
-
|
|
294
|
-
/**
|
|
295
|
-
* Configures the filter settings of the TreeGrid.
|
|
296
|
-
*
|
|
297
|
-
* @default {columns: [], type: 'FilterBar', mode: 'Immediate', showFilterBarStatus: true, immediateModeDelay: 1500 , operators: {}}
|
|
298
|
-
*/
|
|
299
|
-
filterSettings?: FilterSettingsModel;
|
|
300
|
-
|
|
301
|
-
/**
|
|
302
|
-
* Configures the search settings of the TreeGrid.
|
|
303
|
-
*
|
|
304
|
-
* @default {search: [] , operators: {}}
|
|
305
|
-
*/
|
|
306
|
-
searchSettings?: SearchSettingsModel;
|
|
307
|
-
|
|
308
|
-
/**
|
|
309
|
-
* `toolbar` defines the ToolBar items of the TreeGrid.
|
|
310
|
-
* It contains built-in and custom toolbar items.
|
|
311
|
-
* If a string value is assigned to the `toolbar` option, it is considered as the template for the whole TreeGrid ToolBar.
|
|
312
|
-
* If an array value is assigned, it is considered as the list of built-in and custom toolbar items in the TreeGrid's Toolbar.
|
|
313
|
-
* <br><br>
|
|
314
|
-
* The available built-in ToolBar items are:
|
|
315
|
-
* * Search: Searches records by the given key.
|
|
316
|
-
* * ExpandAll: Expands all the rows in TreeGrid
|
|
317
|
-
* * CollapseAll: Collapses all the rows in TreeGrid
|
|
318
|
-
* * ExcelExport - Export the TreeGrid to Excel(excelExport() method manually to make export.)
|
|
319
|
-
* * PdfExport - Export the TreeGrid to PDF(pdfExport() method manually to make export.)
|
|
320
|
-
* * CsvExport - Export the TreeGrid to CSV(csvExport() method manually to make export.)<br><br>
|
|
321
|
-
* The following code example implements the custom toolbar items.
|
|
322
|
-
*
|
|
323
|
-
* @default null
|
|
324
|
-
*/
|
|
325
|
-
toolbar?: (ToolbarItems | string| ItemModel | ToolbarItem)[];
|
|
326
|
-
|
|
327
|
-
/**
|
|
328
|
-
* @hidden
|
|
329
|
-
* It used to render toolbar template
|
|
330
|
-
* @default null
|
|
331
|
-
* @aspType string
|
|
332
|
-
*/
|
|
333
|
-
toolbarTemplate?: string | Function;
|
|
334
|
-
|
|
335
|
-
/**
|
|
336
|
-
* Defines the mode of TreeGrid lines. The available modes are,
|
|
337
|
-
* ```props
|
|
338
|
-
* * Both :- Displays both horizontal and vertical TreeGrid lines.
|
|
339
|
-
* * None :- No TreeGrid lines are displayed.
|
|
340
|
-
* * Horizontal :- Displays the horizontal TreeGrid lines only.
|
|
341
|
-
* * Vertical :- Displays the vertical TreeGrid lines only.
|
|
342
|
-
* * Default :- Displays TreeGrid lines based on the theme.
|
|
343
|
-
* ```
|
|
344
|
-
*
|
|
345
|
-
* @default Syncfusion.EJ2.Grids.GridLine.Default
|
|
346
|
-
* @isEnumeration true
|
|
347
|
-
* @aspType Syncfusion.EJ2.Grids.GridLine
|
|
348
|
-
*/
|
|
349
|
-
gridLines?: GridLine;
|
|
350
|
-
|
|
351
|
-
/**
|
|
352
|
-
* `contextMenuItems` defines both built-in and custom context menu items.
|
|
353
|
-
* <br><br>
|
|
354
|
-
* The available built-in items are,
|
|
355
|
-
* * `AutoFitAll` - Auto fit the size of all columns.
|
|
356
|
-
* * `AutoFit` - Auto fit the current column.
|
|
357
|
-
* * `Edit` - Edit the current record.
|
|
358
|
-
* * `Delete` - Delete the current record.
|
|
359
|
-
* * `Save` - Save the edited record.
|
|
360
|
-
* * `Cancel` - Cancel the edited state.
|
|
361
|
-
* * `PdfExport` - Export the grid as Pdf format.
|
|
362
|
-
* * `ExcelExport` - Export the grid as Excel format.
|
|
363
|
-
* * `CsvExport` - Export the grid as CSV format.
|
|
364
|
-
* * `SortAscending` - Sort the current column in ascending order.
|
|
365
|
-
* * `SortDescending` - Sort the current column in descending order.
|
|
366
|
-
* * `FirstPage` - Go to the first page.
|
|
367
|
-
* * `PrevPage` - Go to the previous page.
|
|
368
|
-
* * `LastPage` - Go to the last page.
|
|
369
|
-
* * `NextPage` - Go to the next page.
|
|
370
|
-
*
|
|
371
|
-
* @default null
|
|
372
|
-
*/
|
|
373
|
-
contextMenuItems?: ContextMenuItem[] | ContextMenuItemModel[];
|
|
374
|
-
|
|
375
|
-
/**
|
|
376
|
-
* `columnMenuItems` defines both built-in and custom column menu items.
|
|
377
|
-
* <br><br>
|
|
378
|
-
* The available built-in items are,
|
|
379
|
-
* * `AutoFitAll` - Auto fit the size of all columns.
|
|
380
|
-
* * `AutoFit` - Auto fit the current column.
|
|
381
|
-
* * `SortAscending` - Sort the current column in ascending order.
|
|
382
|
-
* * `SortDescending` - Sort the current column in descending order.
|
|
383
|
-
* * `Filter` - Filter options will show based on filterSettings property like filterbar, menu filter.
|
|
384
|
-
*
|
|
385
|
-
* @default null
|
|
386
|
-
*/
|
|
387
|
-
columnMenuItems?: ColumnMenuItem[] | ColumnMenuItemModel[];
|
|
388
|
-
|
|
389
|
-
/**
|
|
390
|
-
* The row template that renders customized rows from the given template.
|
|
391
|
-
* By default, TreeGrid renders a table row for every data source item.
|
|
392
|
-
* > * It accepts either [template string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals)
|
|
393
|
-
* or HTML element ID.
|
|
394
|
-
* > * The row template must be a table row.
|
|
395
|
-
*
|
|
396
|
-
* > Check the [`Row Template`](../../treegrid/row) customization.
|
|
397
|
-
*
|
|
398
|
-
* @aspType string
|
|
399
|
-
*/
|
|
400
|
-
rowTemplate?: string | Function;
|
|
401
|
-
|
|
402
|
-
/**
|
|
403
|
-
* `copyHierarchyMode` Defines the copy clipboard types.
|
|
404
|
-
* <br><br>
|
|
405
|
-
* The available built-in items are,
|
|
406
|
-
* * `Parent` - Copy the selected data with parent record.
|
|
407
|
-
* * `Child` - Copy the selected data with child record.
|
|
408
|
-
* * `Both` - Copy the selected data with both parent and child record.
|
|
409
|
-
* * `None` - Copy only the selected record.
|
|
410
|
-
*
|
|
411
|
-
* @default Parent
|
|
412
|
-
*/
|
|
413
|
-
copyHierarchyMode?: CopyHierarchyType;
|
|
414
|
-
|
|
415
|
-
/**
|
|
416
|
-
* Defines the height of TreeGrid rows.
|
|
417
|
-
*
|
|
418
|
-
* @default null
|
|
419
|
-
*/
|
|
420
|
-
rowHeight?: number;
|
|
421
|
-
|
|
422
|
-
/**
|
|
423
|
-
* If `enableAltRow` is set to true, the TreeGrid will render with `e-altrow` CSS class to the alternative tr elements.
|
|
424
|
-
* > Check the [`AltRow`](../../treegrid/row/#styling-alternate-rows/) to customize the styles of alternative rows.
|
|
425
|
-
*
|
|
426
|
-
* @default true
|
|
427
|
-
*/
|
|
428
|
-
enableAltRow?: boolean;
|
|
429
|
-
|
|
430
|
-
/**
|
|
431
|
-
* Enables or disables the key board interaction of TreeGrid.
|
|
432
|
-
*
|
|
433
|
-
* @hidden
|
|
434
|
-
* @default true
|
|
435
|
-
*/
|
|
436
|
-
allowKeyboard?: boolean;
|
|
437
|
-
|
|
438
|
-
/**
|
|
439
|
-
* If `enableHover` is set to true, the row hover is enabled in the TreeGrid.
|
|
440
|
-
*
|
|
441
|
-
* @default false
|
|
442
|
-
*/
|
|
443
|
-
enableHover?: boolean;
|
|
444
|
-
|
|
445
|
-
/**
|
|
446
|
-
* If `enableAutoFill` is set to true, then the auto fill icon will displayed on cell selection for copy cells.
|
|
447
|
-
* It requires the selection `mode` to be Cell and `cellSelectionMode` to be `Box`.
|
|
448
|
-
*
|
|
449
|
-
* @default false
|
|
450
|
-
*/
|
|
451
|
-
enableAutoFill?: boolean;
|
|
452
|
-
|
|
453
|
-
/**
|
|
454
|
-
* If `enableAdaptiveUI` is set to true, the pop-up UI will become adaptive to small screens,
|
|
455
|
-
* and be used for filtering and other features.
|
|
456
|
-
* ```html
|
|
457
|
-
* <div id='treegrid'></div>
|
|
458
|
-
* <script>
|
|
459
|
-
* var treegridObj = new TreeGrid({ enableAdaptiveUI: true });
|
|
460
|
-
* treegridObj.appendTo('#treegrid');
|
|
461
|
-
* </script>
|
|
462
|
-
* ```
|
|
463
|
-
*
|
|
464
|
-
* @default false
|
|
465
|
-
*/
|
|
466
|
-
enableAdaptiveUI?: boolean;
|
|
467
|
-
|
|
468
|
-
/**
|
|
469
|
-
* If `enableImmutableMode` is set to true, the TreeGrid will reuse old rows if it exists in the new result instead of
|
|
470
|
-
* full refresh while performing the TreeGrid actions.
|
|
471
|
-
*
|
|
472
|
-
* @default false
|
|
473
|
-
*/
|
|
474
|
-
enableImmutableMode?: boolean;
|
|
475
|
-
|
|
476
|
-
/**
|
|
477
|
-
* Defines the scrollable height of the TreeGrid content.
|
|
478
|
-
*
|
|
479
|
-
* @default 'auto'
|
|
480
|
-
*/
|
|
481
|
-
height?: string | number;
|
|
482
|
-
|
|
483
|
-
/**
|
|
484
|
-
* Defines the TreeGrid width.
|
|
485
|
-
*
|
|
486
|
-
* @default 'auto'
|
|
487
|
-
*/
|
|
488
|
-
width?: string | number;
|
|
489
|
-
|
|
490
|
-
/**
|
|
491
|
-
* Configures the loading indicator of the Tree Grid. Specifies whether to display spinner or shimmer effect
|
|
492
|
-
* during the waiting time on any actions (paging, sorting, filtering, CRUD operations) performed in Tree Grid.
|
|
493
|
-
*
|
|
494
|
-
* @default {indicatorType: 'Spinner'}
|
|
495
|
-
*/
|
|
496
|
-
loadingIndicator?: LoadingIndicatorModel;
|
|
497
|
-
|
|
238
|
+
* If `allowSorting` is set to true, it allows sorting of treegrid records when column header is clicked.
|
|
239
|
+
*
|
|
240
|
+
* @default false
|
|
241
|
+
*/
|
|
242
|
+
allowSorting?: boolean;
|
|
243
|
+
|
|
244
|
+
/**
|
|
245
|
+
* If `allowMultiSorting` set to true, then it will allow the user to sort multiple column in the treegrid.
|
|
246
|
+
* > `allowSorting` should be true.
|
|
247
|
+
*
|
|
248
|
+
* @default true
|
|
249
|
+
*/
|
|
250
|
+
allowMultiSorting?: boolean;
|
|
251
|
+
|
|
252
|
+
/**
|
|
253
|
+
* Configures the sort settings of the TreeGrid.
|
|
254
|
+
*
|
|
255
|
+
* @default {columns:[]}
|
|
256
|
+
*/
|
|
257
|
+
sortSettings?: SortSettingsModel;
|
|
258
|
+
|
|
259
|
+
/**
|
|
260
|
+
* Configures the TreeGrid aggregate rows.
|
|
261
|
+
* > Check the [`Aggregates`](../../treegrid/aggregates/aggregates) for its configuration.
|
|
262
|
+
*
|
|
263
|
+
* @default []
|
|
264
|
+
*/
|
|
265
|
+
aggregates?: AggregateRowModel[];
|
|
266
|
+
|
|
267
|
+
/**
|
|
268
|
+
* Configures the edit settings.
|
|
269
|
+
*
|
|
270
|
+
* @default { allowAdding: false, allowEditing: false, allowDeleting: false, mode:'Normal',
|
|
271
|
+
* allowEditOnDblClick: true, showConfirmDialog: true, showDeleteConfirmDialog: false }
|
|
272
|
+
*/
|
|
273
|
+
editSettings?: EditSettingsModel;
|
|
274
|
+
|
|
275
|
+
/**
|
|
276
|
+
* If `allowFiltering` is set to true the filter bar will be displayed.
|
|
277
|
+
* If set to false the filter bar will not be displayed.
|
|
278
|
+
* Filter bar allows the user to filter tree grid records with required criteria.
|
|
279
|
+
*
|
|
280
|
+
* @default false
|
|
281
|
+
*/
|
|
282
|
+
allowFiltering?: boolean;
|
|
283
|
+
|
|
284
|
+
/**
|
|
285
|
+
* The detail template allows you to show or hide additional information about a particular row.
|
|
286
|
+
*
|
|
287
|
+
* > It accepts either the [template string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals)
|
|
288
|
+
* or the HTML element ID.
|
|
289
|
+
*
|
|
290
|
+
* @aspType string
|
|
291
|
+
*/
|
|
292
|
+
detailTemplate?: string | Function;
|
|
293
|
+
|
|
294
|
+
/**
|
|
295
|
+
* Configures the filter settings of the TreeGrid.
|
|
296
|
+
*
|
|
297
|
+
* @default {columns: [], type: 'FilterBar', mode: 'Immediate', showFilterBarStatus: true, immediateModeDelay: 1500 , operators: {}}
|
|
298
|
+
*/
|
|
299
|
+
filterSettings?: FilterSettingsModel;
|
|
300
|
+
|
|
301
|
+
/**
|
|
302
|
+
* Configures the search settings of the TreeGrid.
|
|
303
|
+
*
|
|
304
|
+
* @default {search: [] , operators: {}}
|
|
305
|
+
*/
|
|
306
|
+
searchSettings?: SearchSettingsModel;
|
|
307
|
+
|
|
308
|
+
/**
|
|
309
|
+
* `toolbar` defines the ToolBar items of the TreeGrid.
|
|
310
|
+
* It contains built-in and custom toolbar items.
|
|
311
|
+
* If a string value is assigned to the `toolbar` option, it is considered as the template for the whole TreeGrid ToolBar.
|
|
312
|
+
* If an array value is assigned, it is considered as the list of built-in and custom toolbar items in the TreeGrid's Toolbar.
|
|
313
|
+
* <br><br>
|
|
314
|
+
* The available built-in ToolBar items are:
|
|
315
|
+
* * Search: Searches records by the given key.
|
|
316
|
+
* * ExpandAll: Expands all the rows in TreeGrid
|
|
317
|
+
* * CollapseAll: Collapses all the rows in TreeGrid
|
|
318
|
+
* * ExcelExport - Export the TreeGrid to Excel(excelExport() method manually to make export.)
|
|
319
|
+
* * PdfExport - Export the TreeGrid to PDF(pdfExport() method manually to make export.)
|
|
320
|
+
* * CsvExport - Export the TreeGrid to CSV(csvExport() method manually to make export.)<br><br>
|
|
321
|
+
* The following code example implements the custom toolbar items.
|
|
322
|
+
*
|
|
323
|
+
* @default null
|
|
324
|
+
*/
|
|
325
|
+
toolbar?: (ToolbarItems | string| ItemModel | ToolbarItem)[];
|
|
326
|
+
|
|
327
|
+
/**
|
|
328
|
+
* @hidden
|
|
329
|
+
* It used to render toolbar template
|
|
330
|
+
* @default null
|
|
331
|
+
* @aspType string
|
|
332
|
+
*/
|
|
333
|
+
toolbarTemplate?: string | Function;
|
|
334
|
+
|
|
335
|
+
/**
|
|
336
|
+
* Defines the mode of TreeGrid lines. The available modes are,
|
|
337
|
+
* ```props
|
|
338
|
+
* * Both :- Displays both horizontal and vertical TreeGrid lines.
|
|
339
|
+
* * None :- No TreeGrid lines are displayed.
|
|
340
|
+
* * Horizontal :- Displays the horizontal TreeGrid lines only.
|
|
341
|
+
* * Vertical :- Displays the vertical TreeGrid lines only.
|
|
342
|
+
* * Default :- Displays TreeGrid lines based on the theme.
|
|
343
|
+
* ```
|
|
344
|
+
*
|
|
345
|
+
* @default Syncfusion.EJ2.Grids.GridLine.Default
|
|
346
|
+
* @isEnumeration true
|
|
347
|
+
* @aspType Syncfusion.EJ2.Grids.GridLine
|
|
348
|
+
*/
|
|
349
|
+
gridLines?: GridLine;
|
|
350
|
+
|
|
351
|
+
/**
|
|
352
|
+
* `contextMenuItems` defines both built-in and custom context menu items.
|
|
353
|
+
* <br><br>
|
|
354
|
+
* The available built-in items are,
|
|
355
|
+
* * `AutoFitAll` - Auto fit the size of all columns.
|
|
356
|
+
* * `AutoFit` - Auto fit the current column.
|
|
357
|
+
* * `Edit` - Edit the current record.
|
|
358
|
+
* * `Delete` - Delete the current record.
|
|
359
|
+
* * `Save` - Save the edited record.
|
|
360
|
+
* * `Cancel` - Cancel the edited state.
|
|
361
|
+
* * `PdfExport` - Export the grid as Pdf format.
|
|
362
|
+
* * `ExcelExport` - Export the grid as Excel format.
|
|
363
|
+
* * `CsvExport` - Export the grid as CSV format.
|
|
364
|
+
* * `SortAscending` - Sort the current column in ascending order.
|
|
365
|
+
* * `SortDescending` - Sort the current column in descending order.
|
|
366
|
+
* * `FirstPage` - Go to the first page.
|
|
367
|
+
* * `PrevPage` - Go to the previous page.
|
|
368
|
+
* * `LastPage` - Go to the last page.
|
|
369
|
+
* * `NextPage` - Go to the next page.
|
|
370
|
+
*
|
|
371
|
+
* @default null
|
|
372
|
+
*/
|
|
373
|
+
contextMenuItems?: ContextMenuItem[] | ContextMenuItemModel[];
|
|
374
|
+
|
|
375
|
+
/**
|
|
376
|
+
* `columnMenuItems` defines both built-in and custom column menu items.
|
|
377
|
+
* <br><br>
|
|
378
|
+
* The available built-in items are,
|
|
379
|
+
* * `AutoFitAll` - Auto fit the size of all columns.
|
|
380
|
+
* * `AutoFit` - Auto fit the current column.
|
|
381
|
+
* * `SortAscending` - Sort the current column in ascending order.
|
|
382
|
+
* * `SortDescending` - Sort the current column in descending order.
|
|
383
|
+
* * `Filter` - Filter options will show based on filterSettings property like filterbar, menu filter.
|
|
384
|
+
*
|
|
385
|
+
* @default null
|
|
386
|
+
*/
|
|
387
|
+
columnMenuItems?: ColumnMenuItem[] | ColumnMenuItemModel[];
|
|
388
|
+
|
|
389
|
+
/**
|
|
390
|
+
* The row template that renders customized rows from the given template.
|
|
391
|
+
* By default, TreeGrid renders a table row for every data source item.
|
|
392
|
+
* > * It accepts either [template string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals)
|
|
393
|
+
* or HTML element ID.
|
|
394
|
+
* > * The row template must be a table row.
|
|
395
|
+
*
|
|
396
|
+
* > Check the [`Row Template`](../../treegrid/row) customization.
|
|
397
|
+
*
|
|
398
|
+
* @aspType string
|
|
399
|
+
*/
|
|
400
|
+
rowTemplate?: string | Function;
|
|
401
|
+
|
|
402
|
+
/**
|
|
403
|
+
* `copyHierarchyMode` Defines the copy clipboard types.
|
|
404
|
+
* <br><br>
|
|
405
|
+
* The available built-in items are,
|
|
406
|
+
* * `Parent` - Copy the selected data with parent record.
|
|
407
|
+
* * `Child` - Copy the selected data with child record.
|
|
408
|
+
* * `Both` - Copy the selected data with both parent and child record.
|
|
409
|
+
* * `None` - Copy only the selected record.
|
|
410
|
+
*
|
|
411
|
+
* @default Parent
|
|
412
|
+
*/
|
|
413
|
+
copyHierarchyMode?: CopyHierarchyType;
|
|
414
|
+
|
|
415
|
+
/**
|
|
416
|
+
* Defines the height of TreeGrid rows.
|
|
417
|
+
*
|
|
418
|
+
* @default null
|
|
419
|
+
*/
|
|
420
|
+
rowHeight?: number;
|
|
421
|
+
|
|
422
|
+
/**
|
|
423
|
+
* If `enableAltRow` is set to true, the TreeGrid will render with `e-altrow` CSS class to the alternative tr elements.
|
|
424
|
+
* > Check the [`AltRow`](../../treegrid/row/#styling-alternate-rows/) to customize the styles of alternative rows.
|
|
425
|
+
*
|
|
426
|
+
* @default true
|
|
427
|
+
*/
|
|
428
|
+
enableAltRow?: boolean;
|
|
429
|
+
|
|
430
|
+
/**
|
|
431
|
+
* Enables or disables the key board interaction of TreeGrid.
|
|
432
|
+
*
|
|
433
|
+
* @hidden
|
|
434
|
+
* @default true
|
|
435
|
+
*/
|
|
436
|
+
allowKeyboard?: boolean;
|
|
437
|
+
|
|
438
|
+
/**
|
|
439
|
+
* If `enableHover` is set to true, the row hover is enabled in the TreeGrid.
|
|
440
|
+
*
|
|
441
|
+
* @default false
|
|
442
|
+
*/
|
|
443
|
+
enableHover?: boolean;
|
|
444
|
+
|
|
445
|
+
/**
|
|
446
|
+
* If `enableAutoFill` is set to true, then the auto fill icon will displayed on cell selection for copy cells.
|
|
447
|
+
* It requires the selection `mode` to be Cell and `cellSelectionMode` to be `Box`.
|
|
448
|
+
*
|
|
449
|
+
* @default false
|
|
450
|
+
*/
|
|
451
|
+
enableAutoFill?: boolean;
|
|
452
|
+
|
|
453
|
+
/**
|
|
454
|
+
* If `enableAdaptiveUI` is set to true, the pop-up UI will become adaptive to small screens,
|
|
455
|
+
* and be used for filtering and other features.
|
|
456
|
+
* ```html
|
|
457
|
+
* <div id='treegrid'></div>
|
|
458
|
+
* <script>
|
|
459
|
+
* var treegridObj = new TreeGrid({ enableAdaptiveUI: true });
|
|
460
|
+
* treegridObj.appendTo('#treegrid');
|
|
461
|
+
* </script>
|
|
462
|
+
* ```
|
|
463
|
+
*
|
|
464
|
+
* @default false
|
|
465
|
+
*/
|
|
466
|
+
enableAdaptiveUI?: boolean;
|
|
467
|
+
|
|
468
|
+
/**
|
|
469
|
+
* If `enableImmutableMode` is set to true, the TreeGrid will reuse old rows if it exists in the new result instead of
|
|
470
|
+
* full refresh while performing the TreeGrid actions.
|
|
471
|
+
*
|
|
472
|
+
* @default false
|
|
473
|
+
*/
|
|
474
|
+
enableImmutableMode?: boolean;
|
|
475
|
+
|
|
476
|
+
/**
|
|
477
|
+
* Defines the scrollable height of the TreeGrid content.
|
|
478
|
+
*
|
|
479
|
+
* @default 'auto'
|
|
480
|
+
*/
|
|
481
|
+
height?: string | number;
|
|
482
|
+
|
|
483
|
+
/**
|
|
484
|
+
* Defines the TreeGrid width.
|
|
485
|
+
*
|
|
486
|
+
* @default 'auto'
|
|
487
|
+
*/
|
|
488
|
+
width?: string | number;
|
|
489
|
+
|
|
490
|
+
/**
|
|
491
|
+
* Configures the loading indicator of the Tree Grid. Specifies whether to display spinner or shimmer effect
|
|
492
|
+
* during the waiting time on any actions (paging, sorting, filtering, CRUD operations) performed in Tree Grid.
|
|
493
|
+
*
|
|
494
|
+
* @default {indicatorType: 'Spinner'}
|
|
495
|
+
*/
|
|
496
|
+
loadingIndicator?: LoadingIndicatorModel;
|
|
497
|
+
|
|
498
|
+
/**
|
|
499
|
+
* Specifies whether to display shimmer effect during scrolling action in virtual scrolling feature.
|
|
500
|
+
* If disabled, spinner is shown instead of shimmer effect.
|
|
501
|
+
*
|
|
502
|
+
* @default true
|
|
503
|
+
*/
|
|
504
|
+
enableVirtualMaskRow?: boolean;
|
|
505
|
+
|
|
498
506
|
/**
|
|
499
|
-
*
|
|
500
|
-
*
|
|
501
|
-
*
|
|
502
|
-
* @default
|
|
503
|
-
*/
|
|
504
|
-
|
|
507
|
+
* If `enableVirtualization` set to true, then the TreeGrid will render only the rows visible within the view-port
|
|
508
|
+
* and load subsequent rows on vertical scrolling. This helps to load large dataset in TreeGrid.
|
|
509
|
+
*
|
|
510
|
+
* @default false
|
|
511
|
+
*/
|
|
512
|
+
enableVirtualization?: boolean;
|
|
505
513
|
|
|
506
514
|
/**
|
|
507
|
-
* If `
|
|
508
|
-
* and load subsequent
|
|
509
|
-
*
|
|
510
|
-
* @default false
|
|
511
|
-
*/
|
|
512
|
-
|
|
515
|
+
* If `enableColumnVirtualization` set to true, then the Tree Grid will render only the columns visible within the view-port
|
|
516
|
+
* and load subsequent columns on horizontal scrolling. This helps to load large dataset of columns in Tree Grid.
|
|
517
|
+
*
|
|
518
|
+
* @default false
|
|
519
|
+
*/
|
|
520
|
+
enableColumnVirtualization?: boolean;
|
|
513
521
|
|
|
514
522
|
/**
|
|
515
|
-
*
|
|
516
|
-
*
|
|
517
|
-
*
|
|
518
|
-
* @default false
|
|
519
|
-
*/
|
|
520
|
-
|
|
523
|
+
* Specifies whether to display or remove the untrusted HTML values in the TreeGrid component.
|
|
524
|
+
* If `enableHtmlSanitizer` is set to true, then it will sanitize any suspected untrusted strings and scripts before rendering them.
|
|
525
|
+
*
|
|
526
|
+
* @default false
|
|
527
|
+
*/
|
|
528
|
+
enableHtmlSanitizer?: boolean;
|
|
521
529
|
|
|
522
530
|
/**
|
|
523
|
-
*
|
|
524
|
-
*
|
|
525
|
-
*
|
|
526
|
-
* @default false
|
|
527
|
-
|
|
528
|
-
|
|
531
|
+
* If `enableInfiniteScrolling` set to true, then the data will be loaded in TreeGrid when the scrollbar reaches the end.
|
|
532
|
+
* This helps to load large dataset in TreeGrid.
|
|
533
|
+
*
|
|
534
|
+
* @default false
|
|
535
|
+
* @deprecated
|
|
536
|
+
*/
|
|
537
|
+
enableInfiniteScrolling?: boolean;
|
|
529
538
|
|
|
530
539
|
/**
|
|
531
|
-
*
|
|
532
|
-
*
|
|
533
|
-
*
|
|
534
|
-
* @
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
enableInfiniteScrolling?: boolean;
|
|
540
|
+
* Configures the infinite scroll settings.
|
|
541
|
+
*
|
|
542
|
+
* @default { enableCache: false, maxBlocks: 5, initialBlocks: 5 }
|
|
543
|
+
* @deprecated
|
|
544
|
+
*/
|
|
545
|
+
infiniteScrollSettings?: InfiniteScrollSettingsModel;
|
|
538
546
|
|
|
539
547
|
/**
|
|
540
|
-
*
|
|
541
|
-
*
|
|
542
|
-
*
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
548
|
+
* `columnQueryMode`provides options to retrieves data from the data source.Their types are
|
|
549
|
+
* * `All`: It retrieves whole data source.
|
|
550
|
+
* * `Schema`: retrieves data for all the defined columns in TreeGrid from the data source.
|
|
551
|
+
* * `ExcludeHidden`: retrieves data only for visible columns of TreeGrid from the data Source.
|
|
552
|
+
*
|
|
553
|
+
* @default All
|
|
554
|
+
*/
|
|
555
|
+
columnQueryMode?: ColumnQueryModeType;
|
|
546
556
|
|
|
547
557
|
/**
|
|
548
|
-
*
|
|
549
|
-
*
|
|
550
|
-
*
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
* @default All
|
|
554
|
-
*/
|
|
555
|
-
columnQueryMode?: ColumnQueryModeType;
|
|
558
|
+
* Triggers when the component is created.
|
|
559
|
+
*
|
|
560
|
+
* @event created
|
|
561
|
+
*/
|
|
562
|
+
created?: EmitType<Object>;
|
|
556
563
|
|
|
557
564
|
/**
|
|
558
|
-
*
|
|
559
|
-
*
|
|
560
|
-
* @event
|
|
561
|
-
*/
|
|
562
|
-
|
|
565
|
+
* This event allows customization of TreeGrid properties before rendering.
|
|
566
|
+
*
|
|
567
|
+
* @event load
|
|
568
|
+
*/
|
|
569
|
+
load?: EmitType<Object>;
|
|
563
570
|
|
|
564
571
|
/**
|
|
565
|
-
*
|
|
566
|
-
*
|
|
567
|
-
* @event
|
|
568
|
-
*/
|
|
569
|
-
|
|
572
|
+
* Triggers while expanding the TreeGrid record
|
|
573
|
+
*
|
|
574
|
+
* @event expanding
|
|
575
|
+
*/
|
|
576
|
+
expanding?: EmitType<RowExpandingEventArgs>;
|
|
570
577
|
|
|
571
578
|
/**
|
|
572
|
-
* Triggers
|
|
573
|
-
*
|
|
574
|
-
* @event
|
|
575
|
-
*/
|
|
576
|
-
|
|
579
|
+
* Triggers after the record is expanded
|
|
580
|
+
*
|
|
581
|
+
* @event expanded
|
|
582
|
+
*/
|
|
583
|
+
expanded?: EmitType<RowExpandedEventArgs>;
|
|
577
584
|
|
|
578
585
|
/**
|
|
579
|
-
* Triggers
|
|
580
|
-
*
|
|
581
|
-
* @event
|
|
582
|
-
*/
|
|
583
|
-
|
|
586
|
+
* Triggers while collapsing the TreeGrid record
|
|
587
|
+
*
|
|
588
|
+
* @event collapsing
|
|
589
|
+
*/
|
|
590
|
+
collapsing?: EmitType<RowCollapsingEventArgs>;
|
|
584
591
|
|
|
585
592
|
/**
|
|
586
|
-
* Triggers
|
|
587
|
-
*
|
|
588
|
-
* @event
|
|
589
|
-
*/
|
|
590
|
-
|
|
593
|
+
* Triggers after the record is collapsed.
|
|
594
|
+
*
|
|
595
|
+
* @event collapsed
|
|
596
|
+
*/
|
|
597
|
+
collapsed?: EmitType<RowCollapsedEventArgs>;
|
|
591
598
|
|
|
592
599
|
/**
|
|
593
|
-
* Triggers
|
|
594
|
-
*
|
|
595
|
-
* @event
|
|
596
|
-
*/
|
|
597
|
-
|
|
600
|
+
* Triggers when cell is saved.
|
|
601
|
+
*
|
|
602
|
+
* @event cellSave
|
|
603
|
+
*/
|
|
604
|
+
cellSave?: EmitType<CellSaveArgs>;
|
|
598
605
|
|
|
599
606
|
/**
|
|
600
|
-
* Triggers when cell is saved.
|
|
601
|
-
*
|
|
602
|
-
* @event
|
|
603
|
-
*/
|
|
604
|
-
|
|
607
|
+
* Triggers when cell is saved.
|
|
608
|
+
*
|
|
609
|
+
* @event cellSaved
|
|
610
|
+
*/
|
|
611
|
+
cellSaved?: EmitType<CellSaveArgs>;
|
|
605
612
|
|
|
606
613
|
/**
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
cellSaved?: EmitType<CellSaveArgs>;
|
|
614
|
+
* Triggers when TreeGrid actions such as sorting, filtering, paging etc., starts.
|
|
615
|
+
* @event actionBegin
|
|
616
|
+
*/
|
|
617
|
+
actionBegin?: EmitType<PageEventArgs | FilterEventArgs | SortEventArgs | SearchEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs>;
|
|
612
618
|
|
|
613
619
|
/**
|
|
614
|
-
* Triggers when TreeGrid actions such as sorting, filtering, paging etc
|
|
615
|
-
* @event
|
|
616
|
-
*/
|
|
617
|
-
|
|
620
|
+
* Triggers when TreeGrid actions such as sorting, filtering, paging etc. are completed.
|
|
621
|
+
* @event actionComplete
|
|
622
|
+
*/
|
|
623
|
+
|
|
624
|
+
actionComplete?: EmitType<PageEventArgs | FilterEventArgs | SortEventArgs| SearchEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs>;
|
|
618
625
|
|
|
619
626
|
/**
|
|
620
|
-
* Triggers
|
|
621
|
-
* @event
|
|
622
|
-
*/
|
|
623
|
-
|
|
624
|
-
actionComplete?: EmitType<PageEventArgs | FilterEventArgs | SortEventArgs| SearchEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs>;
|
|
627
|
+
* Triggers before the record is to be edit.
|
|
628
|
+
* @event beginEdit
|
|
629
|
+
*/
|
|
630
|
+
beginEdit?: EmitType<BeginEditArgs>;
|
|
625
631
|
|
|
626
632
|
/**
|
|
627
|
-
* Triggers
|
|
628
|
-
* @event
|
|
629
|
-
*/
|
|
630
|
-
|
|
633
|
+
* Triggers when records are added in batch mode.
|
|
634
|
+
* @event batchAdd
|
|
635
|
+
*/
|
|
636
|
+
batchAdd?: EmitType<BatchAddArgs>;
|
|
631
637
|
|
|
632
638
|
/**
|
|
633
|
-
* Triggers when records are
|
|
634
|
-
* @event
|
|
635
|
-
*/
|
|
636
|
-
|
|
639
|
+
* Triggers when records are deleted in batch mode.
|
|
640
|
+
* @event batchDelete
|
|
641
|
+
*/
|
|
642
|
+
batchDelete?: EmitType<BatchDeleteArgs>;
|
|
637
643
|
|
|
638
644
|
/**
|
|
639
|
-
* Triggers
|
|
640
|
-
* @event
|
|
641
|
-
*/
|
|
642
|
-
|
|
645
|
+
* Triggers before records are added in batch mode.
|
|
646
|
+
* @event batchCancel
|
|
647
|
+
*/
|
|
648
|
+
batchCancel?: EmitType<BatchCancelArgs>;
|
|
643
649
|
|
|
644
650
|
/**
|
|
645
|
-
* Triggers before records are added in batch mode.
|
|
646
|
-
* @event
|
|
647
|
-
*/
|
|
648
|
-
|
|
651
|
+
* Triggers before records are added in batch mode.
|
|
652
|
+
* @event beforeBatchAdd
|
|
653
|
+
*/
|
|
654
|
+
beforeBatchAdd?: EmitType<BeforeBatchAddArgs>;
|
|
649
655
|
|
|
650
656
|
/**
|
|
651
|
-
* Triggers before records are
|
|
652
|
-
* @event
|
|
653
|
-
*/
|
|
654
|
-
|
|
657
|
+
* Triggers before records are deleted in batch mode.
|
|
658
|
+
* @event beforeBatchDelete
|
|
659
|
+
*/
|
|
660
|
+
beforeBatchDelete?: EmitType<BeforeBatchDeleteArgs>;
|
|
655
661
|
|
|
656
662
|
/**
|
|
657
|
-
* Triggers before records are
|
|
658
|
-
* @event
|
|
659
|
-
*/
|
|
660
|
-
|
|
663
|
+
* Triggers before records are saved in batch mode.
|
|
664
|
+
* @event beforeBatchSave
|
|
665
|
+
*/
|
|
666
|
+
beforeBatchSave?: EmitType<BeforeBatchSaveArgs>;
|
|
661
667
|
|
|
662
668
|
/**
|
|
663
|
-
* Triggers
|
|
664
|
-
* @event
|
|
665
|
-
*/
|
|
666
|
-
|
|
669
|
+
* Triggers when the cell is being edited.
|
|
670
|
+
* @event cellEdit
|
|
671
|
+
*/
|
|
672
|
+
cellEdit?: EmitType<CellEditArgs>;
|
|
667
673
|
|
|
668
674
|
/**
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
675
|
+
* Triggers when any TreeGrid action failed to achieve the desired results.
|
|
676
|
+
*
|
|
677
|
+
* @event actionFailure
|
|
678
|
+
*/
|
|
679
|
+
actionFailure?: EmitType<FailureEventArgs>;
|
|
673
680
|
|
|
674
681
|
/**
|
|
675
|
-
* Triggers when
|
|
676
|
-
*
|
|
677
|
-
* @event
|
|
678
|
-
*/
|
|
679
|
-
|
|
682
|
+
* Triggers when data source is populated in the TreeGrid.
|
|
683
|
+
*
|
|
684
|
+
* @event dataBound
|
|
685
|
+
*/
|
|
686
|
+
dataBound?: EmitType<Object>;
|
|
680
687
|
|
|
681
688
|
/**
|
|
682
|
-
* Triggers when data
|
|
683
|
-
*
|
|
684
|
-
*
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
* Triggers when the TreeGrid data is added, deleted and updated.
|
|
690
|
-
* Invoke the done method from the argument to start render after edit operation.
|
|
691
|
-
*
|
|
692
|
-
* @event dataSourceChanged
|
|
693
|
-
|
|
694
|
-
*/
|
|
695
|
-
dataSourceChanged?: EmitType<DataSourceChangedEventArgs>;
|
|
689
|
+
* Triggers when the TreeGrid data is added, deleted and updated.
|
|
690
|
+
* Invoke the done method from the argument to start render after edit operation.
|
|
691
|
+
*
|
|
692
|
+
* @event dataSourceChanged
|
|
693
|
+
* @deprecated
|
|
694
|
+
*/
|
|
695
|
+
dataSourceChanged?: EmitType<DataSourceChangedEventArgs>;
|
|
696
696
|
|
|
697
697
|
/**
|
|
698
|
-
* Triggers when the TreeGrid actions such as Sorting, Paging etc., are done.
|
|
699
|
-
* In this event,the current view data and total record count should be assigned to the `dataSource` based on the action performed.
|
|
700
|
-
*
|
|
701
|
-
* @event dataStateChange
|
|
702
|
-
|
|
703
|
-
*/
|
|
704
|
-
dataStateChange?: EmitType<DataStateChangeEventArgs>;
|
|
705
|
-
|
|
706
|
-
/**
|
|
707
|
-
* Triggers when record is double clicked.
|
|
708
|
-
*
|
|
709
|
-
* @event recordDoubleClick
|
|
710
|
-
*/
|
|
711
|
-
recordDoubleClick?: EmitType<RecordDoubleClickEventArgs>;
|
|
712
|
-
|
|
713
|
-
/**
|
|
714
|
-
* Triggered every time a request is made to access row information, element, or data.
|
|
715
|
-
* This will be triggered before the row element is appended to the TreeGrid element.
|
|
716
|
-
*
|
|
717
|
-
* @event rowDataBound
|
|
718
|
-
*/
|
|
719
|
-
rowDataBound?: EmitType<RowDataBoundEventArgs>;
|
|
720
|
-
|
|
721
|
-
/**
|
|
722
|
-
* Triggers after detail row expands.
|
|
723
|
-
* > This event triggers at initial expand.
|
|
724
|
-
*
|
|
725
|
-
* @event detailDataBound
|
|
726
|
-
*/
|
|
727
|
-
detailDataBound?: EmitType<DetailDataBoundEventArgs>;
|
|
728
|
-
|
|
729
|
-
/**
|
|
730
|
-
* Triggered every time a request is made to access cell information, element, or data.
|
|
731
|
-
* This will be triggered before the cell element is appended to the TreeGrid element.
|
|
732
|
-
*
|
|
733
|
-
* @event queryCellInfo
|
|
734
|
-
*/
|
|
735
|
-
queryCellInfo?: EmitType<QueryCellInfoEventArgs>;
|
|
736
|
-
|
|
737
|
-
/**
|
|
738
|
-
* If `allowSelection` is set to true, it allows selection of (highlight row) TreeGrid records by clicking it.
|
|
739
|
-
*
|
|
740
|
-
* @default true
|
|
741
|
-
*/
|
|
742
|
-
allowSelection?: boolean;
|
|
743
|
-
|
|
744
|
-
/**
|
|
745
|
-
* Triggers before row selection occurs.
|
|
746
|
-
*
|
|
747
|
-
* @event rowSelecting
|
|
748
|
-
*/
|
|
749
|
-
rowSelecting?: EmitType<RowSelectingEventArgs>;
|
|
750
|
-
|
|
751
|
-
/**
|
|
752
|
-
* Triggers after a row is selected.
|
|
753
|
-
*
|
|
754
|
-
* @event rowSelected
|
|
755
|
-
*/
|
|
756
|
-
rowSelected?: EmitType<RowSelectEventArgs>;
|
|
757
|
-
|
|
758
|
-
/**
|
|
759
|
-
* Triggers before deselecting the selected row.
|
|
760
|
-
*
|
|
761
|
-
* @event rowSelected
|
|
762
|
-
|
|
763
|
-
*/
|
|
764
|
-
rowDeselecting?: EmitType<RowDeselectEventArgs>;
|
|
698
|
+
* Triggers when the TreeGrid actions such as Sorting, Paging etc., are done.
|
|
699
|
+
* In this event,the current view data and total record count should be assigned to the `dataSource` based on the action performed.
|
|
700
|
+
*
|
|
701
|
+
* @event dataStateChange
|
|
702
|
+
* @deprecated
|
|
703
|
+
*/
|
|
704
|
+
dataStateChange?: EmitType<DataStateChangeEventArgs>;
|
|
765
705
|
|
|
766
706
|
/**
|
|
767
|
-
|
|
768
|
-
*
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
707
|
+
* Triggers when record is double clicked.
|
|
708
|
+
*
|
|
709
|
+
* @event recordDoubleClick
|
|
710
|
+
*/
|
|
711
|
+
recordDoubleClick?: EmitType<RecordDoubleClickEventArgs>;
|
|
772
712
|
|
|
773
713
|
/**
|
|
774
|
-
|
|
775
|
-
*
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
714
|
+
* Triggered every time a request is made to access row information, element, or data.
|
|
715
|
+
* This will be triggered before the row element is appended to the TreeGrid element.
|
|
716
|
+
*
|
|
717
|
+
* @event rowDataBound
|
|
718
|
+
*/
|
|
719
|
+
rowDataBound?: EmitType<RowDataBoundEventArgs>;
|
|
779
720
|
|
|
780
721
|
/**
|
|
781
|
-
* Triggers
|
|
782
|
-
*
|
|
783
|
-
*
|
|
784
|
-
|
|
785
|
-
|
|
722
|
+
* Triggers after detail row expands.
|
|
723
|
+
* > This event triggers at initial expand.
|
|
724
|
+
*
|
|
725
|
+
* @event detailDataBound
|
|
726
|
+
*/
|
|
727
|
+
detailDataBound?: EmitType<DetailDataBoundEventArgs>;
|
|
786
728
|
|
|
787
729
|
/**
|
|
788
|
-
*
|
|
789
|
-
*
|
|
790
|
-
*
|
|
791
|
-
|
|
792
|
-
*/
|
|
793
|
-
|
|
730
|
+
* Triggered every time a request is made to access cell information, element, or data.
|
|
731
|
+
* This will be triggered before the cell element is appended to the TreeGrid element.
|
|
732
|
+
*
|
|
733
|
+
* @event queryCellInfo
|
|
734
|
+
*/
|
|
735
|
+
queryCellInfo?: EmitType<QueryCellInfoEventArgs>;
|
|
794
736
|
|
|
795
737
|
/**
|
|
796
|
-
*
|
|
797
|
-
*
|
|
798
|
-
* @
|
|
799
|
-
*/
|
|
800
|
-
|
|
738
|
+
* If `allowSelection` is set to true, it allows selection of (highlight row) TreeGrid records by clicking it.
|
|
739
|
+
*
|
|
740
|
+
* @default true
|
|
741
|
+
*/
|
|
742
|
+
allowSelection?: boolean;
|
|
801
743
|
|
|
802
744
|
/**
|
|
803
|
-
* Triggers
|
|
804
|
-
*
|
|
805
|
-
* @event
|
|
806
|
-
*/
|
|
807
|
-
|
|
745
|
+
* Triggers before row selection occurs.
|
|
746
|
+
*
|
|
747
|
+
* @event rowSelecting
|
|
748
|
+
*/
|
|
749
|
+
rowSelecting?: EmitType<RowSelectingEventArgs>;
|
|
808
750
|
|
|
809
751
|
/**
|
|
810
|
-
* Triggers
|
|
811
|
-
*
|
|
812
|
-
* @event
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
cellDeselecting?: EmitType<CellDeselectEventArgs>;
|
|
752
|
+
* Triggers after a row is selected.
|
|
753
|
+
*
|
|
754
|
+
* @event rowSelected
|
|
755
|
+
*/
|
|
756
|
+
rowSelected?: EmitType<RowSelectEventArgs>;
|
|
816
757
|
|
|
817
758
|
/**
|
|
818
|
-
|
|
819
|
-
*
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
759
|
+
* Triggers before deselecting the selected row.
|
|
760
|
+
*
|
|
761
|
+
* @event rowSelected
|
|
762
|
+
* @deprecated
|
|
763
|
+
*/
|
|
764
|
+
rowDeselecting?: EmitType<RowDeselectEventArgs>;
|
|
824
765
|
|
|
825
766
|
/**
|
|
826
|
-
|
|
827
|
-
*
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
resizeStart?: EmitType<ResizeArgs>;
|
|
767
|
+
* Triggers when a selected row is deselected.
|
|
768
|
+
*
|
|
769
|
+
* @event rowDeselected
|
|
770
|
+
*/
|
|
771
|
+
rowDeselected?: EmitType<RowDeselectEventArgs>;
|
|
832
772
|
|
|
833
773
|
/**
|
|
834
|
-
|
|
835
|
-
*
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
resizing?: EmitType<ResizeArgs>;
|
|
774
|
+
* Triggered for stacked header.
|
|
775
|
+
*
|
|
776
|
+
* @event headerCellInfo
|
|
777
|
+
*/
|
|
778
|
+
headerCellInfo?: EmitType<HeaderCellInfoEventArgs>;
|
|
840
779
|
|
|
841
780
|
/**
|
|
842
|
-
* Triggers
|
|
843
|
-
*
|
|
844
|
-
* @event
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
resizeStop?: EmitType<ResizeArgs>;
|
|
781
|
+
* Triggers before any cell selection occurs.
|
|
782
|
+
*
|
|
783
|
+
* @event cellSelecting
|
|
784
|
+
*/
|
|
785
|
+
cellSelecting?: EmitType<CellSelectingEventArgs>;
|
|
848
786
|
|
|
849
787
|
/**
|
|
850
|
-
* Triggers
|
|
851
|
-
*
|
|
852
|
-
* @event
|
|
853
|
-
|
|
854
|
-
*/
|
|
855
|
-
|
|
788
|
+
* Triggers before column menu opens.
|
|
789
|
+
*
|
|
790
|
+
* @event columnMenuOpen
|
|
791
|
+
* @deprecated
|
|
792
|
+
*/
|
|
793
|
+
columnMenuOpen?: EmitType<ColumnMenuOpenEventArgs>;
|
|
856
794
|
|
|
857
795
|
/**
|
|
858
|
-
* Triggers when
|
|
859
|
-
*
|
|
860
|
-
* @event
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
columnDrag?: EmitType<ColumnDragEventArgs>;
|
|
796
|
+
* Triggers when click on column menu.
|
|
797
|
+
*
|
|
798
|
+
* @event columnMenuClick
|
|
799
|
+
*/
|
|
800
|
+
columnMenuClick?: EmitType<MenuEventArgs>;
|
|
864
801
|
|
|
865
802
|
/**
|
|
866
|
-
|
|
867
|
-
*
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
columnDrop?: EmitType<ColumnDragEventArgs>;
|
|
803
|
+
* Triggers after a cell is selected.
|
|
804
|
+
*
|
|
805
|
+
* @event cellSelected
|
|
806
|
+
*/
|
|
807
|
+
cellSelected?: EmitType<CellSelectEventArgs>;
|
|
872
808
|
|
|
873
809
|
/**
|
|
874
|
-
|
|
875
|
-
*
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
810
|
+
* Triggers before the selected cell is deselecting.
|
|
811
|
+
*
|
|
812
|
+
* @event cellDeselecting
|
|
813
|
+
* @deprecated
|
|
814
|
+
*/
|
|
815
|
+
cellDeselecting?: EmitType<CellDeselectEventArgs>;
|
|
880
816
|
|
|
881
817
|
/**
|
|
882
|
-
* Triggers
|
|
883
|
-
*
|
|
884
|
-
* @event
|
|
885
|
-
|
|
886
|
-
*/
|
|
887
|
-
|
|
818
|
+
* Triggers when a particular selected cell is deselected.
|
|
819
|
+
*
|
|
820
|
+
* @event cellDeselected
|
|
821
|
+
* @deprecated
|
|
822
|
+
*/
|
|
823
|
+
cellDeselected?: EmitType<CellDeselectEventArgs>;
|
|
888
824
|
|
|
889
825
|
/**
|
|
890
|
-
* Triggers
|
|
891
|
-
*
|
|
892
|
-
* @event
|
|
893
|
-
|
|
894
|
-
*/
|
|
895
|
-
|
|
826
|
+
* Triggers when column resize starts.
|
|
827
|
+
*
|
|
828
|
+
* @event resizeStart
|
|
829
|
+
* @deprecated
|
|
830
|
+
*/
|
|
831
|
+
resizeStart?: EmitType<ResizeArgs>;
|
|
896
832
|
|
|
897
833
|
/**
|
|
898
|
-
* Triggers
|
|
899
|
-
*
|
|
900
|
-
* @event
|
|
901
|
-
|
|
902
|
-
|
|
834
|
+
* Triggers on column resizing.
|
|
835
|
+
*
|
|
836
|
+
* @event resizing
|
|
837
|
+
* @deprecated
|
|
838
|
+
*/
|
|
839
|
+
resizing?: EmitType<ResizeArgs>;
|
|
903
840
|
|
|
904
841
|
/**
|
|
905
|
-
* Triggers
|
|
906
|
-
*
|
|
907
|
-
* @event
|
|
908
|
-
|
|
909
|
-
|
|
842
|
+
* Triggers when column resize ends.
|
|
843
|
+
*
|
|
844
|
+
* @event resizeStop
|
|
845
|
+
* @deprecated
|
|
846
|
+
*/
|
|
847
|
+
resizeStop?: EmitType<ResizeArgs>;
|
|
910
848
|
|
|
911
849
|
/**
|
|
912
|
-
* Triggers
|
|
913
|
-
*
|
|
914
|
-
* @event
|
|
915
|
-
|
|
916
|
-
*/
|
|
917
|
-
|
|
850
|
+
* Triggers when column header element drag (move) starts.
|
|
851
|
+
*
|
|
852
|
+
* @event columnDragStart
|
|
853
|
+
* @deprecated
|
|
854
|
+
*/
|
|
855
|
+
columnDragStart?: EmitType<ColumnDragEventArgs>;
|
|
918
856
|
|
|
919
857
|
/**
|
|
920
|
-
* Triggers when
|
|
921
|
-
*
|
|
922
|
-
* @event
|
|
923
|
-
|
|
924
|
-
|
|
858
|
+
* Triggers when column header element is dragged (moved) continuously.
|
|
859
|
+
*
|
|
860
|
+
* @event columnDrag
|
|
861
|
+
* @deprecated
|
|
862
|
+
*/
|
|
863
|
+
columnDrag?: EmitType<ColumnDragEventArgs>;
|
|
925
864
|
|
|
926
865
|
/**
|
|
927
|
-
* Triggers
|
|
928
|
-
*
|
|
929
|
-
* @event
|
|
930
|
-
|
|
931
|
-
*/
|
|
932
|
-
|
|
866
|
+
* Triggers when a column header element is dropped on the target column.
|
|
867
|
+
*
|
|
868
|
+
* @event columnDrop
|
|
869
|
+
* @deprecated
|
|
870
|
+
*/
|
|
871
|
+
columnDrop?: EmitType<ColumnDragEventArgs>;
|
|
933
872
|
|
|
934
873
|
/**
|
|
935
|
-
* Triggers
|
|
936
|
-
*
|
|
937
|
-
* @event
|
|
938
|
-
|
|
939
|
-
*/
|
|
940
|
-
|
|
874
|
+
* Triggers when the check box state change in checkbox column.
|
|
875
|
+
*
|
|
876
|
+
* @event checkboxChange
|
|
877
|
+
* @deprecated
|
|
878
|
+
*/
|
|
879
|
+
checkboxChange?: EmitType<CheckBoxChangeEventArgs>;
|
|
941
880
|
|
|
942
881
|
/**
|
|
943
|
-
* Triggers
|
|
944
|
-
*
|
|
945
|
-
* @event
|
|
946
|
-
|
|
947
|
-
*/
|
|
948
|
-
|
|
882
|
+
* Triggers after print action is completed.
|
|
883
|
+
*
|
|
884
|
+
* @event printComplete
|
|
885
|
+
* @deprecated
|
|
886
|
+
*/
|
|
887
|
+
printComplete?: EmitType<PrintEventArgs>;
|
|
949
888
|
|
|
950
889
|
/**
|
|
951
|
-
* Triggers
|
|
952
|
-
*
|
|
953
|
-
* @event
|
|
954
|
-
|
|
955
|
-
*/
|
|
956
|
-
|
|
890
|
+
* Triggers before the print action starts.
|
|
891
|
+
*
|
|
892
|
+
* @event beforePrint
|
|
893
|
+
* @deprecated
|
|
894
|
+
*/
|
|
895
|
+
beforePrint?: EmitType<PrintEventArgs>;
|
|
957
896
|
|
|
958
897
|
/**
|
|
959
|
-
* Triggers when
|
|
960
|
-
*
|
|
961
|
-
* @event
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
rowDragStartHelper?: EmitType<RowDragEventArgs>;
|
|
898
|
+
* Triggers when toolbar item is clicked.
|
|
899
|
+
*
|
|
900
|
+
* @event toolbarClick
|
|
901
|
+
*/
|
|
902
|
+
toolbarClick?: EmitType<ClickEventArgs>;
|
|
965
903
|
|
|
966
904
|
/**
|
|
967
|
-
* Triggers
|
|
968
|
-
*
|
|
969
|
-
* @event
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
rowDrop?: EmitType<RowDragEventArgs>;
|
|
905
|
+
* Triggers before data is bound to Tree Grid.
|
|
906
|
+
*
|
|
907
|
+
* @event beforeDataBound
|
|
908
|
+
*/
|
|
909
|
+
beforeDataBound?: EmitType<BeforeDataBoundArgs>;
|
|
973
910
|
|
|
974
911
|
/**
|
|
975
|
-
*
|
|
976
|
-
*
|
|
977
|
-
*
|
|
978
|
-
* @
|
|
979
|
-
*/
|
|
980
|
-
|
|
912
|
+
* Triggers before context menu opens.
|
|
913
|
+
*
|
|
914
|
+
* @event contextMenuOpen
|
|
915
|
+
* @deprecated
|
|
916
|
+
*/
|
|
917
|
+
contextMenuOpen?: EmitType<BeforeOpenCloseMenuEventArgs>;
|
|
981
918
|
|
|
982
919
|
/**
|
|
983
|
-
*
|
|
984
|
-
*
|
|
985
|
-
* @
|
|
986
|
-
*/
|
|
987
|
-
|
|
920
|
+
* Triggers when click on context menu.
|
|
921
|
+
*
|
|
922
|
+
* @event contextMenuClick
|
|
923
|
+
*/
|
|
924
|
+
contextMenuClick?: EmitType<MenuEventArgs>;
|
|
988
925
|
|
|
989
926
|
/**
|
|
990
|
-
*
|
|
991
|
-
*
|
|
992
|
-
*
|
|
993
|
-
*
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
allowExcelExport?: boolean;
|
|
927
|
+
* Triggers before TreeGrid copy action.
|
|
928
|
+
*
|
|
929
|
+
* @event beforeCopy
|
|
930
|
+
* @deprecated
|
|
931
|
+
*/
|
|
932
|
+
beforeCopy?: EmitType<BeforeCopyEventArgs>;
|
|
997
933
|
|
|
998
934
|
/**
|
|
999
|
-
*
|
|
1000
|
-
*
|
|
1001
|
-
*
|
|
1002
|
-
*
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
935
|
+
* Triggers before TreeGrid paste action.
|
|
936
|
+
*
|
|
937
|
+
* @event beforePaste
|
|
938
|
+
* @deprecated
|
|
939
|
+
*/
|
|
940
|
+
beforePaste?: EmitType<BeforePasteEventArgs>;
|
|
941
|
+
|
|
942
|
+
/**
|
|
943
|
+
* Triggers when row elements are dragged (moved) continuously.
|
|
944
|
+
*
|
|
945
|
+
* @event rowDrag
|
|
946
|
+
* @deprecated
|
|
947
|
+
*/
|
|
948
|
+
rowDrag?: EmitType<RowDragEventArgs>;
|
|
1006
949
|
|
|
1007
950
|
/**
|
|
1008
|
-
* Triggers
|
|
1009
|
-
*
|
|
1010
|
-
*
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
pdfQueryCellInfo?: EmitType<PdfQueryCellInfoEventArgs>;
|
|
951
|
+
* Triggers when row element’s drag(move) starts.
|
|
952
|
+
*
|
|
953
|
+
* @event rowDragStart
|
|
954
|
+
* @deprecated
|
|
955
|
+
*/
|
|
956
|
+
rowDragStart?: EmitType<RowDragEventArgs>;
|
|
1015
957
|
|
|
1016
958
|
/**
|
|
1017
|
-
* Triggers
|
|
1018
|
-
*
|
|
1019
|
-
*
|
|
1020
|
-
* @
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
pdfHeaderQueryCellInfo?: EmitType<PdfHeaderQueryCellInfoEventArgs>;
|
|
959
|
+
* Triggers when row element’s before drag(move).
|
|
960
|
+
*
|
|
961
|
+
* @event rowDragStartHelper
|
|
962
|
+
* @deprecated
|
|
963
|
+
*/
|
|
964
|
+
rowDragStartHelper?: EmitType<RowDragEventArgs>;
|
|
1024
965
|
|
|
1025
966
|
/**
|
|
1026
|
-
* Triggers
|
|
1027
|
-
*
|
|
1028
|
-
*
|
|
1029
|
-
* @
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
excelQueryCellInfo?: EmitType<ExcelQueryCellInfoEventArgs>;
|
|
967
|
+
* Triggers when row elements are dropped on the target row.
|
|
968
|
+
*
|
|
969
|
+
* @event rowDrop
|
|
970
|
+
* @deprecated
|
|
971
|
+
*/
|
|
972
|
+
rowDrop?: EmitType<RowDragEventArgs>;
|
|
1033
973
|
|
|
1034
|
-
/**
|
|
1035
|
-
*
|
|
1036
|
-
* You can also
|
|
1037
|
-
*
|
|
1038
|
-
* @
|
|
974
|
+
/**
|
|
975
|
+
* The `selectedRowIndex` allows you to select a row at initial rendering.
|
|
976
|
+
* You can also get the currently selected row index.
|
|
977
|
+
*
|
|
978
|
+
* @default -1
|
|
979
|
+
*/
|
|
980
|
+
selectedRowIndex?: number;
|
|
1039
981
|
|
|
1040
|
-
|
|
1041
|
-
|
|
982
|
+
/**
|
|
983
|
+
* Configures the selection settings.
|
|
984
|
+
*
|
|
985
|
+
* @default {mode: 'Row', cellSelectionMode: 'Flow', type: 'Single'}
|
|
986
|
+
*/
|
|
987
|
+
selectionSettings?: SelectionSettingsModel;
|
|
1042
988
|
|
|
1043
989
|
/**
|
|
1044
|
-
*
|
|
1045
|
-
*
|
|
1046
|
-
*
|
|
1047
|
-
|
|
1048
|
-
|
|
990
|
+
* If `allowExcelExport` set to true, then it will allow the user to export treegrid to Excel file.
|
|
991
|
+
*
|
|
992
|
+
* > Check the [`ExcelExport`](../../treegrid/excel-export/) to configure exporting document.
|
|
993
|
+
*
|
|
994
|
+
* @default false
|
|
995
|
+
*/
|
|
996
|
+
allowExcelExport?: boolean;
|
|
997
|
+
|
|
998
|
+
/**
|
|
999
|
+
* If `allowPdfExport` set to true, then it will allow the user to export treegrid to Pdf file.
|
|
1000
|
+
*
|
|
1001
|
+
* > Check the [`Pdfexport`](../../treegrid/pdf-export/) to configure the exporting document.
|
|
1002
|
+
*
|
|
1003
|
+
* @default false
|
|
1004
|
+
*/
|
|
1005
|
+
allowPdfExport?: boolean;
|
|
1006
|
+
|
|
1007
|
+
/**
|
|
1008
|
+
* Triggers before exporting each cell to PDF document.
|
|
1009
|
+
* You can also customize the PDF cells.
|
|
1010
|
+
*
|
|
1011
|
+
* @event pdfQueryCellInfo
|
|
1012
|
+
* @deprecated
|
|
1013
|
+
*/
|
|
1014
|
+
pdfQueryCellInfo?: EmitType<PdfQueryCellInfoEventArgs>;
|
|
1015
|
+
|
|
1016
|
+
/**
|
|
1017
|
+
* Triggers before exporting each header cell to PDF document.
|
|
1018
|
+
* You can also customize the PDF cells.
|
|
1019
|
+
*
|
|
1020
|
+
* @event pdfHeaderQueryCellInfo
|
|
1021
|
+
* @deprecated
|
|
1022
|
+
*/
|
|
1023
|
+
pdfHeaderQueryCellInfo?: EmitType<PdfHeaderQueryCellInfoEventArgs>;
|
|
1049
1024
|
|
|
1050
1025
|
/**
|
|
1051
|
-
* Triggers
|
|
1052
|
-
*
|
|
1053
|
-
*
|
|
1026
|
+
* Triggers before exporting each cell to Excel file.
|
|
1027
|
+
* You can also customize the Excel cells.
|
|
1028
|
+
*
|
|
1029
|
+
* @event excelQueryCellInfo
|
|
1030
|
+
* @deprecated
|
|
1031
|
+
*/
|
|
1032
|
+
excelQueryCellInfo?: EmitType<ExcelQueryCellInfoEventArgs>;
|
|
1054
1033
|
|
|
1055
|
-
|
|
1056
|
-
|
|
1034
|
+
/**
|
|
1035
|
+
* Triggers before exporting each header cell to Excel file.
|
|
1036
|
+
* You can also customize the Excel cells.
|
|
1037
|
+
*
|
|
1038
|
+
* @event excelHeaderQueryCellInfo
|
|
1039
|
+
* @deprecated
|
|
1040
|
+
*/
|
|
1041
|
+
excelHeaderQueryCellInfo?: EmitType<ExcelHeaderQueryCellInfoEventArgs>;
|
|
1042
|
+
|
|
1043
|
+
/**
|
|
1044
|
+
* Triggers before TreeGrid data is exported to Excel file.
|
|
1045
|
+
*
|
|
1046
|
+
* @event beforeExcelExport
|
|
1047
|
+
*/
|
|
1048
|
+
beforeExcelExport?: EmitType<Object>;
|
|
1057
1049
|
|
|
1058
|
-
/**
|
|
1059
|
-
* Triggers
|
|
1060
|
-
*
|
|
1061
|
-
* @event
|
|
1062
|
-
|
|
1063
|
-
|
|
1050
|
+
/**
|
|
1051
|
+
* Triggers after TreeGrid data is exported to Excel file.
|
|
1052
|
+
*
|
|
1053
|
+
* @event excelExportComplete
|
|
1054
|
+
* @deprecated
|
|
1055
|
+
*/
|
|
1056
|
+
excelExportComplete?: EmitType<ExcelExportCompleteArgs>;
|
|
1057
|
+
|
|
1058
|
+
/**
|
|
1059
|
+
* Triggers before TreeGrid data is exported to PDF document.
|
|
1060
|
+
*
|
|
1061
|
+
* @event beforePdfExport
|
|
1062
|
+
*/
|
|
1063
|
+
beforePdfExport?: EmitType<Object>;
|
|
1064
1064
|
|
|
1065
1065
|
/**
|
|
1066
|
-
* Triggers after TreeGrid data is exported to PDF document.
|
|
1067
|
-
*
|
|
1068
|
-
* @event pdfExportComplete
|
|
1069
|
-
|
|
1070
|
-
*/
|
|
1071
|
-
pdfExportComplete?: EmitType<PdfExportCompleteArgs>;
|
|
1066
|
+
* Triggers after TreeGrid data is exported to PDF document.
|
|
1067
|
+
*
|
|
1068
|
+
* @event pdfExportComplete
|
|
1069
|
+
* @deprecated
|
|
1070
|
+
*/
|
|
1071
|
+
pdfExportComplete?: EmitType<PdfExportCompleteArgs>;
|
|
1072
1072
|
|
|
1073
1073
|
}
|