Properties

NameTypeDefault
altRows boolean false
autoRowHeight boolean true
aggregatesHeight number 34
autoShowLoadElement boolean true
columnsHeight number 30
columns Array<DataTableColumns> []
columnGroups Array<DataTableColumnGroups> []
columnsResize boolean false
columnsReorder boolean false
disabled boolean false
editable boolean false
editSettings DataTableEditSettings { saveOnPageChange: true, saveOnBlur: true, saveOnSelectionChange: true, cancelOnEsc: true, saveOnEnter: true, editSingleCell: false, editOnDoubleClick: true, editOnF2: true }
exportSettings DataTableExportSettings { columnsHeader: true, hiddenColumns: false, serverURL: null, characterSet: null, recordsInView: true, fileName: "jqxDataTable"}
enableHover boolean true
enableBrowserSelection boolean false
filterable boolean false
filterHeight number 30
filterMode DataTableFilterMode "default"
groups Array<any> []
groupsRenderer (value?:DataTableGroupsRenderer['value'], rowData?:DataTableGroupsRenderer['rowdata'], level?:DataTableGroupsRenderer['level']) => string null
height number | string null
initRowDetails (id?:DataTableInitRowDetails['id'], row?:DataTableInitRowDetails['row'], element?:DataTableInitRowDetails['element'], rowInfo?:DataTableInitRowDetails['rowinfo']) => void null
incrementalSearch boolean true
localization any default localization strings.
pagerHeight number 28
pageSize number 10
pageSizeOptions Array<string | number> ['5', '10', '20']
pageable boolean false
pagerPosition DataTablePagerPosition "bottom"
pagerMode DataTablePagerMode "default"
pagerButtonsCount number 5
pagerRenderer () => any null
ready () => void null
rowDetails boolean false
renderToolbar (toolbar?:DataTableRenderToolbar['toolbar']) => void null
renderStatusBar (statusbar?:DataTableRenderStatusBar['statusbar']) => void null
rendering () => void null
rendered () => void null
rtl boolean false
source any null
sortable boolean false
showAggregates boolean false
showToolbar boolean false
showStatusbar boolean false
statusBarHeight number 34
scrollBarSize number | string 17
selectionMode DataTableSelectionMode "multipleRows"
serverProcessing boolean false
showHeader boolean true
theme string ''
toolbarHeight number 34
width string | number null

Events

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

Methods

NameArgumentsReturn Type
addRow rowIndex, rowData, rowPosition
addFilter dataField, filerGroup
applyFilters None
beginUpdate None
beginRowEdit rowIndex
beginCellEdit rowIndex, dataField
clearSelection None
clearFilters None
clear None
destroy None
deleteRow rowIndex
endUpdate None
ensureRowVisible rowIndex
endRowEdit rowIndex, cancelChanges
endCellEdit rowIndex, dataField
exportData exportDataType
focus None
getColumnProperty dataField, propertyName
goToPage pageIndex
goToPrevPage None
goToNextPage None
getSelection None
getRows None
getView None
getCellValue rowIndex, dataField
hideColumn dataField
hideDetails rowIndex
isBindingCompleted None
lockRow rowIndex
refresh None
render None
removeFilter dataField
scrollOffset top, left
setColumnProperty dataField, propertyName, propertyValue
showColumn dataField
selectRow rowIndex
showDetails rowIndex
setCellValue rowIndex, dataField, value
sortBy dataField, sortOrder
updating None
updateBoundData None
unselectRow rowIndex
updateRow rowIndex, rowData
unlockRow rowIndex