Blazor JqxGrid API Reference

Name	Type
Properties
altrows	bool
Enables or disables the alternating rows.
altstart	double
This property specifies the first alternating row.
altstep	double
Sets or gets the alternating step
autoshowloadelement	bool
Determines whether the loading image should be displayed until the Grid's data is loaded.
autoshowfiltericon	bool
Displays the filter icon only when the column is filtered. When the value of this property is set to false, all grid columns will display a filter icon when the filtering is enabled.
autoshowcolumnsmenubutton	bool
Sets or gets whether the columns menu button will be displayed only when the mouse cursor is over a columns header or will be always displayed.
showcolumnlines	bool
Sets or gets whether the columns lines are displayed.
showrowlines	bool
Sets or gets whether the row lines are displayed.
showcolumnheaderlines	bool
Sets or gets whether the column header lines are displayed.
adaptive	bool
Sets or gets whether adaptive mode is enabled.
adaptivewidth	double
Sets or gets the Grid's breakpoint width when adaptive mode is actived.
clipboard	bool
Enables or disables the clipboard operations
closeablegroups	bool
When the value of this property is true, a close button is displayed in each grouping column.
columnsmenuwidth	double
Sets or gets the columns menu width.
columnmenuopening	object
Callback called when a column menu is opening. You can use it for changing the size of the menu or cancelling the opening. Three params are passed - menu, datafield and menu's height. If you return false, the opening will be cancelled.
columnmenuclosing	object
Callback called when a column menu is opening. You can use it for changing the size of the menu or cancelling the opening. Three params are passed - menu, datafield and menu's height. If you return false, the opening will be cancelled.
cellhover	object
Callback called when a cell is hovered.
enablekeyboarddelete	bool
Enables or disables the delete of a cell/row values by using the "delete" key.
enableellipsis	bool
Determines whether ellipsis will be displayed, if the cells or columns content overflows.
enablemousewheel	bool
Determines whether mousewheel scrolling is enabled.
enableanimations	bool
Enables or disables the grid animations.
enabletooltips	bool
Enables or disables the grid tooltips.
enablehover	bool
Enables or disables the grid rows hover state.
enablebrowserselection	bool
Enables the text selection of the browser.
everpresentrowposition	object
Sets the position of the ever present row. Possible values: "top", "bottom", "topAboveFilterRow".
everpresentrowheight	double
Sets the height of the ever present row.
everpresentrowactions	string
Sets the actions of the ever present row. Possible values: "add", "reset", "update", "delete". Instead of "add", you can also use "addBottom" which is the same as "add", but adds the new row to the bottom of the Grid.
everpresentrowactionsmode	object
Sets the actions display mode. By default they are displayed in a popup. You can set the property to "columns" and define columns with datafields - addButtonColumn, resetButtonColumn, updateButtonColumn and deleteButtonColumn to display the actions in columns.
filterrowheight	double
Sets or gets the filter row's height.
filtermode	object
The property specifies the type of rendering of the Filter Menu. Possible values: "default" and "excel". In "excel" mode, the Filter Menu displays a ListBox with Checkboxes with all unique cell values.
groupsrenderer	object
This function is called when a group is rendered. You can use it to customize the default group rendering.
groupcolumnrenderer	object
Sets or gets a custom renderer for the grouping columns displayed in the grouping header when the grouping feature is enabled.
groupsexpandedbydefault	bool
Sets or gets the default state of the grouped rows.
handlekeyboardnavigation	object
The function is called when a key is pressed. If the result of the function is true, the default keyboard navigation will be overriden for the pressed key.
pagerrenderer	object
The function is called when the Grid Pager is rendered. This allows you to customize the default rendering of the pager.
rtl	bool
Sets or gets a value indicating whether widget's elements are aligned to support locales using right-to-left fonts.
showdefaultloadelement	bool
Determines whether the Grid should display the built-in loading element or should use a DIV tag with class 'jqx-grid-load'
showfiltercolumnbackground	bool
When this property is true, the Grid adds an additional visual style to the grid cells in the filter column(s).
showfiltermenuitems	bool
Determines whether to display the filtering items in the column's menu.
showpinnedcolumnbackground	bool
When this property is true, the Grid adds an additional visual style to the grid cells in the pinned column(s).
showsortcolumnbackground	bool
When this property is true, the Grid adds an additional visual style to the grid cells in the sort column.
showsortmenuitems	bool
Determines whether to display the sort menu items.
showgroupmenuitems	bool
Determines whether to display the group menu items.
showrowdetailscolumn	bool
Shows an additional column with expand/collapse toggle buttons when the Row details feature is enabled.
showheader	bool
Shows or hides the columns header.
showgroupsheader	bool
Shows or hides the groups header area.
showaggregates	bool
Shows or hides the aggregates in the grid's statusbar.
showgroupaggregates	bool
Shows or hides the aggregates in Grid groups.
showeverpresentrow	bool
Shows or hides an additional row in jqxGrid which allows you to easily add new rows.
showfilterrow	bool
Shows or hides the filter row.
showemptyrow	bool
Shows or hides the empty row label when the Grid has no records to display.
showstatusbar	bool
Shows or hides the grid's statusbar.
statusbarheight	double
Sets the statusbar's height.
showtoolbar	bool
Shows or hides the grid's toolbar.
selectionmode	object
Sets or gets the selection mode. Possible Values: `'none'-disables the selection` `'singlerow'- full row selection` `'multiplerows' - each click selects a new row. Click on a selected row unselects it` `'multiplerowsextended' - multiple rows selection with drag and drop. The selection behavior resembles the selection of icons on your desktop` `'singlecell' - single cell selection` `'multiplecells' - each click selects a new cell. Click on a selected cell unselects it` `'multiplecellsextended' - in this mode, users can select multiple cells with a drag and drop. The selection behavior resembles the selection of icons on your desktop` `'multiplecellsadvanced' - this mode is the most advanced cells selection mode. In this mode, users can select multiple cells with a drag and drop. The selection behavior resembles the selection of cells in a spreadsheet` `'checkbox' - multiple rows selection through a checkbox.`
updatefilterconditions	object

