TreeGridComponent

TreeTreeGridComponent represents the react TreeTreeGrid.

<TreeTreeGridComponent dataSource={data} allowPaging={true} allowSorting={true}/>

Properties

aggregates

AggregateRowModel[]

Configures the TreeGrid aggregate rows.

Check the Aggregates for its configuration.

Defaults to []

allowExcelExport

boolean

If allowExcelExport set to true, then it will allow the user to export treegrid to Excel file.

Check the ExcelExport to configure exporting document.

Defaults to false

allowFiltering

boolean

If allowFiltering is set to true, pager renders.

Defaults to false

allowMultiSorting

boolean

If allowMultiSorting set to true, then it will allow the user to sort multiple column in the treegrid.

allowSorting should be true.

Defaults to true

allowPaging

boolean

If allowPaging is set to true, pager renders.

Defaults to false

allowPdfExport

boolean

If allowPdfExport set to true, then it will allow the user to export treegrid to Pdf file.

Check the Pdfexport to configure the exporting document.

Defaults to false

allowReordering

boolean

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.

Defaults to false

allowResizing

boolean

If allowResizing is set to true, TreeGrid columns can be resized.

Defaults to false

allowRowDragAndDrop

boolean

Specifies the mapping property path for the expand status of a record in data source

Defaults to false

allowSelection

boolean

If allowSelection is set to true, it allows selection of (highlight row) TreeGrid records by clicking it.

Defaults to true

allowSorting

boolean

If allowSorting is set to true, it allows sorting of treegrid records when column header is clicked.

Defaults to false

allowTextWrap

boolean

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.

Defaults to false

autoCheckHierarchy

boolean

If autoCheckHierarchy is set to true, hierarchy checkbox selection has been enabled in TreeGrid.

Defaults to false

childMapping

string

Specifies the mapping property path for sub tasks in data source

Defaults to null

columnMenuItems

ColumnMenuItem[] | ColumnMenuItemModel[]

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.

Defaults to null

columnMenuModule

ColumnMenu

The columnMenuModule is used to manipulate column menu items and its action in TreeGrid.

columnQueryMode

ColumnQueryModeType

columnQueryModeprovides 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.

Defaults to All

columns

ColumnModel[] | string[] | Column[]

Defines the schema of dataSource. If the columns declaration is empty or undefined then the columns are automatically generated from data source.

Defaults to []

contextMenuItems

ContextMenuItem[] | ContextMenuItemModel[]

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.

Defaults to null

contextMenuModule

ContextMenu

The contextMenuModule is used to handle context menu items and its action in the TreeGrid.

dataSource

Object | DataManager

It is used to render TreeGrid table rows.

Defaults to []

detailTemplate

string

The detail template allows you to show or hide additional information about a particular row.

It accepts either the template string or the HTML element ID.

editModule

Edit

The editModule is used to handle TreeGrid content manipulation.

editSettings

EditSettingsModel

Configures the edit settings.

Defaults to { allowAdding: false, allowEditing: false, allowDeleting: false, mode:‘Normal’,allowEditOnDblClick: true, showConfirmDialog: true, showDeleteConfirmDialog: false }

enableAltRow

boolean

If enableAltRow is set to true, the TreeGrid will render with e-altrow CSS class to the alternative tr elements.

Check the AltRow to customize the styles of alternative rows.

Defaults to true

enableCollapseAll

boolean

Specifies whether to load all the rows in collapsed state when the TreeGrid is rendered for the first time.

Defaults to false

enableHover

boolean

If enableHover is set to true, the row hover is enabled in the TreeGrid.

Defaults to false

enablePersistence

boolean

Enable or disable persisting component’s state between page reloads.

Defaults to false

enableRtl

boolean

Enable or disable rendering component in right to left direction.

Defaults to false

enableVirtualization

boolean

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.

Defaults to false

expandStateMapping

string

Specifies the mapping property path for the expand status of a record in data source.

Defaults to null

filterSettings

FilterSettingsModel

Configures the filter settings of the TreeGrid.

