@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.
Files changed (84) hide show
  1. package/README.md +2 -2
  2. package/dist/ej2-treegrid.min.js +2 -2
  3. package/dist/ej2-treegrid.umd.min.js +2 -2
  4. package/dist/ej2-treegrid.umd.min.js.map +1 -1
  5. package/dist/es6/ej2-treegrid.es2015.js +1281 -519
  6. package/dist/es6/ej2-treegrid.es2015.js.map +1 -1
  7. package/dist/es6/ej2-treegrid.es5.js +1283 -519
  8. package/dist/es6/ej2-treegrid.es5.js.map +1 -1
  9. package/dist/global/ej2-treegrid.min.js +2 -2
  10. package/dist/global/ej2-treegrid.min.js.map +1 -1
  11. package/dist/global/index.d.ts +1 -1
  12. package/package.json +10 -10
  13. package/src/treegrid/actions/batch-edit.js +12 -5
  14. package/src/treegrid/actions/edit.js +12 -12
  15. package/src/treegrid/actions/page.js +1 -1
  16. package/src/treegrid/actions/rowdragdrop.d.ts +21 -1
  17. package/src/treegrid/actions/rowdragdrop.js +252 -48
  18. package/src/treegrid/actions/summary.js +1 -1
  19. package/src/treegrid/actions/virtual-scroll.d.ts +34 -1
  20. package/src/treegrid/actions/virtual-scroll.js +58 -11
  21. package/src/treegrid/base/constant.d.ts +0 -4
  22. package/src/treegrid/base/constant.js +0 -4
  23. package/src/treegrid/base/data.js +47 -46
  24. package/src/treegrid/base/treegrid-model.d.ts +195 -208
  25. package/src/treegrid/base/treegrid.d.ts +598 -411
  26. package/src/treegrid/base/treegrid.js +526 -307
  27. package/src/treegrid/enum.d.ts +77 -80
  28. package/src/treegrid/enum.js +2 -2
  29. package/src/treegrid/models/column.d.ts +122 -177
  30. package/src/treegrid/models/column.js +14 -26
  31. package/src/treegrid/models/edit-settings-model.d.ts +24 -25
  32. package/src/treegrid/models/edit-settings.d.ts +25 -26
  33. package/src/treegrid/models/edit-settings.js +1 -1
  34. package/src/treegrid/models/filter-settings-model.d.ts +41 -49
  35. package/src/treegrid/models/filter-settings.d.ts +43 -51
  36. package/src/treegrid/models/filter-settings.js +2 -2
  37. package/src/treegrid/models/infinite-scroll-settings-model.d.ts +4 -4
  38. package/src/treegrid/models/infinite-scroll-settings.d.ts +4 -4
  39. package/src/treegrid/models/infinite-scroll-settings.js +1 -1
  40. package/src/treegrid/models/loading-indicator-model.d.ts +3 -4
  41. package/src/treegrid/models/loading-indicator.d.ts +4 -4
  42. package/src/treegrid/models/loading-indicator.js +1 -1
  43. package/src/treegrid/models/page-settings-model.d.ts +10 -13
  44. package/src/treegrid/models/page-settings.d.ts +11 -14
  45. package/src/treegrid/models/page-settings.js +1 -1
  46. package/src/treegrid/models/rowdrop-settings-model.d.ts +1 -1
  47. package/src/treegrid/models/rowdrop-settings.d.ts +13 -6
  48. package/src/treegrid/models/rowdrop-settings.js +1 -1
  49. package/src/treegrid/models/search-settings-model.d.ts +13 -11
  50. package/src/treegrid/models/search-settings.d.ts +14 -12
  51. package/src/treegrid/models/search-settings.js +1 -1
  52. package/src/treegrid/models/selection-settings-model.d.ts +18 -29
  53. package/src/treegrid/models/selection-settings.d.ts +18 -29
  54. package/src/treegrid/models/sort-settings-model.d.ts +8 -5
  55. package/src/treegrid/models/sort-settings.d.ts +10 -7
  56. package/src/treegrid/models/sort-settings.js +2 -2
  57. package/src/treegrid/models/summary-model.d.ts +28 -29
  58. package/src/treegrid/models/summary.d.ts +32 -30
  59. package/src/treegrid/models/summary.js +4 -1
  60. package/src/treegrid/models/textwrap-settings-model.d.ts +7 -4
  61. package/src/treegrid/models/textwrap-settings.d.ts +8 -5
  62. package/src/treegrid/models/textwrap-settings.js +1 -1
  63. package/src/treegrid/renderer/render.js +11 -5
  64. package/src/treegrid/renderer/virtual-row-model-generator.js +5 -4
  65. package/src/treegrid/renderer/virtual-tree-content-render.d.ts +277 -0
  66. package/src/treegrid/renderer/virtual-tree-content-render.js +328 -35
  67. package/src/treegrid/utils.d.ts +1 -1
  68. package/styles/bootstrap-lite.css +0 -12
  69. package/styles/bootstrap.css +0 -12
  70. package/styles/bootstrap5-dark-lite.css +1 -1
  71. package/styles/bootstrap5-dark.css +1 -1
  72. package/styles/treegrid/_layout.scss +0 -1
  73. package/styles/treegrid/_material-dark-definition.scss +2 -2
  74. package/styles/treegrid/_material-definition.scss +2 -2
  75. package/styles/treegrid/bootstrap.css +0 -12
  76. package/styles/treegrid/bootstrap5-dark.css +1 -1
  77. package/styles/treegrid/icons/_bootstrap.scss +0 -17
  78. package/styles/treegrid/icons/_bootstrap5.scss +1 -1
  79. package/styles/treegrid/icons/_fabric-dark.scss +1 -1
  80. package/styles/treegrid/icons/_fabric.scss +1 -1
  81. package/styles/treegrid/icons/_fluent2.scss +1 -1
  82. package/styles/treegrid/icons/_fusionnew.scss +1 -0
  83. package/styles/treegrid/icons/_highcontrast-light.scss +1 -1
  84. package/styles/treegrid/icons/_tailwind-dark.scss +2 -2
@@ -165,25 +165,26 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
165
165
  */
166
166
  freezeModule: Freeze;
167
167
  /**
168
- * Gets or sets the number of frozen rows.
168
+ * Specifies the number of rows that should remain visible and fixed at the top of the TreeGrid during scrolling.
169
+ *
170
+ * This feature helps improve readability in data-heavy grids by keeping the header rows or key rows visible.
169
171
  *
170
172
  * @default 0
171
173
  */
172
174
  frozenRows: number;
173
175
  /**
174
- * Gets or sets the number of frozen columns.
176
+ * Specifies the number of columns that should remain visible and fixed on the left side of the TreeGrid during horizontal scrolling.
177
+ *
178
+ * This feature ensures key columns, such as identifiers, stay visible while users scroll through data.
175
179
  *
176
180
  * @default 0
177
181
  */
178
182
  frozenColumns: number;
179
183
  /**
180
- * Defines the mode of clip. The available modes are,
181
- * ```props
182
- * * Clip :- Truncates the cell content when it overflows its area.
183
- * * Ellipsis :- Displays ellipsis when the cell content overflows its area.
184
- * * EllipsisWithTooltip :- Displays ellipsis when the cell content overflows its area,
185
- * ```
186
- * also it will display the tooltip while hover on ellipsis is applied.
184
+ * Defines the options for printing the TreeGrid.
185
+ * The available print modes are:
186
+ * * `AllPages`: Prints all pages of the TreeGrid.
187
+ * * `CurrentPage`: Prints only the current page of the TreeGrid.
187
188
  *
188
189
  * @default Syncfusion.EJ2.Grids.ClipMode.Ellipsis
189
190
  * @aspType Syncfusion.EJ2.Grids.ClipMode
@@ -259,7 +260,10 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
259
260
  */
260
261
  parentIdMapping: string;
261
262
  /**
262
- * Specifies whether to load all the rows in collapsed state when the TreeGrid is rendered for the first time.
263
+ * Specifies whether to load all rows in a collapsed state when the TreeGrid is initially rendered.
264
+ *
265
+ * This setting is particularly useful when dealing with large datasets, as it helps enhance loading performance by
266
+ * reducing initial data rendering.
263
267
  *
264
268
  * @default false
265
269
  */
@@ -271,7 +275,10 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
271
275
  */
272
276
  expandStateMapping: string;
273
277
  /**
274
- * If `allowRowDragAndDrop` is set to true, you can drag and drop treegrid rows at another treegrid.
278
+ * If `allowRowDragAndDrop` is set to true, row reordering functionality is enabled, allowing rows to be dragged
279
+ * and dropped within the TreeGrid or across TreeGrids.
280
+ *
281
+ * This feature enables users to reorganize data dynamically via drag-and-drop operations.
275
282
  *
276
283
  * @default false
277
284
  */
@@ -286,7 +293,7 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
286
293
  */
287
294
  dataSource: Object | DataManager;
288
295
  /**
289
- * Defines the external [`Query`](https://ej2.syncfusion.com/documentation/data/api-query.html)
296
+ * Defines the external [Query](https://ej2.syncfusion.com/documentation/data/api-query.html)
290
297
  * that will be executed along with data processing.
291
298
  *
292
299
  * @default null
@@ -297,11 +304,10 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
297
304
  */
298
305
  cloneQuery: Query;
299
306
  /**
300
- * Defines the print modes. The available print modes are
301
- * ```props
302
- * * AllPages :- Prints all pages of the TreeGrid.
303
- * * CurrentPage :- Prints the current page of the TreeGrid.
304
- * ```
307
+ * Defines the options for printing the TreeGrid.
308
+ * The available print modes are:
309
+ * * `AllPages`: Prints all pages of the TreeGrid.
310
+ * * `CurrentPage`: Prints only the current page of the TreeGrid.
305
311
  *
306
312
  * @default Syncfusion.EJ2.Grids.PrintMode.AllPages
307
313
  * @isEnumeration true
@@ -382,7 +388,7 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
382
388
  /**
383
389
  * If `showColumnMenu` set to true, then it will enable the column menu options in each columns.
384
390
  *
385
- * > Check the [`Column menu`](../../treegrid/columns/#column-menu/) for its configuration.
391
+ * > Check the [Column menu](../../treegrid/columns/#column-menu/) for its configuration.
386
392
  *
387
393
  * @default false
388
394
  */
@@ -414,7 +420,7 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
414
420
  sortSettings: SortSettingsModel;
415
421
  /**
416
422
  * Configures the TreeGrid aggregate rows.
417
- * > Check the [`Aggregates`](../../treegrid/aggregates/aggregates) for its configuration.
423
+ * > Check the [Aggregates](../../treegrid/aggregates/aggregates) for its configuration.
418
424
  *
419
425
  * @default []
420
426
  */
@@ -481,14 +487,13 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
481
487
  */
482
488
  toolbarTemplate: string | Function;
483
489
  /**
484
- * Defines the mode of TreeGrid lines. The available modes are,
485
- * ```props
486
- * * Both :- Displays both horizontal and vertical TreeGrid lines.
487
- * * None :- No TreeGrid lines are displayed.
488
- * * Horizontal :- Displays the horizontal TreeGrid lines only.
489
- * * Vertical :- Displays the vertical TreeGrid lines only.
490
- * * Default :- Displays TreeGrid lines based on the theme.
491
- * ```
490
+ * Defines how TreeGrid content lines are displayed, determining the visibility of vertical and horizontal lines.
491
+ *
492
+ * * `Both`: Displays both horizontal and vertical grid lines.
493
+ * * `None`: Hides both horizontal and vertical grid lines.
494
+ * * `Horizontal`: Displays only horizontal grid lines.
495
+ * * `Vertical`: Displays only vertical grid lines.
496
+ * * `Default`: Adjusts line visibility based on the theme.
492
497
  *
493
498
  * @default Syncfusion.EJ2.Grids.GridLine.Default
494
499
  * @isEnumeration true
@@ -538,7 +543,7 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
538
543
  * or HTML element ID.
539
544
  * > * The row template must be a table row.
540
545
  *
541
- * > Check the [`Row Template`](../../treegrid/row) customization.
546
+ * > Check the [Row Template](../../treegrid/row) customization.
542
547
  *
543
548
  * @aspType string
544
549
  */
