Properties

Appearance
Name Type Default
altrows Boolean false
altstart Number 1
altstep Number 1
autoshowloadelement Boolean true
autoshowfiltericon Boolean true
autoshowcolumnsmenubutton Boolean true
adaptive boolean false
adaptivewidth number 600
clipboard Boolean true
closeablegroups Boolean true
columnsmenuwidth Number 15
columnmenuopening Function null
columnmenuclosing Function null
cellhover Function null
enablekeyboarddelete Boolean true
enableellipsis Boolean true
enablemousewheel Boolean true
enableanimations Boolean true
enabletooltips Boolean false
enablehover Boolean true
enablebrowserselection Boolean false
everpresentrowposition String 'top'
everpresentrowheight Number 30
everpresentrowactions String "add reset"
everpresentrowactionsmode String "popup"
filterrowheight Number 31
filtermode String "default"
groupsrenderer function null
groupcolumnrenderer function null
groupsexpandedbydefault Boolean false
handlekeyboardnavigation function null
pagerrenderer function null
rtl Boolean false
showdefaultloadelement Boolean true
showfiltercolumnbackground Boolean true
showfiltermenuitems Boolean true
showpinnedcolumnbackground Boolean true
showsortcolumnbackground Boolean true
showsortmenuitems Boolean true
showgroupmenuitems Boolean true
showrowdetailscolumn Boolean true
showheader Boolean true
showgroupsheader Boolean true
showaggregates Boolean false
showgroupaggregates Boolean false
showeverpresentrow Boolean false
showfilterrow Boolean false
showemptyrow Boolean true
showstatusbar Boolean false
statusbarheight Number 34
showtoolbar Boolean false
selectionmode String 'singlerow'
theme String ''
toolbarheight Number 34
Layout
Name Type Default
autoheight Boolean false
autorowheight Boolean false
columnsheight Number 32
deferreddatafields Array []
groupsheaderheight Number/String 34
groupindentwidth Number 20
height Number/String 400
pagerheight Number/String 40
rowsheight Number 32
scrollbarsize Number 15
scrollmode String "default"
scrollfeedback function null
width Number/String 600
Behavior
Name Type Default
autosavestate Boolean false
autoloadstate Boolean false
columns Array []
columngroups Array []
columnsmenu Boolean true
columnsresize Boolean false
columnsautoresize Boolean true
columnsreorder Boolean false
disabled Boolean false
editable Boolean false
editmode String 'selectedcell'
filter Function null
filterable Boolean false
groupable Boolean false
groups Array []
horizontalscrollbarstep Number 5
horizontalscrollbarlargestep Number 50
initrowdetails function null
keyboardnavigation Boolean true
pagesize Number 10
pagesizeoptions Array ['5', '10', '20']
pagermode String "default"
pagerbuttonscount Number 5
pageable Boolean false
rowdetails Boolean false
rowdetailstemplate Object null
ready function null
rendered function null
renderstatusbar function null
rendertoolbar function null
rendergridrows function null
sortable Boolean false
sortmode string 'one'
selectedrowindex Number -1
selectedrowindexes Array []
source Object {}
sorttogglestates String 2
updatedelay Number 0
virtualmode Boolean false
verticalscrollbarstep Number 5
verticalscrollbarlargestep Number 400

Events

bindingcomplete Event
columnresized Event
columnreordered Event
columnclick Event
cellclick Event
celldoubleclick Event
cellselect Event
cellunselect Event
cellvaluechanged Event
cellbeginedit Event
cellendedit Event
filter Event
groupschanged Event
groupexpand Event
groupcollapse Event
pagechanged Event
pagesizechanged Event
rowclick Event
rowdoubleclick Event
rowselect Event
rowunselect Event
rowexpand Event
rowcollapse Event
sort Event

Methods

Common
autoresizecolumns Method
autoresizecolumn Method
beginupdate Method
clear Method
destroy Method
endupdate Method
ensurerowvisible Method
focus Method
getcolumnindex Method
getcolumn Method
getcolumnproperty Method
getrowid Method
getrowdata Method
getrowdatabyid Method
getrowboundindexbyid Method
getrowboundindex Method
getrows Method
getboundrows Method
getdisplayrows Method
getdatainformation Method
getsortinformation Method
getpaginginformation Method
hidecolumn Method
hideloadelement Method
hiderowdetails Method
iscolumnvisible Method
iscolumnpinned Method
localizestrings Method
pincolumn Method
refreshdata Method
refresh Method
render Method
scrolloffset Method
scrollposition Method
showloadelement Method
showrowdetails Method
setcolumnindex Method
setcolumnproperty Method
showcolumn Method
unpincolumn Method
updatebounddata Method
updating Method
Sorting(requires jqxgrid.sort.js)
getsortcolumn Method
removesort Method
sortby Method
Grouping(requires jqxgrid.grouping.js)
addgroup Method
cleargroups Method
collapsegroup Method
collapseallgroups Method
expandallgroups Method
expandgroup Method
getrootgroupscount Method
getgroup Method
insertgroup Method
iscolumngroupable Method
removegroupat Method
removegroup Method
Filtering(requires jqxgrid.filter.js)
addfilter Method
applyfilters Method
clearfilters Method
getfilterinformation Method
removefilter Method
refreshfilterrow Method
Paging(requires jqxgrid.pager.js)
gotopage Method
gotoprevpage Method
gotonextpage Method
Editing(requires jqxgrid.edit.js)
addrow Method
begincelledit Method
beginrowedit Method
closemenu Method
deleterow Method
endcelledit Method
endrowedit Method
getcell Method
getcellatposition Method
getcelltext Method
getcelltextbyid Method
getcellvaluebyid Method
getcellvalue Method
isBindingCompleted Method
openmenu Method
setcellvalue Method
setcellvaluebyid Method
showvalidationpopup Method
updaterow Method
Selection(requires jqxgrid.selection.js)
clearselection Method
getselectedrowindex Method
getselectedrowindexes Method
getselectedcell Method
getselectedcells Method
selectcell Method
selectallrows Method
selectrow Method
unselectrow Method
unselectcell Method
Aggregates(requires jqxgrid.aggregates.js)
getcolumnaggregateddata Method
refreshaggregates Method
renderaggregates Method
Export(requires jqxdata.export.js and jqxgrid.export.js)
exportdata Method
Save/Load State(requires jqxgrid.storage.js)
getstate Method
loadstate Method
savestate Method