Properties

NameTypeDefault
altrows Boolean false
altstart Number 1
altstep Number 1
autoshowloadelement Boolean true
autoshowfiltericon Boolean true
autoshowcolumnsmenubutton Boolean true
showcolumnlines Boolean true
showrowlines Boolean true
showcolumnheaderlines 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 36
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'
updatefilterconditions Function null
updatefilterpanel Function null
theme String ''
toolbarheight Number 34
autoheight Boolean false
autorowheight Boolean false
columnsheight Number 32
deferreddatafields Array []
groupsheaderheight Number 34
groupindentwidth Number 20
height String | Number 400
pagerheight Number 40
rowsheight Number 32
scrollbarsize Number 15
scrollmode String "default"
scrollfeedback Function null
width String | Number 600
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
localization Object null
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 Number 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

NameArgumentsReturn Type
autoresizecolumns type None
autoresizecolumn dataField, type None
beginupdate None None
clear None None
destroy None None
endupdate None None
ensurerowvisible rowBoundIndex None
focus None None
getcolumnindex dataField Number
getcolumn dataField Object
getcolumnproperty dataField, propertyName Object
getrowid rowBoundIndex String
getrowdata rowBoundIndex Object
getrowdatabyid rowID Object
getrowboundindexbyid rowID Number
getrowboundindex rowDisplayIndex Number
getrows None Array
getboundrows None Array
getdisplayrows None Array
getdatainformation None Object
getsortinformation None Object
getpaginginformation None Object
hidecolumn dataField None
hideloadelement None None
hiderowdetails rowBoundIndex None
iscolumnvisible dataField Boolean
iscolumnpinned dataField Boolean
localizestrings localizationobject None
pincolumn dataField None
refreshdata None None
refresh None None
render None None
scrolloffset top, left None
scrollposition None Object
showloadelement None None
showrowdetails rowBoundIndex None
setcolumnindex dataField, index None
setcolumnproperty dataField, propertyName, propertyValue None
showcolumn dataField None
unpincolumn dataField None
updatebounddata type None
updating None Boolean
getsortcolumn None String
removesort None None
sortby dataField, sortOrder None
addgroup dataField None
cleargroups None None
collapsegroup group None
collapseallgroups None None
expandallgroups None None
expandgroup group None
getrootgroupscount None Number
getgroup groupIndex Object
insertgroup groupIndex, dataField None
iscolumngroupable None Boolean
removegroupat groupIndex None
removegroup dataField None
addfilter dataField, filterGroup, refreshGrid None
applyfilters None None
clearfilters None None
getfilterinformation None Any
getcolumnat index Object
removefilter dataField, refreshGrid None
refreshfilterrow None None
gotopage pagenumber None
gotoprevpage None None
gotonextpage None None
addrow rowIds, data, rowPosition None
begincelledit rowBoundIndex, dataField None
beginrowedit rowBoundIndex None
closemenu None None
deleterow rowIds None
endcelledit rowBoundIndex, dataField, confirmChanges None
endrowedit rowBoundIndex, confirmChanges None
getcell rowBoundIndex, datafield Object
getcellatposition left, top Object
getcelltext rowBoundIndex, dataField String
getcelltextbyid rowID, dataField String
getcellvaluebyid rowID, dataField Object
getcellvalue rowBoundIndex, dataField Object
isBindingCompleted None Boolean
openmenu dataField None
setcellvalue rowBoundIndex, dataField, value None
setcellvaluebyid rowID, dataField, value None
showvalidationpopup rowBoundIndex, dataField, validationMessage None
updaterow rowIds, data None
clearselection None None
getselectedrowindex None Number
getselectedrowindexes None Array
getselectedcell None Object
getselectedcells None Array
selectcell rowBoundIndex, dataField None
selectallrows None None
selectrow rowBoundIndex None
unselectrow rowBoundIndex None
unselectcell rowBoundIndex, dataField None
getcolumnaggregateddata dataField, aggregates String
refreshaggregates None None
renderaggregates None None
exportdata dataType, fileName, exportHeader, rows, exportHiddenColumns, serverURL, charSet Any
getstate None Object
loadstate stateobject None
savestate None Object