Defaults to {columns: [], type: ‘FilterBar’, mode: ‘Immediate’, showFilterBarStatus: true, immediateModeDelay: 1500 , operators: {}}

frozenColumns

number

Gets or sets the number of frozen columns.

Defaults to 0

frozenRows

number

Gets or sets the number of frozen rows.

Defaults to 0

gridLines

GridLine

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.

Defaults to Syncfusion.EJ2.Grids.GridLine.Default

hasChildMapping

string

Specifies whether record is parent or not for the remote data binding

Defaults to null

height

string | number

Defines the scrollable height of the TreeGrid content.

Defaults to ‘auto’

idMapping

string

Specifies the name of the field in the dataSource, which contains the id of that row.

Defaults to null

keyboardModule

KeyboardEvents

The keyboardModule is used to manipulate keyboard interactions in TreeGrid.

loadChildOnDemand

boolean

If loadChildOnDemand is enabled, parent records are render in expanded state.

Defaults to false

locale

string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

Defaults to ”

pageSettings

PageSettingsModel

Configures the pager in the TreeGrid.

Defaults to {currentPage: 1, pageSize: 12, pageCount: 8, enableQueryString: false, pageSizes: false, template: null}

pagerModule

Page

The pagerModule is used to manipulate paging in the TreeGrid.

parentIdMapping

string

Specifies the name of the field in the dataSource, which contains the parent’s id

Defaults to null

printMode

PrintMode

Defines the print modes. The available print modes are

• AllPages: Prints all pages of the TreeGrid.
• CurrentPage: Prints the current page of the TreeGrid.

Defaults to Syncfusion.EJ2.Grids.PrintMode.AllPages

printModule

Print

The printModule is used to handle the printing feature of the TreeGrid.

query

Query

Defines the external Query that will be executed along with data processing.

Defaults to null

reorderModule

Reorder

The reorderModule is used to manipulate reordering in TreeGrid.

rowDragAndDropModule

RowDD

The rowDragandDrop is used to manipulate Row Reordering in TreeGrid.

rowDropSettings

RowDropSettingsModel

Configures the row drop settings of the TreeGrid.

rowHeight

number

Defines the height of TreeGrid rows.

Defaults to null

rowTemplate

string

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 or HTML element ID.
• The row template must be a table row. Check the Row Template customization.

searchSettings

SearchSettingsModel

Configures the search settings of the TreeGrid.

Defaults to {search: [] , operators: {}}

selectedRowIndex

number

The selectedRowIndex allows you to select a row at initial rendering. You can also get the currently selected row index.

Defaults to -1

selectionSettings

SelectionSettingsModel

Configures the selection settings.

Defaults to {mode: ‘Row’, cellSelectionMode: ‘Flow’, type: ‘Single’}

showColumnMenu

boolean

If showColumnMenu set to true, then it will enable the column menu options in each columns.

Check the Column menu for its configuration.

Defaults to false

sortModule

Sort

The sortModule is used to manipulate sorting in TreeGrid.

sortSettings

SortSettingsModel

Configures the sort settings of the TreeGrid.

Defaults to {columns:[]}

textWrapSettings

TextWrapSettingsModel

Configures the text wrap in the TreeGrid.

Defaults to {wrapMode:“Both”}

toolbar

[]

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 available built-in ToolBar items are:

• Search: Searches records by the given key.
• ExpandAll: Expands all the rows in TreeGrid
• CollapseAll: Collapses all the rows in TreeGrid
• ExcelExport - Export the TreeGrid to Excel(excelExport() method manually to make export.)
• PdfExport - Export the TreeGrid to PDF(pdfExport() method manually to make export.)
• CsvExport - Export the TreeGrid to CSV(csvExport() method manually to make export.)
  
  The following code example implements the custom toolbar items.

Defaults to null

toolbarModule

Toolbar

The toolbarModule is used to manipulate ToolBar items and its action in the TreeGrid.

treeColumnIndex

number

Specifies the index of the column that needs to have the expander button.

Defaults to 0

width

string | number

Defines the TreeGrid width.

Defaults to ‘auto’

Methods

addRecord

Adds a new record to the TreeGrid. Without passing parameters, it adds empty rows.

