React UI Components Documentation

Properties

NameTypeDefault
altRows boolean false
autoRowHeight boolean true
aggregatesHeight number 34
autoShowLoadElement boolean true
checkboxes boolean false
columnsHeight number 30
columns Array<any> []
columnGroups Array<any> []
columnsResize boolean false
columnsReorder boolean false
disabled boolean false
editable boolean false
editSettings TreeGridEditSettings { saveOnPageChange: true, saveOnBlur: true, saveOnSelectionChange: true, cancelOnEsc: true, saveOnEnter: true, editSingleCell: false, editOnDoubleClick: true, editOnF2: true }
exportSettings TreeGridExportSettings {columnsHeader: true, hiddenColumns: false, serverURL: null, characterSet: null, collapsedRecords: false, recordsInView: true,fileName: "jqxTreeGrid"}
enableHover boolean true
enableBrowserSelection boolean false
filterable boolean false
filterHeight number 30
filterMode TreeGridFilterMode "default"
height number | string null
hierarchicalCheckboxes boolean false
icons any false
incrementalSearch boolean true
localization any default localization strings.
pagerHeight number 28
pageSize number 10
pageSizeOptions Array<number | string> ['5', '10', '20']
pageable boolean false
pagerPosition TreeGridPagerPosition "bottom"
pagerMode TreeGridPagerMode "default"
pageSizeMode TreeGridPageSizeMode "default"
pagerButtonsCount number 5
pagerRenderer () => any null
ready () => void null
rowDetails boolean false
rowDetailsRenderer (key: TreeGridRowDetailsRenderer['key'], dataRow: TreeGridRowDetailsRenderer['dataRow']) => any null
renderToolbar (toolBar?: TreeGridRenderToolbar['toolbar']) => void null
renderStatusBar (statusBar?: TreeGridRenderStatusBar['statusbar']) => void null
rendering () => void null
rendered () => void null
rtl boolean false
source any null
sortable boolean false
showAggregates boolean false
showSubAggregates boolean false
showToolbar boolean false
showStatusbar boolean false
statusBarHeight number 34
scrollBarSize number 17
selectionMode TreeGridSelectionMode "multipleRows"
showHeader boolean true
theme string ''
toolbarHeight number 34
width string | number null
virtualModeCreateRecords (expandedRecord?: any, done?: any) => void null
virtualModeRecordCreating (record?: any) => any null

Events

bindingComplete Event
cellBeginEdit Event
cellEndEdit Event
cellValueChanged Event
columnResized Event
columnReordered Event
filter Event
pageChanged Event
pageSizeChanged Event
rowClick Event
rowDoubleClick Event
rowSelect Event
rowUnselect Event
rowBeginEdit Event
rowEndEdit Event
rowExpand Event
rowCollapse Event
rowCheck Event
rowUncheck Event
sort Event

Methods

NameArgumentsReturn Type
addRow rowKey, rowData, rowPosition, parent
addFilter dataField, filerGroup
applyFilters None
beginUpdate None
beginRowEdit rowKey
beginCellEdit rowKey, dataField
clearSelection None
clearFilters None
clear None
checkRow rowKey
collapseRow rowKey
collapseAll None
destroy None
deleteRow rowKey
expandRow rowKey
expandAll None
endUpdate None
ensureRowVisible rowKey
endRowEdit rowKey, cancelChanges
endCellEdit rowKey, dataField, cancelChanges
exportData exportDataType
focus None
getColumnProperty dataField, propertyName
goToPage pageIndex
goToPrevPage None
goToNextPage None
getSelection None
getKey row
getRow rowKey
getRows None
getCheckedRows None
getView None
getCellValue rowKey, dataField
hideColumn dataField
isBindingCompleted None
lockRow rowKey
refresh None
render None
removeFilter dataField
scrollOffset top, left
setColumnProperty dataField, propertyName, propertyValue
showColumn dataField
selectRow rowId
setCellValue rowId, dataField, cellValue
sortBy dataField, sortOrder
updating None
updateBoundData None
unselectRow rowId
uncheckRow rowId
updateRow rowId, data
unlockRow rowId