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 enum:DataTableFilterMode "default"
groups Array<Any> []
groupsRenderer (value:Any, rowData?:Any, level?:Number) => String null
height Size null
initRowDetails (id:Number, row?:Any, element?:Any, rowInfo?:Any) => 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 enum:DataTablePagerPosition "bottom"
pagerMode enum:DataTablePagerMode "default"
pagerButtonsCount Number 5
pagerRenderer () => Any null
ready () => Void null
rowDetails Boolean false
renderToolbar (toolbar:Any) => Void null
renderStatusbar (statusbar:Any) => 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 Size 17
selectionMode enum:DataTableSelectionMode "multipleRows"
serverProcessing Boolean false
showHeader Boolean true
theme String ''
toolbarHeight Number 34
width Size 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

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