@@ -563,7 +568,7 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
563
568
  rowHeight: number;
564
569
  /**
565
570
  * If `enableAltRow` is set to true, the TreeGrid will render with `e-altrow` CSS class to the alternative tr elements.
566
- * > Check the [`AltRow`](../../treegrid/row/#styling-alternate-rows/) to customize the styles of alternative rows.
571
+ * > Check the [AltRow](../../treegrid/row/#styling-alternate-rows/) to customize the styles of alternative rows.
567
572
  *
568
573
  * @default true
569
574
  */
@@ -643,43 +648,77 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
643
648
  */
644
649
  enableVirtualization: boolean;
645
650
  /**
646
- * If `enableColumnVirtualization` set to true, then the Tree Grid will render only the columns visible within the view-port
647
- * and load subsequent columns on horizontal scrolling. This helps to load large dataset of columns in Tree Grid.
651
+ * Enables column virtualization in the TreeGrid. When set to `true`, only columns visible within the viewport are rendered.
652
+ * Additional columns are loaded as you horizontally scroll. This is beneficial for rendering large datasets efficiently.
648
653
  *
649
654
  * @default false
650
655
  */
651
656
  enableColumnVirtualization: boolean;
652
657
  /**
653
- * Specifies whether to display or remove the untrusted HTML values in the TreeGrid component.
654
- * If `enableHtmlSanitizer` is set to true, then it will sanitize any suspected untrusted strings and scripts before rendering them.
658
+ * Determines whether to sanitize untrusted HTML content in the TreeGrid. If `true`, potentially harmful HTML strings
659
+ * and scripts are sanitized before rendering to protect against XSS attacks.
655
660
  *
656
661
  * @default false
657
662
  */
658
663
  enableHtmlSanitizer: boolean;
659
664
  /**
660
- * If `enableInfiniteScrolling` set to true, then the data will be loaded in TreeGrid when the scrollbar reaches the end.
661
- * This helps to load large dataset in TreeGrid.
665
+ * Enables infinite scrolling in the TreeGrid. When set to `true`, additional data is loaded as the scrollbar
666
+ * reaches the end. Useful for handling large datasets.
662
667
  *
663
668
  * @default false
664
-
665
669
  */
666
670
  enableInfiniteScrolling: boolean;
667
671
  /**
668
- * Configures the infinite scroll settings.
672
+ * Configures settings for infinite scrolling.
669
673
  *
670
674
  * @default { enableCache: false, maxBlocks: 5, initialBlocks: 5 }
671
-
672
675
  */
673
676
  infiniteScrollSettings: InfiniteScrollSettingsModel;
674
677
  /**
675
- * `columnQueryMode`provides options to retrieves data from the data source.Their types are
676
- * * `All`: It retrieves whole data source.
677
- * * `Schema`: retrieves data for all the defined columns in TreeGrid from the data source.
678
- * * `ExcludeHidden`: retrieves data only for visible columns of TreeGrid from the data Source.
678
+ * Specifies how data is retrieved from the data source for the TreeGrid.
679
+ * The available modes are:
680
+ * * `All`: Retrieve the entire data source.
681
+ * * `Schema`: Retrieve data only for defined columns.
682
+ * * `ExcludeHidden`: Retrieve data only for visible columns in the TreeGrid.
679
683
  *
680
684
  * @default All
681
685
  */
682
686
  columnQueryMode: ColumnQueryModeType;
687
+ /**
688
+ * If `allowSelection` is set to true, selection of (highlight row) TreeGrid records by clicking is allowed.
689
+ *
690
+ * @default true
691
+ */
692
+ allowSelection: boolean;
693
+ /**
694
+ * Specifies the index of the row to be selected upon initial rendering.
695
+ * Also retrieves the index of the currently selected row.
696
+ *
697
+ * @default -1
698
+ */
699
+ selectedRowIndex: number;
700
+ /**
701
+ * Configures the selection behavior.
702
+ *
703
+ * @default {mode: 'Row', cellSelectionMode: 'Flow', type: 'Single'}
704
+ */
705
+ selectionSettings: SelectionSettingsModel;
706
+ /**
707
+ * Enables exporting the TreeGrid to an Excel file if set to true.
708
+ *
709
+ * > Check the [ExcelExport](../../treegrid/excel-export/) documentation for more details.
710
+ *
711
+ * @default false
712
+ */
713
+ allowExcelExport: boolean;
714
+ /**
715
+ * Enables exporting the TreeGrid to a PDF file if set to true.
716
+ *
717
+ * > Check the [PdfExport](../../treegrid/pdf-export/) documentation for more details.
718
+ *
719
+ * @default false
720
+ */
721
+ allowPdfExport: boolean;
683
722
  /**
684
723
  * Triggers when the component is created.
685
724
  *
@@ -687,158 +726,161 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
687
726
  */
688
727
  created: EmitType<Object>;
689
728
  /**
690
- * This event allows customization of TreeGrid properties before rendering.
729
+ * Allows customization of TreeGrid properties before rendering.
691
730
  *
692
731
  * @event load
693
732
  */
694
733
  load: EmitType<Object>;
695
734
  /**
696
- * Triggers while expanding the TreeGrid record
735
+ * Triggers while a TreeGrid record is expanding.
697
736
  *
698
737
  * @event expanding
699
738
  */
700
739
  expanding: EmitType<RowExpandingEventArgs>;
701
740
  /**
702
- * Triggers after the record is expanded
741
+ * Triggers after a TreeGrid record is expanded.
703
742
  *
704
743
  * @event expanded
705
744
  */
706
745
  expanded: EmitType<RowExpandedEventArgs>;
707
746
  /**
708
- * Triggers while collapsing the TreeGrid record
747
+ * Triggers while a TreeGrid record is collapsing.
709
748
  *
710
749
  * @event collapsing
711
750
  */
712
751
  collapsing: EmitType<RowCollapsingEventArgs>;
713
752
  /**
714
- * Triggers after the record is collapsed.
753
+ * Triggers after a TreeGrid record is collapsed.
715
754
  *
716
755
  * @event collapsed
717
756
  */
718
757
  collapsed: EmitType<RowCollapsedEventArgs>;
719
758
  /**
720
- * Triggers when cell is saved.
759
+ * Triggers when a cell is being saved.
721
760
  *
722
761
  * @event cellSave
723
762
  */
724
763
  cellSave: EmitType<CellSaveArgs>;
725
764
  /**
726
- * Triggers when cell is saved.
765
+ * Triggers after a cell is saved.
727
766
  *
728
767
  * @event cellSaved
729
768
  */
730
769
  cellSaved: EmitType<CellSaveArgs>;
731
770
  /**
732
- * Triggers when TreeGrid actions such as sorting, filtering, paging etc., starts.
771
+ * Triggers when TreeGrid actions like sorting, filtering, paging, etc., start.
772
+ *
733
773
  * @event actionBegin
734
774
  */
735
775
  actionBegin: EmitType<PageEventArgs | FilterEventArgs | SortEventArgs | SearchEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs>;
736
776
  /**
737
- * Triggers when TreeGrid actions such as sorting, filtering, paging etc. are completed.
777
+ * Triggers when TreeGrid actions like sorting, filtering, paging, etc., are completed.
778
+ *
738
779
  * @event actionComplete
739
780
  */
740
781
  actionComplete: EmitType<PageEventArgs | FilterEventArgs | SortEventArgs | SearchEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs>;
741
782
  /**
742
- * Triggers before the record is to be edit.
783
+ * Triggers before a record is edited.
784
+ *
743
785
  * @event beginEdit
744
786
  */
745
787
  beginEdit: EmitType<BeginEditArgs>;
746
788
  /**
747
789
  * Triggers when records are added in batch mode.
790
+ *
748
791
  * @event batchAdd
749
792
  */
750
793
  batchAdd: EmitType<BatchAddArgs>;
751
794
  /**
752
795
  * Triggers when records are deleted in batch mode.
796
+ *
753
797
  * @event batchDelete
754
798
  */
755
799
  batchDelete: EmitType<BatchDeleteArgs>;
756
800
  /**
757
- * Triggers before records are added in batch mode.
801
+ * Triggers before records are cancelled in batch mode.
802
+ *
758
803
  * @event batchCancel
759
804
  */
760
805
  batchCancel: EmitType<BatchCancelArgs>;
761
806
  /**
762
807
  * Triggers before records are added in batch mode.
808
+ *
763
809
  * @event beforeBatchAdd
764
810
  */
765
811
  beforeBatchAdd: EmitType<BeforeBatchAddArgs>;
766
812
  /**
767
813
  * Triggers before records are deleted in batch mode.
814
+ *
768
815
  * @event beforeBatchDelete
769
816
  */
770
817
  beforeBatchDelete: EmitType<BeforeBatchDeleteArgs>;
771
818
  /**
772
819
  * Triggers before records are saved in batch mode.
820
+ *
773
821
  * @event beforeBatchSave
774
822
  */
775
823
  beforeBatchSave: EmitType<BeforeBatchSaveArgs>;
776
824
  /**
777
- * Triggers when the cell is being edited.
825
+ * Triggers when a cell is being edited.
826
+ *
778
827
  * @event cellEdit
779
828
  */
780
829
  cellEdit: EmitType<CellEditArgs>;
781
830
  /**
782
- * Triggers when any TreeGrid action failed to achieve the desired results.
831
+ * Triggers when any TreeGrid action fails to achieve the desired results.
783
832
  *
784
833
  * @event actionFailure
785
834
  */
786
835
  actionFailure: EmitType<FailureEventArgs>;
787
836
  /**
788
- * Triggers when data source is populated in the TreeGrid.
837
+ * Triggers when the data source is populated in the TreeGrid.
789
838
  *
790
839
  * @event dataBound
791
840
  */
792
841
  dataBound: EmitType<Object>;
793
842
  /**
794
- * Triggers when the TreeGrid data is added, deleted and updated.
795
- * Invoke the done method from the argument to start render after edit operation.
843
+ * Triggers when data in the TreeGrid is added, deleted, or updated.
844
+ * Invoke the done method from the argument to start rendering after an edit operation.
796
845
  *
797
846
  * @event dataSourceChanged
798
847
 
799
848
  */
800
849
  dataSourceChanged: EmitType<DataSourceChangedEventArgs>;
801
850
  /**
802
- * Triggers when the TreeGrid actions such as Sorting, Paging etc., are done.
803
- * In this event,the current view data and total record count should be assigned to the `dataSource` based on the action performed.
851
+ * Triggers when TreeGrid actions such as sorting, paging, etc., are completed.
852
+ * The current view data and total record count should be assigned to the dataSource based on the action performed.
804
853
  *
805
854
  * @event dataStateChange
806
855
 
807
856
  */
808
857
  dataStateChange: EmitType<DataStateChangeEventArgs>;
809
858
  /**
810
- * Triggers when record is double clicked.
859
+ * Triggers when a record is double-clicked.
811
860
  *
812
861
  * @event recordDoubleClick
813
862
  */
814
863
  recordDoubleClick: EmitType<RecordDoubleClickEventArgs>;
815
864
  /**
816
865
  * Triggered every time a request is made to access row information, element, or data.
817
- * This will be triggered before the row element is appended to the TreeGrid element.
866
+ * This event is triggered before the row element is appended to the TreeGrid element.
818
867
  *
819
868
  * @event rowDataBound
820
869
  */
821
870
  rowDataBound: EmitType<RowDataBoundEventArgs>;
822
871
  /**
823
- * Triggers after detail row expands.
824
- * > This event triggers at initial expand.
872
+ * Triggers after a detail row expands. This event triggers initially during the first expand.
825
873
  *
826
874
  * @event detailDataBound
827
875
  */
828
876
  detailDataBound: EmitType<DetailDataBoundEventArgs>;
829
877
  /**
830
878
  * Triggered every time a request is made to access cell information, element, or data.
831
- * This will be triggered before the cell element is appended to the TreeGrid element.
879
+ * This event is triggered before the cell element is appended to the TreeGrid element.
832
880
  *
833
881
  * @event queryCellInfo
834
882
  */
835
883
  queryCellInfo: EmitType<QueryCellInfoEventArgs>;
