Jqgrid入门

   上一篇中,Jqgrid已经可以从服务端获得数据,并显示在Grid表格中了。下面说一下,如何操作表格及其数据。

 
        jqGrid有很多方法函数,用来操作数据或者操作Grid表格本身。jqGrid的方法有两种调用方式:

          $(“#grid_id”).jqGridMethod( parameter1,…,parameterN );

或者

        $(“#grid_id”).jqGrid(‘method’, parameter1,…,parameterN );

        首先介绍一下Jqgrid的几个最常用的方法函数,具体的方法API也可以参考文档(http://www.trirand.com/jqgridwiki/doku.php?id=wiki:methods) 。

1. getGridParam

        这个方法用来获得jqGrid的选项值。它具有一个可选参数name,name即代表着jqGrid的选项名,如果不传入name参数,则会返回 Jqgrid整个选项options。例如:

1
2
3
4
5
6
var  id = $( "#gridTable" ).jqGrid( "getGridParam" "selrow" );       //获得选中行的ID
var  sort = $( "#gridTable" ).jqGrid( "getGridParam" "sortname" );   //获得排序的字段
var  page = $( "#gridTable" ).jqGrid( "getGridParam" "page" );       //获得当前的页数
var  row = $( "#gridTable" ).jqGrid( "getGridParam" "rowNum" );      //获得当前页的行数
var  count = $( "#gridTable" ).jqGrid( "getGridParam" "records" );   //获得总记录数
var  rows = $( "#gridTable" ).jqGrid( "getGridParam" "selarrrow" );  //可以多选时,返回选中行的ID

2. getRowData

这个方法用来获得某行的数据。它具有一个rowid参数,Jqgrid会根据这个rowid返回对应行的数据,返回的是name:value类型的数组。如果rowid未能被找到,则返回一个空数组;如果未设置rowid参数,则以数组的形式返回Grid的所有行数据。例如:

1
2
3
var  getRowdata =  function () {
     var  selectedId = $( "#gridTable" ).jqGrid( "getGridParam" "selrow" );
     var  rowData = $( "#gridTable" ).jqGrid( "getRowData" , selectedId);

3. addRowData

        这个方法用于向Grid中插入新的一行。执行成功返回true,否则返回false。它具有4个参数:

  • rowid:新行的id号;
  • data:新行的数据对象,形式为{name1:value1,name2: value2…},其中name为colModel中定义的列名称name;
  • position:插入的位置(first:表格顶端;last:表格底端;before:srcrowid之前;after:srcrowid之后);
  • srcrowid:新行将插入到srcrowid指定行的前面或后面。
        这个方法可以一次性插入多行,data参数必须是[{name1:value1,name2: value2…}, {name1:value1,name2: value2…}]这样的数组形式。例如:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
var addStudent= function () {
var selectedId = $( "#gridTable" ).jqGrid( "getGridParam" , "selrow" );
var dataRow = {
id : 99,
lastName : "Zhang" ,
firstName : "San" ,
email : "<a href=" mailto:[email protected] ">[email protected]</a>" ,
telNo : "0086-12345678"
};
if (selectedId) {
$( "#gridTable" ).jqGrid( "addRowData" , 99, dataRow, "before" , selectedId);
} else {
$( "#gridTable" ).jqGrid( "addRowData" , 99, dataRow, "first" );
}
};
         4. setRowData
        
        这个方法用于为某行数据设置数据值。执行成功返回true,否则返回false。它具有3个参数:
  • rowid:更新数据的行id;
  • data:更新的数据对象,形式为{name1:value1,name2: value2…},其中name为colModel中定义的列名称name;这个数据对象,不必设置完全,需要更新哪列,就设置哪列的name:value对;
  • cssprop:如果cssprop为String类型,则会使用jQuery的addClass为行增加相应名称的CSS类;如果为object类型,则会使用html的css属性,为行添加样式。如果只想增加css样式而不更新数据,可以将data参数设为false。

例如:

1
2
3
4
5
6
7
8
9
10
11
12
var updateStudent = function () {
var selectedId = $( "#gridTable" ).jqGrid( "getGridParam" , "selrow" );
var dataRow = {
lastName : "Li" ,
firstName : "Si" ,
email : "<a href=" mailto:[email protected] ">[email protected]</a>"
};
var cssprop = {
color : "#FF0000"
};
$( "#gridTable" ).jqGrid( 'setRowData' , selectedId, dataRow, cssprop);
};

5. delRowData

        这个方法用于删除某行数据。执行成功返回true,否则返回false。具有一个参数rowid,代表要删除的行id。例如:

1
2
3
4
var deleteStudent = function () {
var selectedId = $( "#gridTable" ).jqGrid( "getGridParam" , "selrow" );
$( "#gridTable" ).jqGrid( 'delRowData' , selectedId);
};

6. trigger(“reloadGrid”)

        根据当前设置,重新载入Grid表格,即意味着向服务端重新发送一个新的请求。此方法只能用于已经构建好的Grid。此外,此方法不会使对colModel所做出的改变生效。应该使用gridUnload来重新载入对colModel的新设置。例如:

1
2
3
4
5
$( "#gridTable" ).jqGrid( "setGridParam" , {
datatype : "json" ,
search : true ,
mtype : "post"
}).trigger( "reloadGrid" );

7. 其他方法

除了以上介绍的的方法外,jqGrid还有其他有用的方法,例如:addJSONData、clearGridData、hideCol、resetSelection、setCaption、setGridHeight、setLabel、showCol等以及增强模块提供的方法,例如:filterGrid、GridDestroy、GridUnload、setColProp等。这些方法的具体用法,或浅显易懂,或不是非常常用。都可以参考官方文档(http://www.trirand.com/jqgridwiki/doku.php?id=wiki:methods),得到具体指示。


你可能感兴趣的:(Jqgrid入门)