jqgrid 部分文档摘录

参考官方文档（http://www.trirand.com/jqgridwiki/doku.php?id=wiki:methods ）

参考文档（https://blog.mn886.net/jqGrid/ ）

jqGrid|初始化|参数

---

名称	类型	描述	默认值	可修改
url	string	获取数据的地址
datatype	string	从服务器端返回的数据类型，默认xml。可选类型：xml，local，json，jsonnp，script，xmlstring，jsonstring，clientside
mtype	string	ajax提交方式。POST或者GET，默认GET
colNames	Array	列显示名称，是一个数组对象
colModel	Array	常用到的属性：name 列显示的名称；index 传到服务器端用来排序用的列名称；width 列宽度；align 对齐方式；sortable 是否可以排序
pager	string	定义翻页用的导航栏，必须是有效的html元素。翻页工具栏可以放置在html页面任意位置
rowNum	int	在grid上显示记录条数，这个参数是要被传递到后台
rowList	array	一个下拉选择框，用来改变显示记录数，当选择时会覆盖rowNum参数传递到后台
sortname	string	默认的排序列。可以是列名称或者是一个数字，这个参数会被提交到后台
viewrecords	boolean	定义是否要显示总记录数
caption	string	表格名称
[a1]	object	对ajax参数进行全局设置，可以覆盖ajax事件	null	是
[a2]	object	对ajax的select参数进行全局设置	null	是
altclass	String	用来指定行显示的css，可以编辑自己的css文件，只有当altRows设为 ture时起作用	ui-priority-secondary
altRows	boolean	设置表格 zebra-striped 值
autoencode	boolean	对url进行编码	false	是
autowidth	boolean	如果为ture时，则当表格在首次被创建时会根据父元素比例重新调整表格宽度。如果父元素宽度改变，为了使表格宽度能够自动调整则需要实现函数：setGridWidth	false	否
cellLayout	integer	定义了单元格padding + border 宽度。通常不必修改此值。初始值为	5	是
cellEdit	boolean	启用或者禁用单元格编辑功能	false	是
cellsubmit	String	定义了单元格内容保存位置	‘remote’	是
cellurl	String	单元格提交的url	空值	是
datastr	String	xmlstring或者jsonstring	空值	是
deselectAfterSort	boolean	只有当datatype为local时起作用。当排序时不选择当前行	true	是
direction	string	表格中文字的显示方向，从左向右（ltr）或者从右向左（rtr）	ltr	否
editurl	string	定义对form编辑时的url	空值	是
emptyrecords	string	当返回的数据行数为0时显示的信息。只有当属性 viewrecords 设置为ture时起作用		是
ExpandColClick	boolean	当为true时，点击展开行的文本时，treeGrid就能展开或者收缩，不仅仅是点击图片	true	否
ExpandColumn	string	指定那列来展开tree grid，默认为第一列，只有在treeGrid为true时起作用	空值	否
[a3]	boolean	当为true时，会在翻页栏之上增加一行	false	否
forceFit	boolean	当为ture时，调整列宽度不会改变表格的宽度。当shrinkToFit 为false时，此属性会被忽略	false	否
gridstate	string	定义当前表格的状态：‘visible’ or ‘hidden’	visible	否
gridview	boolean	构造一行数据后添加到grid中，如果设为true则是将整个表格的数据都构造完成后再添加到grid中，但treeGrid, subGrid, or afterInsertRow 不能用	false	是
height	mixed	表格高度，可以是数字，像素值或者百分比	150	否
hiddengrid	boolean	当为ture时，表格不会被显示，只显示表格的标题。只有当点击显示表格的那个按钮时才会去初始化表格数据。	false	否
hidegrid	boolean	启用或者禁用控制表格显示、隐藏的按钮，只有当caption 属性不为空时起效	true	否
hoverrows	boolean	当为false时mouse hovering会被禁用	false	是
jsonReader	array	描述json 数据格式的数组		否
lastpage	integer	只读属性，定义了总页数	0	否
lastsort	integer	只读属性，定义了最后排序列的索引，从0开始	0	否
loadonce	boolean	如果为ture则数据只从服务器端抓取一次，之后所有操作都是在客户端执行，翻页功能会被禁用	false	否
loadtext	string	当请求或者排序时所显示的文字内容	Loading…	否
loadui	string	当执行ajax请求时要干什么。disable禁用ajax执行提示；enable默认，当执行ajax请求时的提示； block启用Loading提示，但是阻止其他操作	enable	是
multikey	string	只有在multiselect设置为ture时起作用，定义使用那个key来做多选。shiftKey，altKey，ctrlKey	空值	是
multiboxonly	boolean	只有当multiselect = true.起作用，当multiboxonly 为ture时只有选择checkbox才会起作用	false	是
multiselect	boolean	定义是否可以多选	false	否
multiselectWidth	integer	当multiselect为true时设置multiselect列宽度	20	否
page	integer	设置初始的页码	1	是
pagerpos	string	指定分页栏的位置	center	否
pgbuttons	boolean	是否显示翻页按钮	true	否
pginput	boolean	是否显示跳转页面的输入框	true	否
pgtext	string	当前页信息		是
prmNames	array	Default valuesprmNames: {page:“page”,rows:“rows”, sort: “sidx”,order: “sord”, search:“_search”, nd:“nd”, npage:null} 当参数为null时不会被发到服务器端	none	是
postData	array	此数组内容直接赋值到url上，参数类型：{name1:value1…}	空array	是
reccount	integer	只读属性，定义了grid中确切的行数。通常情况下与records属性相同，但有一种情况例外，假如rowNum=15，但是从服务器端返回的记录数是20，那么records值是20，但reccount值仍然为15，而且表格中也只显示15条记录。	0	否
recordpos	string	定义了记录信息的位置： left, center, right	right	否
records	integer	只读属性，定义了返回的记录数	none	否
recordtext	string	显示记录数信息。{0} 为记录数开始，{1}为记录数结束。viewrecords为ture时才能起效，且总记录数大于0时才会显示此信息
resizeclass	string	定义一个class到一个列上用来显示列宽度调整时的效果	空值	否
rowList	array	一个数组用来调整表格显示的记录数，此参数值会替代rowNum参数值传给服务器端。	[]	否
rownumbers	boolean	如果为ture则会在表格左边新增一列，显示行顺序号，从1开始递增。此列名为’rn’.	false	否
rownumWidth	integer	如果rownumbers为true，则可以设置column的宽度	25	否
savedRow	array	只读属性，只用在编辑模式下保存数据	空值	否
scroll	boolean	创建一个动态滚动的表格，当为true时，翻页栏被禁用，使用垂直滚动条加载数据，且在首次访问服务器端时将加载所有数据到客户端。当此参数为数字时，表格只控制可见的几行，所有数据都在这几行中加载	false	否
scrollOffset	integer	设置垂直滚动条宽度	18	否
scrollrows	boolean	当为true时让所选择的行可见	false	是
selarrrow	array	只读属性，用来存放当前选择的行	array	否
selrow	string	只读属性，最后选择行的id	null	否
shrinkToFit	boolean	此属性用来说明当初始化列宽度时候的计算类型，如果为ture，则按比例初始化列宽度。如果为false，则列宽度使用colModel指定的宽度	true	否
sortable	boolean	是否可排序	false	否
sortname	string	排序列的名称，此参数会被传到后台	空字符串	是
sortorder	string	排序顺序，升序或者降序（asc or desc）	asc	是
subGrid	boolean	是否使用suggrid	false	否
subGridModel	array	subgrid模型	array	否
subGridType	mixed	如果为空则使用表格的dataType	null	是
subGridUrl	string	加载subgrid数据的url，jqGrid会把每行的id值加到url中	空值	是
subGridWidth	integer	subgrid列的宽度	20	否
toolbar	array	表格的工具栏。数组中有两个值，第一个为是否启用，第二个指定工具栏位置（相对于body layer），如：[true,”both”] 。工具栏位置可选值：“top”,”bottom”, “both”. 如果工具栏在上面，则工具栏id为“t_”+表格id；如果在下面则为 “tb_”+表格id；如果只有一个工具栏则为 “t_”+表格id	[false,‘’]	否
totaltime	integer	只读属性，计算加载数据的时间。目前支持xml跟json数据	0	否
treedatatype	mixed	数据类型，通常情况下与datatype相同，不会变	null	否
treeGrid	boolean	启用或者禁用treegrid模式	false	否
treeGridModel	string	treeGrid所使用的方法	Nested	否
treeIcons	array	树的图标，默认值：{plus:‘ui-icon-triangle-1-e’,minus:‘ui-icon-triangle-1-s’,leaf:‘ui-icon-radio-off’}		否
treeReader	array	扩展表格的colModel且加在colModel定义的后面		否
tree_root_level	numeric	r oot元素的级别，	0	否
userData	array	从request中取得的一些用户信息	array	否
userDataOnFooter	boolean	当为true时把userData放到底部，用法：如果userData的值与colModel的值相同，那么此列就显示正确的值，如果不等那么此列就为空	false	是
viewrecords	boolean	是否要显示总记录数	false	否
viewsortcols	array	定义排序列的外观跟行为。数据格式：[false,‘vertical’,true].第一个参数是说，是否都要显示排序列的图标，false就是只显示 当前排序列的图标；第二个参数是指图标如何显示，vertical：排序图标垂直放置，horizontal：排序图标水平放置；第三个参数指单击功 能，true：单击列可排序，false：单击图标排序。说明：如果第三个参数为false则第一个参数必须为ture否则不能排序		否
width	number	如果设置则按此设置为主，如果没有设置则按colModel中定义的宽度计算	none	否
xmlReader	array	对xml数据结构的描述		否