836
- /**
837
- * If `allowSelection` is set to true, it allows selection of (highlight row) TreeGrid records by clicking it.
838
- *
839
- * @default true
840
- */
841
- allowSelection: boolean;
842
884
  /**
843
885
  * Triggers before row selection occurs.
844
886
  *
@@ -852,9 +894,9 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
852
894
  */
853
895
  rowSelected: EmitType<RowSelectEventArgs>;
854
896
  /**
855
- * Triggers before deselecting the selected row.
897
+ * Triggers before the selected row is deselected.
856
898
  *
857
- * @event rowSelected
899
+ * @event rowDeselecting
858
900
 
859
901
  */
860
902
  rowDeselecting: EmitType<RowDeselectEventArgs>;
@@ -865,7 +907,7 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
865
907
  */
866
908
  rowDeselected: EmitType<RowDeselectEventArgs>;
867
909
  /**
868
- * Triggered for stacked header.
910
+ * Triggered for accessing header information.
869
911
  *
870
912
  * @event headerCellInfo
871
913
  */
@@ -877,14 +919,14 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
877
919
  */
878
920
  cellSelecting: EmitType<CellSelectingEventArgs>;
879
921
  /**
880
- * Triggers before column menu opens.
922
+ * Triggers before the column menu opens.
881
923
  *
882
924
  * @event columnMenuOpen
883
925
 
884
926
  */
885
927
  columnMenuOpen: EmitType<ColumnMenuOpenEventArgs>;
886
928
  /**
887
- * Triggers when click on column menu.
929
+ * Triggers when there is a click on the column menu.
888
930
  *
889
931
  * @event columnMenuClick
890
932
  */
@@ -896,284 +938,230 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
896
938
  */
897
939
  cellSelected: EmitType<CellSelectEventArgs>;
898
940
  /**
899
- * Triggers before the selected cell is deselecting.
941
+ * Triggers before a selected cell is deselected.
900
942
  *
901
943
  * @event cellDeselecting
902
944
 
903
945
  */
904
946
  cellDeselecting: EmitType<CellDeselectEventArgs>;
905
947
  /**
906
- * Triggers when a particular selected cell is deselected.
948
+ * Triggers when a selected cell is deselected.
907
949
  *
908
950
  * @event cellDeselected
909
951
 
910
952
  */
911
953
  cellDeselected: EmitType<CellDeselectEventArgs>;
912
954
  /**
913
- * Triggers when column resize starts.
955
+ * Triggers when column resizing starts.
914
956
  *
915
957
  * @event resizeStart
916
958
 
917
959
  */
918
960
  resizeStart: EmitType<ResizeArgs>;
919
961
  /**
920
- * Triggers on column resizing.
962
+ * Triggers during column resizing.
921
963
  *
922
964
  * @event resizing
923
-
924
965
  */
925
966
  resizing: EmitType<ResizeArgs>;
926
967
  /**
927
- * Triggers when column resize ends.
968
+ * Triggers when column resizing ends.
928
969
  *
929
970
  * @event resizeStop
930
-
931
971
  */
932
972
  resizeStop: EmitType<ResizeArgs>;
933
973
  /**
934
- * Triggers when column header element drag (move) starts.
974
+ * Triggers when column header dragging begins.
935
975
  *
936
976
  * @event columnDragStart
937
-
938
977
  */
939
978
  columnDragStart: EmitType<ColumnDragEventArgs>;
940
979
  /**
941
- * Triggers when column header element is dragged (moved) continuously.
980
+ * Triggers continuously while the column header is being dragged.
942
981
  *
943
982
  * @event columnDrag
944
-
945
983
  */
946
984
  columnDrag: EmitType<ColumnDragEventArgs>;
947
985
  /**
948
- * Triggers when a column header element is dropped on the target column.
986
+ * Triggers when a column header is dropped onto the target column.
949
987
  *
950
988
  * @event columnDrop
951
-
952
989
  */
953
990
  columnDrop: EmitType<ColumnDragEventArgs>;
954
991
  /**
955
- * Triggers when the check box state change in checkbox column.
992
+ * Triggers when the state of a checkbox changes in a checkbox column.
956
993
  *
957
994
  * @event checkboxChange
958
-
959
995
  */
960
996
  checkboxChange: EmitType<CheckBoxChangeEventArgs>;
961
997
  /**
962
- * Triggers after print action is completed.
998
+ * Triggers after the print action has been completed.
963
999
  *
964
1000
  * @event printComplete
965
-
966
1001
  */
967
1002
  printComplete: EmitType<PrintEventArgs>;
968
1003
  /**
969
- * Triggers before the print action starts.
1004
+ * Triggers before the print action begins.
970
1005
  *
971
1006
  * @event beforePrint
972
-
973
1007
  */
974
1008
  beforePrint: EmitType<PrintEventArgs>;
975
1009
  /**
976
- * Triggers when toolbar item is clicked.
1010
+ * Triggers when a toolbar item is clicked.
977
1011
  *
978
1012
  * @event toolbarClick
979
1013
  */
980
1014
  toolbarClick: EmitType<ClickEventArgs>;
981
1015
  /**
982
- * Triggers before data is bound to Tree Grid.
1016
+ * Triggers before data is bound to the TreeGrid.
983
1017
  *
984
1018
  * @event beforeDataBound
985
1019
  */
986
1020
  beforeDataBound: EmitType<BeforeDataBoundArgs>;
987
1021
  /**
988
- * Triggers before context menu opens.
1022
+ * Triggers before the context menu opens.
989
1023
  *
990
1024
  * @event contextMenuOpen
991
-
992
1025
  */
993
1026
  contextMenuOpen: EmitType<BeforeOpenCloseMenuEventArgs>;
994
1027
  /**
995
- * Triggers when click on context menu.
1028
+ * Triggers when an item in the context menu is clicked.
996
1029
  *
997
1030
  * @event contextMenuClick
998
1031
  */
999
1032
  contextMenuClick: EmitType<MenuEventArgs>;
1000
1033
  /**
1001
- * Triggers before TreeGrid copy action.
1034
+ * Triggers before the TreeGrid copy action is initiated.
1002
1035
  *
1003
1036
  * @event beforeCopy
1004
-
1005
1037
  */
1006
1038
  beforeCopy: EmitType<BeforeCopyEventArgs>;
1007
1039
  /**
1008
- * Triggers before TreeGrid paste action.
1040
+ * Triggers before the TreeGrid paste action is initiated.
1009
1041
  *
1010
1042
  * @event beforePaste
1011
-
1012
1043
  */
1013
1044
  beforePaste: EmitType<BeforePasteEventArgs>;
1014
1045
  /**
1015
- * Triggers when row elements are dragged (moved) continuously.
1046
+ * Triggers continuously while row elements are being dragged.
1016
1047
  *
1017
1048
  * @event rowDrag
1018
-
1019
1049
  */
1020
1050
  rowDrag: EmitType<RowDragEventArgs>;
1021
1051
  /**
1022
- * Triggers when row element’s drag(move) starts.
1052
+ * Triggers when row element dragging starts.
1023
1053
  *
1024
1054
  * @event rowDragStart
1025
-
1026
1055
  */
1027
1056
  rowDragStart: EmitType<RowDragEventArgs>;
1028
1057
  /**
1029
- * Triggers when row element’s before drag(move).
1058
+ * Triggers just before the row element dragging begins.
1030
1059
  *
1031
1060
  * @event rowDragStartHelper
1032
-
1033
1061
  */
1034
1062
  rowDragStartHelper: EmitType<RowDragEventArgs>;
1035
1063
  /**
1036
- * Triggers when row elements are dropped on the target row.
1064
+ * Triggers when a row element is dropped onto the target row.
1037
1065
  *
1038
1066
  * @event rowDrop
1039
-
1040
1067
  */
1041
1068
  rowDrop: EmitType<RowDragEventArgs>;
1042
1069
  /**
1043
- * The `selectedRowIndex` allows you to select a row at initial rendering.
1044
- * You can also get the currently selected row index.
1045
- *
1046
- * @default -1
1047
- */
1048
- selectedRowIndex: number;
1049
- /**
1050
- * Configures the selection settings.
1051
- *
1052
- * @default {mode: 'Row', cellSelectionMode: 'Flow', type: 'Single'}
1053
- */
1054
- selectionSettings: SelectionSettingsModel;
1055
- /**
1056
- * If `allowExcelExport` set to true, then it will allow the user to export treegrid to Excel file.
1057
- *
1058
- * > Check the [`ExcelExport`](../../treegrid/excel-export/) to configure exporting document.
1059
- *
1060
- * @default false
1061
- */
1062
- allowExcelExport: boolean;
1063
- /**
1064
- * If `allowPdfExport` set to true, then it will allow the user to export treegrid to Pdf file.
1065
- *
1066
- * > Check the [`Pdfexport`](../../treegrid/pdf-export/) to configure the exporting document.
1067
- *
1068
- * @default false
1069
- */
1070
- allowPdfExport: boolean;
1071
- /**
1072
- * Triggers before exporting each cell to PDF document.
1073
- * You can also customize the PDF cells.
1070
+ * Triggers before each cell is exported to a PDF document, allowing customization of cells.
1074
1071
  *
1075
1072
  * @event pdfQueryCellInfo
1076
-
1077
1073
  */
1078
1074
  pdfQueryCellInfo: EmitType<PdfQueryCellInfoEventArgs>;
1079
1075
  /**
1080
- * Triggers before exporting each header cell to PDF document.
1081
- * You can also customize the PDF cells.
1076
+ * Triggers before each header cell is exported to a PDF document, allowing customization of cells.
1082
1077
  *
1083
1078
  * @event pdfHeaderQueryCellInfo
1084
-
1085
1079
  */
1086
1080
  pdfHeaderQueryCellInfo: EmitType<PdfHeaderQueryCellInfoEventArgs>;
1087
1081
  /**
1088
- * Triggers before exporting each cell to Excel file.
1089
- * You can also customize the Excel cells.
1082
+ * Triggers before each cell is exported to an Excel file, allowing customization of cells.
1090
1083
  *
1091
1084
  * @event excelQueryCellInfo
1092
-
1093
1085
  */
1094
1086
  excelQueryCellInfo: EmitType<ExcelQueryCellInfoEventArgs>;
1095
1087
  /**
1096
- * Triggers before exporting each header cell to Excel file.
1097
- * You can also customize the Excel cells.
1088
+ * Triggers before each header cell is exported to an Excel file, allowing customization of cells.
1098
1089
  *
1099
1090
  * @event excelHeaderQueryCellInfo
1100
-
1101
1091
  */
1102
1092
  excelHeaderQueryCellInfo: EmitType<ExcelHeaderQueryCellInfoEventArgs>;
1103
1093
  /**
1104
- * Triggers before TreeGrid data is exported to Excel file.
1094
+ * Triggers before TreeGrid data is exported to an Excel file.
1105
1095
  *
1106
1096
  * @event beforeExcelExport
1107
1097
  */
1108
1098
  beforeExcelExport: EmitType<Object>;
1109
1099
  /**
1110
- * Triggers after TreeGrid data is exported to Excel file.
1100
+ * Triggers after TreeGrid data is exported to an Excel file.
1111
1101
  *
1112
1102
  * @event excelExportComplete
1113
-
1114
1103
  */
1115
1104
  excelExportComplete: EmitType<ExcelExportCompleteArgs>;
1116
1105
  /**
1117
- * Triggers before TreeGrid data is exported to PDF document.
1106
+ * Triggers before TreeGrid data is exported to a PDF document.
1118
1107
  *
1119
1108
  * @event beforePdfExport
1120
1109
  */
1121
1110
  beforePdfExport: EmitType<Object>;
1122
1111
  /**
1123
- * Triggers after TreeGrid data is exported to PDF document.
1112
+ * Triggers after TreeGrid data is exported to a PDF document.
1124
1113
  *
1125
1114
  * @event pdfExportComplete
1126
-
1127
1115
  */
1128
1116
  pdfExportComplete: EmitType<PdfExportCompleteArgs>;