editSettings.allowEditing should be true.

Returns void

autoFitColumns

Changes the column width to automatically fit its content to ensure that the width shows the content without wrapping/hiding.

• This method ignores the hidden columns.
• Uses the autoFitColumns method in the dataBound event to resize at initial rendering.

Returns void

clearFiltering

Clears all the filtered rows of the TreeGrid.

Returns void

clearSelection

Deselects the current selected rows and cells.

Returns void

clearSorting

Clears all the sorted columns of the TreeGrid.

Returns void

closeEdit

Cancels edited state.

Returns void

collapseAll

Collapses All the rows

Returns void

collapseAtLevel

Collapses the records at specific hierarchical level

Returns void

collapseRow

Collapses child rows

Returns void

csvExport

Export TreeGrid data to CSV file.

Returns Promise

deleteRecord

Delete a record with Given options. If fieldName and data is not given then TreeGrid will delete the selected record.

editSettings.allowDeleting should be true.

Returns void

deleteRow

Delete any visible row by TR element.

Returns void

destroy

Destroys the component (detaches/removes all event handlers, attributes, classes, and empties the component element).

Returns void

editCell

To edit any particular cell using row index and cell index.

Returns void

enableToolbarItems

Enables or disables ToolBar items.

Returns void

endEdit

If TreeGrid is in editable state, you can save a record by invoking endEdit.

Returns void

excelExport

Export TreeGrid data to Excel file(.xlsx).

Returns Promise

expandAll

Expands All the rows

Returns void

expandAtLevel

Expands the records at specific hierarchical level

Returns void

expandRow

Expands child rows

Returns void

filterByColumn

Filters TreeGrid row by column name with the given options.

Returns void

getCellFromIndex

Gets a cell by row and column index.

Returns Element

getCheckedRecords

Get the records of checked rows.

Returns Object[]

getCheckedRowIndexes

Get the indexes of checked rows.

Returns number[]

getColumnByField

Gets a Column by column name.

Returns Column

getColumnByUid

Gets a column by UID.

Returns Column

getColumnFieldNames

Gets the collection of column fields.

Returns string[]

getColumnHeaderByField

Gets a column header by column name.

Returns Element

getColumnHeaderByIndex

Gets a column header by column index.

Returns Element

getColumnHeaderByUid

Gets a column header by UID.

Returns Element

getColumnIndexByField

Gets a column index by column name.

Returns number

getColumnIndexByUid

Gets a column index by UID.

Returns number

getColumns

Gets the columns from the TreeGrid.

Returns Column[]

getContent

Gets the content div of the TreeGrid.

Returns Element

getContentTable

Gets the content table of the TreeGrid.

Returns Element

getCurrentViewRecords

Get current visible data of TreeGrid.

Returns Object[]

getDataModule

Gets the data module.

Returns Object

getDataRows

Gets all the TreeGrid’s data rows.

Returns Element[]

getFooterContent

Gets the footer div of the TreeGrid.

Returns Element

getFooterContentTable

Gets the footer table element of the TreeGrid.

Returns Element

getHeaderContent

Gets the header div of the TreeGrid.

Returns Element

getHeaderTable

Gets the header table element of the TreeGrid.

Returns Element

getMovableCellFromIndex

Gets a movable table cell by row and column index.

Returns Element

getMovableDataRows

Gets all the TreeGrid’s movable table data rows.

Returns Element[]

getMovableRowByIndex

Gets a movable tables row by index.

Returns Element

getMovableRows

Gets the TreeGrid’s movable content rows from frozen treegrid.

Returns Element[]

getPager

Gets the pager of the TreeGrid.

Returns Element

getPrimaryKeyFieldNames

Get the names of the primary key columns of the TreeGrid.

Returns string[]

getRowByIndex

Gets a row by index.

Returns Element

getRowInfo

Get a row information based on cell

Returns RowInfo

getRows

Returns TreeGrid rows

Returns HTMLTableRowElement[]

getSelectedRecords

Gets the collection of selected records.

Returns Object[]

getSelectedRowCellIndexes

