Syncfusion.EJ2
Properties  Methods 


TreeGrid Class Members

The following tables list the members exposed by TreeGrid.

Public Constructors
 NameDescription
Public Constructor  
Top
Public Properties
 NameDescription
Public Property Triggers when TreeGrid actions such as sorting, filtering, paging etc., starts.  
Public Property Triggers when TreeGrid actions such as sorting, filtering, paging etc. are completed.  
Public Property Triggers when any TreeGrid action failed to achieve the desired results.  
Public Property Configures the TreeGrid aggregate rows. > Check the [`Aggregates`](./aggregates.html) for its configuration.  
Public Property If `allowExcelExport` set to true, then it will allow the user to export treegrid to Excel file.  
Public Property If `allowFiltering` is set to true, pager renders.  
Public Property If `allowMultiSorting` set to true, then it will allow the user to sort multiple column in the treegrid. > `allowSorting` should be true.  
Public Property If `allowPaging` is set to true, pager renders.  
Public Property If `allowPdfExport` set to true, then it will allow the user to export treegrid to Pdf file.  
Public Property If `allowReordering` is set to true, TreeGrid columns can be reordered. Reordering can be done by drag and drop of a particular column from one index to another index. > If TreeGrid is rendered with stacked headers, reordering is allowed only at the same level as the column headers.  
Public Property If `allowResizing` is set to true, TreeGrid columns can be resized.  
Public Property If `allowRowDragAndDrop` is set to true, you can drag and drop treegrid rows at another treegrid.  
Public Property If `allowSelection` is set to true, it allows selection of (highlight row) TreeGrid records by clicking it.  
Public Property If `allowSorting` is set to true, it allows sorting of treegrid records when column header is clicked.  
Public Property If `allowTextWrap` set to true, then text content will wrap to the next line when its text content exceeds the width of the Column Cells.  
Public Property If `autoCheckHierarchy` is set to true, hierarchy checkbox selection has been enabled in TreeGrid.  
Public Property Triggers when a particular selected cell is deselected.  
Public Property Triggers before TreeGrid data is exported to Excel file.  
Public Property Triggers before TreeGrid data is exported to PDF document.  
Public Property Triggers before the print action starts.  
Public Property Triggers before the record is to be edit.  
Public Property Triggers when a particular selected cell is deselected.  
Public Property Triggers before the selected cell is deselecting.  
Public Property Triggers when the cell is being edited.  
Public Property Triggers when cell is saved.  
Public Property Triggers after a cell is selected.  
Public Property Triggers before any cell selection occurs.  
Public Property Triggers when the check box state change in checkbox column.  
Public Property Specifies the mapping property path for sub tasks in data source  
Public Property Triggers after collapse the TreeGrid record  
Public Property Triggers while collapsing the TreeGrid record  
Public Property Triggers when column header element is dragged (moved) continuously.  
Public Property Triggers when column header element drag (move) starts.  
Public Property Triggers when a column header element is dropped on the target column.  
Public Property Triggers when click on column menu.  
Public Property `columnMenuItems` defines both built-in and custom column menu items. The available built-in items are, `AutoFitAll` - Auto fit the size of all columns. `AutoFit` - Auto fit the current column. `SortAscending` - Sort the current column in ascending order. `SortDescending` - Sort the current column in descending order. `Filter` - Filter options will show based on filterSettings property like filterbar, menu filter.  
Public Property Triggers before column menu opens.  
Public Property `columnQueryMode`provides options to retrieves data from the data source.Their types are `All`: It retrieves whole data source. `Schema`: retrieves data for all the defined columns in TreeGrid from the data source. `ExcludeHidden`: retrieves data only for visible columns of TreeGrid from the data Source.  
Public Property Defines the schema of dataSource. If the `columns` declaration is empty or undefined then the `columns` are automatically generated from data source.  
Public Property Triggers when click on context menu.  
Public Property `contextMenuItems` defines both built-in and custom context menu items. The available built-in items are, `AutoFitAll` - Auto fit the size of all columns. `AutoFit` - Auto fit the current column. `Edit` - Edit the current record. `Delete` - Delete the current record. `Save` - Save the edited record. `Cancel` - Cancel the edited state. `PdfExport` - Export the grid as Pdf format. `ExcelExport` - Export the grid as Excel format. `CsvExport` - Export the grid as CSV format. `SortAscending` - Sort the current column in ascending order. `SortDescending` - Sort the current column in descending order. `FirstPage` - Go to the first page. `PrevPage` - Go to the previous page. `LastPage` - Go to the last page. `NextPage` - Go to the next page.  
Public Property Triggers before context menu opens.  
Public Property Triggers when the component is created.  
Public Property Triggers when data source is populated in the TreeGrid.  
Public Property It is used to render TreeGrid table rows.  
Public Property Triggers when the TreeGrid data is added, deleted and updated. Invoke the done method from the argument to start render after edit operation.  
Public Property Triggers when the TreeGrid actions such as Sorting, Paging etc., are done. In this event,the current view data and total record count should be assigned to the `dataSource` based on the action performed.  
Public Property Triggers after detail row expands. > This event triggers at initial expand.  
Public Property The detail template allows you to show or hide additional information about a particular row.  
Public Property Configures the edit settings.  
Public Property If `enableAltRow` is set to true, the TreeGrid will render with `e-altrow` CSS class to the alternative tr elements. > Check the [`AltRow`](./row.html#styling-alternate-rows) to customize the styles of alternative rows.  
Public Property Specifies whether to load all the rows in collapsed state when the TreeGrid is rendered for the first time.  
Public Property If `enableHover` is set to true, the row hover is enabled in the TreeGrid.  
Public Property Enable or disable persisting component's state between page reloads.  
Public Property Enable or disable rendering component in right to left direction.  
Public Property If `enableVirtualization` set to true, then the TreeGrid will render only the rows visible within the view-port and load subsequent rows on vertical scrolling. This helps to load large dataset in TreeGrid.  
Public Property Triggers after TreeGrid data is exported to Excel file.  
Public Property Triggers before exporting each header cell to Excel file. You can also customize the Excel cells.  
Public Property Triggers before exporting each cell to Excel file. You can also customize the Excel cells.  
Public Property Triggers after expand the record  
Public Property Triggers while expanding the TreeGrid record  
Public Property Specifies the mapping property path for the expand status of a record in data source.  
Public Property Configures the filter settings of the TreeGrid.  
Public Property Gets or sets the number of frozen columns.  
Public Property Gets or sets the number of frozen rows.  
Public Property Defines the mode of TreeGrid lines. The available modes are, `Both`: Displays both horizontal and vertical TreeGrid lines. `None`: No TreeGrid lines are displayed. `Horizontal`: Displays the horizontal TreeGrid lines only. `Vertical`: Displays the vertical TreeGrid lines only. `Default`: Displays TreeGrid lines based on the theme.  
Public Property Specifies whether record is parent or not for the remote data binding  
Public Property Triggered for stacked header.  
Public Property Defines the scrollable height of the TreeGrid content.  
Public Property Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.  
Public Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Public Property Specifies the name of the field in the dataSource, which contains the id of that row.  
Public Property This event allows customization of TreeGrid properties before rendering.  
Public Property If `loadChildOnDemand` is enabled, parent records are render in expanded state.  
Public Property Overrides the global culture and localization value for this component. Default global culture is 'en-US'.  
Public Property Configures the pager in the TreeGrid.  
Public Property Specifies the name of the field in the dataSource, which contains the parent’s id  
Public Property Triggers after TreeGrid data is exported to PDF document.  
Public Property Triggers before exporting each header cell to PDF document. You can also customize the PDF cells.  
Public Property Triggers before exporting each cell to PDF document. You can also customize the PDF cells.  
Public Property Triggers after print action is completed.  
Public Property Defines the print modes. The available print modes are `AllPages`: Prints all pages of the TreeGrid. `CurrentPage`: Prints the current page of the TreeGrid.  
Public Property Defines the external [`Query`](../../data/query/) that will be executed along with data processing.  
Public Property Triggered every time a request is made to access cell information, element, or data. This will be triggered before the cell element is appended to the TreeGrid element.  
Public Property Triggers when record is double clicked.  
Public Property Triggers when column resize starts.  
Public Property Triggers when column resize ends.  
Public Property Triggers on column resizing.  
Public Property Triggered every time a request is made to access row information, element, or data. This will be triggered before the row element is appended to the TreeGrid element.  
Public Property Triggers when a selected row is deselected.  
Public Property Triggers before deselecting the selected row.  
Public Property Triggers when row elements are dragged (moved) continuously.  
Public Property Triggers when row element’s drag(move) starts.  
Public Property Triggers when row element’s before drag(move).  
Public Property Triggers when row elements are dropped on the target row.  
Public Property Configures the row drop settings of the TreeGrid.  
Public Property Defines the height of TreeGrid rows.  
Public Property Triggers after a row is selected.  
Public Property Triggers before row selection occurs.  
Public Property The row template that renders customized rows from the given template. By default, TreeGrid renders a table row for every data source item. > It accepts either [template string](../../common/template-engine.html) or HTML element ID. > The row template must be a table row.  
Public Property Configures the search settings of the TreeGrid.  
Public Property The `selectedRowIndex` allows you to select a row at initial rendering. You can also get the currently selected row index.  
Public Property Configures the selection settings.  
Public Property If `showColumnMenu` set to true, then it will enable the column menu options in each columns.  
Public Property Configures the sort settings of the TreeGrid.  
Public Property Configures the text wrap in the TreeGrid.  
Public Property `toolbar` defines the ToolBar items of the TreeGrid. It contains built-in and custom toolbar items. If a string value is assigned to the `toolbar` option, it is considered as the template for the whole TreeGrid ToolBar. If an array value is assigned, it is considered as the list of built-in and custom toolbar items in the TreeGrid's Toolbar. The following code example implements the custom toolbar items.  
Public Property Triggers when toolbar item is clicked.  
Public Property Specifies the index of the column that needs to have the expander button.  
Public Property Defines the TreeGrid width.  
Top
Protected Properties
 NameDescription
Protected PropertyOverridden.   
Protected Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected PropertyOverridden.   
Protected PropertyOverridden.   
Protected Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected PropertyOverridden.   
Top
Public Methods
Protected Methods
 NameDescription
Protected Method (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected Method (Inherited from Syncfusion.EJ2.EJTagHelper)
Top
Extension Methods
 NameDescription
Public Extension MethodOverloaded.  Iterates the index.
Top
See Also