jqGrid colModel配置参数

colModel配置语法示例
jQuery("#gridid").jqGrid({
//...
   colModel: [ {name:'name1', index:'index1'...}, {...}, ... ],
//...
});
  下表列出了colModel可用的属性。name属性是唯一需要配置。colModel配置可以读写通过getColProp和setColProp方法。
配置项 类型 描述 默认值
align string 定义单元格中内容对齐方式,可用值: left, center, right. left
cellattr function 这个方法在创建单元格内容的时候给单元格添加附加到属性。所有可用的单元格属性或者style属性中可用的值都可以使用,这个方法需要返回字符串。传递进入这个配置方法的参数如下
rowId - 单元格所属行id
val - 显示在单元格中的值
rawObject -原始的数据行对象。如果jqGrid配置中datatype为json,则为array对象。datatype为xml时则为xml node节点
cm - 所有colModel中配置的属于此列的属性
rdata - the data row which will be inserted in the row.  参数为键值对对象数组,name为colModel定义的name
null
classes string 给单元格添加附加样式。如果有多个样式需要添加,样式用空格隔开。例如:classes:'class1 class2' 将会给此列单元格设置class1和class2样式。在css中有一个预定义的样式ui-ellipsis允许附加到特定的行 empty string
datefmt string sorttype配置为date(datetype被设置为local)或者editrules 配置为{date:true} 字段时,定义日期的显示格式。使用如php类型的时间格式。“/”,“-”,“.”可用于的时间分隔符号。可用的时间格式如下
y,Y,yyyy :对应4位数字的年份
YY, yy :对应2位数字的年份
m,mm :对应月份
d,dd :对应日期
ISO Date (Y-m-d)
defval string 作为搜索字段的默认值。只用于自定义搜索时的初始值。 empty
editable boolean 定义字段是否可以编辑。用于单元格,行编辑,和表单编辑。 参考:jqGrid通用编辑规则 false
editoptions array 依据edittype提供允许的值列表。 参考:jqGrid通用编辑规则 empty array
editrules array 给可编辑子都设置附加的规则。 参考:jqGrid通用编辑规则 empty array
edittype string 给行,表单编辑配置字段编辑类型。可能的值: text, textarea, select, checkbox, password, button, image and file。参考:jqGrid通用编辑规则 text
firstsortorder string 设置为asc或者desc时,初始化时列将会按照这个进行排序。 随后排序将会轮流切换。 null
fixed boolean 即使jqGrid的shrinkToFit配置为ture时,当此配置为true,也不允许重新计算列的宽度。如果shrinkToFit为true,当jqGrid容器宽度变化后调用setGridWidth 方法也不会修改此列宽度。 false
formoptions array 定义表单编辑时的配置 参考: Form options empty
formatoptions array 重写默认配置语言文件中的配置项。 参考:jqGrid预定义格式化类型 none
formatter mixed 默认类型(string)或者客户自定义函数控制此字段的显示格式。 参考:jqGrid预定义格式化类型 none
frozen boolean 设置为ture,此列将为固定的,不允许拖拽改变位置。 false
hidedlg boolean 设置为true此列将不会出现在模式对话框中,用户可以选择此列的显示或者隐藏。参考:jqGrid显示和隐藏列 false
hidden boolean 定义是否隐藏此列在初始化时。 false
index string 通过sidx参数设置排序时的索引名。详细参考:jqGrid选项配置中的prmNames和sortname配置 empty string
jsonmap string 定义此列数据键和json数据源中的映射关系 。参考:jqGrid JSON数据源读取器选项配置 none
key boolean 如果从服务器获取的数据部包含id,可以通过此配置指定唯一id列。只有一列能指定此属性,如果多列配置了这个属性,第一个配置的生效,后续会被忽略。 false
label string 如果jqGrid的colNames数组为空,这个将作为此列的列头。如果colNames和这个配置为空,那name配置将作为此列的列头。 none
name string 设置此列的唯一名称。name是必须的。jqGrid配置的事件名称和属性名称,保留字不能作为此配置项的值,包括subgrid,cb和rn。 Required
resizable boolean 定义此列是否允许调整宽度 true
search boolean 当配置了查询模块后,是否允许将此列作为查询条件. Search Configuration true
searchoptions array 定义查询选项 Search Configuration empty
sortable boolean 定义是否允许点击列表头进行排序 true
sorttype mixed 当datatype为local时有效。定义适当的排序类型。可用值
int/integer :按照整数排序
float/number/currency:按照数字排序
date :日期排序
text :文本排序
function :按照自定义函数来排序。自定义函数接受此列排序的值,需要返回一个值。【原文: To this function we pass the value to be sorted and it should return a value too.】应该和javascript数组排序使用函数作为参数排序差不多,return-1/0/1
text
stype string 定义查询对象的类型。 See Search Configuration text
surl string  Custom Searching 中有效 和edittype为 'select' 时这个配置从哪个动态页地址获取已经生成好的select html结构。 empty string
template object 设置colModel有效属性。当你希望覆盖列模式默认值时配置这个比较有用。 See cmTemplate in grid options null
title boolean 如果设置为false,当鼠标移动到单元格上时不显示title提示信息。 true
width number 设置初始化列宽,单位px。注意不能设置为百分比 150
xmlmap string 定义此列和xml文件中的xml节点映射。参考:jqGrid XML数据源读取器选项配置 none
unformat function 返回单元格的原始值,详细参考:jqGrid自定义格式化类型(在排序时也会调用unformat,在排序过程中返回值用于比较) null
viewable boolean 此配置仅在viewGridRow 方法下有效。当配置为false时此列不会出现在view Form中。 true

翻译来源:http://www.trirand.com/jqgridwiki/doku.php?id=wiki:colmodel_options



原创文章,转载请注明出处:jqGrid colModel配置参数
评论(0)Web开发网
阅读(3883)喜欢(1)不喜欢(0)jqGrid中文API