1129
1117
  /**
1130
- * Export TreeGrid data to Excel file(.xlsx).
1118
+ * Exports the TreeGrid data to an Excel file (.xlsx).
1131
1119
  *
1132
- * @param {ExcelExportProperties | TreeGridExcelExportProperties} excelExportProperties - Defines the export properties of the Tree Grid.
1133
- * @param {boolean} isMultipleExport - Define to enable multiple export.
1134
- * @param {workbook} workbook - Defines the Workbook if multiple export is enabled.
1135
- * @param {boolean} isBlob - If 'isBlob' set to true, then it will be returned as blob data.
1136
- * @returns {Promise<any>} - Returns promise object of export action
1120
+ * @param {ExcelExportProperties | TreeGridExcelExportProperties} excelExportProperties - The properties used to configure the Excel export.
1121
+ * @param {boolean} isMultipleExport - Indicates whether multiple exporting is enabled.
1122
+ * @param {workbook} workbook - The workbook instance used for multiple exports.
1123
+ * @param {boolean} isBlob - If set to true, the result will be returned as blob data.
1124
+ * @returns {Promise<any>} - Returns a promise that resolves with the result of the export action.
1137
1125
  */
1138
1126
  excelExport(excelExportProperties?: ExcelExportProperties | TreeGridExcelExportProperties, isMultipleExport?: boolean, workbook?: any, isBlob?: boolean): Promise<any>;
1139
1127
  /**
1140
- * Export TreeGrid data to CSV file.
1128
+ * Exports the TreeGrid data to a CSV file.
1141
1129
  *
1142
- * @param {ExcelExportProperties} excelExportProperties - Defines the export properties of the TreeGrid.
1143
- * @param {boolean} isMultipleExport - Define to enable multiple export.
1144
- * @param {workbook} workbook - Defines the Workbook if multiple export is enabled.
1145
- * @param {boolean} isBlob - If 'isBlob' set to true, then it will be returned as blob data.
1146
- * @returns {Promise<any>} - Returns promise object of export action
1130
+ * @param {ExcelExportProperties} excelExportProperties - The properties used to configure the CSV export.
1131
+ * @param {boolean} isMultipleExport - Indicates whether multiple exporting is enabled.
1132
+ * @param {workbook} workbook - The workbook instance used for multiple exports.
1133
+ * @param {boolean} isBlob - If set to true, the result will be returned as blob data.
1134
+ * @returns {Promise<any>} - Returns a promise that resolves with the result of the export action.
1147
1135
  */
1148
1136
  csvExport(excelExportProperties?: ExcelExportProperties, isMultipleExport?: boolean, workbook?: any, isBlob?: boolean): Promise<any>;
1149
1137
  /**
1150
- * Export TreeGrid data to PDF document.
1138
+ * Exports the TreeGrid data to a PDF document.
1151
1139
  *
1152
- * @param {PdfExportProperties | TreeGridPdfExportProperties} pdfExportProperties - Defines the export properties of the Tree Grid.
1153
- * @param {boolean} isMultipleExport - Define to enable multiple export.
1154
- * @param {Object} pdfDoc - Defined the Pdf Document if multiple export is enabled.
1155
- * @param {boolean} isBlob - If 'isBlob' set to true, then it will be returned as blob data.
1156
- * @returns {Promise<any>} - Returns promise object of export action
1140
+ * @param {PdfExportProperties | TreeGridPdfExportProperties} pdfExportProperties - The properties used to configure the PDF export.
1141
+ * @param {boolean} isMultipleExport - Indicates whether multiple exporting is enabled.
1142
+ * @param {Object} pdfDoc - The PDF document instance used for multiple exports.
1143
+ * @param {boolean} isBlob - If set to true, the result will be returned as blob data.
1144
+ * @returns {Promise<any>} - Returns a promise that resolves with the result of the export action.
1157
1145
  */
1158
1146
  pdfExport(pdfExportProperties?: PdfExportProperties | TreeGridPdfExportProperties, isMultipleExport?: boolean, pdfDoc?: Object, isBlob?: boolean): Promise<Object>;
1159
1147
  /**
1160
- * Sends a post request to export tree grid to excel file in server side.
1148
+ * Sends a POST request to export the TreeGrid to an Excel file on the server side.
1161
1149
  *
1162
- * @param {string} url - Pass URL for server side excel export action.
1150
+ * @param {string} url - The URL for the server-side Excel export action.
1163
1151
  * @returns {void}
1164
1152
  */
1165
1153
  serverExcelExport(url: string): void;
1166
1154
  /**
1167
- * Sends a post request to export tree grid to pdf file in server side.
1155
+ * Sends a POST request to export the TreeGrid to a PDF document on the server side.
1168
1156
  *
1169
- * @param {string} url - Pass URL for server-side pdf export action.
1157
+ * @param {string} url - The URL for the server-side PDF export action.
1170
1158
  * @returns {void}
1171
1159
  */
1172
1160
  serverPdfExport(url: string): void;
1173
1161
  /**
1174
- * Sends a Post request to export Tree Grid to CSV file in server side.
1162
+ * Sends a POST request to export the TreeGrid to a CSV file on the server side.
1175
1163
  *
1176
- * @param {string} url - Pass URL for server-side csv export action.
1164
+ * @param {string} url - The URL for the server-side CSV export action.
1177
1165
  * @returns {void}
1178
1166
  */
1179
1167
  serverCsvExport(url: string): void;
@@ -1214,62 +1202,57 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
1214
1202
  */
1215
1203
  protected preRender(): void;
1216
1204
  /**
1217
- * Sorts a column with the given options.
1205
+ * Sorts a column with the specified options.
1218
1206
  *
1219
- * @param {string} columnName - Defines the column name to be sorted.
1220
- * @param {SortDirection} direction - Defines the direction of sorting field.
1221
- * @param {boolean} isMultiSort - Specifies whether the previous sorted columns are to be maintained.
1207
+ * @param {string} columnName - The name of the column to be sorted.
1208
+ * @param {SortDirection} direction - The direction of the sorting operation.
1209
+ * @param {boolean} isMultiSort - Specifies whether previous sorted columns should be maintained during sorting.
1222
1210
  * @returns {void}
1223
1211
  */
1224
1212
  sortByColumn(columnName: string, direction: SortDirection, isMultiSort?: boolean): void;
1225
1213
  /**
1226
- * Clears all the sorted columns of the TreeGrid.
1214
+ * Clears all the sorted columns in the TreeGrid.
1227
1215
  *
1228
1216
  * @returns {void}
1229
1217
  */
1230
1218
  clearSorting(): void;
1231
1219
  /**
1232
- * Remove sorted column by field name.
1220
+ * Removes the sorted state from a column specified by the field name.
1233
1221
  *
1234
- * @param {string} field - Defines the column field name to remove sort.
1222
+ * @param {string} field - The field name of the column from which the sort state should be removed.
1235
1223
  * @returns {void}
1236
1224
  * @hidden
1237
1225
  */
1238
1226
  removeSortColumn(field: string): void;
1239
1227
  /**
1240
- * Searches TreeGrid records using the given key.
1241
- * You can customize the default search option by using the
1242
- * [`searchSettings`](./#searchsettings/).
1228
+ * Searches for TreeGrid records using a specified search string.
1229
+ * Customize the search behavior through the [searchSettings](./#searchsettings/).
1243
1230
  *
1244
- * @param {string} searchString - Defines the key.
1231
+ * @param {string} searchString - The string used as the search key.
1245
1232
  * @returns {void}
1246
1233
  */
1247
1234
  search(searchString: string): void;
1248
1235
  /**
1249
- * Changes the column width to automatically fit its content to ensure that the width shows the content without wrapping/hiding.
1250
- * > * This method ignores the hidden columns.
1251
- * > * Uses the `autoFitColumns` method in the `dataBound` event to resize at initial rendering.
1236
+ * Adjusts column widths to fit their content, ensuring content is displayed without wrapping or truncation.
1237
+ * - Hidden columns are ignored by this method.
1238
+ * - Use the `autoFitColumns` method during the `dataBound` event for initial rendering.
1252
1239
  *
1253
- * @param {string |string[]} fieldNames - Defines the column names.
1240
+ * @param {string | string[]} fieldNames - The name(s) of the column(s) to be auto-fitted.
1254
1241
  * @returns {void}
1255
- *
1256
- *
1257
- *
1258
1242
  */
1259
1243
  autoFitColumns(fieldNames?: string | string[]): void;
1260
1244
  /**
1261
- * Changes the TreeGrid column positions by field names.
1245
+ * Reorders TreeGrid columns by specifying their field names.
1262
1246
  *
1263
- * @param {string} fromFName - Defines the origin field name.
1264
- * @param {string} toFName - Defines the destination field name.
1247
+ * @param {string | string[]} fromFName - The field name(s) of the column(s) to be moved.
1248
+ * @param {string} toFName - The destination field name to place the moved columns.
1265
1249
  * @returns {void}
1266
1250
  */
1267
1251
  reorderColumns(fromFName: string | string[], toFName: string): void;
1268
1252
  private TreeGridLocale;
1269
1253
  /**
1270
- * By default, prints all the pages of the TreeGrid and hides the pager.
1271
- * > You can customize print options using the
1272
- * [`printMode`](./#printmode).
1254
+ * Prints all the pages of the TreeGrid and hides the pager by default.
1255
+ * Customize print options using the [printMode](./#printmode).
1273
1256
  *
1274
1257
  * @returns {void}
1275
1258
  */
@@ -1279,16 +1262,19 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
1279
1262
  private findPreviousRowElement;
1280
1263
  private initProperties;
1281
1264
  /**
1282
- * Binding events to the element while component creation.
1265
+ * Attaches event handlers to the necessary elements during the component's initialization.
1283
1266
  *
1284
1267
  * @hidden
1285
1268
  * @returns {void}
1286
1269
  */
1287
1270
  wireEvents(): void;
1288
1271
  /**
1289
- * To provide the array of modules needed for component rendering
1272
+ * Provides a list of the modules that are required for rendering the TreeGrid component.
1273
+ *
1274
+ * This method is essential for ensuring that all dependent modules are loaded and available
1275
+ * during the component's lifecycle, enabling full functionality.
1290
1276
  *
1291
- * @returns {ModuleDeclaration[]} - Returns TreeGrid modules collection
1277
+ * @returns {ModuleDeclaration[]} - Returns an array of the required TreeGrid module declarations.
1292
1278
  * @hidden
1293
1279
  */
1294
1280
  requiredModules(): ModuleDeclaration[];
@@ -1368,6 +1354,7 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
1368
1354
  */
1369
1355
  private getGridToolbar;
1370
1356
  private getGridColumns;
1357
+ private lastRowCellBorderUpdated;
1371
1358
  /**
1372
1359
  * Called internally if any of the property value changed.
1373
1360
  *
@@ -1378,14 +1365,19 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
1378
1365
  onPropertyChanged(newProp: TreeGridModel): void;
1379
1366
  private updateTreeColumnTextAlign;
1380
1367
  /**
1381
- * Destroys the component (detaches/removes all event handlers, attributes, classes, and empties the component element).
1368
+ * Destroys the TreeGrid component by detaching event handlers,
1369
+ * removing attributes and classes, and clearing the component's DOM elements.
1370
+ *
1371
+ * This method ensures that all resources used by the TreeGrid are properly released
1372
+ * and the component is cleaned up from the DOM to prevent memory leaks.
1382
1373
  *
1383
1374
  * @method destroy
1384
1375
  * @returns {void}
1385
1376
  */
1386
1377
  destroy(): void;
1387
1378
  /**
1388
- * Update the TreeGrid model
1379
+ * Updates the TreeGrid model and ensures that the underlying Grid's data model is in sync with TreeGrid.
1380
+ * This method binds current data and settings to the TreeGrid.
1389
1381
  *
1390
1382
  * @method dataBind
1391
1383
  * @returns {void}
@@ -1393,7 +1385,10 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
1393
1385
  */
1394
1386
  dataBind(): void;