---

jqGrid colModel 参数

---

ColModel 是jqGrid里最重要的一个属性，设置表格列的属性。

属性	数据类型	备注	默认值
align	string	left, center, right.	left
classes	string	设置列的css。多个class之间用空格分隔，如：‘class1 class2’ 。表格默认的css属性是ui-ellipsis	empty string
datefmt	string	”/”, ”-”, and ”.”都是有效的日期分隔符。y,Y,yyyy 年YY, yy 月m,mm for monthsd,dd 日.	ISO Date (Y-m-d)
defval	string	查询字段的默认值	空
editable	boolean	单元格是否可编辑	false
editoptions	array	编辑的一系列选项。{name:’__department_id’,index:’__department_id’,width:200,editable:true,edittype:’select’,editoptions: {dataUrl:”/jqGrid/admin/deplistforstu.action”}},这个是演示动态从服务器端获取数据。	empty
editrules	array	编辑的规则{name:’age’,index:’age’, width:90,editable:true,editrules: {edithidden:true,required:true,number:true,minValue:10,maxValue:100}},设定 年龄的最大值为100，最小值为10，而且为数字类型，并且为必输字段。	empty
edittype	string	可以编辑的类型。可选值：text, textarea, select, checkbox, password, button, image and file.	text
fixed	boolean	列宽度是否要固定不可变	false
formoptions	array	对于form进行编辑时的属性设置	empty
formatoptions	array	对某些列进行格式化的设置	none
formatter	mixed	对列进行格式化时设置的函数名或者类型 {name:’sex’,index:’sex’, align:’center’,width:60,editable:true,edittype:’select’,editoptions: {value:’0:待定;1:男;2:女’},formatter:function(cellvalue, options, rowObject){ var temp = “1){ temp = temp +”user-white.png”; } else if(cellvalue2){ temp = temp +”user-white-female.png”; } else { temp = temp + “user-silhouette.png”; } temp = temp + “‘ border=’0 ′ />” return temp; }},// 返回性别的图标。	none
hidedlg	boolean	是否显示或者隐藏此列	false
hidden	boolean	在初始化表格时是否要隐藏此列	false
index	string	索引。其和后台交互的参数为sidx	empty
jsonmap	string	定义了返回的json数据映射	none
key	boolean	当从服务器端返回的数据中没有id时，将此作为唯一rowid使用只有一个列可以做这项设置。如果设置多于一个，那么只选取第一个，其他被忽略	false
label	string	如果colNames为空则用此值来作为列的显示名称，如果都没有设置则使用name 值	none
name	string	表格列的名称，所有关键字，保留字都不能作为名称使用包括subgrid, cb and rn.	Required
resizable	boolean	是否可以被resizable	true
search	boolean	在搜索模式下，定义此列是否可以作为搜索列	true
searchoptions	array	设置搜索参数	empty
sortable	boolean	是否可排序	true
sorttype	string	用在当datatype为local时，定义搜索列的类型，可选值：int/integer - 对integer排序float/number/currency - 排序数字date - 排序日期text - 排序文本	text
stype	string	定义搜索元素的类型	text
surl	string	搜索数据时的url	empty
width	number	默认列的宽度，只能是象素值，不能是百分比	150
xmlmap	string	定义当前列跟返回的xml数据之间的映射关系	none
unformat	function	‘unformat’单元格值	null

