React UI Components Documentation

Properties

NameTypeDefault
altrows Boolean false
altstart Number 1
altstep Number 1
autoshowloadelement Boolean true
autoshowfiltericon Boolean true
autoshowcolumnsmenubutton Boolean true
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'
updatefilterconditions function null
updatefilterpanel function null
theme String ''
toolbarheight Number 34
autoheight Boolean false
autorowheight Boolean false
columnsheight Number 28
deferreddatafields Array []
groupsheaderheight Number 34
groupindentwidth Number 20
height String | Number 400
pagerheight Number 30
rowsheight Number 28
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
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

NameReturn Type
autoresizecolumns None
autoresizecolumn None
beginupdate None
clear None
destroy None
endupdate None
ensurerowvisible None
focus None
getcolumnindex Number
getcolumn Object
getcolumnproperty Object
getrowid String
getrowdata Object
getrowdatabyid Object
getrowboundindexbyid Number
getrowboundindex Number
getrows Array
getboundrows Array
getdisplayrows Array
getdatainformation Object
getsortinformation Object
getpaginginformation Object
hidecolumn None
hideloadelement None
hiderowdetails None
iscolumnvisible Boolean
iscolumnpinned Boolean
localizestrings None
pincolumn None
refreshdata None
refresh None
render None
scrolloffset None
scrollposition Object
showloadelement None
showrowdetails None
setcolumnindex None
setcolumnproperty None
showcolumn None
unpincolumn None
updatebounddata None
updating Boolean
getsortcolumn String
removesort None
sortby None
addgroup None
cleargroups None
collapsegroup None
collapseallgroups None
expandallgroups None
expandgroup None
getrootgroupscount Number
getgroup Object
insertgroup None
iscolumngroupable Boolean
removegroupat None
removegroup None
addfilter None
applyfilters None
clearfilters None
getfilterinformation None
getcolumnat Object
removefilter None
refreshfilterrow None
gotopage None
gotoprevpage None
gotonextpage None
addrow None
begincelledit None
beginrowedit None
closemenu None
deleterow None
endcelledit None
endrowedit None
getcell Object
getcellatposition Object
getcelltext String
getcelltextbyid String
getcellvaluebyid Object
getcellvalue Object
isBindingCompleted Boolean
openmenu None
setcellvalue None
setcellvaluebyid None
showvalidationpopup None
updaterow None
clearselection None
getselectedrowindex Number
getselectedrowindexes Array
getselectedcell Object
getselectedcells Array
selectcell None
selectallrows None
selectrow None
unselectrow None
unselectcell None
getcolumnaggregateddata String
refreshaggregates None
renderaggregates None
exportdata any
getstate Object
loadstate None
savestate None