jqGrid的userData的用法!!!
在一次项目中想从后台自定义一些返回值传回jqGrid,所以就想到了jqGrid的这个userData属性,但是真的是坑了我好惨,这里记录一下!
1、首先看说明,这个jsonReader的默认配置,userdata:'userdata'
1 jsonReader : { 2 root: "rows", // json中代表实际模型数据的入口 3 page: "page", // json中代表当前页码的数据 4 total: "total", // json中代表页码总数的数据 5 records: "records", // json中代表数据行总数的数据 6 repeatitems: true, // 如果设为false,则jqGrid在解析json时,会根据name来搜索对应的数据元素(即可以json中元素可以不按顺序);而所使用的name是来自于colModel中的name设定。 7 cell: "cell", 8 id: "id", 9 userdata: "userdata", 10 subgrid: { 11 root:"rows", 12 repeatitems: true, 13 cell:"cell" 14 } 15 }
2、在使用过程中,最开始我是这样使用的,
//在后台,我自己定义了几个求和数值放在了一个叫userdata的对象中,这个时候,我是没有修改jsonReader的默认配置,也就是说userdata是'userdata',
//我这里起的名字是userdata,跟jsonReader配置的名字一样
var result = new { currentPage = request.page, totalPages = request.totalPages, totalCount = request.totalCount, rows = resultList, //求和 自定义jqGrid返回参数 userdata = new { sumWeight = request.SumWeight, sumIncome = request.SumIncome, sumQuantity = request.SumQuantity } };
//在前台,我想这么取出来,失败
var userData = $("#gridList").jqGrid('getGridParam').userdata;
3、总结!
结果,当然是成功取出来了,经过了F12的好一顿乱搞,我终于发现,在$("#gridList").jqGrid('getGridParam')中,有一个userData属性,这个属性名是固定的就是大写,它存放的值就是jsonReader中的那个userdata:'userdata'的值,在这里默认是小写的userdata,其实这个设置,只是跟你在后台起对象名有关系,比如,你这里默认是userdata,那么你在后台想用userdata的时候,你就必须也用userdata,这俩必须一一对应,然后。重要的事情说三遍!!!嗯就是三个!!!,这个时候,我以为在取值的时候,这么取了
var userData = $("#gridList").jqGrid('getGridParam').userdata;
结果,不对!,其实在取值的时候呢,是用的$("#gridList").jqGrid('getGridParam')自己固定的一个属性,它就叫userData,!!!不管你在jsonReader中起了什么狗名字userdata 也好,xxxfs也罢,只有你在后台存放数据的时候,名字跟这个一致就可以!但是,在取值的时候,就是用.userData就好了!!!