以下是详细说明：

1.0	colModel	要呈现字段的属性设置
1.1	align	定义数据相对单元格的对齐方式.string left
1.2	datefmt	日期格式， string Y-m-d
1.3	editable	定义字段是否可编辑 boolean false
1.4	defval	搜索字段的默认值,(只用于自定义搜索) string empty
1.5	edittype	该字段控件类型(text, textarea, select, checkbox, password, button, image , file) string text
1.6	surl	只有在自定义搜索和edittype属性为select和描述的url得到select 的element% string empty
1.7	editoptions	针对edittype配置的控件类型的属性设置 array empty array
1.7.1	value	依据edittype，配置属性%（详见: editoptions的value配置）mixed none
1.7.2	dataUrl	这个属性只适用与edittype属性为select (指定select的数据源edittype:“select”,editoptions:{dataUrl:‘test.txt’, defaultValue:‘Intime’}) string empty
1.7.3	dataInit	当控件被创建时仅触发1次 function null
1.7.4	dataEvents	给当前控件追加事件处理% array empty array
1.7.5	defaultValue	默认值(可以是函数返回值) mixed none
1.7.6	其他	可设置控件的任何有效属性editoptions:{size:10,maxlength:8}mixed none
1.8	editrules	设置编辑字段的控件的规则 array empty array
1.8.1	edithidden	该字段隐藏时, 此属性可以控制是否可编辑 boolean false
1.8.2	required	是否验证空数据 boolean false
1.8.3	number	是否验证数字 boolean false
1.8.4	integer	是否验证整数 boolean false
1.8.5	minValue	验证最小值 number(integer) empty
1.8.6	maxValue	验证最大值 number(integer) empty
1.8.7	email	是否验证email boolean false
1.8.8	url	是否验证是有效的网址 boolean false
1.8.9	date	是否验证日期 boolean false
1.8.10	time	是否验证时间 boolean false
		如果此字段不是必填,如果填了才验证是否是email 那么应该配置 email:true, required:false
