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 (menu?: GridColumnmenuopening['menu'], datafield?: GridColumnmenuopening['datafield'], height?: GridColumnmenuopening['height']) => boolean null
columnmenuclosing (menu?: GridColumnmenuclosing['menu'], datafield?: GridColumnmenuclosing['datafield'], height?: GridColumnmenuclosing['height']) => boolean null
cellhover (cellhtmlElement?: GridCellhover['cellhtmlElement'], x?: GridCellhover['x'], y?: GridCellhover['y']) => void null
enablekeyboarddelete boolean true
enableellipsis boolean true
enablemousewheel boolean true
enableanimations boolean true
enabletooltips boolean false
enablehover boolean true
enablebrowserselection boolean false
everpresentrowposition GridEverPresentRowPosition 'top'
everpresentrowheight number 30
everpresentrowactions string "add reset"
everpresentrowactionsmode GridEverPresentRowActionsMode "popup"
filterrowheight number 36
filtermode GridFilterMode "default"
groupsrenderer (text?: GridGroupsrenderer['text'], group?: GridGroupsrenderer['group'], expanded?: GridGroupsrenderer['expanded'], data?: GridGroupsrenderer['data']) => string null
groupcolumnrenderer (text?: GridGroupcolumnrenderer['text']) => string null
groupsexpandedbydefault boolean false
handlekeyboardnavigation (event: GridHandlekeyboardnavigation['event']) => 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 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 32
deferreddatafields Array<string> []
groupsheaderheight number 34
groupindentwidth number 20
height number | string 400
pagerheight number | string 40
rowsheight number 32
scrollbarsize number | string 15
scrollmode GridScrollMode "default"
scrollfeedback (row: GridScrollfeedback['row']) => string null
width string | number 600
autosavestate boolean false
autoloadstate boolean false
columns GridColumn[] []
columngroups Array<any> []
columnsmenu boolean true
columnsresize boolean false
columnsautoresize boolean true
columnsreorder boolean false
disabled boolean false
editable boolean false
editmode GridEditMode 'selectedcell'
filter (cellValue?: GridFilter['cellValue'], rowData?: GridFilter['rowData'], dataField?: GridFilter['dataField'], filterGroup?: GridFilter['filterGroup'], defaultFilterResult?: GridFilter['defaultFilterResult']) => 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 GridLocalizationobject null
pagesize number 10
pagesizeoptions Array<number | string> ['5', '10', '20']
pagermode GridPagerMode "default"
pagerbuttonscount number 5
pageable boolean false
rowdetails boolean false
rowdetailstemplate any null
ready () => void null
rendered () => void null
renderstatusbar (statusbar?: GridRenderstatusbar['statusbar']) => void null
rendertoolbar (toolbar?: GridRendertoolbar['toolbar']) => void null
rendergridrows (params?: any) => any null
sortable boolean false
sortmode string 'one'
selectedrowindex number -1
selectedrowindexes Array<number> []
source GridSource {}
sorttogglestates 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

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