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