1395
1387
  /**
1396
- * Get the properties to be maintained in the persisted state.
1388
+ * Retrieves the properties of the TreeGrid that should be retained and persisted between sessions.
1389
+ *
1390
+ * The method ensures that user preferences and important settings like paging, sorting, filtering,
1391
+ * column configurations, etc., are preserved and can be restored when the component is re-initialized.
1397
1392
  *
1398
1393
  * @returns {string} - Returns persist properties details
1399
1394
  * @hidden
@@ -1403,41 +1398,53 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
1403
1398
  private ignoreInColumn;
1404
1399
  private mouseClickHandler;
1405
1400
  /**
1406
- * Returns TreeGrid rows
1401
+ * Retrieves all the TreeGrid row elements.
1402
+ *
1403
+ * This method is useful for accessing the HTML representation of the rows for further manipulation or inspection.
1407
1404
  *
1408
1405
  * @returns {HTMLTableRowElement[]} - Returns row elements collection
1409
1406
  */
1410
1407
  getRows(): HTMLTableRowElement[];
1411
1408
  /**
1412
- * Gets the pager of the TreeGrid.
1409
+ * Obtains the pager element of the TreeGrid.
1410
+ *
1411
+ * The pager enables navigation between pages when the TreeGrid displays paginated data.
1413
1412
  *
1414
1413
  * @returns {Element} - Returns pager element
1415
1414
  */
1416
1415
  getPager(): Element;
1417
1416
  /**
1418
- * Adds a new record to the TreeGrid. Without passing parameters, it adds empty rows.
1419
- * > `editSettings.allowEditing` should be true.
1417
+ * Adds a new record to the TreeGrid at the specified position or default location.
1418
+ *
1419
+ * @param {Object} data - Object containing the data for the new record. If omitted, an empty row is added.
1420
+ * @param {number} index - The index at which the new row should be added.
1421
+ * @param {RowPosition} position - Specifies the position of the new row (e.g., before, after or child).
1422
+ *
1423
+ * > Requires `editSettings.allowAdding` to be true.
1420
1424
  *
1421
- * @param {Object} data - Defines the new add record data.
1422
- * @param {number} index - Defines the row index to be added.
1423
- * @param {RowPosition} position - Defines the new row position to be added.
1424
1425
  * @returns {void}
1425
1426
  */
1426
1427
  addRecord(data?: Object, index?: number, position?: RowPosition): void;
1427
1428
  /**
1428
- * Cancels edited state.
1429
+ * Cancels the current edit operation on the TreeGrid.
1430
+ *
1431
+ * This method discards changes made to the row and exits the edit mode without saving.
1429
1432
  *
1430
1433
  * @returns {void}
1431
1434
  */
1432
1435
  closeEdit(): void;
1433
1436
  /**
1434
- * Saves the cell that is currently edited. It does not save the value to the DataSource.
1437
+ * Saves the current cell value changes without committing to the data source.
1438
+ *
1439
+ * This operation persists the changes in the UI but not in the underlying data model.
1435
1440
  *
1436
1441
  * @returns {void}
1437
1442
  */
1438
1443
  saveCell(): void;
1439
1444
  /**
1440
- * To update the specified cell by given value without changing into edited state.
1445
+ * Updates the value of a specific cell directly, bypassing the edit mode.
1446
+ *
1447
+ * This method provides a quick way to update the UI and data without user interaction.
1441
1448
  *
1442
1449
  * @param {number} rowIndex Defines the row index.
1443
1450
  * @param {string} field Defines the column field.
@@ -1446,210 +1453,278 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
1446
1453
  */
1447
1454
  updateCell(rowIndex: number, field: string, value: string | number | boolean | Date): void;
1448
1455
  /**
1449
- * To update the specified row by given values without changing into edited state.
1456
+ * Updates a specific row with given values directly, skipping the edit state.
1450
1457
  *
1451
- * @param {number} index Defines the row index.
1452
- * @param {Object} data Defines the data object to be updated.
1458
+ * This method allows for bulk updates of row data programmatically.
1459
+ *
1460
+ * @param {number} index - The index of the row to update.
1461
+ * @param {Object} data - The data object containing updated field values.
1453
1462
  * @returns {void}
1454
1463
  */
1455
1464
  updateRow(index: number, data: Object): void;
1456
1465
  /**
1457
- * Delete a record with Given options. If fieldName and data is not given then TreeGrid will delete the selected record.
1458
- * > `editSettings.allowDeleting` should be true.
1466
+ * Deletes a record based on specified criteria or the selected record if none specified.
1459
1467
  *
1460
- * @param {string} fieldName - Defines the primary key field, 'Name of the column'.
1461
- * @param {Object} data - Defines the JSON data of the record to be deleted.
1468
+ * @param {string} fieldName - The name of the primary key field.
1469
+ * @param {Object} data - The data object representing the record to delete.
1462
1470
  * @returns {void}
1471
+ *
1472
+ * > Requires `editSettings.allowDeleting` to be true.
1463
1473
  */
1464
1474
  deleteRecord(fieldName?: string, data?: Object): void;
1465
1475
  /**
1466
- * To edit any particular row by TR element.
1476
+ * Initiates editing for a specific row using its HTML element.
1477
+ *
1478
+ * This allows for manual control of which row enters edit mode through the UI.
1467
1479
  *
1468
- * @param {HTMLTableRowElement} row - Defines the table row to be edited.
1480
+ * @param {HTMLTableRowElement} row - The table row element to enter into edit mode.
1469
1481
  * @returns {void}
1470
1482
  */
1471
1483
  startEdit(row?: HTMLTableRowElement): void;
1472
1484
  /**
1473
- * To edit any particular cell using row index and cell index.
1485
+ * Begins editing of a specific cell using row and field indices.
1474
1486
  *
1475
- * @param {number} rowIndex - Defines row index to edit a particular cell.
1476
- * @param {string} field - Defines the field name of the column to perform cell edit.
1487
+ * Customers can programmatically specify which cell to edit without user input.
1488
+ *
1489
+ * @param {number} rowIndex - The index of the row containing the cell.
1490
+ * @param {string} field - The field name of the cell to edit.
1477
1491
  * @returns {void}
1478
1492
  */
1479
1493
  editCell(rowIndex?: number, field?: string): void;
1480
1494
  /**
1481
- * Enables or disables ToolBar items.
1495
+ * Enables or disables specified ToolBar items within the TreeGrid.
1496
+ *
1497
+ * This facilitates dynamic control of toolbar actions based on application logic.
1482
1498
  *
1483
- * @param {string[]} items - Defines the collection of itemID of ToolBar items.
1484
- * @param {boolean} isEnable - Defines the items to be enabled or disabled.
1499
+ * @param {string[]} items - Array of ToolBar item IDs to enable or disable.
1500
+ * @param {boolean} isEnable - Boolean flag to determine whether to enable (true) or disable (false) items.
1485
1501
  * @returns {void}
1486
1502
  */
1487
1503
  enableToolbarItems(items: string[], isEnable: boolean): void;
1488
1504
  /**
1489
- * If TreeGrid is in editable state, you can save a record by invoking endEdit.
1505
+ * Commits the edits made to a record in edit mode, updating the data source.
1506
+ *
1507
+ * Use this method to finalize changes for rows in edit mode, ensuring persistence.
1490
1508
  *
1491
1509
  * @returns {void}
1492
1510
  */
1493
1511
  endEdit(): void;
1494
1512
  /**
1495
- * Column chooser can be displayed on screen by given position(X and Y axis).
1513
+ * Displays the column chooser at a specified screen position.
1496
1514
  *
1497
- * @param {number} x - Defines the X axis.
1498
- * @param {number} y - Defines the Y axis.
1515
+ * Useful for customizing the visibility of columns interactively via the UI.
1516
+ *
1517
+ * @param {number} x - The X-axis position of the column chooser.
1518
+ * @param {number} y - The Y-axis position of the column chooser.
1499
1519
  * @returns {void}
1500
1520
  */
1501
1521
  openColumnChooser(x?: number, y?: number): void;
1502
1522
  /**
1503
- * Delete any visible row by TR element.
1523
+ * Deletes a visible row from the TreeGrid using its HTML element.
1524
+ *
1525
+ * Apply this method when handling row deletions through DOM manipulations.
1504
1526
  *
1505
- * @param {HTMLTableRowElement} tr - Defines the table row element.
1527
+ * @param {HTMLTableRowElement} tr - The table row element to remove.
1506
1528
  * @returns {void}
1507
1529
  */
1508
1530
  deleteRow(tr: HTMLTableRowElement): void;
1509
1531
  /**
1510
- * Get the names of the primary key columns of the TreeGrid.
1532
+ * Retrieves the primary key field names used in the TreeGrid.
1533
+ *
1534
+ * This information is crucial for identifying and manipulating unique rows.
1511
1535
  *
1512
- * @returns {string[]} - Returns primary key collection
1536
+ * @returns {string[]} - Returns an array of primary key field names.
1513
1537
  */
1514
1538
  getPrimaryKeyFieldNames(): string[];
1515
1539
  /**
1516
- * Updates particular cell value based on the given primary key value.
1517
- * > Primary key column must be specified using `columns.isPrimaryKey` property.
1540
+ * Updates the value of a specific cell using its primary key for identification.
1518
1541
  *
1519
- * @param {string| number} key - Specifies the PrimaryKey value of dataSource.
1520
- * @param {string } field - Specifies the field name which you want to update.
1521
- * @param {string | number | boolean | Date} value - To update new value for the particular cell.
1542
+ * Useful for targeted updates that leverage unique identifiers to ensure accuracy.
1543
+ *
1544
+ * @param {string| number} key - The primary key value of the row containing the cell.
1545
+ * @param {string} field - The field name of the cell to update.
1546
+ * @param {string | number | boolean | Date} value - The new value to assign to the specified cell.
1522
1547
  * @returns {void}
1523
1548
  */
1524
1549
  setCellValue(key: string | number, field: string, value: string | number | boolean | Date): void;
1525
1550
  /**
1526
- * Updates and refresh the particular row values based on the given primary key value.
1527
- * > Primary key column must be specified using `columns.isPrimaryKey` property.
1551
+ * Updates the data for a specific row identified by its primary key and refreshes the display.
1552
+ *
1553
+ * Important for keeping the displayed data consistent with the source database or dataset.
1528
1554
  *
1529
- * @param {string| number} key - Specifies the PrimaryKey value of dataSource.
1530
- * @param {Object} rowData - To update new data for the particular row.
1555
+ * @param {string| number} key - The primary key value of the row to update.
1556
+ * @param {Object} rowData - The new data to apply to the row.
1531
1557
  * @returns {void}
1532
1558
  */
1533
1559
  setRowData(key: string | number, rowData?: ITreeData): void;
1534
1560
  /**
1535
- * Navigates to the specified target page.
1561
+ * Navigates to a specified page number within the TreeGrid pagination.
1562
+ *
1563
+ * This can be used to programmatically change the page being viewed,
1564
+ * allowing for scripted navigation through data.
1536
1565
  *
1537
- * @param {number} pageNo - Defines the page number to navigate.
1566
+ * @param {number} pageNo - The page number to navigate to. Must be within valid page range.
1538
1567
  * @returns {void}
1539
1568
  */
1540
1569
  goToPage(pageNo: number): void;
1541
1570
  /**
1542
- * Defines the text of external message.
1571
+ * Updates the external message displayed within the pager component.
1543
1572
  *
1544
- * @param {string} message - Defines the message to update.
1573
+ * This is useful for showing custom messages or additional information
1574
+ * related to the data set or pagination status.
1575
+ *
1576
+ * @param {string} message - The custom message to display in the pager.
1545
1577
  * @returns {void}
1546
1578
  */
1547
1579
  updateExternalMessage(message: string): void;
1548
1580
  /**
1549
- * Gets a cell by row and column index.
1581
+ * Retrieves a cell element based on its row and column indices in the TreeGrid.
1550
1582
  *
1551
- * @param {number} rowIndex - Specifies the row index.
1552
- * @param {number} columnIndex - Specifies the column index.
1553
- * @returns {Element} - Returns cell element in grid content
1583
+ * This method is helpful for accessing cell-level elements for custom
1584
+ * operations or styling.
1585
+ *
1586
+ * @param {number} rowIndex - The index of the row containing the cell.
1587
+ * @param {number} columnIndex - The index of the column containing the cell.
1588
+ * @returns {Element} - Returns the HTML element of the specified cell.
1554
1589
  */