Gets the collection of selected row and cell indexes.

Returns ISelectedCell[]

getSelectedRowIndexes

Gets the collection of selected row indexes.

Returns number[]

getSelectedRows

Gets the collection of selected rows.

Returns Element[]

getUidByColumnField

Gets UID by column name.

Returns string

getVisibleColumns

Gets the visible columns from the TreeGrid.

Returns Column[]

goToPage

Navigates to the specified target page.

Returns void

hideColumns

Hides a column by column name.

Returns void

hideSpinner

Manually shown spinner needs to hide by hideSpinnner.

Returns void

pdfExport

Export TreeGrid data to PDF document.

Returns Promise

print

By default, prints all the pages of the TreeGrid and hides the pager.

You can customize print options using the printMode.

Returns void

refresh

Refreshes the TreeGrid header and content.

Returns void

refreshColumns

Refreshes the TreeGrid column changes.

Returns void

refreshHeader

Refreshes the TreeGrid header.

Returns void

reorderColumns

Changes the TreeGrid column positions by field names.

Returns void

reorderRows

Reorder the rows based on given indexes and position

Returns void

search

Searches TreeGrid records using the given key. You can customize the default search option by using the searchSettings.

Returns void

selectCell

Selects a cell by the given index.

Returns void

selectCheckboxes

Checked the checkboxes using rowIndexes.

Returns void

selectRow

Selects a row by given index.

Returns void

selectRows

Selects a collection of rows by indexes.

Returns void

setCellValue

Updates particular cell value based on the given primary key value.

Primary key column must be specified using columns.isPrimaryKey property.

Returns void

setRowData

Updates and refresh the particular row values based on the given primary key value.

Primary key column must be specified using columns.isPrimaryKey property. @param {string| number} key - Specifies the PrimaryKey value of dataSource. @param {Object} rowData - To update new data for the particular row.

Returns void

showColumns

Shows a column by its column name.

Returns void

showSpinner

By default, TreeGrid shows the spinner for all its actions. You can use this method to show spinner at your needed time.

Returns void

sortByColumn

Sorts a column with the given options.

Returns void

startEdit

To edit any particular row by TR element.

Returns void

updateExternalMessage

Defines the text of external message.

Returns void

Events

actionBegin

EmitType<PageEventArgs|FilterEventArgs|SortEventArgs|SearchEventArgs|AddEventArgs|SaveEventArgs|EditEventArgs|DeleteEventArgs>

Triggers when TreeGrid actions such as sorting, filtering, paging etc., starts.

actionComplete

EmitType<CellSaveEventArgs>

Triggers when TreeGrid actions such as sorting, filtering, paging etc. are completed.

actionFailure

EmitType<FailureEventArgs>

Triggers when any TreeGrid action failed to achieve the desired results.

beforeDataBound

EmitType<BeforeDataBoundArgs>

Triggers when a particular selected cell is deselected.

beforeExcelExport

EmitType<Object>

Triggers before TreeGrid data is exported to Excel file.

beforePdfExport

EmitType<Object>

Triggers before TreeGrid data is exported to PDF document.

beforePrint

EmitType<PrintEventArgs>

Triggers before the print action starts.

beginEdit

EmitType<BeginEditArgs>

Triggers before the record is to be edit.

cellDeselected

EmitType<CellDeselectEventArgs>

Triggers when a particular selected cell is deselected.

cellDeselecting

EmitType<CellDeselectEventArgs>

Triggers before the selected cell is deselecting.

cellEdit

EmitType<CellEditArgs>

Triggers when the cell is being edited.

cellSave

EmitType<CellSaveArgs>

Triggers when cell is saved.

cellSelected

EmitType<CellSelectEventArgs>

Triggers after a cell is selected.

cellSelecting

EmitType<CellSelectingEventArgs>

Triggers before any cell selection occurs.

checkboxChange

EmitType<CheckBoxChangeEventArgs>

Triggers when the check box state change in checkbox column.

collapsed

EmitType<RowExpandingEventArgs>

Triggers after collapse the TreeGrid record

collapsing

EmitType<RowExpandingEventArgs>

