jqGrid中的formatter,表格中值的格式化

时间:2023-03-09 18:07:30
jqGrid中的formatter,表格中值的格式化

jqGrid中对列表cell数次那个格式话设置主要通过colModel中formatter,formatoptions来设置。

基本用法:

  1. jQuery("#jqGrid_id").jqGrid({
  2. ...
  3. colModel: [
  4. ...
  5. {name:'price', index:'price',  formatter:'integer', formatoptions:{thousandsSeparator: ','}},
  6. ...
  7. ]
  8. ...
  9. });

formatter主要是设置格式化类型(integer ,email等以及函数来支持自定义类型),formatoptions用来设置对应formatter的参数,

jqGrid中预定义了常见的格式及其options:

integer

thousandSeparator://千分位分隔符,

defaulValue

number

decimalSeparator,//小数分隔符,如"."

tousandsSwparator,//千分位分隔符,如","

decimalPlaces,//小数保留位数

defaulValue

currency

decimalSeparator, //小数分隔符,如"."
thousandsSeparator, //千分位分隔符,如","
decimalPlaces, //小数保留位数
defaulValue,
prefix //前缀,如加上"$"
suffix//后缀
date
srcformat, //source的本来格式
newformat //新格式
email
没有参数,会在该cell是email加上: mailto:name@domain.com
showlink
baseLinkUrl, //在当前cell中加入link的url,如"jq/query.action"
showAction, //在baseLinkUrl后加入&action=actionName
addParam, //在baseLinkUrl后加入额外的参数,如"&name=aaaa"
target,
idName     //默认会在baseLinkUrl后加入,如".action?id=1"。改如果设置idName="name",那么".action?name=1"。其中取值为当前rowid
checkbox
disabled      //true/false 默认为true此时的checkbox不能编辑,如当前cell的值是1、0会将1选中
select
设置下拉框,没有参数,需要和colModel里的editoptions配合使用
下面是一个使用的例子:
  1. var datas = [
  2. {"id":1,  "name":"name1",  "price":123.1,     "email":"abc@163.com",  "amount":1123423,   "gender":"1", "type":"0"},
  3. {"id":2,  "name":"name2",  "price":1452.2,    "email":"abc@163.com",  "amount":12212321,  "gender":"1", "type":"1"},
  4. {"id":3,  "name":"name3",  "price":125454,    "email":"abc@163.com",  "amount":2345234,   "gender":"0", "type":"0"},
  5. {"id":4,  "name":"name4",  "price":23232.4,   "email":"abc@163.com",  "amount":2345234,   "gender":"1", "type":"2"}]
  1. colModel:[
  2. {name:'id',     index:'id',     formatter:  customFmatter},
  3. {name:'name',   index:'name',   formatter: "showlink", formatoptions:{baseLinkUrl:"save.action",idName: "id", addParam:"&name=123"}},
  4. {name:'price',  index:'price',  formatter: "currency", formatoptions: {thousandsSeparator:",",decimalSeparator:".", prefix:"$"}},
  5. {name:'email',  index:'email',  formatter: "email"},
  6. {name:'amount', index:'amount', formatter: "number", formatoptions: {thousandsSeparator:",", defaulValue:"",decimalPlaces:3}},
  7. {name:'gender', index:'gender', formatter: "checkbox",formatoptions:{disabled:false}},
  8. {name:'type',   index:'type',   formatter: "select", editoptions:{value:"0:无效;1:正常;2:未知"}}
  9. ],
其中customFmatter声明如下
  1. function customFmatter(cellvalue, options, rowObject){
  2. console.log(cellvalue);
  3. console.log(options);
  4. console.log(rowObject);
  5. return "["+cellvalue+"]";
  6. };
 在页面显示的效果如下:
jqGrid中的formatter,表格中值的格式化
当然还得支持自定义formatter函数,只需要在formatter:customFmatter设置formatter函数,该函数有三个签名
  1. function customFmatter(cellvalue, options, rowObject){
  2. }
  3. //cellvalue - 当前cell的值
  4. //options - 该cell的options设置,包括{rowId, colModel,pos,gid}
  5. //rowObject - 当前cell所在row的值,如{ id=1, name="name1", price=123.1, ...}
 当然对于自定义formatter,在修改时需要获取原来的值,这里就提供了unformat函数,这里见官网的例子:
  1. jQuery("#grid_id").jqGrid({
  2. ...
  3. colModel: [
  4. ...
  5. {name:'price', index:'price', width:60, align:"center", editable: true, formatter:imageFormat, unformat:imageUnFormat},
  6. ...
  7. ]
  8. ...
  9. });
  10. function imageFormat( cellvalue, options, rowObject ){
  11. return '<img src="'+cellvalue+'" />';
  12. }
  13. function imageUnFormat( cellvalue, options, cell){
  14. return $('img', cell).attr('src');
  15. }
  附上官网DOC: