jqGrid Chinese document option setting_jquery

jqGrid provides a large number of option settings. Developers can control jqGrid by setting the corresponding values ​​​​of the options. For example, the width, height, data type, column name, etc. of the table are all completed through option settings. The options of jqGrid are generally in the form of name:value (name:value), and can also be configured in the form of object (object) and array (array).

jqGrid Option(Option)

To call jqGrid, you only need to execute the following code:

jQuery("#grid_id").jqGrid(options);

options are the option settings of jqGrid, please refer to the following table.

for details

Properties	Type	Description	Default value
ajaxGridOptions	object	This item is used to set the global properties of ajax when the table setting obtains data. Note that this item may override all current ajax settings (including error, complete and beforeSend events).	empty
ajaxSelectOptions	object	This item is used to set the global properties of ajax when selecting elements through dataUrl in editoptions or searchoptions objects.	empty
altclass	string	Class for alternating rows.This is only valid when altRows is set to true.	ui-priority-secondary
altRows	boolean	Set as alternating row table	false
autoencode	boolean	When set to true, encodes data from the server and submitted data. For example, < will be converted to <	false
autowidth	boolean	When set to true, the table width will automatically match the width of the parent element. This matching is only performed when the table is created. In order to make the table change when the width of the parent element changes, you can use the setGridWidth method	false
caption	string	The title of the table. Displayed on the Header. It will not be displayed if it is empty.	empty
cellLayout	integer	This property determines the padding border width of the cell. Usually this attribute is not modified, but if the td element is changed in the CSS of the table, this attribute needs to be modified. The default value 5 means paddingLef(2) paddingRight(2) borderLeft(1)=5	5
cellEdit	boolean	Whether to allow cell editing.	false
cellsubmit	string	Determine whether the cell content is saved in remote or clientArray.	'remote'
cellurl	string	The url saved in the cell.	null
colModel	array	Describes the column parameter array. This is the most important part of the table, see colModel API.	null
colNames	array[]	Array of column names. This name will be displayed in the Header. The names are separated by commas and the number should be equal to the number of colModel arrays	empty
data	array	Save local data in the form of an array.	empty
datastr	string	When datatype is set to xmlstring or jsonstring, it is a data string.	null
datatype	string	Define the type of data the table hopes to obtain. Valid values ​​are: Xml —xml data xmlstring—xml string json—JSON data jsonstring—JSON string local—client data (array) javascript—javascript data function—function returns data	xml
deselectAfterSort	boolean	Only applicable when datatype is local. Deselects the currently selected rows when a sort is applied.	true
direction	string	Writing direction in table."ltr" left to right (default), "rtl" right to left	ltr
editurl	string	Define inline edit address URL	null
emptyrecords	string	The information displayed when the returned (or current) quantity is zero. This item is only valid when viewrecords is set to true.
ExpandColClick	boolean	When true, click to expand the text of the row, and the treeGrid will expand or collapse	true
ExpandColumn	string	Specify the column (name comes from colModel) used to expand the treeGrid. If not set, the first column is used.This item is only valid when treeGrid is true.	null
footerrow	boolean	If set to true, a table footer row will be generated with the number of columns equal to colModel	false
forceFit	boolean	If set to true and the column width is changed, adjacent columns will also be adjusted to fit the overall table, and horizontal scroll bars will not appear.	false
gridstate	string	The current status of the table. Either visible or hidden	visible
gridview	boolean	Setting to true will increase the display speed by 5~10 times.But you can no longer use the treeGrid, subGrid, or afterInsertRow events	false
grouping	boolean	Whether to set a table group	false
height	mixed	Table height. Can be a value, percentage or auto	150
hiddengrid	boolean	If set to true, the table will start to be hidden, the data will not be loaded, and only the title will be displayed. When the show/hide button is clicked for the first time to display the table, the data is loaded from the server.	false
hidegrid	boolean	Whether to allow show/hide buttons to be available. Only available if title is not empty.	true
hoverrows	boolean	Whether the table row has a mouseover effect	true
jsonReader	array	JSON data structure array
lastpage	integer	The total number of pages returned by the request	0
lastsort	integer	Column number for sorting (starting from 0)	0
loadonce	boolean	When set to true, the table reads the server data (using the appropriate datatype) only once. After that, the datatype automatically changes to local, all further operations are done on the client, and the pager function (if it exists) will be disabled.	false
loadtext	string	Text displayed when data is requested and sorted	Loading…
loadui	string	This item controls the action when the ajax process is in progress. Disable—Cancel jqGrid's process instructions. Custom instructions can be used. enable (default)—Loading is displayed in the middle of the table. block - Displays a "Loading" message, disabling all functionality on the page until data loading is complete.	enable
mtype	string	Define submission type POST or GET	GET
multikey	string	This attribute is only valid when multiselect is true. It defines the key combination for multi-select. The optional values ​​are: shiftKey, altKey, ctrlKey	empty
multiboxonly	boolean	This attribute is only valid when multiselect is true. When Multiboxonly is set to true, the row will be selected only when the checkbox is clicked. Clicking on other columns will clear the selection of the current row.	false
multiselect	boolean	此属性设为true时启用多行选择，出现复选框	false
multiselectWidth	integer	若multiselect 为true时，定义多选列的宽度。	20
page	integer	设置请求初始页的数量，此参数通过URL从服务器接受数据	1
pager	mixed	定义分页浏览导航条。必须是一个HTML元素，如	empty
pagerpos	string	Define the position of the table browsing navigation bar. By default, a navigation bar is created consisting of 3 parts: page number, navigation button and record information.	center
pgbuttons	boolean	Define whether the navigation button is displayed when navigation is activated.	true
pginput	boolean	Define whether the navigation bar has a page number input box.	true
pgtext	string	Current page information. The first amount is the current page, and the second amount is the total number of pages.
prmNames	array	By default prmNames: { page: "page", rows: "rows", sort: "sidx", order: "sord", search: "_search", nd: "nd", npage:null} Sent to the server in POST mode, the fields are: page, rows, sidx, sord, search, nd. For example, if you want to change sidx to mysort, you can write: prmNames: {sort: “mysort”}. In this way, the string submitted to the server will be Becomes: page=1&rows=10&mysort=myindex&sord=asc If some parameters are set to null, these parameters will no longer be sent to the server. For example prmNames: { nd:null} then the nd parameter will not be sent. For Npage parameters, see scroll option.	none
postData	array	This array can be passed directly to the url. This array can be of the form {name1:value1…}.	empty
recount	integer	Read-only attribute. Defines the number of rows displayed in the table. Not to be confused with records.	0
recordpos	string	Define the position of recording information on the page, which can be left, center, or right.	right
recordpos	object	Class for alternating rows	true
records	integer	Read-only attribute. Define the number of records to get from the request	none
recordtext	string	Prompt information that can be displayed on the page, this