1555
1590
  getCellFromIndex(rowIndex: number, columnIndex: number): Element;
1556
1591
  /**
1557
- * Gets a Column by column name.
1592
+ * Retrieves a column object by the column's field name.
1593
+ *
1594
+ * This is typically used for obtaining the details of a column for
1595
+ * configuration or data manipulation purposes.
1558
1596
  *
1559
- * @param {string} field - Specifies the column name.
1560
- * @returns {Column} - Returns tree grid column
1597
+ * @param {string} field - The field name of the column.
1598
+ * @returns {Column} - Returns the column object corresponding to the field.
1561
1599
  */
1562
1600
  getColumnByField(field: string): Column;
1563
1601
  /**
1564
- * Gets a column by UID.
1602
+ * Fetches a column object using the column's unique identifier (UID).
1603
+ *
1604
+ * Useful in scenarios where columns do not have unique field names but
1605
+ * are uniquely identifiable via UID.
1565
1606
  *
1566
- * @param {string} uid - Specifies the column UID.
1567
- * @returns {Column} - Returns tree grid column
1607
+ * @param {string} uid - The unique identifier for the column.
1608
+ * @returns {Column} - Returns the column object for the given UID.
1568
1609
  */
1569
1610
  getColumnByUid(uid: string): Column;
1570
1611
  /**
1571
- * Gets the collection of column fields.
1612
+ * Retrieves the names of all column fields in the TreeGrid.
1572
1613
  *
1573
- * @returns {string[]} - Returns column field name as collection
1614
+ * This method provides a list of field names useful for dynamic operations
1615
+ * or configuration where fields need to be enumerated or manipulated.
1616
+ *
1617
+ * @returns {string[]} - Returns an array of column field names.
1574
1618
  */
1575
1619
  getColumnFieldNames(): string[];
1576
1620
  /**
1577
- * Gets the footer div of the TreeGrid.
1621
+ * Retrieves the footer content element of the TreeGrid, usually for styling or custom manipulation.
1622
+ *
1623
+ * This can be used to access the footer for adding custom functionality
1624
+ * or styling purposes to enhance user interaction at the bottom of the grid.
1578
1625
  *
1579
- * @returns {Element} - Returns footer content div element
1626
+ * @returns {Element} - Returns the footer content HTML element.
1580
1627
  */
1581
1628
  getFooterContent(): Element;
1582
1629
  /**
1583
- * Gets the footer table element of the TreeGrid.
1630
+ * Acquires the footer table element of the TreeGrid for layout management.
1631
+ *
1632
+ * Useful for manipulating the table's structure or style beneath the grid content.
1584
1633
  *
1585
- * @returns {Element} - Returns footer content table element
1634
+ * @returns {Element} - Returns the footer table HTML element.
1586
1635
  */
1587
1636
  getFooterContentTable(): Element;
1588
1637
  /**
1589
- * Shows a column by its column name.
1638
+ * Shows one or more columns based on the specified column names.
1590
1639
  *
1591
- * @param {string|string[]} keys - Defines a single or collection of column names.
1592
- * @param {string} showBy - Defines the column key either as field name or header text.
1640
+ * This is useful for dynamically adjusting the visibility of columns
1641
+ * based on user actions or application logic.
1642
+ *
1643
+ * @param {string|string[]} keys - A single column name or an array of column names to show.
1644
+ * @param {string} showBy - Key to determine visibility either as field name or header text.
1593
1645
  * @returns {void}
1594
1646
  */
1595
1647
  showColumns(keys: string | string[], showBy?: string): void;
1596
1648
  /**
1597
- * Hides a column by column name.
1649
+ * Hides one or more columns based on the specified column names.
1650
+ *
1651
+ * Utilized to dynamically reduce the visibility of columns based on
1652
+ * user roles or preferences.
1598
1653
  *
1599
- * @param {string|string[]} keys - Defines a single or collection of column names.
1600
- * @param {string} hideBy - Defines the column key either as field name or header text.
1654
+ * @param {string|string[]} keys - A single column name or an array of column names to hide.
1655
+ * @param {string} hideBy - Key to evaluate columns either as field name or header text.
1601
1656
  * @returns {void}
1602
1657
  */
1603
1658
  hideColumns(keys: string | string[], hideBy?: string): void;
1604
1659
  /**
1605
- * Gets a column header by column name.
1660
+ * Retrieves a column header element based on the field name of the column.
1661
+ *
1662
+ * This method helps to directly manipulate headers, such as applying custom styles.
1606
1663
  *
1607
- * @param {string} field - Specifies the column name.
1608
- * @returns {Element} - Returns column header element
1664
+ * @param {string} field - The field name of the desired column.
1665
+ * @returns {Element} - Returns the HTML element of the column header.
1609
1666
  */
1610
1667
  getColumnHeaderByField(field: string): Element;
1611
1668
  /**
1612
- * Gets a column header by column index.
1669
+ * Acquires the column header element using the column's index.
1613
1670
  *
1614
- * @param {number} index - Specifies the column index.
1615
- * @returns {Element} - Returns column header element
1671
+ * Suitable for situations where direct column index is available
1672
+ * and header access is needed for operations.
1673
+ *
1674
+ * @param {number} index - The index of the column.
1675
+ * @returns {Element} - Returns the HTML element of the specified column header.
1616
1676
  */
1617
1677
  getColumnHeaderByIndex(index: number): Element;
1618
1678
  /**
1619
- * Gets a column header by UID.
1679
+ * Retrieves a column header element utilizing the column's UID.
1680
+ *
1681
+ * Useful for precision access to header elements when UIDs are used
1682
+ * uniquely to manage column identities.
1620
1683
  *
1621
- * @param {string} uid - Specifies the column uid.
1622
- * @returns {Element} - Returns column header element
1684
+ * @param {string} uid - The UID of the column.
1685
+ * @returns {Element} - Returns the HTML element of the column header.
1623
1686
  */
1624
1687
  getColumnHeaderByUid(uid: string): Element;
1625
1688
  /**
1626
- * Gets a column index by column name.
1689
+ * Determines the column index by the specified field name.
1627
1690
  *
1628
- * @param {string} field - Specifies the column name.
1629
- * @returns {number} - Returns column index
1691
+ * Helpful in converting field names to indices for operations that require
1692
+ * numeric input for array or collection indexing.
1693
+ *
1694
+ * @param {string} field - The field name of the column.
1695
+ * @returns {number} - Returns the index of the column.
1630
1696
  */
1631
1697
  getColumnIndexByField(field: string): number;
1632
1698
  private getVirtualColIndexByUid;
1633
1699
  /**
1634
- * Gets a column index by UID.
1700
+ * Determines the column index based on the unique identifier (UID).
1701
+ *
1702
+ * This can be crucial in scenarios that involve dynamic column management
1703
+ * where UID provides an accurate reference.
1635
1704
  *
1636
- * @param {string} uid - Specifies the column UID.
1637
- * @returns {number} - Returns column index
1705
+ * @param {string} uid - The UID of the column.
1706
+ * @returns {number} - Returns the column index.
1638
1707
  */
1639
1708
  getColumnIndexByUid(uid: string): number;
1640
1709
  /**
1641
- * Gets the columns from the TreeGrid.
1710
+ * Fetches a collection of columns from the TreeGrid optionally refreshing the column model.
1711
+ *
1712
+ * Use this method to retrieve and optionally refresh the list of columns
1713
+ * to ensure up-to-date configurations and settings.
1642
1714
  *
1643
- * @param {boolean} isRefresh - Defined whether to update DOM
1644
- * @returns {Column[]} - Returns treegrid columns collection
1715
+ * @param {boolean} isRefresh - Determines whether to refresh the grid's column model.
1716
+ * @returns {Column[]} - Returns an array of TreeGrid column objects.
1645
1717
  */
1646
1718
  getColumns(isRefresh?: boolean): Column[];
1647
1719
  private updateColumnModel;
1648
1720
  private updateColumnsWidth;
1649
1721
  /**
1650
- * Gets the content div of the TreeGrid.
1722
+ * Retrieves the main content area of the TreeGrid.
1651
1723
  *
1652
- * @returns {Element} - Return tree grid content element
1724
+ * This method allows access to the main content DIV, which can
1725
+ * be used for layout adjustments or adding custom elements.
1726
+ *
1727
+ * @returns {Element} - Returns the TreeGrid content HTML element.
1653
1728
  */
1654
1729
  getContent(): Element;
1655
1730
  private mergePersistTreeGridData;
@@ -1659,124 +1734,177 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
1659
1734
  private isFrozenGrid;
1660
1735
  private updateTreeGridModel;
1661
1736
  /**
1662
- * Gets the content table of the TreeGrid.
1737
+ * Retrieves the content table element of the TreeGrid.
1738
+ *
1739
+ * This table contains the main data display area, allowing for
1740
+ * interaction and data manipulation directly within the TreeGrid.
1663
1741
  *
1664
- * @returns {Element} - Returns content table element
1742
+ * @returns {Element} - Returns the HTML element representing the content table.
1665
1743
  */
1666
1744
  getContentTable(): Element;
1667
1745
  /**
1668
- * Gets all the TreeGrid's data rows.
1746
+ * Obtains all data row elements from the TreeGrid, excluding summary rows.
1669
1747
  *
1670
- * @returns {Element[]} - Returns row elements
1748
+ * Provides a way to access the visual representation of data for purposes
1749
+ * like custom formatting or event binding.
1750
+ *
1751
+ * @returns {Element[]} - Returns an array of data row elements.
1671
1752
  */
1672
1753
  getDataRows(): Element[];
1673
1754
  /**
1674
- * Get current visible data of TreeGrid.
1755
+ * Retrieves the current set of records that are visible in the TreeGrid view.
1756
+ *
1757
+ * This method excludes any summary rows to focus on the main data set
1758
+ * currently being viewed by the user.
1675
1759
  *
1676
- * @returns {Object[]} - Returns current view records
1760
+ * @returns {Object[]} - Returns an array of the current view records.
1677
1761
  * @isGenericType true
1678
1762
  */
1679
1763
  getCurrentViewRecords(): Object[];
1680
1764
  /**
1681
- * Gets the added, edited,and deleted data before bulk save to the DataSource in batch mode.
1765
+ * Collects data changes (added, edited, and deleted) that have not been saved in batch mode.
1766
+ *
1767
+ * This allows you to view pending changes awaiting a commit to the data source.
1682
1768
  *
1683
- * @returns {Object} - Returns batch changes
1769
+ * @returns {Object} - Returns an object detailing batch changes.
1684
1770
  */
1685
1771
  getBatchChanges(): Object;
1686
1772
  /**
1687
- * Gets the header div of the TreeGrid.
1773
+ * Retrieves the header content element of the TreeGrid.
1688
1774
  *
1689
- * @returns {Element} - Returns Header content element
1775
+ * Mainly used for interacting with the header section, which includes
1776
+ * column headers and any applied header styling or events.
1777
+ *
1778
+ * @returns {Element} - Returns the HTML element for header content.
1690
1779
  */
1691
1780
  getHeaderContent(): Element;
1692
1781
  /**
1693
- * Gets the header table element of the TreeGrid.
1782
+ * Retrieves the header table element of the TreeGrid.
1783
+ *
1784
+ * This method is useful for direct access to the table structure
1785
+ * where column headers are defined.
1694
1786
  *
1695
- * @returns {Element} - Return header table element
1787
+ * @returns {Element} - Returns the HTML element for the header table.
1696
1788
  */
1697
1789
  getHeaderTable(): Element;
1698
1790
  /**
1699
- * Gets a row by index.
1791
+ * Fetches a specific row element based on its index in the TreeGrid.
1700
1792
  *
1701
- * @param {number} index - Specifies the row index.
1702
- * @returns {Element} - Returns row element
1793
+ * This provides a way to directly access and manipulate a row using its index.
1794
+ *
1795
+ * @param {number} index - The index of the desired row.
1796
+ * @returns {Element} - Returns the HTML element of the specified row.
1703
1797
  */
1704
1798
  getRowByIndex(index: number): Element;