updatefilterpanel	object

theme	string
Sets the widget's theme. Include the theme's CSS file after jqx.base.css. The following code example adds the 'material' theme. `<link rel="stylesheet" href="../../jqwidgets/styles/jqx.base.css" type="text/css" /> <link rel="stylesheet" href="../../jqwidgets/styles/jqx.material.css" type="text/css" />` Set the widget's theme property to 'material' when you initialize it.
toolbarheight	double
Sets or gets the toolbar's height.
autoheight	bool
Sets or gets the height of the grid to be equal to the summary height of the grid rows. This option should be set when the Grid is in paging mode.
autorowheight	bool
This property works along with the "autoheight" property. When it is set to true, the height of the Grid rows is dynamically changed depending on the cell values.
columnsheight	double
Sets or gets the columns height.
deferreddatafields	string[]
Determines the cell values displayed in a tooltip next to the scrollbar when the "scrollmode" is set to "deferred".
groupsheaderheight	double
Sets or gets the height of the Grid Groups Header.
groupindentwidth	double
Sets or gets the group indent size. This size is used when the grid is grouped. This is the size of the columns with expand/collapse toggle buttons.
height	object
Sets or gets the Grid's height.
pagerheight	object
Sets or gets the height of the Grid Pager.
rowsheight	double
Sets or gets the height of the grid rows.
scrollbarsize	object
Sets or gets the scrollbars size.
scrollmode	object
Determines the scrolling mode. Possible Values: `'default'` `'logical'- the movement of the scrollbar thumb is by row, not by pixel` `'deferred'-content is stationary when the user drags the Thumb of a ScrollBar`
scrollfeedback	object
When the "scrollmode" is set to "deferred", the "scrollfeedback" function may be used to display custom UI Tooltip next to the scrollbar.
width	object
Sets or gets the Grid's width.
autosavestate	bool
Determines whether the Grid automatically saves its current state.
autoloadstate	bool
Determines whether the Grid automatically loads its current state(if there's already saved one). The Grid's state is loaded when the page is refreshed.
columns	object
Sets the Grid columns.
columngroups	object[]
parentgroup - sets the column header's parent group name. name - sets the column header's name. align - sets the column header's alignment to 'left', 'center' or 'right'.
columnsmenu	bool
Enables or disables the columns dropdown menu.
columnsresize	bool
Enables or disables the columns resizing.
columnsautoresize	bool
Enables or disables the columns resizing when the column's border is double-clicked and `columnsresize` is set to true.
columnsreorder	bool
Enables or disables the columns reordering.
disabled	bool
Enables or disables the Grid's plugin.
editable	bool
The editable property enables or disables the Grid editing feature.
editmode	object
The editmode property specifies the action that the end-user should make to open an editor. Possible Values: `'click' - Marks the clicked cell as selected and shows the editor. The editor’s value is equal to the cell’s value` `'selectedcell' - Marks the cell as selected. A second click on the selected cell shows the editor. The editor’s value is equal to the cell’s value` `'selectedrow' - A second click on a selected row shows the row editors.` `'dblclick' - Marks the clicked cell as selected and shows the editor. The editor’s value is equal to the cell’s value` `'programmatic' - Cell editors are activated and deactivated only through the API(see begincelledit and endcelledit methods)`
filter	object
Custom Filtering function. It overrides the built-in Filtering. When the user filters, the Grid calls this function, when it is implemented. The function is expected to return a boolean value or undefined. cellValue - current cell's value. rowData - JSON object which contains the current row's data. dataField - filter column's field. filterGroup - group of filters. defaultFilterResult - the default filter result.
filterable	bool
Enables or disables the Grid Filtering feature. When the value of this property is true, the Grid displays a filtering panel in the columns popup menus.
groupable	bool
This property enables or disables the grouping feature.
groups	string[]
Sets or gets the Grid groups when the Grouping feature is enabled.
horizontalscrollbarstep	double
Sets or gets the scrollbar's step when the user clicks the scroll arrows.
horizontalscrollbarlargestep	double
Sets or gets the scrollbar's large step. This property specifies the step with which the horizontal scrollbar's value is changed when the user clicks the area above or below the thumb.
initrowdetails	object
This function is called when the user expands the row details and the details are going to be rendered.
keyboardnavigation	bool
Enables or disables the keyboard navigation.
localization	object
Localizes the Grid.
pagesize	double
Sets or gets the number of visible rows per page when the Grid paging is enabled.
pagesizeoptions	object
Sets or gets the available page size options.
pagermode	object
Sets or gets the rendering mode of the pager. Available values - "simple" and "default".
pagerbuttonscount	double
Sets or gets the buttons displayed in the pager when the "pagermode" is set to "simple".
pageable	bool
Enables or disables the Grid Paging feature. When the value of this property is true, the Grid displays a pager below the rows.
rowdetails	bool
Enables or disables the row details. When this option is enabled, the Grid can show additional information below each grid row.
rowdetailstemplate	object
Determines the template of the row details. The rowdetails field specifies the HTML used for details. The rowdetailsheight specifies the height of the details.
ready	object
This function is called when the grid is initialized and the binding is complete.
rendered	object
Callback function which is called when the jqxGrid's render function is called either internally or not.
renderstatusbar	object
Callback function which allows you to customize the rendering of the Grid's statusbar.
rendertoolbar	object
Callback function which allows you to customize the rendering of the Grid's toolbar.
rendergridrows	object
This is a function called when the grid is used in virtual mode. The function should return an array of rows which will be rendered by the Grid.
sortable	bool
The sortable property enables or disables the sorting feature.
sortmode	string
The sortmode property determines the Grid can sort by single or multiple columns.
selectedrowindex	double
Selects a row at a specified index.
selectedrowindexes	double[]
Selects single or multiple rows.
source	object
Sets and gets the source.
sorttogglestates	object
Possible Values: `'0'-disables toggling` '1'-enables togging. Click on a column toggles the sort direction `'2'-enables remove sorting option`
updatedelay	double
Sets or gets the rendering update delay. This could be used for deferred scrolling scenarios.
virtualmode	bool
Enables or disables the virtual data mode.
verticalscrollbarstep	double
Sets or gets the scrollbar's step when the user clicks the scroll arrows.
verticalscrollbarlargestep	double
Sets or gets the scrollbar's large step. This property specifies the step with which the vertical scrollbar's value is changed when the user clicks the area above or below the thumb.
Events
onBindingcomplete	Event
This event is triggered when the binding is completed. Note: Bind to that event before the Grid's initialization, because if you data bind the Grid to a local data source and bind to the "bindingcomplete" event after the initializaation, the data binding will be already completed.
onColumnresized	Event
This event is triggered when a Grid Column is resized.
onColumnreordered	Event
This event is triggered when a Grid Column is moved to a new position.
onColumnclick	Event
This event is triggered when a column is clicked.
onCellclick	Event
This event is triggered when a cell is clicked.
onCelldoubleclick	Event
This event is triggered when a cell is double-clicked.
onCellselect	Event
This event is triggered when a cell is selected.
onCellunselect	Event
This event is triggered when a cell is unselected.
onCellvaluechanged	Event
This event is triggered when a cell's value is changed.
onCellbeginedit	Event
This event is triggered when a cell's editor is displayed.
onCellendedit	Event
This event is triggered when a cell's edit operation has ended.
onFilter	Event
This event is triggered when the Grid is filtered.
onGroupschanged	Event
This event is triggered when a group is added, inserted or removed.
onGroupexpand	Event
This event is triggered when a group is expanded.
onGroupcollapse	Event
This event is triggered when a group is collapsed.
onPagechanged	Event
This event is triggered when the current page is changed.
onPagesizechanged	Event
This event is triggered when the page size is changed.
onRowclick	Event
This event is triggered when a row is clicked.
onRowdoubleclick	Event
This event is triggered when a row is double clicked.
onRowselect	Event
This event is triggered when a row is selected.
onRowunselect	Event
This event is triggered when a row is unselected.
onRowexpand	Event
This event is triggered when a row with details is expanded.
onRowcollapse	Event
This event is triggered when a row with details is collapsed.
onSort	Event
This event is triggered when the Grid is sorted.
Methods
Name	Arguments	Return Type
autoresizecolumns	(string type)	void
Auto-resizes all columns.
autoresizecolumn	(string dataField, string type)	void
Auto-resizes a column.
beginupdate	()	void
Starts an update operation. This is appropriate when calling multiple methods or set multiple properties at once. Optional boolean parameter: suspendAllActions. When you call beginupdate with parameter equal to `true`, the jqxGrid stops all rendering processes and when you call "endupdate", it will call the "render" method. Otherwise, it will try to resume its state with minimial performance impact. Use the suspendAllActions when you make multiple changes which require full-rerender such as changing the Grid's source, columns, groups.
clear	()	void
Clears the Grid contents.
destroy	()	void
Removes the Grid from the document and releases its resources.
endupdate	()	void
Ends the update operation.
ensurerowvisible	(double rowBoundIndex)	void
Scrolls to a row. The parameter is a bound index.
focus	()	void
Sets the keyboard Focus to the jqxGrid widget.
getcolumnindex	(string dataField)	double
Gets the index of a column in the columns collection.
getcolumn	(string dataField)	object
Gets a column by datafield value.Column's fields: datafield - column's datafield. To get the cells labels and values from the data source, the Grid uses the "datafield" and "displayfield" properties. If the "displayfield" is not set, the "displayfield" is equal to the "datafield'. text - column's text. displayfield - column's displayfield. To get the cells labels and values from the data source, the Grid uses the "datafield" and "displayfield" properties. If the "displayfield" is not set, the "displayfield" is equal to the "datafield'. sortable - determines whether the column is sortable. filterable - determines whether the column is filterable. exportable - determines whether the column will be exported through the "exportdata" method. editable - determines whether the column is editable. groupable - determines whether the column is groupable. resizable - determines whether the column is resizable. draggable - determines whether the column is draggable. classname - determines the column's header classname. cellclassname - determines the column's cells classname. width - determines the column's width. menu - determines whether the column has an associated popup menu or not.
getcolumnproperty	(string dataField, string propertyName)	object
Gets a property of a column. Possible property names: 'text', 'hidden', 'hideable', 'renderer', 'cellsrenderer', 'align', 'cellsalign', 'cellsformat', 'pinned', 'contenttype', 'resizable', 'filterable', 'editable', 'cellclassname', 'classname', 'width', 'minwidth', 'maxwidth'
getrowid	(double rowBoundIndex)	string
Gets the id of a row. The returned value is a 'string' or 'number' depending on the id's type. The parameter is the row's bound index.
getrowdata	(double rowBoundIndex)	object
Gets the data of a row. The returned value is a JSON object. The parameter is the row's bound index. Note: If you pass a bound index of a row which is not visible in the Grid, the method returns null.
getrowdatabyid	(string rowID)	object
Gets the data of a row. The returned value is a JSON object. The parameter is the row's id.
getrowboundindexbyid	(string rowID)	double
Gets the index of a row in the array returned by the `getboundrows` method.
getrowboundindex	(double rowDisplayIndex)	double
Gets the index of a row in the array returned by the `getboundrows` method.
getrows	()	object[]
Gets all rows. Returns an array of all rows loaded in the Grid. If the Grid is filtered, the returned value is an array of the filtered records.
getboundrows	()	object[]
Gets all rows loaded from the data source. The method returns an Array of all rows. The Grid's sorting, filtering, grouping and paging will not affect the result of this method. It will always return the rows collection loaded from the data source.
getdisplayrows	()	object[]
Gets all rows that are currently displayed in the Grid. The method returns an Array of the displayed rows. The Grid's sorting, filtering, grouping and paging will affect the result of this method.
getdatainformation	()	object
Gets bound data information.
getsortinformation	()	object
Gets the sort information.
getpaginginformation	()	object
Gets the paging information.
hidecolumn	(string dataField)	void
Hides a column.
hideloadelement	()	void
Hides the data loading image.
hiderowdetails	(double rowBoundIndex)	void
Hides the details of a row.
iscolumnvisible	(string dataField)	bool
Gets whether a column is visible. Returns a boolean value.
iscolumnpinned	(string dataField)	bool
Gets whether a column is pinned. Returns a boolean value.
localizestrings	(object localizationobject)	void
Localizes the grid strings. This method allows you to change the valus of all Grid strings and also to change the cells formatting settings.
pincolumn	(string dataField)	void
Pins the column.
refreshdata	()	void
Refreshes the data.
refresh	()	void
Repaints the Grid View.
render	()	void
Renders the Grid contents. This method completely refreshes the Grid cells, columns, layout and repaints the view.
scrolloffset	(double top, double left)	void
Scrolls the grid contents.
scrollposition	()	object
Returns the scrollbars position.
showloadelement	()	void
Shows the data loading image.
showrowdetails	(double rowBoundIndex)	void
Shows the details of a row.
setcolumnindex	(string dataField, double index)	void
n Sets the index of a column in the columns collection.
setcolumnproperty	(string dataField, object propertyName, object propertyValue)	void
Sets a property of a column.Possible property names: 'text', 'hidden', 'hideable', 'renderer', 'cellsrenderer', 'align', 'cellsalign', 'cellsformat', 'pinned', 'contenttype', 'resizable', 'filterable', 'editable', 'cellclassname', 'classname', 'width', 'minwidth', 'maxwidth'
showcolumn	(string dataField)	void
Shows a column.
unpincolumn	(string dataField)	void
Unpins the column.
updatebounddata	(object type)	void
Updates the bound data and refreshes the grid. You can pass 'filter' or 'sort' as parameter, if the update reason is change in 'filtering' or 'sorting'. To update only the data without the columns, use the 'data' parameter. To make a quick update of the cells, pass "cells" as parameter. Passing "cells" will refresh only the cells values when the new rows count is equal to the previous rows count. To make a full update, do not pass any parameter.
updating	()	bool
Gets the updating operation state. Returns a boolean value.
getsortcolumn	()	string
Gets the sort column. Returns the column's datafield or null, if sorting is not applied.
removesort	()	void
Removes the sorting.
sortby	(string dataField, string sortOrder)	void
Sorts the Grid data.
addgroup	(string dataField)	void
Groups by a column.
cleargroups	()	void
Clears all groups.
collapsegroup	(object group)	void
Collapses a group.
collapseallgroups	()	void
Collapses all groups.
expandallgroups	()	void
Expands all groups.
expandgroup	(object group)	void
Expands a group.
getrootgroupscount	()	double
Gets the number of root groups.
getgroup	(double groupIndex)	object
Gets a group. The method returns an object with details about the Group. The object has the following fields: group - group's name. level - group's level in the group's hierarchy. expanded - group's expand state. subgroups - an array of sub groups or null. subrows - an array of rows or null.
insertgroup	(double groupIndex, string dataField)	void
Groups by a column.
iscolumngroupable	()	bool
Gets whether the user can group by a column. Returns a boolean value.
removegroupat	(double groupIndex)	void
Removes a group at specific index.
removegroup	(string dataField)	void
Removes a group.
addfilter	(string dataField, object filterGroup, bool refreshGrid)	void
Adds a filter to the Grid.
applyfilters	()	void
Applies all filters to the Grid.
clearfilters	()	void
Clears all filters from the Grid. You can call the method with optional boolean parameter. If the parameter is "true" or you call the method without parameter, the Grid will clear the filters and refresh the Grid(default behavior). If the parameter is "false", the method will clear the filters without refreshing the Grid.
getfilterinformation	()	object
Gets the information about the Grid filters. The method returns an array of the applied filters. The returned information includes the filter objects and filter columns. Each filter in the Array has the following fields: filter - a filter object which may contain one or more filters. Properties and Methods of the filter object. getfilters - returns an array of all filters in the filter object. Each filter in the Array has: value - filter's value. id - filter's id. condition - filter's operator. For string filter the value could be: 'EMPTY', 'NOT_EMPTY', 'CONTAINS', 'CONTAINS_CASE_SENSITIVE', 'DOES_NOT_CONTAIN', 'DOES_NOT_CONTAIN_CASE_SENSITIVE', 'STARTS_WITH', 'STARTS_WITH_CASE_SENSITIVE', 'ENDS_WITH', 'ENDS_WITH_CASE_SENSITIVE', 'EQUAL', 'EQUAL_CASE_SENSITIVE', 'NULL', 'NOT_NULL. For Date and number filter the value could be: 'EQUAL', 'NOT_EQUAL', 'LESS_THAN', 'LESS_THAN_OR_EQUAL', 'GREATER_THAN', 'GREATER_THAN_OR_EQUAL', 'NULL', 'NOT_NULL'. For boolean filter, the value could be: 'EQUAL', 'NOT_EQUAL' type - filter's type - 'stringfilter', 'numericfilter', 'booleanfilter' or 'datefilter'. operator - 'and' or 'or'. Determines the connection between the filters in the group. datafield - the column's datafield. displayfield - the column's display field.
getcolumnat	(double index)	object

removefilter	(string dataField, bool refreshGrid)	void
Removes a filter from the Grid.
refreshfilterrow	()	void
Refreshes the filter row and updates the filter widgets. The filter row's widgets are synchronized with the applied filters.
gotopage	(double pagenumber)	void
Navigates to a page when the Grid paging is enabled i.e when the pageable property value is true.
gotoprevpage	()	void
Navigates to a previous page when the Grid paging is enabled i.e when the pageable property value is true.
gotonextpage	()	void
Navigates to a next page when the Grid paging is enabled i.e when the pageable property value is true.
addrow	(object rowIds, object data, object rowPosition)	void
Adds a new row or multiple rows.
begincelledit	(double rowBoundIndex, string dataField)	void
Shows the cell's editor.
beginrowedit	(double rowBoundIndex)	void
Shows the cell editors for an entire row.
closemenu	()	void
Closes a column's menu.
deleterow	(object rowIds)	void
Deletes a row or multiple rows. Returns a boolean value.
endcelledit	(double rowBoundIndex, string dataField, bool confirmChanges)	void
Hides the edit cell's editor and saves or cancels the changes.
endrowedit	(double rowBoundIndex, bool confirmChanges)	void
Hides the edited row's editors and saves or cancels the changes.
getcell	(double rowBoundIndex, string datafield)	object
Gets a cell. Returns an object with the following fields: value - cell's value. row - cell's row number. column - column's datafield.
getcellatposition	(double left, double top)	object
Gets a cell at specific position. Returns an object with the following fields: value - cell's value. row - cell's row number. column - column's datafield.
getcelltext	(double rowBoundIndex, string dataField)	string
Gets the text of a cell.
getcelltextbyid	(string rowID, string dataField)	string
Gets the text of a cell.
getcellvaluebyid	(string rowID, string dataField)	object
Gets the value of a cell.
getcellvalue	(double rowBoundIndex, string dataField)	object
Gets the value of a cell.
isBindingCompleted	()	bool
Returns whether the binding is completed and if the result is true, this means that you can invoke methods and set properties. Otherwise, if the binding is not completed and you try to set a property or invoke a method, the widget will throw an exception.
openmenu	(string dataField)	void
Displays a column's menu.
setcellvalue	(double rowBoundIndex, string dataField, object value)	void
Sets a new value to a cell.
setcellvaluebyid	(string rowID, string dataField, object value)	void
Sets a new value to a cell.
showvalidationpopup	(double rowBoundIndex, string dataField, string validationMessage)	void
Displays a validation popup below a Grid cell.
updaterow	(object rowIds, object data)	void
Updates a row or multiple rows.
clearselection	()	void
Clears the selection.
getselectedrowindex	()	double
The expected selection mode is 'singlerow', 'multiplerows' or 'multiplerowsextended' Gets the bound index of the selected row. Returns -1, if there's no selection.
getselectedrowindexes	()	double[]
The expected selection mode is 'singlerow', 'multiplerows' or 'multiplerowsextended' Gets the indexes of the selected rows. Returns an array of the selected rows.
getselectedcell	()	object
The expected selection mode is 'singlecell', 'multiplecells' or 'multiplecellsextended' Gets the selected cell. The returned value is an object with two fields: 'rowindex' - the row's bound index and 'datafield' - the column's datafield.
getselectedcells	()	object
The expected selection mode is 'singlecell', 'multiplecells' or 'multiplecellsextended' Gets all selected cells. Returns an array of all selected cells. Each cell in the array is an object with two fields: 'rowindex' - the row's bound index and 'datafield' - the column's datafield.
selectcell	(double rowBoundIndex, string dataField)	void
The expected selection mode is 'singlecell', 'multiplecells' or 'multiplecellsextended' Selects a cell.
selectallrows	()	void
The selection mode should be set to: 'multiplerows' or 'multiplerowsextended' Selects all Grid rows.
selectrow	(double rowBoundIndex)	void
The expected selection mode is 'singlerow', 'multiplerows' or 'multiplerowsextended' Selects a row.
unselectrow	(double rowBoundIndex)	void
The expected selection mode is 'singlerow', 'multiplerows' or 'multiplerowsextended' Unselects a row.
unselectcell	(double rowBoundIndex, string dataField)	void
The expected selection mode is 'singlecell', 'multiplecells' or 'multiplecellsextended' Unselects a cell.
getcolumnaggregateddata	(string dataField, object[] aggregates)	string
Gets the aggregated data of a Grid column. Returns a JSON object. Each field name is the aggregate's type('min', 'max', 'sum', etc.).
refreshaggregates	()	void
Refreshes the Aggregates in the Grid's status bar.
renderaggregates	()	void
Renders the aggregates in the Grid's status bar.
exportdata	(string dataType, string fileName, bool exportHeader, double[] rows, bool exportHiddenColumns, string serverURL, string charSet)	object
Exports all rows loaded within the Grid to Excel, XML, CSV, TSV, HTML or JSON. `var data = $("#jqxgrid").jqxGrid('exportdata', 'json');`
getstate	()	object
Gets the Grid's state. the getstate method gets the following information: 'sort column, sort order, page number, page size, applied filters and filter row values, column widths and visibility, cells and rows selection and groups. width - the Grid's width. height - the Grid's height. pagenum - the Grid's page number. pagesize - the Grid's page size. pagesizeoptions - the Grid's page size options - an array of the available page sizes. sortcolumn - the Grid's sort column. The value is the column's datafield or null, if sorting is not applied. sortdirection - JSON object with two boolean fields: 'ascending' and 'descending'. filters - the applied filters. See the 'getfilterinformation' method. groups - the Grid's groups array which contains the grouped columns data fields. columns - an array of Columns. Each column in the array has the following fields: width - column's width. hidden - column's visible state. pinned - column's pinned state. groupable - column's groupable state. resizable - column's resizable state. draggable - column's draggable state. text - column's text. align - column's align. cellsalign - column's cells align.
loadstate	(object stateobject)	void
Loads the Grid's state. the loadstate method loads the following information: 'sort column, sort order, page number, page size, applied filters and filter row values, column widths and visibility, cells and rows selection and groups.
savestate	()	object
Saves the Grid's current state. the savestate method saves the following information: 'sort column, sort order, page number, page size, applied filters and filter row values, column widths and visibility, cells and rows selection and groups.

Properties

Events

Methods