1.9	formoptions	设置该字段相对表单中的相关设置 array empty array
1.9.1	elmprefix	如果设置,则会在控件前面出现该设置 string empty
1.9.2	elmsuffix	如果设置,则会在控件后面出现该设置 string empty
1.9.3	label	如果设置,则会替换colNames设置的名称 string empty
1.9.4	rowpos	设置该字段所在行的位置,从1开始计数 number empty
1.9.5	colpos	设置该字段所在列的位置,从1开始计数 number empty
1.10	formatoptions	设置特定列的格式,覆盖语言文件的默认值 array empty array
1.11	formatter	指定formatoptions设置格式的类型 mixed none
1.11.1	integer	当formatter指定为此属性时, formatoptions可以设置以下属性.
1.11.1.1	thousandsSeparator	每千位分隔符 string empty
1.11.1.2	defaulValue	在没有数据的情况下的默认值 string empty
1.11.2	number	当formatter指定为此属性时, formatoptions可以设置以下属性.
1.11.2.1	decimalSeparator	小数位分隔符 string empty
1.11.2.2	thousandsSeparator	每千位分隔符 string empty
1.11.2.3	decimalPlaces	小数位数 string empty
1.11.2.4	defaulValue	在没有数据的情况下的默认值 string empty
1.11.3	currency	当formatter指定为此属性时, formatoptions可以设置以下属性.
1.11.3.1	decimalSeparator	小数位分隔符 string empty
1.11.3.2	thousandsSeparator	每千位分隔符 string empty
1.11.3.3	decimalPlaces	小数位数 string empty
1.11.3.4	defaulValue	在没有数据的情况下的默认值 string empty
1.11.3.5	prefix	在数据前面添加的文本比如货币符号”$” string empty
1.11.3.6	suffix	在数据后面添加的文本比如货币符号”$” string empty
1.11.4	date	当formatter指定为此属性时, formatoptions可以设置以下属性.
1.11.4.1	srcformat	原格式 string empty
1.11.4.2	newformat	新的输出格式 string empty
1.11.5	email	当formatter指定为 email类型,直接使这个email加href string empty
1.11.6	link	当formatter指定为此属性时, formatoptions可以设置以下属性.
1.11.6.1	target	默认为empty如果设置,则创建一个以单元格的值和target属性的链接string empty
1.11.7	showlink	当formatter指定为此属性时, formatoptions可以设置以下属性.
1.11.7.1	baseLinkUrl	链接. string empty
1.11.7.2	showAction	附加值,在baseLinkUrl后面 . string empty
1.11.7.3	addParam	额外参数. string empty
1.11.7.4	target	如果设置,增加1条附加属性. string empty
1.11.7.5	idName	是第1个参数,之后由showAction补充,默认情况下,这是id string empty
1.11.8	checkbox	当formatter指定为此属性时, formatoptions可以设置以下属性.
1.11.8.1	disabled	默认true禁止改变状态,如果设置为false是可以改变的 boolean
1.11.9	select	当edittype ,formatter指定为此属性时, editoptions:{value:“1:One;2:Two”}值是1,2显示的则是one,two string empty
		colModel:[{name:‘myname’, edittype:‘select’, formatter:‘select’, formatoptions:{baseLinkUrl:‘myrul.php’, addParam: ‘&action=edit’, idName:‘myid’}, …}
1.12	unformat	可以为formatter指定自定义格式的方法 function null
1.13	hidedlg	如果设置为true在显示/隐藏字段功能中，该字段将不会出现% boolean false
1.14	hidden	该字段是否隐藏 boolean false
1.15	index	排序时, sidx的参数 string empty
1.16	jsonmap	定义json映射这个字段时的json字符串 string empty
1.17	xmlmap	定义xml文件映射这个字段时的xml字符串 string empty
1.18	key	如果服务器端没有定义id,可以设置字段为行号,只有一个字段可以设置此属性,只认可第1个,其他的将被忽略. boolean false
1.19	name	设置此字段的唯一名称,此属性是必须要设置的, string empty
1.20	label	当colNames为空,则标题显示此设置.如果colNames数组和此设置同时为空,则标题显示name属性. string empty
1.21	resizable	设置此字段是否可编辑 boolean true
1.22	search	该字段是否允许搜索(查询) boolean true
1.23	stype	设置搜索时的数据类型 string text
1.24	searchoptions	配置搜索选项 array empty array
1.24.1	dataUrl	该属性只适用于 stype:’select’ string empty
1.24.2	dataInit	等同于editoptions的dataInit function null
1.24.3	dataEvents	等同于editoptions的dataEvents array empty array
1.24.4	attr	可以设置创建的元素的有效属性 object null
1.24.5	searchhidden	该字段隐藏时,此属性可控制是否可搜索 boolean false
1.24.6	defaultValue	默认值 string empty
1.24.7	sopt	比较运算符,可任意组合(‘eq’,‘ne’,‘lt’,‘le’,‘gt’,‘ge’,‘bw’,‘bn’,‘in’,‘ni’,‘ew’,‘en’,‘cn’,‘nc’)array empty array 等于 eq = 不等于 ne <> 小于 lt < 小于等于 le <= 大于 gt > 大于等于 ge >= 以开头 bw like 不以开头 bn not like 在 in in 不在 ni not in 以结尾 ew like 不以结尾 en not like 包含 cn like 不包含 nc not like
1.25	sortable	设置该字段是否进行排序 boolean true
1.26	sorttype	排序的数据类型 string text
1.27	width	宽度,不能设置百分比 number 150
2.0	navGrid	功能按钮(增删改查,搜,刷新)设置
2.1	top	距离顶端的象素 number(integer) 0
2.2	left	距离左边的象素 number(integer) 0
2.3	width	宽度 number(integer) 300
2.4	height	高度 number(integer) auto
2.5	dataheight	表单内容距离按钮高度 number(integer) auto
2.6	modal	是否模态窗体 boolean false
2.7	drag	是否可拖动 boolean true
2.8	resize	是否可改变大小 boolean true
2.9	url	提交的URL,如果设置则替换editurl string empty
2.10	mtype	请求类型post | get string post
2.11	editData	提交到服务器的数据 array empty array
2.12	recreateForm	每次操作是否创建新的表单 boolean false
2.13	jqModal	设置为true使用存在的jqModal插件的对话框。如果被设置为true和插件不存在jqGrid使用它自己的方式来创造对话框, 比如会影响到日期插件,true和false不同的效果 boolean true
2.14	addedrow	%
2.15	topinfo	头部信息 string empty
2.16	bottominfo	底部信息 string empty
2.17	saveicon	保存的图片,第一项启用/禁用的图片, 第二个项目告诉哪里放置图片到文本的左或右. 第三项对应的有效UI图片样式 [true,”left”,”ui-icon-disk”]
2.18	closeicon	取消的图片同上 [true,”left”,”ui-icon-close”]
2.19	savekey	保存的快捷键,默认回车 [false,13]
2.20	navkeys	移动上个,下个的快捷键 ,默认上下箭头 [false,38,40]
2.21	checkOnSubmit	保存时,是否弹出再次确认对话框,仅用在编辑模式 boolean false
2.22	checkOnUpdate	取消时,是否弹出再次确定对话框,仅用在新增和编辑模式 boolean false
2.23	closeAfterAdd	添加模式时,添加记录后是否关闭对话框 boolean false
2.24	clearAfterAdd	添加数据时,是否清空上1次的数据 boolean true
2.25	closeAfterEdit	编辑模式时,编辑完成后是否关闭对话框 boolean false
2.26	reloadAfterSubmit	操作完成后,是否重新加载数据 boolean true
2.27	closeOnEscape	是否关联esc键 boolean false
2.28	ajaxEditOptions	% object empty object

---

jqGrid json数据

---

jqGrid可支持的数据类型：xml、json、jsonp、local or clientSide、xmlstring、jsonstring 、script、function (…)。

Json数据

需要定义jsonReader来跟服务器端返回的数据做对应，其默认值：

jsonReader : {
root: "rows",       
page: "page",
total: "total",
records: "records",
repeatitems: true,
cell: "cell",
id: "id",
userdata: "userdata",            
subgrid: {
    root:"rows",
    repeatitems: true,                  	cell:"cell"              }   

这样服务器端返回的数据格式：

{   
   total: "xxx",   
   page: "yyy",   
   records: "zzz",  
   rows : [  
     {id:"1", cell:["cell11", "cell12", "cell13"]},  
     {id:"2", cell:["cell21", "cell22", "cell23"]},  
       //...  
   ]  
}

jsonReader的属性

属性	备注
total	总页数
page	当前页
records	查询出的记录数
rows	包含实际数据的数组
id	行id
cell	当前行的所有单元格

自定义数据解析

jQuery("#gridid").jqGrid({  
//...  
	jsonReader : {  
		root:"invdata",  
		page: "currpage",  
		total: "totalpages",  
		records: "totalrecords",  
		cell: "invrow"  
	},  
//...  
}); 
	totalpages: "xxx",   
	currpage: "yyy",  
	totalrecords: "zzz",  
	invdata : [  
		{id:"1", invrow:["cell11", "cell12", "cell13"]},  
		{id:"2", invrow:["cell21", "cell22", "cell23"]},  
		//...  
	] 

​

repeatitems :指明每行的数据是可以重复的，如果设为false，则会从返回的数据中按名字来搜索元素，这个名字就是colModel中的名字

jsonReader : {  
	root:"invdata",  
	page: "currpage",  
	total: "totalpages",  
	records: "totalrecords",  
	repeatitems: false,  
	id: "0"  
}
totalpages: "xxx",   
currpage: "yyy",  
totalrecords: "zzz",  
invdata : [  
	{invid:"1",invdate:"cell11", amount:"cell12", tax:"cell13", total:"1234", note:"somenote"},  
	{invid:"2",invdate:"cell21", amount:"cell22", tax:"cell23", total:"2345", note:"some note"},  
	//...  
]

​

此例中，id属性值为“invid”。 一旦当此属性设为false时，我们就不必把所有在colModel定义的name值都赋值。因为是按name来进行搜索元素的，所以他的排序也不是按colModel中指定的排序结果。

用户数据（user data） 在某些情况下，我们需要从服务器端返回一些参数但并不想直接把他们显示到表格中，而是想在别的地方显示，那么我们就需要用到userdata标签

jsonReader: {  
	//...  
	userdata: "userdata",  
	//...  
} 
{   
	total: "xxx",   
	page: "yyy",   
	records: "zzz",   
	userdata: {totalinvoice:240.00, tax:40.00},   
	rows : [   
		{id:"1", cell:["cell11", "cell12", "cell13"]},   
		{id:"2", cell:["cell21", "cell22", "cell23"]},   
		//...   
	]   
}

在客户端我们可以有下面两种方法得到这些额外信息：

1.jQuery(“grid_id”).getGridParam(‘userData’)

2.jQuery(“grid_id”).getUserData()

3.jQuery(“grid_id”).getUserDataItem( key )

---

jqGrid方法大全

jqGrid的方法，从3.6开始已经完全兼容jQuery UI库。

jQuery("#grid_id").jqGridMethod( parameter1,...parameterN );
jQuery("#grid_id").setGridParam({...}).hideCol("somecol").trigger("reloadGrid");

如果使用新的API：

jQuery("#grid_id").jqGrid('method',parameter1,...parameterN );
jQuery("#grid_id").jqGrid('setGridParam',{...}).jqGrid('hideCol',"somecol").trigger("reloadGrid");

jqGrid配置使用新的api

DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">  
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">  
	<head>  
		<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />  
		<title>My First Gridtitle>  
		<link rel="stylesheet" type="text/css" media="screen" href="css/ui-lightness/jquery-ui-1.7.1.custom.css" />
		<link rel="stylesheet" type="text/css" media="screen" href="css/ui.jqgrid.css" />  
		<script src="js/jquery-1.3.2.min.js" type="text/javascript">script>  
		<script src="js/i18n/grid.locale-en.js" type="text/javascript">script>  
		<script type="text/javascript"> 
        	jQuery.jgrid.no_legacy_api = true;  
		script>  
		<script src="js/jquery.jqGrid.min.js" type="text/javascript">script>  
	head>  
	<body>  
	...  
	body>  
html>

jqGrid方法

方法名	参数	返回值	说明
addJSONData	data	none	使用传来的data数据填充表格。使用方法： var mygrid = jQuery(”#”+grid_id)[0]; var myjsongrid = eval(”(”+jsonresponse.responseText+”)”); mygrid.addJSONData(myjsongrid); myjsongrid = null; jsonresponse =null;
addRowData	rowid,data, position, srcrowid	成功为true, 否则为false	根据参数插入一行新的数据，rowid为新行的id，data为新行的数据，position为新增行的位置，srcrowid为新增行的参考位置。data数据格式：{name1:value1,name2: value2…} name为在colModel中指定的名称
addXMLData	data	none	根据传来的数据填充表格。用法：var mygrid = jQuery(”#”+grid_id)[0]; mygrid.addXmlData(xmlresponse.responseXML);
clearGridData	clearfooter	jqGrid对象	清除表格当前加载的数据。如果clearfooter为true时则此方法删除表格最后一行的数据
delRowData	rowid	成功为true否则为false	根据rowid删除行，但不会从服务器端删除数据
footerData	action,data, format	jgGrid对象	设置或者取得底部数据。action：“get”或者“set”，默认为“get”，如果为“get”返回值为name:value，name为colModel中名称。如果为“set”则值为name：value，name是colModel中的名称。format：默认为true，当为 true时，在设置新值时会调用formatter格式化数值
getCell	rowid, iCol	单元格内容	返回指定rowid，iCol的单元格内容，iCol既可以是当前列在colModel中的位置索引也可以是name值。注意：在编辑行或者单元格时不能使用此方法，此时返回的并不是改变的值，而是原始值
getCol	colname, returntype, mathoperation	array[] or value	返回列的值。colname既可以是当前列在colModel中的位置索引也可以是name值。returntype指定返回数据的类型，默认为false。当为false时，返回的数组中只包含列的值，当为true时返回数组是对象数组，具体格式 {id:rowid, value:cellvalue} ，id为行的id，value为列的值。如： [{id:1,value:1},{id:2,value:2}…]。mathoperation 可选值为’sum, ‘avg’, ‘count’
getDataIDs	none	array[]	返回当前grid里所有数据的id
getGridParam	name	mixed value	返回请求的参数信息
getInd	rowid,rowcontent	mixed	如果rowcontent为false，返回行所在的索引位置，id为行id。rowcontent默认为false。如果rowconent为ture则返回的为行对象，如果找不到行则返回false
getRowData	rowid or none	array[]	返回指定行的数据，返回数据类型为name:value，name为colModel中的名称，value为所在行的列的值，如果根据rowid找不到则返回空。在编辑模式下不能用此方法来获取数据，它得到的并不是编辑后的值
hideCol	colnameor[colnames]	jqGrid对象	如果参数为一个列名则隐藏此列，如果给定的是数组则隐藏指定的所有列。格式： [“name1”,”name2”]
remapColumns	permutation, updateCells, keepHeader	none	调整表格列的显示顺序,permutation为当前列的顺序，假如值是[1,0,2]，那么第一列就会在第二位显示。如果updateCells为ture则是对单元格数据进行重新排序，如果keepHeader为true则对header数据显示位置进行调整
resetSelection	none	jqGrid对象	选择或者反选行数据，在多选模式下也同样起作用
setCaption	caption	jqGrid对象	设置表格的标题
setCell	rowid,colname, data, class, properties	jqGrid对象	改变单元格的值。rowid：当前行id；colname：列名称，也可以是列的位置索引，从0开始；data：改变单元格的内容，如果为空则不更 新；class：如果是string则会使用addClass方法将其加入到单元格的css中，如果是array则会直接加到style属性中；properties：设置单元格属性
setGridParam	object	jqGrid对象	设置grid的参数。有些参数的修改必须要重新加载grid才可以生效，这个方法可以覆盖事件
setGridHeight	new_height	jqGrid对象	动态改变grid的高度，只能对单元格的高度进行设置而不能对表格的高度进行动态修改。new_height：可以是象素值，百分比或者"auto"
setGridWidth	new_width,shrink	jqGrid对象	动态改变表格的宽度。new_width:表格宽度，象素值；shrink：true或者false，作用同shrinkToFit
setLabel	colname, data, class, properties	jqGrid对象	给指定列设置一个新的显示名称。colname：列名称，也可以是列的位置索引，从0开始；data：列显示名称，如果为空则不修改；class：如果是 string则会使用addClass方法将其加入到单元格的css中，如果是array则会直接加到style属性中；properties：设置 label的属性
setRowData	rowid,data, cssprop	成功true否则false	更新行的值，rowid为行id。data值格式：{name1:value1,name2: value2…} name为colModel中名称；cssprop：如果是string则会使用addClass方法将其加入到行的css中，如果是array或者对象 则会直接加到style属性中
setSelection	rowid,onselectrow	jqGrid对象	选择或反选指定行。如果onselectrow为ture则会触发事件onSelectRow，onselectrow默认为ture
showCol	colname	jqGrid	显示列。colname可以是数组[“name1”,”name2”],但是name1或者name2必须是colModel中的name
trigger(“reloadGrid”)	none	jqGrid对象	重新加载当前表格，也会向服务器发起新的请求
updateColumns	none	none	同步表格的宽度，用在表格拖拽时，用法：var mygrid=jQuery(”#grid_id”)[0];mygrid.updateColumns();

jqGrid 的通用方法和设置

这些方法并不和jqGrid对象绑定，可以随意使用：

jQuery.jgrid.jqGridFunction( parameter1,...parameterN );

函数名	参数	返回值	说明
ajaxOptions	空对象	none	这个函数可以改变jqgrid中用到的ajax请求参数，这个函数可以覆盖当前所有ajax请求设置。从3.6版本开始起有3个级别的ajax设置：第一 个级别就是在模块中设置ajax请求；第二个级别就是通过此函数设置；第三级别的设置是控制全局ajax请求的设置：jQuery.extend(jQuery.ajax({method specific options}, ajaxOptions, ThirdLevelajaxSettinds)); 当然我们也可以单独设置ajax的参数
jqID	string	解析后的string	转义字符串，把两个反斜杠(\)转化为单个反斜杠()
jgrid.htmlDecode	string	转换后string	把转码后的字符串还原
jgrid.htmlEncode	string	编码后的string	把字符串编码
jgrid.format	string	格式化后string	简单字符串模板。用法：Example jQuery.jqgformat(“Please enter a value between {0} and {1}.”, 4,result : “Please enter a value between 4 and 8.”
jgrid.getCellIndex	cell	index	这个方法是用来修复在ie7里的一个bug
jgrid.stringToDoc	xmlstring	xmlDoc	把xmlstring转换为dom对象
jgrid.stripHtml	content	new_content	去掉html标签返回标签中内容
jgrid.parse	jsonstring	对象	把一个jsonstring转换为json对象

其他方法

方法名	参数	返回值	说明
filterGrid	grid_id,params	HTML对象	构造jqGrid的查询界面。grid_id:表格id；params：参数
filterToolbar	params	jqGrid对象	同上。不同的是搜索输入框在header层下方
getColProp	colname	array	返回指定列的属性集合。name为colModel中名称
GridDestroy	grid_id	boolean	从dom上删除此grid
GridUnload	grid_id	boolean	跟GridDestroy不同的是table对象跟pager对象并不会被删除，以便下次使用
setGridState	state	jqGrid对象	设置grid的状态，显示或者隐藏。这个方法不会触发onHeaderClick 事件。
setColProp	colname, properties	jqGrid对象	设置新的属性，对于动态改变列属性是非常有用的，但是有些属性的修改并不会起效。用法：jQuery(”#grid_id”).setColProp(‘colname’,{editoptions:{value:“True:False”}});
sortGrid	colname, reload	jqGrid对象	按指定列进行排序。效果同setGridParam({sortname:‘myname’}).trigger(‘reloadGrid’). 如果reload为true则会重新加载数据
updateGridRows	data,rowidname,jsonreader	boolean	修改表格中某行的数据，data数据格式：[{name:value,name1:value1…}, {name:value,name2:value2…}]，name为colModel中的名称；rowidname某行的名称。 jsonreader：boolean值，默认false。如果为true则是定义数据的格式，data的值并不是name：value形式而只是 value

---

jqGrid 格式化

---

jqGrid的格式化是定义在语言包中

 $jgrid = {  
//...  
   formatter : {  
     integer : {thousandsSeparator: " ", defaultValue: '0'},  
     number : {decimalSeparator:".", thousandsSeparator: " ", decimalPlaces: 2, defaultValue: '0.00'},  
     currency : {decimalSeparator:".", thousandsSeparator: " ", decimalPlaces: 2, prefix: "", suffix:"", defaultValue: '0.00'},  
     date : {  
       dayNames: [  
         "Sun", "Mon", "Tue", "Wed", "Thr", "Fri", "Sat", "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"  
       ],  
       monthNames: [  
         "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec",  
         "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"  
       ],  
       AmPm : ["am","pm","AM","PM"],  
       S: function (j) {return j < 11 || j > 13 ? ['st', 'nd', 'rd', 'th'][Math.min((j - 1) % 10, 3)] : 'th'},  
       srcformat: 'Y-m-d',  
       newformat: 'd/m/Y',  
       masks : {  
         ISO8601Long:"Y-m-d H:i:s",  
         ISO8601Short:"Y-m-d",  
         ShortDate: "n/j/Y",  
         LongDate: "l, F d, Y",  
         FullDateTime: "l, F d, Y g:i:s A",  
         MonthDay: "F d",  
         ShortTime: "g:i A",  
         LongTime: "g:i:s A",  
         SortableDateTime: "Y-m-d\\TH:i:s",  
         UniversalSortableDateTime: "Y-m-d H:i:sO",  
         YearMonth: "F, Y"  
       },  
       reformatAfterEdit : false  
     },  
     baseLinkUrl: '',  
     showAction: '',  
     target: '',  
     checkbox : {disabled:true},  
     idName : 'id'  
   }  
//...

这些设置可以通过colModel中的formatoptions参数修改

jQuery("#grid_id").jqGrid({  
//...  
   colModel : [  
  // ...  
      {name:'myname', ... formatter:'number', ...},  
   //...  
   ],  
//...  
});

此实例是对名为“myname”的列进行格式化，格式化类是“number”，假如初始值为“1234.1”则格式化后显示为“1 234.10” 。

如果给某列进行格式化：

jQuery("#grid_id").jqGrid({  
//...  
   colModel : [  
  // ...  
      {name:'myname', ... formatter:'currency', formatoptions:{decimalSeparator:",", thousandsSeparator: ",", decimalPlaces: 2, prefix: "$ "} } ,  
  // ...  
   ],  
//...  
});

这个设置会覆盖语言包中的设置。
select类型的格式化实例： 原始数据

jQuery("#grid_id").jqGrid({  
//...  
   colModel : [ {name:'myname', edittype:'select', editoptions:{value:"1:One;2:Two"}} ... ],  
//...  
});	

使用格式化后

jQuery("#grid_id").jqGrid({  
//...  
   colModel : [ {name:'myname', edittype:'select', formatter:'select', editoptions:{value:"1:One;2:Two"}} ... ]  
//...  
});

结果是，表格的数据值为1或者2但是现实的是One或者Two。 对超链接使用select类型的格式化：

jQuery("#grid_id").jqGrid({  

//...  
   colModel: [ {name:'myname', edittype:'select', formatter:'select', formatoptions:{baseLinkUrl:'someurl.php', addParam: '&action=edit'}, ...}   
      //...   
   ]  
//...  
});

得到http://localhost/someurl.php?id=123&action=edit 如果想改变id值则

jQuery("#grid_id").jqGrid({  
//...  
   colModel: [ {name:'myname', edittype:'select', formatter:'select', formatoptions:{baseLinkUrl:'someurl.php', addParam: '&action=edit', idName:'myid'}, ...}   
      //...   
   ]  
//...  
});

得到http://localhost/someurl.php?myid=123&action=edit

jqGrid 自定义格式化

---

jQuery("#grid_id").jqGrid({  
//...  
   colModel: [   
      //...   
      {name:'price', index:'price', width:60, align:"center", editable: true, formatter:currencyFmatter},  
      //...  
   ]  
//...  
});  
function currencyFmatter (cellvalue, options, rowObject)  
{  
   // do something here  
   return new_format_value  
}

cellvalue：要被格式化的值

options：对数据进行格式化时的参数设置，格式为： { rowId: rid, colModel: cm}

rowObject：行数据

数据的反格式化跟格式化用法相似.

jQuery("#grid_id").jqGrid({  
//...  
   colModel: [   
     // ...   
      {name:'price', index:'price', width:60, align:"center", editable: true, formatter:currencyFmatter, unformat:unformatCurrency},  
      //...  
   ]  
//...  
});  
function currencyFmatter (cellvalue, options, rowObject)  
{  
   return "$"+cellvalue;  
}  
function  unformatCurrency (cellvalue, options)  
{  
   return cellvalue.replace("$","");  
} 

表格中数据实际值为123.00，但是显示的是$123.00; 我们使用getRowData ，getCell 方法取得的值是123.00。 创建通用的格式化函数

<script type="text/javascript">  
jQuery.extend($.fn.fmatter , {  
    currencyFmatter : function(cellvalue, options, rowdata) {  
    return "$"+cellvalue;  
}  
});  
jQuery.extend($.fn.fmatter.currencyFmatter , {  
    unformat : function(cellvalue, options) {  
    return cellvalue.replace("$","");  
}  
});  
</script>

具体使用：

jQuery("#grid_id").jqGrid({  
//...  
   colModel: [   
      //...   
      {name:'price', index:'price', width:60, align:"center", editable: true, formatter:currencyFmatter},  
      //...  
   ]  
//...  
})

---