您的位置：首页 > 其它

jqgrid--常用参数说明

2014-08-05 10:50 260 查看

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	表格名称
ajaxGridOptions [a1]	object	对 ajax 参数进行全局设置，可以覆盖 ajax 事件	null	是
ajaxSelectOptions [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 时起作用	空值	否
footerrow [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 数据结构的描述		否

ColModel API

属性	数据类型	备注	默认值
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:”${ctx}/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 = “<img src=’${ctx}/jquery-ui-1.7.2.custom/css/img/” if(cellvalue==1){ temp = temp +”user-white.png”; } else if(cellvalue==2){ 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

内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理

标签：

相关文章推荐

新的分享

章节导航