1705
1799
  /**
1706
- * Get a row information based on cell
1800
+ * Provides detailed information about a row based on a specified target element.
1801
+ *
1802
+ * Integral for retrieving metadata such as row index or data object
1803
+ * when working with events or complex tree structures.
1707
1804
  *
1708
- * @param {Element | EventTarget} target - Target row element
1709
- * @returns {RowInfo} - Returns row information in a JSON object
1805
+ * @param {Element | EventTarget} target - The target element or event triggering the request.
1806
+ * @returns {RowInfo} - Returns an object containing row information.
1710
1807
  */
1711
1808
  getRowInfo(target: Element | EventTarget): RowInfo;
1712
1809
  /**
1713
- * Gets UID by column name.
1810
+ * Finds the unique identifier (UID) for a column based on its field name.
1811
+ *
1812
+ * UIDs are essential for precise identification and manipulation within complex grids.
1714
1813
  *
1715
- * @param {string} field - Specifies the column name.
1716
- * @returns {string} - Returns unique id based on column field name given
1814
+ * @param {string} field - The field name of the column.
1815
+ * @returns {string} - Returns the unique identifier for the specified column.
1717
1816
  */
1718
1817
  getUidByColumnField(field: string): string;
1719
1818
  /**
1720
- * Gets the visible columns from the TreeGrid.
1819
+ * Retrieves all the columns that are currently set to be visible within the TreeGrid.
1721
1820
  *
1722
- * @returns {Column[]} - Returns visible columns collection
1821
+ * Helps in understanding the user's current view and can be used to dynamically
1822
+ * adjust the visible columns.
1823
+ *
1824
+ * @returns {Column[]} - Returns an array of visible column objects.
1723
1825
  */
1724
1826
  getVisibleColumns(): Column[];
1725
1827
  /**
1726
- * By default, TreeGrid shows the spinner for all its actions. You can use this method to show spinner at your needed time.
1828
+ * Displays a loading spinner overlay across the TreeGrid for any data action or long-running process.
1829
+ *
1830
+ * This can be manually invoked to indicate processing, enhancing user experience by providing feedback.
1727
1831
  *
1728
1832
  * @returns {void}
1729
1833
  */
1730
1834
  showSpinner(): void;
1731
1835
  /**
1732
- * Manually shown spinner needs to hide by `hideSpinnner`.
1836
+ * Hides a manually shown loading spinner overlay from the TreeGrid.
1837
+ *
1838
+ * Ensures that any long-running process indication is removed after completion
1839
+ * to manage user interface aesthetics.
1733
1840
  *
1734
1841
  * @returns {void}
1735
1842
  */
1736
1843
  hideSpinner(): void;
1737
1844
  /**
1738
- * Refreshes the TreeGrid header and content.
1845
+ * Refreshes the visual appearance and data of the TreeGrid, updating header and content.
1846
+ *
1847
+ * This is crucial for synchronizing the displayed data with the underlying data source,
1848
+ * ensuring the view reflects current data.
1739
1849
  *
1740
1850
  * @returns {void}
1741
1851
  */
1742
1852
  refresh(): void;
1743
1853
  /**
1744
- * Get the records of checked rows.
1854
+ * Retrieves the records associated with rows that have their checkboxes checked.
1855
+ *
1856
+ * Facilitates operations that require information about specifically selected or
1857
+ * interacted rows within the grid.
1745
1858
  *
1746
- * @returns {Object[]} - Returns records that has been checked
1859
+ * @returns {Object[]} - Returns an array of checked row data objects.
1747
1860
  * @isGenericType true
1748
1861
  */
1749
1862
  getCheckedRecords(): Object[];
1750
1863
  /**
1751
- * Get the visible records corresponding to rows visually displayed.
1864
+ * Retrieves currently visible records according to the TreeGrid's visual state.
1865
+ *
1866
+ * It considers row expansion and collapse states to return only those records
1867
+ * that a user can currently interact with.
1752
1868
  *
1753
- * @returns {Object[]} - Returns visible records based on collapse state of rows
1869
+ * @returns {Object[]} - Returns visible records reflecting the TreeGrid's current view.
1754
1870
  * @isGenericType true
1755
1871
  */
1756
1872
  getVisibleRecords(): Object[];
1757
1873
  /**
1758
- * Get the indexes of checked rows.
1874
+ * Retrieves the indices of rows that have their checkboxes checked.
1759
1875
  *
1760
- * @returns {number[]} - Returns checked row indexes
1876
+ * This can assist in programatically assessing which rows have been selected
1877
+ * by checkbox interaction for further processing.
1878
+ *
1879
+ * @returns {number[]} - Returns an array of indices corresponding to checked rows.
1761
1880
  */
1762
1881
  getCheckedRowIndexes(): number[];
1763
1882
  /**
1764
- * Checked the checkboxes using rowIndexes.
1883
+ * Selects rows in the TreeGrid using row indices, checking their associated checkboxes.
1884
+ *
1885
+ * This method provides automation for selecting or highlighting specific rows,
1886
+ * useful in scenarios needing pre-selection or default selections.
1765
1887
  *
1766
- * @param {number[]} indexes - row indexes
1888
+ * @param {number[]} indexes - An array of row indices to be marked as selected.
1767
1889
  * @returns {void}
1768
1890
  */
1769
1891
  selectCheckboxes(indexes: number[]): void;
1770
1892
  /**
1771
- * Refreshes the TreeGrid column changes.
1893
+ * Updates and refreshes the TreeGrid's column definitions and layout.
1894
+ *
1895
+ * Ensures that the latest column settings are displayed, either refreshing the UI
1896
+ * or adjusting internal configurations to match current data or configuration updates.
1772
1897
  *
1773
- * @param {boolean} refreshUI - Defined whether to refresh the DOM
1898
+ * @param {boolean} refreshUI - A flag indicating whether the DOM should be updated.
1774
1899
  * @returns {void}
1775
1900
  */
1776
1901
  refreshColumns(refreshUI?: boolean): void;
1777
1902
  private getTreeColumn;
1778
1903
  /**
1779
- * Refreshes the TreeGrid header.
1904
+ * Refreshes the header section of the TreeGrid to reflect any structural or data changes.
1905
+ *
1906
+ * This method is useful when there are dynamic updates or layout adjustments
1907
+ * needed in the header portion to ensure it aligns with current grid data or settings.
1780
1908
  *
1781
1909
  * @returns {void}
1782
1910
  */
@@ -1790,12 +1918,15 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
1790
1918
  */
1791
1919
  private expandCollapseRequest;
1792
1920
  /**
1793
- * Expands child rows
1921
+ * Expands the specified parent row within the TreeGrid to reveal its nested data.
1922
+ *
1923
+ * This method is useful for programmatically expanding rows to display their
1924
+ * hierarchical children, providing detailed views for nested data structures.
1794
1925
  *
1795
- * @param {HTMLTableRowElement} row - Expands the given row
1796
- * @param {Object} record - Expands the given record
1797
- * @param {Object} key - Primary key value
1798
- * @param {number} level - Specifies the hierarchical level of the record
1926
+ * @param {HTMLTableRowElement} row - The table row element that should be expanded.
1927
+ * @param {Object} record - Optional. Represents the data record associated with the row to be expanded.
1928
+ * @param {Object} key - Optional. The primary key value that uniquely identifies the record.
1929
+ * @param {number} level - Optional. Indicates the hierarchical level of the record within the TreeGrid.
1799
1930
  * @returns {void}
1800
1931
  */
1801
1932
  expandRow(row: HTMLTableRowElement, record?: Object, key?: Object, level?: number): void;
@@ -1803,56 +1934,83 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
1803
1934
  private expandCollapseAllChildren;
1804
1935
  private getCollapseExpandRecords;
1805
1936
  /**
1806
- * Collapses child rows
1937
+ * Collapses the specified parent row in the TreeGrid.
1938
+ *
1939
+ * This method collapses the row associated with the provided HTMLTableRowElement,
1940
+ * hiding any of its displayed child rows. It is typically used to manage the
1941
+ * visibility of hierarchical data within a tree structure.
1807
1942
  *
1808
- * @param {HTMLTableRowElement} row - Collapse the given row
1809
- * @param {Object} record - Collapse the given record
1810
- * @param {Object} key - Primary key value
1943
+ * @param {HTMLTableRowElement} row - The HTMLTableRowElement representing the parent row
1944
+ * whose child rows are to be collapsed.
1945
+ * @param {Object} record - (Optional) The data record associated with the row being collapsed.
1946
+ * This can be used to access or manipulate the underlying data
1947
+ * when collapsing the row.
1948
+ * @param {Object} key - (Optional) The primary key value of the record. It can be used to identify
1949
+ * the target record uniquely when collapsing the row, especially in cases
1950
+ * where the row or record data needs to be referenced or logged.
1811
1951
  * @returns {void}
1812
1952
  */
1813
1953
  collapseRow(row: HTMLTableRowElement, record?: Object, key?: Object): void;
1814
1954
  private collapseRows;
1815
1955
  private updateExpandStateMapping;
1816
1956
  /**
1817
- * Expands the records at specific hierarchical level
1957
+ * Expands all the records at the specified hierarchical level within the TreeGrid.
1818
1958
  *
1819
- * @param {number} level - Expands the parent rows at given level
1959
+ * This method is useful for visually expanding data at a certain depth, making
1960
+ * all parent rows visible at the given level and their child rows accessible.
1961
+ *
1962
+ * @param {number} level - The hierarchical level at which parent rows should be expanded.
1820
1963
  * @returns {void}
1821
1964
  */
1822
1965
  expandAtLevel(level: number): void;
1823
1966
  /**
1824
- * Expands the records by given primary key value
1967
+ * Expands a specific record identified by the provided primary key value.
1968
+ *
1969
+ * This method is useful for expanding particular node in the TreeGrid when
1970
+ * the parent rows need to be targeted individually by their unique key.
1825
1971
  *
1826
- * @param {Object} key - Expands the parent rows with given primary key value
1972
+ * @param {Object} key - The primary key value of the record to be expanded.
1827
1973
  * @returns {void}
1828
1974
  */
1829
1975
  expandByKey(key: Object): void;
1830
1976
  private expandAction;
1831
1977
  private getRecordDetails;
1832
1978
  /**
1833
- * Collapses the records at specific hierarchical level
1979
+ * Collapses all the records at the specified hierarchical level within the TreeGrid.
1980
+ *
1981
+ * This function helps in hiding child rows for all parent nodes at a given level,
1982
+ * effectively reducing the visible depth of the hierarchical structure.
1834
1983
  *
1835
- * @param {number} level - Define the parent row level which needs to be collapsed
1984
+ * @param {number} level - The hierarchical level at which parent rows should be collapsed.
1836
1985
  * @returns {void}
1837
1986
  */
1838
1987
  collapseAtLevel(level: number): void;
1839
1988
  /**
1840
- * Collapses the records by given primary key value
1989
+ * Collapses a specific record identified by the provided primary key value.
1841
1990
  *
1842
- * @param {Object} key - Collapses the parent rows with given primary key value
1991
+ * This method is useful for collapsing particular node in the TreeGrid when
1992
+ * the parent rows need to be targeted individually by their unique key.
1993
+ *
1994
+ * @param {Object} key - The primary key value of the record to be collapsed.
1843
1995
  * @returns {void}
1844
1996
  */
1845
1997
  collapseByKey(key: Object): void;
1846
1998
  private expandCollapseActionByKey;
1847
1999
  private collapseAction;
1848
2000
  /**
1849
- * Expands All the rows
2001
+ * Expands all rows in the TreeGrid, making the full hierarchy visible.
2002
+ *
2003
+ * This method should be used with caution on large datasets, as it makes
2004
+ * all nodes and their child rows visible, which might affect performance.
1850
2005
  *
1851
2006
  * @returns {void}
1852
2007
  */
1853
2008
  expandAll(): void;
1854
2009
  /**
1855
- * Collapses All the rows
2010
+ * Collapses all rows in the TreeGrid, hiding all child rows and leaving only parent nodes visible.
2011
+ *
2012
+ * This method can be used to quickly minimize the view to only top-level data,
2013
+ * which is helpful for summarizing or performing broad overviews of the dataset.
1856
2014
  *
1857
2015
  * @returns {void}
1858
2016
  */
@@ -1874,15 +2032,6 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
1874
2032
  * @hidden
