Search results

Overview API in JavaScript TreeGrid API control

Name Description
Edit TreeGrid Edit Module
The Edit module is used to handle editing actions.
TreeGrid Represents the TreeGrid component.
Column Represents the “Column” model class for TreeGrid, defining essential properties and functionalities of a column.
StackedColumn Defines stacked tree grid column
TreeGridColumn Defines TreeGrid column
EditSettings Configures the edit behavior of the TreeGrid, defining how records can be added, modified, or deleted.
FilterSettings Configures the filtering behavior of the TreeGrid, enabling complex data filtering capabilities.
Predicate Represents the filter configuration for a column in the TreeGrid.
InfiniteScrollSettings Configures the infinite scroll behavior of the Tree Grid.
LoadingIndicator Configures the loading indicator for the Tree Grid, allowing you to display a visual indicator during data loading operations to enhance user experience.
PageSettings Configures the paging behavior of the TreeGrid, enabling you to manage and display data efficiently across multiple pages.
RowDropSettings Configures the settings for row dragging and dropping within the TreeGrid, allowing for enhanced user interaction and data manipulation capabilities.
SearchSettings Configures the searching behavior of the TreeGrid.
SelectionSettings Configures the selection behavior of the TreeGrid.
SortDescriptor Represents the field name and direction of a sort column in the TreeGrid.
SortSettings Configures the sorting behavior of the TreeGrid.
AggregateColumn Configures the aggregate column for the TreeGrid.
AggregateRow Configures the aggregate rows in the TreeGrid.
TextWrapSettings Configures the text wrapping behavior of the TreeGrid.
TreeGridExcelExportProperties Specifies the Tree Grid ExcelExport properties
TreeGridPdfExportProperties Specifies the Tree Grid PdfExport properties
TreeActionEventArgs Interface for TreeGrid row drop action event arguments, providing detailed information about the row drop operation and its related context.
Static Functions Root static functions of Treegrid Component
CopyHierarchyType Defines the types of CopyHierarchyMode for grid data.
The available copy hierarchy types are:
* Parent: Copies data maintaining only parent hierarchy.
* Child: Copies data with child hierarchy.
* Both: Maintains both parent and child hierarchy during copy.
* None: Copies data without any hierarchy structure.
EditMode Defines modes of editing supported by TreeGrids.
The available editing modes are:
* Cell: Enables cell editing mode.
* Row: Enables row editing mode.
* Dialog: Opens a dialog for editing.
* Batch: Allows for batch editing of multiple records.
FilterHierarchyMode Defines modes of Filter Hierarchy used in TreeGrids.
The available modes are:
* Parent: Shows filtered records along with their parent records.
* Child: Shows filtered records along with their child records.
* Both: Shows filtered records with both parent and child records.
* None: Shows only the filtered records without any parent or child context.
FilterType Defines types of filters available in TreeGrids.
The available filter types are:
* Menu: Applies a dialog-based filtering option, where users can select operators such as ‘equals’, ‘contains’, etc., and enter filter values for more granular control.
* Excel: Provides Excel-like filtering capabilities.
* FilterBar: Uses a filter bar at the top of each column.
PageSizeMode Defines the available PageSizeMode options for pagination in a tree grid structure.
The available page size modes are:

* All: Considers all records, including both parent and child records, when calculating the number of records per page.
* Root: Considers only root-level parent records, excluding child records, when calculating the number of records per page.
RowPosition Defines the target position for adding new rows in the TreeGrid.
The available positions are:
* Top: Adds a new row at the top of all rows.
* Bottom: Adds a new row at the bottom of all rows.
* Above: Adds a new row above the currently selected row.
* Below: Adds a new row below the currently selected row.
* Child: Adds a new row as a child to the currently selected row.
WrapMode Defines wrapping modes for column content in TreeGrids.
The available wrap modes are:
* Both: Wraps both header and content.
* Header: Wraps only the header.
* Content: Wraps only the content.