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 (menu?: Any, datafield?: String, height?: Number | String) => Boolean null
columnmenuclosing (menu?: Any, datafield?: String, height?: Number | String) => Boolean null
cellhover (cellhtmlElement?: Any, x?: Number, y?: Number) => Void null
enablekeyboarddelete Boolean true
enableellipsis Boolean true
enablemousewheel Boolean true
enableanimations Boolean true
enabletooltips Boolean false
enablehover Boolean true
enablebrowserselection Boolean false
everpresentrowposition enum:GridEverPresentRowPosition 'top'
everpresentrowheight Number 30
everpresentrowactions String "add reset"
everpresentrowactionsmode enum:GridEverPresentRowActionsMode "popup"
filterrowheight Number 31
filtermode enum:GridFilterMode "default"
groupsrenderer (text?: String, group?: Number, expanded?: Boolean, data?: Any) => String null
groupcolumnrenderer (text?: String, group?: Number, expanded?: Boolean, data?: Any) => String null
groupsexpandedbydefault Boolean false
handlekeyboardnavigation (event: Any) => Boolean null
pagerrenderer () => Any[] 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 enum:GridSelectionMode 'singlerow'
updatefilterconditions (type?: String, defaultconditions?: Any) => Any null
updatefilterpanel (filtertypedropdown1?: Any, filtertypedropdown2?: Any, filteroperatordropdown?: Any, filterinputfield1?: Any, filterinputfield2?: Any, filterbutton?: Any, clearbutton?: Any, columnfilter?: Any, filtertype?: Any, filterconditions?: Any) => Any null
theme String ''
toolbarheight Number 34
autoheight Boolean false
autorowheight Boolean false
columnsheight Number 28
deferreddatafields Array<String> []
groupsheaderheight Number 34
groupindentwidth Number 20
height String | Number 400
pagerheight String | Number 30
rowsheight Number 28
scrollbarsize String | Number 15
scrollmode enum:GridScrollMode "default"
scrollfeedback (row: Any) => String null
width String | Number 600
autosavestate Boolean false
autoloadstate Boolean false
columns Array<GridColumn> []
columngroups Array<Any> []
columnsmenu Boolean true
columnsresize Boolean false
columnsautoresize Boolean true
columnsreorder Boolean false
disabled Boolean false
editable Boolean false
editmode enum:GridEditMode 'selectedcell'
filter (cellValue?: Any, rowData?: Any, dataField?: String, filterGroup?: Any, defaultFilterResult?: Boolean) => Any null
filterable Boolean false
groupable Boolean false
groups Array<String> []
horizontalscrollbarstep Number 5
horizontalscrollbarlargestep Number 50
initrowdetails (index?: Number, parentElement?: Any, gridElement?: Any, datarecord?: Any) => Void null
keyboardnavigation Boolean true
localization Any null
pagesize Number 10
pagesizeoptions Array<Number | String> ['5', '10', '20']
pagermode enum:GridPagerMode "default"
pagerbuttonscount Number 5
pageable Boolean false
rowdetails Boolean false
rowdetailstemplate Any null
ready () => Void null
rendered () => Void null
renderstatusbar (statusbar?: Any) => Void null
rendertoolbar (toolbar?: Any) => Void null
rendergridrows (params?: Any) => Any null
sortable Boolean false
selectedrowindex Number -1
selectedrowindexes Array<Number> []
source Any {}
sorttogglestates enum:GridSortToggleStates 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 TypeArguments
autoresizecolumns Void type: String
autoresizecolumn Void dataField: String,
type: String
beginupdate Void None
clear Void None
destroy Void None
endupdate Void None
ensurerowvisible Void rowBoundIndex: Number
focus Void None
getcolumnindex Number dataField: String
getcolumn GridGetColumn dataField: String
getcolumnproperty Any dataField: String,
propertyName: String
getrowid String rowBoundIndex: Number
getrowdata Any rowBoundIndex: Number
getrowdatabyid Any rowID: String
getrowboundindexbyid Number rowID: String
getrowboundindex Number rowDisplayIndex: Number
getrows Array<Any> None
getboundrows Array<Any> None
getdisplayrows Array<Any> None
getdatainformation GridGetDataInformation None
getsortinformation GridGetSortInformation None
getpaginginformation GridGetPagingInformation None
hidecolumn Void dataField: String
hideloadelement Void None
hiderowdetails Void rowBoundIndex: Number
iscolumnvisible Boolean dataField: String
iscolumnpinned Boolean dataField: String
localizestrings Void localizationObject: GridLocalizationObject
pincolumn Void dataField: String
refreshdata Void None
refresh Void None
render Void None
scrolloffset Void top: Number,
left: Number
scrollposition GridScrollPosition None
showloadelement Void None
showrowdetails Void rowBoundIndex: Number
setcolumnindex Void dataField: String,
index: Number
setcolumnproperty Void dataField: String,
propertyName: Any,
propertyValue: Any
showcolumn Void dataField: String
unpincolumn Void dataField: String
updatebounddata Void type: Any
updating Boolean None
getsortcolumn String None
removesort Void None
sortby Void dataField: String,
sortOrder: String
addgroup Void dataField: String
cleargroups Void None
collapsegroup Void group: String | Number
collapseallgroups Void None
expandallgroups Void None
expandgroup Void group: String | Number
getrootgroupscount Number None
getgroup GridGetGroup groupIndex: Number
insertgroup Void groupIndex: Number,
dataField: String
iscolumngroupable Boolean None
removegroupat Void groupIndex: Number
removegroup Void dataField: String
addfilter Void dataField: String,
filterGroup: Any,
refreshGrid: Boolean
applyfilters Void None
clearfilters Void None
getfilterinformation Any None
getcolumnat Any index: Number
removefilter Void dataField: String,
refreshGrid: Boolean
refreshfilterrow Void None
gotopage Void pageNumber: Number
gotoprevpage Void None
gotonextpage Void None
addrow Void rowIds: Any,
data: Any,
rowPosition: Any
begincelledit Void rowBoundIndex: Number,
dataField: String
beginrowedit Void rowBoundIndex: Number
closemenu Void None
deleterow Void rowIds: String | Number | Array<Number | String>
endcelledit Void rowBoundIndex: Number,
dataField: String,
confirmChanges: Boolean
endrowedit Void rowBoundIndex: Number,
confirmChanges: Boolean
getcell GridGetCell rowBoundIndex: Number,
datafield: String
getcellatposition GridGetCell left: Number,
top: Number
getcelltext String rowBoundIndex: Number,
dataField: String
getcelltextbyid String rowID: String,
dataField: String
getcellvaluebyid Any rowID: String,
dataField: String
getcellvalue Any rowBoundIndex: Number,
dataField: String
isBindingCompleted Boolean None
openmenu Void dataField: String
setcellvalue Void rowBoundIndex: Number,
dataField: String,
value: Any
setcellvaluebyid Void rowID: String,
dataField: String,
value: Any
showvalidationpopup Void rowBoundIndex: Number,
dataField: String,
validationMessage: String
updaterow Void rowIds: String | Number | Array<Number | String>,
data: Any
clearselection Void None
getselectedrowindex Number None
getselectedrowindexes Array<Number> None
getselectedcell GridGetSelectedCell None
getselectedcells Array<GridGetSelectedCell> None
selectcell Void rowBoundIndex: Number,
dataField: String
selectallrows Void None
selectrow Void rowBoundIndex: Number
unselectrow Void rowBoundIndex: Number
unselectcell Void rowBoundIndex: Number,
dataField: String
getcolumnaggregateddata String dataField: String,
aggregates: Array<Any>
refreshaggregates Void None
renderaggregates Void None
exportdata Any dataType: String,
fileName: String,
exportHeader: Boolean,
rows: Array<Number>,
exportHiddenColumns: Boolean,
serverURL: String,
charSet: String
getstate GridGetState None
loadstate Void stateObject: Any
savestate GridGetState None