1875
2033
  */
1876
2034
  private sanitize;
1877
- /**
1878
- * Updates the rows and cells
1879
- *
1880
- * @param {Object[]} records - Updates the given records
1881
- * @param {HTMLTableRowElement[]} rows - Updates the given rows
1882
- * @param {number} index - Updates the given cell index
1883
- * @returns {void}
1884
- */
1885
- private updateRowAndCellElements;
1886
2035
  /**
1887
2036
  * @hidden
1888
2037
  * @returns {void}
@@ -1895,23 +2044,26 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
1895
2044
  */
1896
2045
  private removeListener;
1897
2046
  /**
1898
- * Filters TreeGrid row by column name with the given options.
2047
+ * Filters the TreeGrid rows based on a specified column and filter criteria.
2048
+ *
2049
+ * This method allows for dynamic filtering against column data using various
2050
+ * operators and values, supporting case-sensitive filtering and accent sensitivity.
1899
2051
  *
1900
- * @param {string} fieldName - Defines the field name of the column.
1901
- * @param {string} filterOperator - Defines the operator to filter records.
1902
- * @param {string | number | Date | boolean} filterValue - Defines the value used to filter records.
1903
- * @param {string} predicate - Defines the relationship between one filter query and another by using AND or OR predicate.
1904
- * @param {boolean} matchCase - If match case is set to true, the TreeGrid filters the records with exact match. if false, it filters
1905
- * case insensitive records (uppercase and lowercase letters are treated the same).
1906
- * @param {boolean} ignoreAccent - If ignoreAccent is set to true,
1907
- * then filter ignores diacritic characters or accents while filtering.
1908
- * @param {string} actualFilterValue - Defines the actual filter value for filter column.
1909
- * @param {string} actualOperator - Defines the actual filter operator for filter column.
2052
+ * @param {string} fieldName - The name of the column to apply the filter on.
2053
+ * @param {string} filterOperator - The operator used to perform the filter (e.g., 'equals', 'startswith').
2054
+ * @param {string | number | Date | boolean } filterValue - The value to filter against.
2055
+ * @param {string} predicate - The logical operator ('AND'/'OR') to combine this filter with others.
2056
+ * @param {boolean} matchCase - If true, the filter performs a case-sensitive match.
2057
+ * @param {boolean} ignoreAccent - If true, the filter ignores diacritical marks.
2058
+ * @param {string} actualFilterValue - The original value used for filtering, useful for distinguishing displayed and actual values.
2059
+ * @param {string} actualOperator - The actual operator that is applied when different from the displayed operator.
1910
2060
  * @returns {void}
1911
2061
  */
1912
2062
  filterByColumn(fieldName: string, filterOperator: string, filterValue: string | number | Date | boolean | number[] | string[] | Date[] | boolean[], predicate?: string, matchCase?: boolean, ignoreAccent?: boolean, actualFilterValue?: string, actualOperator?: string): void;
1913
2063
  /**
1914
- * Clears all the filtered rows of the TreeGrid.
2064
+ * Clears all filters applied to the TreeGrid, restoring the view to show all records.
2065
+ *
2066
+ * This method is useful for resetting the grid to its unfiltered state.
1915
2067
  *
1916
2068
  * @returns {void}
1917
2069
  */
@@ -1926,54 +2078,68 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
1926
2078
  */
1927
2079
  removeFilteredColsByField(field: string, isClearFilterBar?: boolean): void;
1928
2080
  /**
1929
- * Selects a row by given index.
2081
+ * Selects a row in the TreeGrid by its index.
1930
2082
  *
1931
- * @param {number} index - Defines the row index.
1932
- * @param {boolean} isToggle - If set to true, then it toggles the selection.
2083
+ * Use this method to highlight a specific row; useful for programmatically navigating data.
2084
+ *
2085
+ * @param {number} index - Index of the row to select.
2086
+ * @param {boolean} isToggle - If true, toggles the selection state of the row.
1933
2087
  * @returns {void}
1934
2088
  */
1935
2089
  selectRow(index: number, isToggle?: boolean): void;
1936
2090
  /**
1937
- * Selects a collection of rows by indexes.
2091
+ * Selects multiple rows in the TreeGrid given an array of row indexes.
2092
+ *
2093
+ * Useful for batch operations where multiple row selections are necessary.
1938
2094
  *
1939
- * @param {number[]} rowIndexes - Specifies the row indexes.
2095
+ * @param {number[]} rowIndexes - Array of row index numbers to select.
1940
2096
  * @returns {void}
1941
2097
  */
1942
2098
  selectRows(rowIndexes: number[]): void;
1943
2099
  /**
1944
- * Deselects the current selected rows and cells.
2100
+ * Deselects all selected rows and cells within the TreeGrid.
2101
+ *
2102
+ * Resets the selection state of the grid, which is useful after bulk operations.
1945
2103
  *
1946
2104
  * @returns {void}
1947
2105
  */
1948
2106
  clearSelection(): void;
1949
2107
  /**
1950
- * Copy the selected rows or cells data into clipboard.
2108
+ * Copies the data of selected rows or cells to the clipboard.
1951
2109
  *
1952
- * @param {boolean} withHeader - Specifies whether the column header text needs to be copied along with rows or cells.
2110
+ * This method supports including headers for better context when pasting elsewhere.
2111
+ *
2112
+ * @param {boolean} withHeader - (Optional) If true, includes column headers in the copied data.
1953
2113
  * @returns {void}
1954
2114
  */
1955
2115
  copy(withHeader?: boolean): void;
1956
2116
  /**
1957
- * Paste data from clipboard to selected cells.
2117
+ * Pastes data into the selected cells from the clipboard.
2118
+ *
2119
+ * Automatically places the pasted data starting from the specified indices.
1958
2120
  *
1959
- * @param {boolean} data - Specifies the date for paste.
1960
- * @param {boolean} rowIndex - Specifies the row index.
1961
- * @param {boolean} colIndex - Specifies the column index.
2121
+ * @param {string} data - The clipboard data to paste.
2122
+ * @param {number} rowIndex - The starting row index for pasting.
2123
+ * @param {number} colIndex - The starting column index for pasting.
1962
2124
  * @returns {void}
1963
2125
  */
1964
2126
  paste(data: string, rowIndex: number, colIndex: number): void;
1965
2127
  /**
1966
- * Selects a cell by the given index.
2128
+ * Selects a cell by its index position in the TreeGrid.
2129
+ *
2130
+ * Useful for navigating or highlighting specific data cells within the grid.
1967
2131
  *
1968
- * @param {IIndex} cellIndex - Defines the row and column indexes.
1969
- * @param {boolean} isToggle - If set to true, then it toggles the selection.
2132
+ * @param {IIndex} cellIndex - An object specifying the row and column indexes.
2133
+ * @param {boolean} isToggle - (Optional) If true, toggles the selection state of the cell.
1970
2134
  * @returns {void}
1971
2135
  */
1972
2136
  selectCell(cellIndex: IIndex, isToggle?: boolean): void;
1973
2137
  /**
1974
- * Gets the collection of selected rows.
2138
+ * Retrieves the currently selected rows.
1975
2139
  *
1976
- * @returns {Element[]} - Returns selected row elements collection
2140
+ * Useful for obtaining the selected data elements for downstream processing.
2141
+ *
2142
+ * @returns {Element[]} - An array of Element objects representing the selected rows.
1977
2143
  */
1978
2144
  getSelectedRows(): Element[];
1979
2145
  /**
@@ -2126,53 +2292,74 @@ export declare class TreeGrid extends Component<HTMLElement> implements INotifyP
2126
2292
  getFrozenColumns(): number;
2127
2293
  private getFrozenCount;
2128
2294
  /**
2129
- * Gets the collection of selected row indexes.
2295
+ * Retrieves the indexes of the currently selected rows in the TreeGrid.
2296
+ *
2297
+ * This method is useful when you need to perform actions based on the selected rows,
2298
+ * such as retrieving data or changing the selection.
2130
2299
  *
2131
- * @returns {number[]} - Returns selected rows index collection
2300
+ * @returns {number[]} - An array of numbers representing the indexes of selected rows.
2132
2301
  */
2133
2302
  getSelectedRowIndexes(): number[];
2134
2303
  /**
2135
- * Gets the collection of selected row and cell indexes.
2304
+ * Retrieves the indexes of the selected cells within the selected rows.
2305
+ *
2306
+ * This can be useful for handling cell-specific operations, such as
2307
+ * applying styles or editing values programmatically.
2136
2308
  *
2137
- * @returns {ISelectedCell[]} - Returns selected cell's index details
2309
+ * @returns {ISelectedCell[]} - An array of objects representing the selected cells' indexes.
2138
2310
  */
2139
2311
  getSelectedRowCellIndexes(): ISelectedCell[];
2140
2312
  /**
2141
- * Gets the collection of selected records.
2313
+ * Retrieves the data records corresponding to the currently selected rows.
2314
+ *
2315
+ * This method provides the full record data for the selected rows,
2316
+ * which is useful for data manipulation or extraction operations.
2142
2317
  *
2143
2318
  * @isGenericType true
2144
- * @returns {Object[]} - Returns selected records collection
2319
+ * @returns {Object[]} - An array of data objects representing the selected records.
2145
2320
  */
2146
2321
  getSelectedRecords(): Object[];
2147
2322
  /**
2148
- * Gets the data module.
2323
+ * Obtains the data handling modules used by the TreeGrid.
2324
+ *
2325
+ * This includes both the base data module for standard grid operations and the tree module
2326
+ * for handling hierarchical data, giving complete access to data management capabilities.
2149
2327
  *
2150
- * @returns {{baseModule: Data, treeModule: DataManipulation}}: Returns grid and treegrid data module
2328
+ * @returns {{baseModule: Data, treeModule: DataManipulation}} - An object containing both grid and tree data modules.
2151
2329
  */
2152
2330
  getDataModule(): {
2153
2331
  baseModule: Data;
2154
2332
  treeModule: DataManipulation;
2155
2333
  };
2156
2334
  /**
2157
- * Reorder the rows based on given indexes and position
2335
+ * Reorders rows in the TreeGrid based on specified source indexes and a target position.
2336
+ *
2337
+ * This functionality allows for dynamic rearrangement of rows, such as moving selected
2338
+ * rows to a new position as siblings or children.
2158
2339
  *
2159
- * @param {number[]} fromIndexes - Source indexes of rows
2160
- * @param {number} toIndex - Destination index of row
2161
- * @param {string} position - Defines drop position as above or below or child
2340
+ * @param {number[]} fromIndexes - An array indicating the source indexes of the rows to be moved.
2341
+ * @param {number} toIndex - The target index where the rows should be moved.
2342
+ * @param {string} position - The position relative to the target index ('above', 'below', 'child').
2162
2343
  * @returns {void}
2163
2344
  */
2164
2345
  reorderRows(fromIndexes: number[], toIndex: number, position: string): void;
2165
2346
  /**
2166
- * Indents the record to one level of hierarchy. Moves the selected row as the last child of its previous row.
2347
+ * Indents a specified record, promoting it to one level deeper in the hierarchy.
2167
2348
  *
2168
- * @param {Object} record specifies the record to do indented
2349
+ * This function moves the selected row to become the last child of its preceding row,
2350
+ * altering the visual and hierarchical data structure.
2351
+ *
2352
+ * @param {Object} record - (Optional) The record to be indented. If omitted, the currently selected row is used.
2169
2353
  * @returns {void}
2170
2354
  */
2171
2355
  indent(record?: Object): void;
2172
2356
  /**
2173
- * Outdent the record to one level of hierarchy. Moves the selected row as sibling to its parent row.
2357
+ * Outdents a specified record, moving it one level up in the hierarchy.
2358
+ *
2359
+ * This method repositions the selected row to be a sibling of its parent, impacting
2360
+ * its display and the hierarchical relationships within the TreeGrid.
2174
2361
  *
2175
- * @param {Object} record specifies the record to do outdented
2362
+ * @param {Object} record - (Optional) The record to be outdented. If omitted, the currently selected row is used.
2176
2363
  * @returns {void}
2177
2364
  */
2178
2365
  outdent(record?: Object): void;