jqGrid colModel 参数(来自中文手册)

it2022-05-05  134

jqGrid colModel 参数


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

属性数据类型备注默认值alignstringleft, center, right.leftclassesstring设置列的css。多个class之间用空格分隔,如:'class1 class2' 。表格默认的css属性是ui-ellipsisempty stringdatefmtstring”/”, ”-”, and ”.”都是有效的日期分隔符。y,Y,yyyy 年YY, yy 月m,mm for monthsd,dd 日.ISO Date (Y-m-d)defvalstring查询字段的默认值空editableboolean单元格是否可编辑falseeditoptionsarray编辑的一系列选项。{name:’__department_id’,index:’__department_id’,width:200,editable:true,edittype:’select’,editoptions: {dataUrl:”/jqGrid/admin/deplistforstu.action”}},这个是演示动态从服务器端获取数据。emptyeditrulesarray编辑的规则{name:’age’,index:’age’, width:90,editable:true,editrules: {edithidden:true,required:true,number:true,minValue:10,maxValue:100}},设定 年龄的最大值为100,最小值为10,而且为数字类型,并且为必输字段。emptyedittypestring可以编辑的类型。可选值:text, textarea, select, checkbox, password, button, image and file.textfixedboolean列宽度是否要固定不可变falseformoptionsarray对于form进行编辑时的属性设置emptyformatoptionsarray对某些列进行格式化的设置noneformattermixed对列进行格式化时设置的函数名或者类型 {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=’/jqGrid/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;}},// 返回性别的图标。nonehidedlgboolean是否显示或者隐藏此列falsehiddenboolean在初始化表格时是否要隐藏此列falseindexstring索引。其和后台交互的参数为sidxemptyjsonmapstring定义了返回的json数据映射nonekeyboolean当从服务器端返回的数据中没有id时,将此作为唯一rowid使用只有一个列可以做这项设置。如果设置多于一个,那么只选取第一个,其他被忽略falselabelstring如果colNames为空则用此值来作为列的显示名称,如果都没有设置则使用name 值nonenamestring表格列的名称,所有关键字,保留字都不能作为名称使用包括subgrid, cb and rn.Requiredresizableboolean是否可以被resizabletruesearchboolean在搜索模式下,定义此列是否可以作为搜索列truesearchoptionsarray设置搜索参数emptysortableboolean是否可排序truesorttypestring用在当datatype为local时,定义搜索列的类型,可选值:int/integer - 对integer排序float/number/currency - 排序数字date - 排序日期text - 排序文本textstypestring定义搜索元素的类型textsurlstring搜索数据时的urlemptywidthnumber默认列的宽度,只能是象素值,不能是百分比150xmlmapstring定义当前列跟返回的xml数据之间的映射关系noneunformatfunction‘unformat’单元格值null

以下是详细说明:

1.0colModel要呈现字段的属性设置1.1align定义数据相对单元格的对齐方式.string left1.2datefmt日期格式, string Y-m-d1.3editable定义字段是否可编辑 boolean false1.4defval搜索字段的默认值,(只用于自定义搜索) string empty1.5edittype该字段控件类型(text, textarea, select, checkbox, password, button, image , file) string text1.6surl只有在自定义搜索和edittype属性为select和描述的url得到select 的element% string empty1.7editoptions针对edittype配置的控件类型的属性设置 array empty array1.7.1value依据edittype,配置属性%(详见: editoptions的value配置)mixed none1.7.2dataUrl这个属性只适用与edittype属性为select (指定select的数据源edittype:"select",editoptions:{dataUrl:'test.txt', defaultValue:'Intime'}) string empty1.7.3dataInit当控件被创建时仅触发1次 function null1.7.4dataEvents给当前控件追加事件处理% array empty array1.7.5defaultValue默认值(可以是函数返回值) mixed none1.7.6其他可设置控件的任何有效属性editoptions:{size:10,maxlength:8}mixed none1.8editrules设置编辑字段的控件的规则 array empty array1.8.1edithidden该字段隐藏时, 此属性可以控制是否可编辑 boolean false1.8.2required是否验证空数据 boolean false1.8.3number是否验证数字 boolean false1.8.4integer是否验证整数 boolean false1.8.5minValue验证最小值 number(integer) empty1.8.6maxValue验证最大值 number(integer) empty1.8.7email是否验证email boolean false1.8.8url是否验证是有效的网址 boolean false1.8.9date是否验证日期 boolean false1.8.10time是否验证时间 boolean false  如果此字段不是必填,如果填了才验证是否是email 那么应该配置 email:true, required:false1.9formoptions设置该字段相对表单中的相关设置 array empty array1.9.1elmprefix如果设置,则会在控件前面出现该设置 string empty1.9.2elmsuffix如果设置,则会在控件后面出现该设置 string empty1.9.3label如果设置,则会替换colNames设置的名称 string empty1.9.4rowpos设置该字段所在行的位置,从1开始计数 number empty1.9.5colpos设置该字段所在列的位置,从1开始计数 number empty1.10formatoptions设置特定列的格式,覆盖语言文件的默认值 array empty array1.11formatter指定formatoptions设置格式的类型 mixed none1.11.1integer当formatter指定为此属性时, formatoptions可以设置以下属性.1.11.1.1thousandsSeparator每千位分隔符 string empty1.11.1.2defaulValue在没有数据的情况下的默认值 string empty1.11.2number当formatter指定为此属性时, formatoptions可以设置以下属性.1.11.2.1decimalSeparator小数位分隔符 string empty1.11.2.2thousandsSeparator每千位分隔符 string empty1.11.2.3decimalPlaces小数位数 string empty1.11.2.4defaulValue在没有数据的情况下的默认值 string empty1.11.3currency当formatter指定为此属性时, formatoptions可以设置以下属性.1.11.3.1decimalSeparator小数位分隔符 string empty1.11.3.2thousandsSeparator每千位分隔符 string empty1.11.3.3decimalPlaces小数位数 string empty1.11.3.4defaulValue在没有数据的情况下的默认值 string empty1.11.3.5prefix在数据前面添加的文本比如货币符号”$” string empty1.11.3.6suffix在数据后面添加的文本比如货币符号”$” string empty1.11.4date当formatter指定为此属性时, formatoptions可以设置以下属性.1.11.4.1srcformat原格式 string empty1.11.4.2newformat新的输出格式 string empty1.11.5email当formatter指定为 email类型,直接使这个email加href string empty1.11.6link当formatter指定为此属性时, formatoptions可以设置以下属性.1.11.6.1target默认为empty如果设置,则创建一个以单元格的值和target属性的链接string empty1.11.7showlink当formatter指定为此属性时, formatoptions可以设置以下属性.1.11.7.1baseLinkUrl链接. string empty1.11.7.2showAction附加值,在baseLinkUrl后面 . string empty1.11.7.3addParam额外参数. string empty1.11.7.4target如果设置,增加1条附加属性. string empty1.11.7.5idName是第1个参数,之后由showAction补充,默认情况下,这是id string empty1.11.8checkbox当formatter指定为此属性时, formatoptions可以设置以下属性.1.11.8.1disabled默认true禁止改变状态,如果设置为false是可以改变的 boolean1.11.9select当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.12unformat可以为formatter指定自定义格式的方法 function null1.13hidedlg如果设置为true在显示/隐藏字段功能中,该字段将不会出现% boolean false1.14hidden该字段是否隐藏 boolean false1.15index排序时, sidx的参数 string empty1.16jsonmap定义json映射这个字段时的json字符串 string empty1.17xmlmap定义xml文件映射这个字段时的xml字符串 string empty1.18key如果服务器端没有定义id,可以设置字段为行号,只有一个字段可以设置此属性,只认可第1个,其他的将被忽略. boolean false1.19name设置此字段的唯一名称,此属性是必须要设置的, string empty1.20label当colNames为空,则标题显示此设置.如果colNames数组和此设置同时为空,则标题显示name属性. string empty1.21resizable设置此字段是否可编辑 boolean true1.22search该字段是否允许搜索(查询) boolean true1.23stype设置搜索时的数据类型 string text1.24searchoptions配置搜索选项 array empty array1.24.1dataUrl该属性只适用于 stype:’select’ string empty1.24.2dataInit等同于editoptions的dataInit function null1.24.3dataEvents等同于editoptions的dataEvents array empty array1.24.4attr可以设置创建的元素的有效属性 object null1.24.5searchhidden该字段隐藏时,此属性可控制是否可搜索 boolean false1.24.6defaultValue默认值 string empty1.24.7sopt比较运算符,可任意组合('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.25sortable设置该字段是否进行排序 boolean true1.26sorttype排序的数据类型 string text1.27width宽度,不能设置百分比 number 150   2.0navGrid功能按钮(增删改查,搜,刷新)设置2.1top距离顶端的象素 number(integer) 02.2left距离左边的象素 number(integer) 02.3width宽度 number(integer) 3002.4height高度 number(integer) auto2.5dataheight表单内容距离按钮高度 number(integer) auto2.6modal是否模态窗体 boolean false2.7drag是否可拖动 boolean true2.8resize是否可改变大小 boolean true2.9url提交的URL,如果设置则替换editurl string empty2.10mtype请求类型post | get string post2.11editData提交到服务器的数据 array empty array2.12recreateForm每次操作是否创建新的表单 boolean false2.13jqModal设置为true使用存在的jqModal插件的对话框。如果被设置为true和插件不存在jqGrid使用它自己的方式来创造对话框, 比如会影响到日期插件,true和false不同的效果 boolean true2.14addedrow%2.15topinfo头部信息 string empty2.16bottominfo底部信息 string empty2.17saveicon保存的图片,第一项启用/禁用的图片, 第二个项目告诉哪里放置图片到文本的左或右. 第三项对应的有效UI图片样式 [true,”left”,”ui-icon-disk”]2.18closeicon取消的图片同上 [true,”left”,”ui-icon-close”]2.19savekey保存的快捷键,默认回车 [false,13]2.20navkeys移动上个,下个的快捷键 ,默认上下箭头 [false,38,40]2.21checkOnSubmit保存时,是否弹出再次确认对话框,仅用在编辑模式 boolean false2.22checkOnUpdate取消时,是否弹出再次确定对话框,仅用在新增和编辑模式 boolean false2.23closeAfterAdd添加模式时,添加记录后是否关闭对话框 boolean false2.24clearAfterAdd添加数据时,是否清空上1次的数据 boolean true2.25closeAfterEdit编辑模式时,编辑完成后是否关闭对话框 boolean false2.26reloadAfterSubmit操作完成后,是否重新加载数据 boolean true2.27closeOnEscape是否关联esc键 boolean false2.28ajaxEditOptions% object empty object
官方同步更新!如有疑问,联系邮箱:webmaster@mn886.net。感谢jqGrid团队! 全部实例均可正常运行,浏览器建议火狐,谷歌,IE9.0+

转载于:https://www.cnblogs.com/leolzi/p/7879295.html

相关资源:jqGrid手册教程一本通

最新回复(0)