上有很多jqGrid的API,大家可以查看。
在$("#tableId").jqGrid(optional);中,optional对象包含如下的属性:(属性按字母顺序排列)
参数名称
|
类型
|
描述
|
默认值
|
是否可以被修改
|
ajaxGridOptions
|
object
|
对ajax参数进行全局设置,可以覆盖ajax事件:error,complete 和 beforeSend
|
空值
|
是
|
ajaxGridOptions
|
object
|
对ajax参数进行全局设置
|
空值
|
是
|
ajaxSelectOptions
|
object
|
对ajax的select参数进行全局设置,设置editoptions跟searchoptions 参数的select属性值
|
空值
|
是
|
altclass
|
String
|
用于表格行交替变色的class属性。你可以定义自己的class来替代默认值。只有当altRows属性设置为true时,该属性才起作用
|
ui-priority-secondary
|
是,但需要重新加载
|
altRows
|
boolean
|
设置表格是否允许行交替变色值
|
false
|
是,需重新加载
|
autoencode
|
boolean
|
当为 ture 时对url进行编码
|
false
|
是
|
autowidth
|
boolean
|
如果为ture时,则当表格在首次被创建时会根据父元素比例重新调整表格宽度。如果父元素宽度改变,为了使表格宽度能够自动调整则需要实现函数:setGridWidth
|
false
|
否
|
caption
|
String
|
定义表格名称
|
空值
|
否,但是可以用api修改
|
cellLayout
|
integer
|
定义了单元格padding + border 宽度。通常不必修改此值。初始值为5,paddingLef?2+paddingRight?2+borderLeft?1=5
|
5
|
否
|
cellEdit
|
boolean
|
启用或者禁用单元格编辑功能
|
false
|
是
|
cellsubmit
|
String
|
定义了单元格内容保存位置:“remote”,“clientArray”
|
‘remote’
|
是
|
cellurl
|
String
|
单元格提交的url
|
空值
|
是
|
colModel
|
array
|
对显示列属性的设置,是一个数组对象。常用到的属性:
name 列显示的名称;
index传到服务器端用来排序用的列名称;
width 列宽度;
align 对齐方式;
sortable是否可以排序
|
空值
|
否
|
colNames
|
array[]
|
放置列名称的数组,必须与colModel大小相同
|
空数组
|
否
|
datastr
|
String
|
xmlstring或者jsonstring
|
空值
|
是
|
datatype
|
string
|
从服务器端返回的数据类型,(表格期望接收的数据类型)。可选类型:xml,xmlstring,json,local,function
|
xml
|
是
|
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
|
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时,表格不会被显示,只显示表格的标题。只有当点击显示表格的那个按钮时才会去初始化表格数据。只有当caption 属性不为空而且hidegrid为ture时才起作用
|