Triggers while collapsing the TreeGrid record

columnDrag

EmitType<ColumnDragEventArgs>

Triggers when column header element is dragged (moved) continuously.

columnDragStart

EmitType<ColumnDragEventArgs>

Triggers when column header element drag (move) starts.

columnDrop

EmitType<ColumnDragEventArgs>

Triggers when a column header element is dropped on the target column.

columnMenuClick

EmitType<MenuEventArgs>

Triggers when click on column menu.

columnMenuOpen

EmitType<ColumnMenuOpenEventArgs>

Triggers before column menu opens.

contextMenuClick

EmitType<MenuEventArgs>

Triggers when click on context menu.

contextMenuOpen

EmitType<BeforeOpenCloseMenuEventArgs>

Triggers before context menu opens.

created

EmitType<Object>

Triggers when the component is created.

dataBound

EmitType<Object>

Triggers when data source is populated in the TreeGrid.

dataSourceChanged

EmitType<DataSourceChangedEventArgs>

Triggers when the TreeGrid data is added, deleted and updated. Invoke the done method from the argument to start render after edit operation.

dataStateChange

EmitType<DataStateChangeEventArgs>

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.

detailDataBound

EmitType<DetailDataBoundEventArgs>

Triggers after detail row expands.

This event triggers at initial expand.

excelExportComplete

EmitType<ExcelExportCompleteArgs>

Triggers after TreeGrid data is exported to Excel file.

excelHeaderQueryCellInfo

EmitType<ExcelHeaderQueryCellInfoEventArgs>

Triggers before exporting each header cell to Excel file. You can also customize the Excel cells.

excelQueryCellInfo

EmitType<ExcelQueryCellInfoEventArgs>

Triggers before exporting each cell to Excel file. You can also customize the Excel cells.

expanded

EmitType<RowExpandedEventArgs>

Triggers after expand the record

expanding

EmitType<RowExpandingEventArgs>

Triggers while expanding the TreeGrid record

headerCellInfo

EmitType<HeaderCellInfoEventArgs>

Triggered for stacked header.

load

EmitType<Object>

This event allows customization of TreeGrid properties before rendering.

pdfExportComplete

EmitType<PdfExportCompleteArgs>

Triggers after TreeGrid data is exported to PDF document.

pdfHeaderQueryCellInfo

EmitType<PdfHeaderQueryCellInfoEventArgs>

Triggers before exporting each header cell to PDF document. You can also customize the PDF cells.

pdfQueryCellInfo

EmitType<PdfQueryCellInfoEventArgs>

Triggers before exporting each cell to PDF document. You can also customize the PDF cells.

printComplete

EmitType<PrintEventArgs>

Triggers after print action is completed.

queryCellInfo

EmitType<QueryCellInfoEventArgs>

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.

recordDoubleClick

EmitType<RecordDoubleClickEventArgs>

Triggers when record is double clicked.

resizeStart

EmitType<ResizeArgs>

Triggers when column resize starts.

resizeStop

EmitType<ResizeArgs>

Triggers when column resize ends.

resizing

EmitType<ResizeArgs>

Triggers on column resizing.

rowDataBound

EmitType<RowDataBoundEventArgs>

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.

rowDeselected

EmitType<RowDeselectEventArgs>

Triggers when a selected row is deselected.

rowDeselecting

EmitType<RowDeselectEventArgs>

Triggers before deselecting the selected row.

rowDrag

EmitType<RowDragEventArgs>

Triggers when row elements are dragged (moved) continuously.

rowDragStart

EmitType<RowDragEventArgs>

Triggers when row element’s drag(move) starts.

rowDragStartHelper

EmitType<RowDragEventArgs>

Triggers when row element’s before drag(move).

rowDrop

EmitType<RowDragEventArgs>

Triggers when row elements are dropped on the target row.

rowSelected

EmitType<RowSelectEventArgs>

Triggers after a row is selected.

rowSelecting

EmitType<RowSelectingEventArgs>

Triggers before row selection occurs.

toolbarClick

EmitType<ClickEventArgs>

Triggers when toolbar item is clicked.