@syncfusion/ej2-treegrid 28.2.6 → 29.1.37
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/ej2-treegrid.min.js +2 -2
- package/dist/ej2-treegrid.umd.min.js +2 -2
- package/dist/ej2-treegrid.umd.min.js.map +1 -1
- package/dist/es6/ej2-treegrid.es2015.js +1281 -519
- package/dist/es6/ej2-treegrid.es2015.js.map +1 -1
- package/dist/es6/ej2-treegrid.es5.js +1283 -519
- package/dist/es6/ej2-treegrid.es5.js.map +1 -1
- package/dist/global/ej2-treegrid.min.js +2 -2
- package/dist/global/ej2-treegrid.min.js.map +1 -1
- package/dist/global/index.d.ts +1 -1
- package/package.json +10 -10
- package/src/treegrid/actions/batch-edit.js +12 -5
- package/src/treegrid/actions/edit.js +12 -12
- package/src/treegrid/actions/page.js +1 -1
- package/src/treegrid/actions/rowdragdrop.d.ts +21 -1
- package/src/treegrid/actions/rowdragdrop.js +252 -48
- package/src/treegrid/actions/summary.js +1 -1
- package/src/treegrid/actions/virtual-scroll.d.ts +34 -1
- package/src/treegrid/actions/virtual-scroll.js +58 -11
- package/src/treegrid/base/constant.d.ts +0 -4
- package/src/treegrid/base/constant.js +0 -4
- package/src/treegrid/base/data.js +47 -46
- package/src/treegrid/base/treegrid-model.d.ts +195 -208
- package/src/treegrid/base/treegrid.d.ts +598 -411
- package/src/treegrid/base/treegrid.js +526 -307
- package/src/treegrid/enum.d.ts +77 -80
- package/src/treegrid/enum.js +2 -2
- package/src/treegrid/models/column.d.ts +122 -177
- package/src/treegrid/models/column.js +14 -26
- package/src/treegrid/models/edit-settings-model.d.ts +24 -25
- package/src/treegrid/models/edit-settings.d.ts +25 -26
- package/src/treegrid/models/edit-settings.js +1 -1
- package/src/treegrid/models/filter-settings-model.d.ts +41 -49
- package/src/treegrid/models/filter-settings.d.ts +43 -51
- package/src/treegrid/models/filter-settings.js +2 -2
- package/src/treegrid/models/infinite-scroll-settings-model.d.ts +4 -4
- package/src/treegrid/models/infinite-scroll-settings.d.ts +4 -4
- package/src/treegrid/models/infinite-scroll-settings.js +1 -1
- package/src/treegrid/models/loading-indicator-model.d.ts +3 -4
- package/src/treegrid/models/loading-indicator.d.ts +4 -4
- package/src/treegrid/models/loading-indicator.js +1 -1
- package/src/treegrid/models/page-settings-model.d.ts +10 -13
- package/src/treegrid/models/page-settings.d.ts +11 -14
- package/src/treegrid/models/page-settings.js +1 -1
- package/src/treegrid/models/rowdrop-settings-model.d.ts +1 -1
- package/src/treegrid/models/rowdrop-settings.d.ts +13 -6
- package/src/treegrid/models/rowdrop-settings.js +1 -1
- package/src/treegrid/models/search-settings-model.d.ts +13 -11
- package/src/treegrid/models/search-settings.d.ts +14 -12
- package/src/treegrid/models/search-settings.js +1 -1
- package/src/treegrid/models/selection-settings-model.d.ts +18 -29
- package/src/treegrid/models/selection-settings.d.ts +18 -29
- package/src/treegrid/models/sort-settings-model.d.ts +8 -5
- package/src/treegrid/models/sort-settings.d.ts +10 -7
- package/src/treegrid/models/sort-settings.js +2 -2
- package/src/treegrid/models/summary-model.d.ts +28 -29
- package/src/treegrid/models/summary.d.ts +32 -30
- package/src/treegrid/models/summary.js +4 -1
- package/src/treegrid/models/textwrap-settings-model.d.ts +7 -4
- package/src/treegrid/models/textwrap-settings.d.ts +8 -5
- package/src/treegrid/models/textwrap-settings.js +1 -1
- package/src/treegrid/renderer/render.js +11 -5
- package/src/treegrid/renderer/virtual-row-model-generator.js +5 -4
- package/src/treegrid/renderer/virtual-tree-content-render.d.ts +277 -0
- package/src/treegrid/renderer/virtual-tree-content-render.js +328 -35
- package/src/treegrid/utils.d.ts +1 -1
- package/styles/bootstrap-lite.css +0 -12
- package/styles/bootstrap.css +0 -12
- package/styles/bootstrap5-dark-lite.css +1 -1
- package/styles/bootstrap5-dark.css +1 -1
- package/styles/treegrid/_layout.scss +0 -1
- package/styles/treegrid/_material-dark-definition.scss +2 -2
- package/styles/treegrid/_material-definition.scss +2 -2
- package/styles/treegrid/bootstrap.css +0 -12
- package/styles/treegrid/bootstrap5-dark.css +1 -1
- package/styles/treegrid/icons/_bootstrap.scss +0 -17
- package/styles/treegrid/icons/_bootstrap5.scss +1 -1
- package/styles/treegrid/icons/_fabric-dark.scss +1 -1
- package/styles/treegrid/icons/_fabric.scss +1 -1
- package/styles/treegrid/icons/_fluent2.scss +1 -1
- package/styles/treegrid/icons/_fusionnew.scss +1 -0
- package/styles/treegrid/icons/_highcontrast-light.scss +1 -1
- package/styles/treegrid/icons/_tailwind-dark.scss +2 -2
|
@@ -7,27 +7,28 @@ import {ComponentModel} from '@syncfusion/ej2-base';
|
|
|
7
7
|
export interface TreeGridModel extends ComponentModel{
|
|
8
8
|
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
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.
|
|
11
13
|
*
|
|
12
14
|
* @default 0
|
|
13
15
|
*/
|
|
14
16
|
frozenRows?: number;
|
|
15
17
|
|
|
16
18
|
/**
|
|
17
|
-
*
|
|
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.
|
|
18
22
|
*
|
|
19
23
|
* @default 0
|
|
20
24
|
*/
|
|
21
25
|
frozenColumns?: number;
|
|
22
26
|
|
|
23
27
|
/**
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
* *
|
|
27
|
-
* *
|
|
28
|
-
* * EllipsisWithTooltip :- Displays ellipsis when the cell content overflows its area,
|
|
29
|
-
* ```
|
|
30
|
-
* also it will display the tooltip while hover on ellipsis is applied.
|
|
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.
|
|
31
32
|
*
|
|
32
33
|
* @default Syncfusion.EJ2.Grids.ClipMode.Ellipsis
|
|
33
34
|
* @aspType Syncfusion.EJ2.Grids.ClipMode
|
|
@@ -83,7 +84,10 @@ export interface TreeGridModel extends ComponentModel{
|
|
|
83
84
|
parentIdMapping?: string;
|
|
84
85
|
|
|
85
86
|
/**
|
|
86
|
-
* Specifies whether to load all
|
|
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.
|
|
87
91
|
*
|
|
88
92
|
* @default false
|
|
89
93
|
*/
|
|
@@ -97,7 +101,10 @@ export interface TreeGridModel extends ComponentModel{
|
|
|
97
101
|
expandStateMapping?: string;
|
|
98
102
|
|
|
99
103
|
/**
|
|
100
|
-
* If `allowRowDragAndDrop` is set to true,
|
|
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.
|
|
101
108
|
*
|
|
102
109
|
* @default false
|
|
103
110
|
*/
|
|
@@ -114,7 +121,7 @@ export interface TreeGridModel extends ComponentModel{
|
|
|
114
121
|
dataSource?: Object | DataManager;
|
|
115
122
|
|
|
116
123
|
/**
|
|
117
|
-
* Defines the external [
|
|
124
|
+
* Defines the external [Query](https://ej2.syncfusion.com/documentation/data/api-query.html)
|
|
118
125
|
* that will be executed along with data processing.
|
|
119
126
|
*
|
|
120
127
|
* @default null
|
|
@@ -127,11 +134,10 @@ export interface TreeGridModel extends ComponentModel{
|
|
|
127
134
|
cloneQuery?: Query;
|
|
128
135
|
|
|
129
136
|
/**
|
|
130
|
-
* Defines the
|
|
131
|
-
*
|
|
132
|
-
* * AllPages
|
|
133
|
-
* * CurrentPage
|
|
134
|
-
* ```
|
|
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.
|
|
135
141
|
*
|
|
136
142
|
* @default Syncfusion.EJ2.Grids.PrintMode.AllPages
|
|
137
143
|
* @isEnumeration true
|
|
@@ -224,7 +230,7 @@ export interface TreeGridModel extends ComponentModel{
|
|
|
224
230
|
/**
|
|
225
231
|
* If `showColumnMenu` set to true, then it will enable the column menu options in each columns.
|
|
226
232
|
*
|
|
227
|
-
* > Check the [
|
|
233
|
+
* > Check the [Column menu](../../treegrid/columns/#column-menu/) for its configuration.
|
|
228
234
|
*
|
|
229
235
|
* @default false
|
|
230
236
|
*/
|
|
@@ -261,7 +267,7 @@ export interface TreeGridModel extends ComponentModel{
|
|
|
261
267
|
|
|
262
268
|
/**
|
|
263
269
|
* Configures the TreeGrid aggregate rows.
|
|
264
|
-
* > Check the [
|
|
270
|
+
* > Check the [Aggregates](../../treegrid/aggregates/aggregates) for its configuration.
|
|
265
271
|
*
|
|
266
272
|
* @default []
|
|
267
273
|
*/
|
|
@@ -336,14 +342,13 @@ export interface TreeGridModel extends ComponentModel{
|
|
|
336
342
|
toolbarTemplate?: string | Function;
|
|
337
343
|
|
|
338
344
|
/**
|
|
339
|
-
* Defines the
|
|
340
|
-
*
|
|
341
|
-
* * Both
|
|
342
|
-
* * None
|
|
343
|
-
* * Horizontal
|
|
344
|
-
* * Vertical
|
|
345
|
-
* * Default
|
|
346
|
-
* ```
|
|
345
|
+
* Defines how TreeGrid content lines are displayed, determining the visibility of vertical and horizontal lines.
|
|
346
|
+
*
|
|
347
|
+
* * `Both`: Displays both horizontal and vertical grid lines.
|
|
348
|
+
* * `None`: Hides both horizontal and vertical grid lines.
|
|
349
|
+
* * `Horizontal`: Displays only horizontal grid lines.
|
|
350
|
+
* * `Vertical`: Displays only vertical grid lines.
|
|
351
|
+
* * `Default`: Adjusts line visibility based on the theme.
|
|
347
352
|
*
|
|
348
353
|
* @default Syncfusion.EJ2.Grids.GridLine.Default
|
|
349
354
|
* @isEnumeration true
|
|
@@ -396,7 +401,7 @@ export interface TreeGridModel extends ComponentModel{
|
|
|
396
401
|
* or HTML element ID.
|
|
397
402
|
* > * The row template must be a table row.
|
|
398
403
|
*
|
|
399
|
-
* > Check the [
|
|
404
|
+
* > Check the [Row Template](../../treegrid/row) customization.
|
|
400
405
|
*
|
|
401
406
|
* @aspType string
|
|
402
407
|
*/
|
|
@@ -424,7 +429,7 @@ export interface TreeGridModel extends ComponentModel{
|
|
|
424
429
|
|
|
425
430
|
/**
|
|
426
431
|
* If `enableAltRow` is set to true, the TreeGrid will render with `e-altrow` CSS class to the alternative tr elements.
|
|
427
|
-
* > Check the [
|
|
432
|
+
* > Check the [AltRow](../../treegrid/row/#styling-alternate-rows/) to customize the styles of alternative rows.
|
|
428
433
|
*
|
|
429
434
|
* @default true
|
|
430
435
|
*/
|
|
@@ -515,48 +520,87 @@ export interface TreeGridModel extends ComponentModel{
|
|
|
515
520
|
enableVirtualization?: boolean;
|
|
516
521
|
|
|
517
522
|
/**
|
|
518
|
-
*
|
|
519
|
-
*
|
|
523
|
+
* Enables column virtualization in the TreeGrid. When set to `true`, only columns visible within the viewport are rendered.
|
|
524
|
+
* Additional columns are loaded as you horizontally scroll. This is beneficial for rendering large datasets efficiently.
|
|
520
525
|
*
|
|
521
526
|
* @default false
|
|
522
527
|
*/
|
|
523
528
|
enableColumnVirtualization?: boolean;
|
|
524
529
|
|
|
525
530
|
/**
|
|
526
|
-
*
|
|
527
|
-
*
|
|
531
|
+
* Determines whether to sanitize untrusted HTML content in the TreeGrid. If `true`, potentially harmful HTML strings
|
|
532
|
+
* and scripts are sanitized before rendering to protect against XSS attacks.
|
|
528
533
|
*
|
|
529
534
|
* @default false
|
|
530
535
|
*/
|
|
531
536
|
enableHtmlSanitizer?: boolean;
|
|
532
537
|
|
|
533
538
|
/**
|
|
534
|
-
*
|
|
535
|
-
*
|
|
539
|
+
* Enables infinite scrolling in the TreeGrid. When set to `true`, additional data is loaded as the scrollbar
|
|
540
|
+
* reaches the end. Useful for handling large datasets.
|
|
536
541
|
*
|
|
537
542
|
* @default false
|
|
538
|
-
|
|
539
543
|
*/
|
|
540
544
|
enableInfiniteScrolling?: boolean;
|
|
541
545
|
|
|
542
546
|
/**
|
|
543
|
-
* Configures
|
|
547
|
+
* Configures settings for infinite scrolling.
|
|
544
548
|
*
|
|
545
549
|
* @default { enableCache: false, maxBlocks: 5, initialBlocks: 5 }
|
|
546
|
-
|
|
547
550
|
*/
|
|
548
551
|
infiniteScrollSettings?: InfiniteScrollSettingsModel;
|
|
549
552
|
|
|
550
553
|
/**
|
|
551
|
-
*
|
|
552
|
-
*
|
|
553
|
-
* * `
|
|
554
|
-
* * `
|
|
554
|
+
* Specifies how data is retrieved from the data source for the TreeGrid.
|
|
555
|
+
* The available modes are:
|
|
556
|
+
* * `All`: Retrieve the entire data source.
|
|
557
|
+
* * `Schema`: Retrieve data only for defined columns.
|
|
558
|
+
* * `ExcludeHidden`: Retrieve data only for visible columns in the TreeGrid.
|
|
555
559
|
*
|
|
556
560
|
* @default All
|
|
557
561
|
*/
|
|
558
562
|
columnQueryMode?: ColumnQueryModeType;
|
|
559
563
|
|
|
564
|
+
/**
|
|
565
|
+
* If `allowSelection` is set to true, selection of (highlight row) TreeGrid records by clicking is allowed.
|
|
566
|
+
*
|
|
567
|
+
* @default true
|
|
568
|
+
*/
|
|
569
|
+
allowSelection?: boolean;
|
|
570
|
+
|
|
571
|
+
/**
|
|
572
|
+
* Specifies the index of the row to be selected upon initial rendering.
|
|
573
|
+
* Also retrieves the index of the currently selected row.
|
|
574
|
+
*
|
|
575
|
+
* @default -1
|
|
576
|
+
*/
|
|
577
|
+
selectedRowIndex?: number;
|
|
578
|
+
|
|
579
|
+
/**
|
|
580
|
+
* Configures the selection behavior.
|
|
581
|
+
*
|
|
582
|
+
* @default {mode: 'Row', cellSelectionMode: 'Flow', type: 'Single'}
|
|
583
|
+
*/
|
|
584
|
+
selectionSettings?: SelectionSettingsModel;
|
|
585
|
+
|
|
586
|
+
/**
|
|
587
|
+
* Enables exporting the TreeGrid to an Excel file if set to true.
|
|
588
|
+
*
|
|
589
|
+
* > Check the [ExcelExport](../../treegrid/excel-export/) documentation for more details.
|
|
590
|
+
*
|
|
591
|
+
* @default false
|
|
592
|
+
*/
|
|
593
|
+
allowExcelExport?: boolean;
|
|
594
|
+
|
|
595
|
+
/**
|
|
596
|
+
* Enables exporting the TreeGrid to a PDF file if set to true.
|
|
597
|
+
*
|
|
598
|
+
* > Check the [PdfExport](../../treegrid/pdf-export/) documentation for more details.
|
|
599
|
+
*
|
|
600
|
+
* @default false
|
|
601
|
+
*/
|
|
602
|
+
allowPdfExport?: boolean;
|
|
603
|
+
|
|
560
604
|
/**
|
|
561
605
|
* Triggers when the component is created.
|
|
562
606
|
*
|
|
@@ -565,132 +609,141 @@ export interface TreeGridModel extends ComponentModel{
|
|
|
565
609
|
created?: EmitType<Object>;
|
|
566
610
|
|
|
567
611
|
/**
|
|
568
|
-
*
|
|
612
|
+
* Allows customization of TreeGrid properties before rendering.
|
|
569
613
|
*
|
|
570
614
|
* @event load
|
|
571
615
|
*/
|
|
572
616
|
load?: EmitType<Object>;
|
|
573
617
|
|
|
574
618
|
/**
|
|
575
|
-
* Triggers while
|
|
619
|
+
* Triggers while a TreeGrid record is expanding.
|
|
576
620
|
*
|
|
577
621
|
* @event expanding
|
|
578
622
|
*/
|
|
579
623
|
expanding?: EmitType<RowExpandingEventArgs>;
|
|
580
624
|
|
|
581
625
|
/**
|
|
582
|
-
* Triggers after
|
|
626
|
+
* Triggers after a TreeGrid record is expanded.
|
|
583
627
|
*
|
|
584
628
|
* @event expanded
|
|
585
629
|
*/
|
|
586
630
|
expanded?: EmitType<RowExpandedEventArgs>;
|
|
587
631
|
|
|
588
632
|
/**
|
|
589
|
-
* Triggers while
|
|
633
|
+
* Triggers while a TreeGrid record is collapsing.
|
|
590
634
|
*
|
|
591
635
|
* @event collapsing
|
|
592
636
|
*/
|
|
593
637
|
collapsing?: EmitType<RowCollapsingEventArgs>;
|
|
594
638
|
|
|
595
639
|
/**
|
|
596
|
-
* Triggers after
|
|
640
|
+
* Triggers after a TreeGrid record is collapsed.
|
|
597
641
|
*
|
|
598
642
|
* @event collapsed
|
|
599
643
|
*/
|
|
600
644
|
collapsed?: EmitType<RowCollapsedEventArgs>;
|
|
601
645
|
|
|
602
646
|
/**
|
|
603
|
-
* Triggers when cell is saved.
|
|
647
|
+
* Triggers when a cell is being saved.
|
|
604
648
|
*
|
|
605
649
|
* @event cellSave
|
|
606
650
|
*/
|
|
607
651
|
cellSave?: EmitType<CellSaveArgs>;
|
|
608
652
|
|
|
609
653
|
/**
|
|
610
|
-
* Triggers
|
|
654
|
+
* Triggers after a cell is saved.
|
|
611
655
|
*
|
|
612
656
|
* @event cellSaved
|
|
613
657
|
*/
|
|
614
658
|
cellSaved?: EmitType<CellSaveArgs>;
|
|
615
659
|
|
|
616
660
|
/**
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
661
|
+
* Triggers when TreeGrid actions like sorting, filtering, paging, etc., start.
|
|
662
|
+
*
|
|
663
|
+
* @event actionBegin
|
|
664
|
+
*/
|
|
620
665
|
actionBegin?: EmitType<PageEventArgs | FilterEventArgs | SortEventArgs | SearchEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs>;
|
|
621
666
|
|
|
622
667
|
/**
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
actionComplete?: EmitType<PageEventArgs | FilterEventArgs | SortEventArgs| SearchEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs>;
|
|
668
|
+
* Triggers when TreeGrid actions like sorting, filtering, paging, etc., are completed.
|
|
669
|
+
*
|
|
670
|
+
* @event actionComplete
|
|
671
|
+
*/
|
|
672
|
+
actionComplete?: EmitType<PageEventArgs | FilterEventArgs | SortEventArgs | SearchEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs>;
|
|
628
673
|
|
|
629
674
|
/**
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
675
|
+
* Triggers before a record is edited.
|
|
676
|
+
*
|
|
677
|
+
* @event beginEdit
|
|
678
|
+
*/
|
|
633
679
|
beginEdit?: EmitType<BeginEditArgs>;
|
|
634
680
|
|
|
635
681
|
/**
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
682
|
+
* Triggers when records are added in batch mode.
|
|
683
|
+
*
|
|
684
|
+
* @event batchAdd
|
|
685
|
+
*/
|
|
639
686
|
batchAdd?: EmitType<BatchAddArgs>;
|
|
640
687
|
|
|
641
688
|
/**
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
689
|
+
* Triggers when records are deleted in batch mode.
|
|
690
|
+
*
|
|
691
|
+
* @event batchDelete
|
|
692
|
+
*/
|
|
645
693
|
batchDelete?: EmitType<BatchDeleteArgs>;
|
|
646
694
|
|
|
647
695
|
/**
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
696
|
+
* Triggers before records are cancelled in batch mode.
|
|
697
|
+
*
|
|
698
|
+
* @event batchCancel
|
|
699
|
+
*/
|
|
651
700
|
batchCancel?: EmitType<BatchCancelArgs>;
|
|
652
701
|
|
|
653
702
|
/**
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
703
|
+
* Triggers before records are added in batch mode.
|
|
704
|
+
*
|
|
705
|
+
* @event beforeBatchAdd
|
|
706
|
+
*/
|
|
657
707
|
beforeBatchAdd?: EmitType<BeforeBatchAddArgs>;
|
|
658
708
|
|
|
659
709
|
/**
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
710
|
+
* Triggers before records are deleted in batch mode.
|
|
711
|
+
*
|
|
712
|
+
* @event beforeBatchDelete
|
|
713
|
+
*/
|
|
663
714
|
beforeBatchDelete?: EmitType<BeforeBatchDeleteArgs>;
|
|
664
715
|
|
|
665
716
|
/**
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
717
|
+
* Triggers before records are saved in batch mode.
|
|
718
|
+
*
|
|
719
|
+
* @event beforeBatchSave
|
|
720
|
+
*/
|
|
669
721
|
beforeBatchSave?: EmitType<BeforeBatchSaveArgs>;
|
|
670
722
|
|
|
671
723
|
/**
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
724
|
+
* Triggers when a cell is being edited.
|
|
725
|
+
*
|
|
726
|
+
* @event cellEdit
|
|
727
|
+
*/
|
|
675
728
|
cellEdit?: EmitType<CellEditArgs>;
|
|
676
729
|
|
|
677
730
|
/**
|
|
678
|
-
* Triggers when any TreeGrid action
|
|
731
|
+
* Triggers when any TreeGrid action fails to achieve the desired results.
|
|
679
732
|
*
|
|
680
733
|
* @event actionFailure
|
|
681
734
|
*/
|
|
682
735
|
actionFailure?: EmitType<FailureEventArgs>;
|
|
683
736
|
|
|
684
737
|
/**
|
|
685
|
-
* Triggers when data source is populated in the TreeGrid.
|
|
738
|
+
* Triggers when the data source is populated in the TreeGrid.
|
|
686
739
|
*
|
|
687
740
|
* @event dataBound
|
|
688
741
|
*/
|
|
689
742
|
dataBound?: EmitType<Object>;
|
|
690
743
|
|
|
691
744
|
/**
|
|
692
|
-
* Triggers when the TreeGrid
|
|
693
|
-
* Invoke the done method from the argument to start
|
|
745
|
+
* Triggers when data in the TreeGrid is added, deleted, or updated.
|
|
746
|
+
* Invoke the done method from the argument to start rendering after an edit operation.
|
|
694
747
|
*
|
|
695
748
|
* @event dataSourceChanged
|
|
696
749
|
|
|
@@ -698,8 +751,8 @@ export interface TreeGridModel extends ComponentModel{
|
|
|
698
751
|
dataSourceChanged?: EmitType<DataSourceChangedEventArgs>;
|
|
699
752
|
|
|
700
753
|
/**
|
|
701
|
-
* Triggers when
|
|
702
|
-
*
|
|
754
|
+
* Triggers when TreeGrid actions such as sorting, paging, etc., are completed.
|
|
755
|
+
* The current view data and total record count should be assigned to the dataSource based on the action performed.
|
|
703
756
|
*
|
|
704
757
|
* @event dataStateChange
|
|
705
758
|
|
|
@@ -707,7 +760,7 @@ export interface TreeGridModel extends ComponentModel{
|
|
|
707
760
|
dataStateChange?: EmitType<DataStateChangeEventArgs>;
|
|
708
761
|
|
|
709
762
|
/**
|
|
710
|
-
* Triggers when record is double
|
|
763
|
+
* Triggers when a record is double-clicked.
|
|
711
764
|
*
|
|
712
765
|
* @event recordDoubleClick
|
|
713
766
|
*/
|
|
@@ -715,15 +768,14 @@ export interface TreeGridModel extends ComponentModel{
|
|
|
715
768
|
|
|
716
769
|
/**
|
|
717
770
|
* Triggered every time a request is made to access row information, element, or data.
|
|
718
|
-
* This
|
|
771
|
+
* This event is triggered before the row element is appended to the TreeGrid element.
|
|
719
772
|
*
|
|
720
773
|
* @event rowDataBound
|
|
721
774
|
*/
|
|
722
775
|
rowDataBound?: EmitType<RowDataBoundEventArgs>;
|
|
723
776
|
|
|
724
777
|
/**
|
|
725
|
-
* Triggers after detail row expands.
|
|
726
|
-
* > This event triggers at initial expand.
|
|
778
|
+
* Triggers after a detail row expands. This event triggers initially during the first expand.
|
|
727
779
|
*
|
|
728
780
|
* @event detailDataBound
|
|
729
781
|
*/
|
|
@@ -731,53 +783,46 @@ export interface TreeGridModel extends ComponentModel{
|
|
|
731
783
|
|
|
732
784
|
/**
|
|
733
785
|
* Triggered every time a request is made to access cell information, element, or data.
|
|
734
|
-
* This
|
|
786
|
+
* This event is triggered before the cell element is appended to the TreeGrid element.
|
|
735
787
|
*
|
|
736
788
|
* @event queryCellInfo
|
|
737
789
|
*/
|
|
738
790
|
queryCellInfo?: EmitType<QueryCellInfoEventArgs>;
|
|
739
791
|
|
|
740
792
|
/**
|
|
741
|
-
*
|
|
793
|
+
* Triggers before row selection occurs.
|
|
742
794
|
*
|
|
743
|
-
* @
|
|
795
|
+
* @event rowSelecting
|
|
744
796
|
*/
|
|
745
|
-
allowSelection?: boolean;
|
|
746
|
-
|
|
747
|
-
/**
|
|
748
|
-
* Triggers before row selection occurs.
|
|
749
|
-
*
|
|
750
|
-
* @event rowSelecting
|
|
751
|
-
*/
|
|
752
797
|
rowSelecting?: EmitType<RowSelectingEventArgs>;
|
|
753
798
|
|
|
754
799
|
/**
|
|
755
|
-
|
|
800
|
+
* Triggers after a row is selected.
|
|
756
801
|
*
|
|
757
|
-
|
|
758
|
-
|
|
802
|
+
* @event rowSelected
|
|
803
|
+
*/
|
|
759
804
|
rowSelected?: EmitType<RowSelectEventArgs>;
|
|
760
805
|
|
|
761
806
|
/**
|
|
762
|
-
|
|
807
|
+
* Triggers before the selected row is deselected.
|
|
763
808
|
*
|
|
764
|
-
|
|
809
|
+
* @event rowDeselecting
|
|
765
810
|
|
|
766
|
-
|
|
811
|
+
*/
|
|
767
812
|
rowDeselecting?: EmitType<RowDeselectEventArgs>;
|
|
768
813
|
|
|
769
814
|
/**
|
|
770
|
-
|
|
815
|
+
* Triggers when a selected row is deselected.
|
|
771
816
|
*
|
|
772
|
-
|
|
773
|
-
|
|
817
|
+
* @event rowDeselected
|
|
818
|
+
*/
|
|
774
819
|
rowDeselected?: EmitType<RowDeselectEventArgs>;
|
|
775
820
|
|
|
776
821
|
/**
|
|
777
|
-
|
|
822
|
+
* Triggered for accessing header information.
|
|
778
823
|
*
|
|
779
|
-
|
|
780
|
-
|
|
824
|
+
* @event headerCellInfo
|
|
825
|
+
*/
|
|
781
826
|
headerCellInfo?: EmitType<HeaderCellInfoEventArgs>;
|
|
782
827
|
|
|
783
828
|
/**
|
|
@@ -788,7 +833,7 @@ export interface TreeGridModel extends ComponentModel{
|
|
|
788
833
|
cellSelecting?: EmitType<CellSelectingEventArgs>;
|
|
789
834
|
|
|
790
835
|
/**
|
|
791
|
-
* Triggers before column menu opens.
|
|
836
|
+
* Triggers before the column menu opens.
|
|
792
837
|
*
|
|
793
838
|
* @event columnMenuOpen
|
|
794
839
|
|
|
@@ -796,29 +841,29 @@ export interface TreeGridModel extends ComponentModel{
|
|
|
796
841
|
columnMenuOpen?: EmitType<ColumnMenuOpenEventArgs>;
|
|
797
842
|
|
|
798
843
|
/**
|
|
799
|
-
* Triggers when click on column menu.
|
|
844
|
+
* Triggers when there is a click on the column menu.
|
|
800
845
|
*
|
|
801
846
|
* @event columnMenuClick
|
|
802
847
|
*/
|
|
803
848
|
columnMenuClick?: EmitType<MenuEventArgs>;
|
|
804
849
|
|
|
805
850
|
/**
|
|
806
|
-
|
|
851
|
+
* Triggers after a cell is selected.
|
|
807
852
|
*
|
|
808
|
-
|
|
809
|
-
|
|
853
|
+
* @event cellSelected
|
|
854
|
+
*/
|
|
810
855
|
cellSelected?: EmitType<CellSelectEventArgs>;
|
|
811
856
|
|
|
812
857
|
/**
|
|
813
|
-
|
|
858
|
+
* Triggers before a selected cell is deselected.
|
|
814
859
|
*
|
|
815
|
-
|
|
860
|
+
* @event cellDeselecting
|
|
816
861
|
|
|
817
|
-
|
|
862
|
+
*/
|
|
818
863
|
cellDeselecting?: EmitType<CellDeselectEventArgs>;
|
|
819
864
|
|
|
820
865
|
/**
|
|
821
|
-
* Triggers when a
|
|
866
|
+
* Triggers when a selected cell is deselected.
|
|
822
867
|
*
|
|
823
868
|
* @event cellDeselected
|
|
824
869
|
|
|
@@ -826,7 +871,7 @@ export interface TreeGridModel extends ComponentModel{
|
|
|
826
871
|
cellDeselected?: EmitType<CellDeselectEventArgs>;
|
|
827
872
|
|
|
828
873
|
/**
|
|
829
|
-
* Triggers when column
|
|
874
|
+
* Triggers when column resizing starts.
|
|
830
875
|
*
|
|
831
876
|
* @event resizeStart
|
|
832
877
|
|
|
@@ -834,242 +879,184 @@ export interface TreeGridModel extends ComponentModel{
|
|
|
834
879
|
resizeStart?: EmitType<ResizeArgs>;
|
|
835
880
|
|
|
836
881
|
/**
|
|
837
|
-
* Triggers
|
|
882
|
+
* Triggers during column resizing.
|
|
838
883
|
*
|
|
839
884
|
* @event resizing
|
|
840
|
-
|
|
841
885
|
*/
|
|
842
886
|
resizing?: EmitType<ResizeArgs>;
|
|
843
887
|
|
|
844
888
|
/**
|
|
845
|
-
* Triggers when column
|
|
889
|
+
* Triggers when column resizing ends.
|
|
846
890
|
*
|
|
847
891
|
* @event resizeStop
|
|
848
|
-
|
|
849
892
|
*/
|
|
850
893
|
resizeStop?: EmitType<ResizeArgs>;
|
|
851
894
|
|
|
852
895
|
/**
|
|
853
|
-
* Triggers when column header
|
|
896
|
+
* Triggers when column header dragging begins.
|
|
854
897
|
*
|
|
855
898
|
* @event columnDragStart
|
|
856
|
-
|
|
857
899
|
*/
|
|
858
900
|
columnDragStart?: EmitType<ColumnDragEventArgs>;
|
|
859
901
|
|
|
860
902
|
/**
|
|
861
|
-
* Triggers
|
|
903
|
+
* Triggers continuously while the column header is being dragged.
|
|
862
904
|
*
|
|
863
905
|
* @event columnDrag
|
|
864
|
-
|
|
865
906
|
*/
|
|
866
907
|
columnDrag?: EmitType<ColumnDragEventArgs>;
|
|
867
908
|
|
|
868
909
|
/**
|
|
869
|
-
* Triggers when a column header
|
|
910
|
+
* Triggers when a column header is dropped onto the target column.
|
|
870
911
|
*
|
|
871
912
|
* @event columnDrop
|
|
872
|
-
|
|
873
913
|
*/
|
|
874
914
|
columnDrop?: EmitType<ColumnDragEventArgs>;
|
|
875
915
|
|
|
876
916
|
/**
|
|
877
|
-
* Triggers when the
|
|
917
|
+
* Triggers when the state of a checkbox changes in a checkbox column.
|
|
878
918
|
*
|
|
879
919
|
* @event checkboxChange
|
|
880
|
-
|
|
881
920
|
*/
|
|
882
921
|
checkboxChange?: EmitType<CheckBoxChangeEventArgs>;
|
|
883
922
|
|
|
884
923
|
/**
|
|
885
|
-
* Triggers after print action
|
|
924
|
+
* Triggers after the print action has been completed.
|
|
886
925
|
*
|
|
887
926
|
* @event printComplete
|
|
888
|
-
|
|
889
927
|
*/
|
|
890
928
|
printComplete?: EmitType<PrintEventArgs>;
|
|
891
929
|
|
|
892
930
|
/**
|
|
893
|
-
* Triggers before the print action
|
|
931
|
+
* Triggers before the print action begins.
|
|
894
932
|
*
|
|
895
933
|
* @event beforePrint
|
|
896
|
-
|
|
897
934
|
*/
|
|
898
935
|
beforePrint?: EmitType<PrintEventArgs>;
|
|
899
936
|
|
|
900
937
|
/**
|
|
901
|
-
* Triggers when toolbar item is clicked.
|
|
938
|
+
* Triggers when a toolbar item is clicked.
|
|
902
939
|
*
|
|
903
940
|
* @event toolbarClick
|
|
904
941
|
*/
|
|
905
942
|
toolbarClick?: EmitType<ClickEventArgs>;
|
|
906
943
|
|
|
907
944
|
/**
|
|
908
|
-
* Triggers before data is bound to
|
|
945
|
+
* Triggers before data is bound to the TreeGrid.
|
|
909
946
|
*
|
|
910
947
|
* @event beforeDataBound
|
|
911
948
|
*/
|
|
912
949
|
beforeDataBound?: EmitType<BeforeDataBoundArgs>;
|
|
913
950
|
|
|
914
951
|
/**
|
|
915
|
-
* Triggers before context menu opens.
|
|
952
|
+
* Triggers before the context menu opens.
|
|
916
953
|
*
|
|
917
954
|
* @event contextMenuOpen
|
|
918
|
-
|
|
919
955
|
*/
|
|
920
956
|
contextMenuOpen?: EmitType<BeforeOpenCloseMenuEventArgs>;
|
|
921
957
|
|
|
922
958
|
/**
|
|
923
|
-
* Triggers when
|
|
959
|
+
* Triggers when an item in the context menu is clicked.
|
|
924
960
|
*
|
|
925
961
|
* @event contextMenuClick
|
|
926
962
|
*/
|
|
927
963
|
contextMenuClick?: EmitType<MenuEventArgs>;
|
|
928
964
|
|
|
929
965
|
/**
|
|
930
|
-
* Triggers before TreeGrid copy action.
|
|
966
|
+
* Triggers before the TreeGrid copy action is initiated.
|
|
931
967
|
*
|
|
932
968
|
* @event beforeCopy
|
|
933
|
-
|
|
934
969
|
*/
|
|
935
970
|
beforeCopy?: EmitType<BeforeCopyEventArgs>;
|
|
936
971
|
|
|
937
972
|
/**
|
|
938
|
-
* Triggers before TreeGrid paste action.
|
|
973
|
+
* Triggers before the TreeGrid paste action is initiated.
|
|
939
974
|
*
|
|
940
975
|
* @event beforePaste
|
|
941
|
-
|
|
942
976
|
*/
|
|
943
977
|
beforePaste?: EmitType<BeforePasteEventArgs>;
|
|
944
978
|
|
|
945
979
|
/**
|
|
946
|
-
* Triggers
|
|
980
|
+
* Triggers continuously while row elements are being dragged.
|
|
947
981
|
*
|
|
948
982
|
* @event rowDrag
|
|
949
|
-
|
|
950
983
|
*/
|
|
951
984
|
rowDrag?: EmitType<RowDragEventArgs>;
|
|
952
985
|
|
|
953
986
|
/**
|
|
954
|
-
* Triggers when row element
|
|
987
|
+
* Triggers when row element dragging starts.
|
|
955
988
|
*
|
|
956
989
|
* @event rowDragStart
|
|
957
|
-
|
|
958
990
|
*/
|
|
959
991
|
rowDragStart?: EmitType<RowDragEventArgs>;
|
|
960
992
|
|
|
961
993
|
/**
|
|
962
|
-
* Triggers
|
|
994
|
+
* Triggers just before the row element dragging begins.
|
|
963
995
|
*
|
|
964
996
|
* @event rowDragStartHelper
|
|
965
|
-
|
|
966
997
|
*/
|
|
967
998
|
rowDragStartHelper?: EmitType<RowDragEventArgs>;
|
|
968
999
|
|
|
969
1000
|
/**
|
|
970
|
-
* Triggers when row
|
|
1001
|
+
* Triggers when a row element is dropped onto the target row.
|
|
971
1002
|
*
|
|
972
1003
|
* @event rowDrop
|
|
973
|
-
|
|
974
1004
|
*/
|
|
975
1005
|
rowDrop?: EmitType<RowDragEventArgs>;
|
|
976
1006
|
|
|
977
1007
|
/**
|
|
978
|
-
*
|
|
979
|
-
* You can also get the currently selected row index.
|
|
980
|
-
*
|
|
981
|
-
* @default -1
|
|
982
|
-
*/
|
|
983
|
-
selectedRowIndex?: number;
|
|
984
|
-
|
|
985
|
-
/**
|
|
986
|
-
* Configures the selection settings.
|
|
987
|
-
*
|
|
988
|
-
* @default {mode: 'Row', cellSelectionMode: 'Flow', type: 'Single'}
|
|
989
|
-
*/
|
|
990
|
-
selectionSettings?: SelectionSettingsModel;
|
|
991
|
-
|
|
992
|
-
/**
|
|
993
|
-
* If `allowExcelExport` set to true, then it will allow the user to export treegrid to Excel file.
|
|
994
|
-
*
|
|
995
|
-
* > Check the [`ExcelExport`](../../treegrid/excel-export/) to configure exporting document.
|
|
996
|
-
*
|
|
997
|
-
* @default false
|
|
998
|
-
*/
|
|
999
|
-
allowExcelExport?: boolean;
|
|
1000
|
-
|
|
1001
|
-
/**
|
|
1002
|
-
* If `allowPdfExport` set to true, then it will allow the user to export treegrid to Pdf file.
|
|
1003
|
-
*
|
|
1004
|
-
* > Check the [`Pdfexport`](../../treegrid/pdf-export/) to configure the exporting document.
|
|
1008
|
+
* Triggers before each cell is exported to a PDF document, allowing customization of cells.
|
|
1005
1009
|
*
|
|
1006
|
-
* @
|
|
1010
|
+
* @event pdfQueryCellInfo
|
|
1007
1011
|
*/
|
|
1008
|
-
allowPdfExport?: boolean;
|
|
1009
|
-
|
|
1010
|
-
/**
|
|
1011
|
-
* Triggers before exporting each cell to PDF document.
|
|
1012
|
-
* You can also customize the PDF cells.
|
|
1013
|
-
*
|
|
1014
|
-
* @event pdfQueryCellInfo
|
|
1015
|
-
|
|
1016
|
-
*/
|
|
1017
1012
|
pdfQueryCellInfo?: EmitType<PdfQueryCellInfoEventArgs>;
|
|
1018
1013
|
|
|
1019
1014
|
/**
|
|
1020
|
-
* Triggers before
|
|
1021
|
-
* You can also customize the PDF cells.
|
|
1015
|
+
* Triggers before each header cell is exported to a PDF document, allowing customization of cells.
|
|
1022
1016
|
*
|
|
1023
1017
|
* @event pdfHeaderQueryCellInfo
|
|
1024
|
-
|
|
1025
1018
|
*/
|
|
1026
1019
|
pdfHeaderQueryCellInfo?: EmitType<PdfHeaderQueryCellInfoEventArgs>;
|
|
1027
1020
|
|
|
1028
1021
|
/**
|
|
1029
|
-
* Triggers before
|
|
1030
|
-
* You can also customize the Excel cells.
|
|
1022
|
+
* Triggers before each cell is exported to an Excel file, allowing customization of cells.
|
|
1031
1023
|
*
|
|
1032
1024
|
* @event excelQueryCellInfo
|
|
1033
|
-
|
|
1034
1025
|
*/
|
|
1035
1026
|
excelQueryCellInfo?: EmitType<ExcelQueryCellInfoEventArgs>;
|
|
1036
1027
|
|
|
1037
1028
|
/**
|
|
1038
|
-
* Triggers before
|
|
1039
|
-
* You can also customize the Excel cells.
|
|
1029
|
+
* Triggers before each header cell is exported to an Excel file, allowing customization of cells.
|
|
1040
1030
|
*
|
|
1041
1031
|
* @event excelHeaderQueryCellInfo
|
|
1042
|
-
|
|
1043
1032
|
*/
|
|
1044
1033
|
excelHeaderQueryCellInfo?: EmitType<ExcelHeaderQueryCellInfoEventArgs>;
|
|
1045
1034
|
|
|
1046
1035
|
/**
|
|
1047
|
-
* Triggers before TreeGrid data is exported to Excel file.
|
|
1036
|
+
* Triggers before TreeGrid data is exported to an Excel file.
|
|
1048
1037
|
*
|
|
1049
1038
|
* @event beforeExcelExport
|
|
1050
1039
|
*/
|
|
1051
1040
|
beforeExcelExport?: EmitType<Object>;
|
|
1052
1041
|
|
|
1053
1042
|
/**
|
|
1054
|
-
* Triggers after TreeGrid data is exported to Excel file.
|
|
1043
|
+
* Triggers after TreeGrid data is exported to an Excel file.
|
|
1055
1044
|
*
|
|
1056
1045
|
* @event excelExportComplete
|
|
1057
|
-
|
|
1058
1046
|
*/
|
|
1059
1047
|
excelExportComplete?: EmitType<ExcelExportCompleteArgs>;
|
|
1060
1048
|
|
|
1061
1049
|
/**
|
|
1062
|
-
* Triggers before TreeGrid data is exported to PDF document.
|
|
1050
|
+
* Triggers before TreeGrid data is exported to a PDF document.
|
|
1063
1051
|
*
|
|
1064
1052
|
* @event beforePdfExport
|
|
1065
1053
|
*/
|
|
1066
1054
|
beforePdfExport?: EmitType<Object>;
|
|
1067
1055
|
|
|
1068
1056
|
/**
|
|
1069
|
-
* Triggers after TreeGrid data is exported to PDF document.
|
|
1057
|
+
* Triggers after TreeGrid data is exported to a PDF document.
|
|
1070
1058
|
*
|
|
1071
1059
|
* @event pdfExportComplete
|
|
1072
|
-
|
|
1073
1060
|
*/
|
|
1074
1061
|
pdfExportComplete?: EmitType<PdfExportCompleteArgs>;
|
|
1075
1062
|
|