Properties

NameTypeDefault
altRows Boolean false
autoRowHeight Boolean true
aggregatesHeight Number 34
autoShowLoadElement Boolean true
checkboxes Boolean false
columnsHeight Number 30
columns Array []
columnGroups Array []
columnsResize Boolean false
columnsReorder Boolean false
disabled Boolean false
editable Boolean false
editSettings Object { saveOnPageChange: true, saveOnBlur: true, saveOnSelectionChange: true, cancelOnEsc: true, saveOnEnter: true, editSingleCell: false, editOnDoubleClick: true, editOnF2: true }
exportSettings Object {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 String "default"
height Number | String null
hierarchicalCheckboxes Boolean false
icons Boolean | Function false
incrementalSearch Boolean true
localization Object default localization strings.
pagerHeight Number 28
pageSize Number 10
pageSizeOptions Array ['5', '10', '20']
pageable Boolean false
pagerPosition String "bottom"
pagerMode String "default"
pageSizeMode String "default"
pagerButtonsCount Number 5
pagerRenderer Function null
ready Function null
rowDetails Boolean false
rowDetailsRenderer Function null
renderToolbar Function null
renderStatusBar Function null
rendering Function null
rendered Function null
rtl Boolean false
source Object null
sortable Boolean false
showAggregates Boolean false
showSubAggregates Boolean false
showToolbar Boolean false
showStatusbar Boolean false
statusBarHeight Number 34
scrollBarSize Number 17
selectionMode String "multipleRows"
showHeader Boolean true
theme String ''
toolbarHeight Number 34
width Number | String null
virtualModeCreateRecords Function null
virtualModeRecordCreating Function 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 None
addFilter dataField, filerGroup None
applyFilters None None
beginUpdate None None
beginRowEdit rowKey None
beginCellEdit rowKey, dataField None
clearSelection None None
clearFilters None None
clear None None
checkRow rowKey None
collapseRow rowKey None
collapseAll None None
destroy None None
deleteRow rowKey None
expandRow rowKey None
expandAll None None
endUpdate None None
ensureRowVisible rowKey None
endRowEdit rowKey, cancelChanges None
endCellEdit rowKey, dataField, cancelChanges None
exportData exportDataType Object(optional)
focus None None
getColumnProperty dataField, propertyName Object
goToPage pageIndex None
goToPrevPage None None
goToNextPage None None
getSelection None Array
getKey row String
getRow rowKey Object
getRows None Array
getCheckedRows None Array
getView None Array
getCellValue rowKey, dataField Object
hideColumn dataField None
isBindingCompleted None Boolean
lockRow rowKey None
refresh None None
render None None
removeFilter dataField None
scrollOffset top, left Object
setColumnProperty dataField, propertyName, propertyValue None
showColumn dataField None
selectRow rowId None
setCellValue rowId, dataField, cellValue None
sortBy dataField, sortOrder None
updating None Boolean
updateBoundData None None
unselectRow rowId None
uncheckRow rowId None
updateRow rowId, data None
unlockRow rowId None