Skip to main content

DxTreeList

The DxTreeList component is used for displaying the data in the form of multi-column tree view.

info

For more details, refer to DxTreeList page.

Props

AttributeDescriptionTypeDefault
dataSourceBinds the IU component to dataarray
activeStateEnabledSpecifies whether the UI component changes its visual state as a result of user interaction.booleanfalse
allowColumnReorderingDefines whatever the user can reorder columnsbooleanfalse
cacheEnabledSpecifies whether data should be cached.booleantrue
cellHintEnabledEnables a hint when the user hovers the mouse over the cell with truncated contentbooleanfalse
columnAutoWidthDefines whether columns should adjust their width to contentbooleantrue
columnMinWidthSpecifies the minimum width of the columnsnumber
columnWidthSpecifies the width of the columnsstring
columnResingModeSpecifies how the user resize columns. Activated only if the allowColumnResizing is true.string
columnHidingEnabledDefines whatever the IU component should hide components to adept to the container size or to the screen. Does not work if allowColumnResizing is true and columnResizingMode is 'widget'.booleanfalse
dateSerializationFormatSpecifies the format in which date-time values should be sent to the server.stringundefined
disabledSpecifies if the current component is disabled or notbooleanfalse
headerFilterAdds header filter featureObjectfalse
highlightChangesSpecifies whether to highlight rows and cells with edited data. To activate it repaintChangesOnly should be true.booleanfalse
focusedRowEnabledSpecifies whether the focused row feature is enabled.booleanfalse
noDataTextDefines the text string when there is no data shown in the treelist.string
repaintChangesOnlySpecifies whether to repaint only those cells whose data changed.booleanfalse
rowAlternationEnabledDefines whether the rows should be shaded differently.booleanfalse
showbordersSpecifies whether the outer borders of the UI component are visible.booleanfalse
showColumnHeadersDefines if the columns header should be visible or not.booleanfalse
showColumnLinesSpecifies if the lines between columns are visible or not.booleantrue
showRowLinesSpecifies if the horizontal lines between rows are visible or not.booleantrue
wordWrapEnabledSpecifies whether text does not fit into a column should be wrapped.booleanfalse
rootValueDefines the root node's identifier.any'0'
expandedRowKeysExpands specifies rows and specifies keys of expanded rows.array
keyExprDefines the key property that provides key values to access each data items.string'id'
datastructureNotifies the UI component of the used data structure.string'plain'
itemsExprSpecifies which data field contains nested structure.string
parentIdExprSpecifies which data field provides parent key.string'hid'
visibleVisibility of DxTreeList componentbooleantrue

Events

AttributeDescription
onEditorPrepared(No Parameter)Executed after editor is created.
onSelectionChanged(selected)Executed after selecting a row.
onRowClick(e)Executed when a row is clicked or tapped.
onCellClick(e)Executed when a cell is clicked or tapped
onOptionChanged(event)Executed after UI component property is changed.

Samples Component

DxTreeList Bar Usage

You can manage some properties with this bar:

DxSearchPanel

DxFilterRow

DxHeaderFilter

DxSelection

DxColumnChooser

DxTreelist Column Background Change Sample

You can set the color of the column with cssClass.

DxTreeList Color Sample:

dxTreeList-color

DxTreelist Edit Sample

In the DxTreelist component we can edit the data. To edit the data, the component must have DxEditing. After adding that user can customize it using Mode property which have 'batch' , 'cell' , 'row' ,'form' , 'popup' options. According to these options users can update their data. To correctly use it the allowUpdating property must be true.

DxTreeList Edit Sample:

dxTreelist-editing

DxTreelist Column Reorder Sample

DxTreeList Column Reorder Sample:

dxTreelist-columnreodering

DxTreelist External Filter Sample

DxTreeList Extarnel Filter Sample:

dxTreelist-extarnelfiltre

DxTreelist Array Store Live Connection Sample

DxTreeList Array Store Live Sample:

DxTreeListArrStoreLiveCon