jqgrid之路初始篇

常用options：

• url ：jqGrid控件通过这个参数得到需要显示的数据，具体的返回值可以使XML也可以是Json。
• datatype ：这个参数用于设定将要得到的数据类型。我最常用的是“json”，其余的类型还包括：xml、xmlstring、local、javascript、function。
• mtype : 定义使用哪种方法发起请求，GET或者POST。
• height ：Grid的高度，可以接受数字、%值、auto，默认值为150。
• width ：Grid的宽度，如果未设置，则宽度应为所有列宽的之和；如果设置了宽度，则每列的宽度将会根据shrinkToFit选项的设置，进行设置。
• shrinkToFit ：此选项用于根据width计算每列宽度的算法。默认值为true。如果shrinkToFit为true且设置了width值，则每列宽度会根据width成比例缩放；如果shrinkToFit为false且设置了width值，则每列的宽度不会成比例缩放，而是保持原有设置，而Grid将会有水平滚动条。
• autowidth ：默认值为false。如果设为true，则Grid的宽度会根据父容器的宽度自动重算。重算仅发生在Grid初始化的阶段；如果当父容器尺寸变化了，同时也需要变化Grid的尺寸的话，则需要在自己的代码中调用setGridWidth方法来完成。
• pager ：定义页码控制条Page Bar
• sortname ：指定默认的排序列，可以是列名也可以是数字。此参数会在被传递到Server端。
• viewrecords ：设置是否在Pager Bar显示所有记录的总数。
• caption ：设置Grid表格的标题，如果未设置，则标题区域不显示。
• caption ：Grid的标题。如果设置了，则将显示在Grid的Header层。
• rowNum ：用于设置Grid中一次显示的行数，默认值为20。正是这个选项将参数rows（prmNames中设置的）通过url选项设置的链接传递到Server。注意如果Server返回的数据行数超过了rowNum的设定，则Grid也只显示rowNum设定的行数。
• rowList ：一个数组，用于设置Grid可以接受的rowNum值。例如[10,20,30]。
• colNames ：字符串数组，用于指定各列的题头文本，与列的顺序是对应的。
• colModel ：最重要的数组之一，用于设定各列的参数。
• prmNames ：这是一个数组，用于设置jqGrid将要向Server传递的参数名称。
• jsonReader ：这又是一个数组，用来设定如何解析从Server端发回来的json数据。

  其中有几个选项比较重要，现详细说明：

  通过prmNames来自定义当向Server发送请求时，默认发送的参数名称

  prmNames : {  

  page:"page",    // 表示请求页码的参数名称  

  rows:"rows",    // 表示请求行数的参数名称  

  sort: "sidx", // 表示用于排序的列名的参数名称  

  order: "sord", // 表示采用的排序方式的参数名称  

  search:"_search", // 表示是否是搜索请求的参数名称  

  nd:"nd", // 表示已经发送请求的次数的参数名称  

  id:"id", // 表示当在编辑数据模块中发送数据时，使用的id的名称  

  oper:"oper",    // operation参数名称

  editoper:"edit",  // 当在edit模式中提交数据时，操作的名称  

  addoper:"add", // 当在add模式中提交数据时，操作的名称  

  deloper:"del", // 当在delete模式中提交数据时，操作的名称  

  subgridid:"id", // 当点击以载入数据到子表时，传递的数据名称  

  npage: null,   

  totalrows:"totalrows" // 表示需从Server得到总共多少行数据的参数名称，参见jqGrid选项中的rowTotal  

  } 

  jsonReader用于设置如何解析从Server端发回来的json数据

  jsonReader : {  

  root: "rows",   // json中代表实际模型数据的入口  

  page: "page",   // json中代表当前页码的数据  

  total: "total", // json中代表页码总数的数据  

  records: "records", // json中代表数据行总数的数据  

  repeatitems: true, // 如果设为false，则jqGrid在解析json时，会根据name来搜索对应的数据元素（即可以json中元素可以不按顺序）；而所使用的name是来自于colModel中的name设定。  

  cell: "cell",  

  id: "id",  

  userdata: "userdata",  

  subgrid: {  

  root:"rows",   

   repeatitems: true,   

  cell:"cell"  

   }  

  }

   

  prmNames设置了如何将Grid所需要的参数传给Server，而jsonReader设置了如何去解析从Server端传回来的json数据。如果没有设置jsonReader的话，jqGrid将会根据默认的设置来解析json数据，并显示在表格里。但如果传回来的json数据，不太符合默认设置（比如内部的结构名不太一样），那么就有必要修改这一设置。

   

  colModel:{

• name ：为Grid中的每个列设置唯一的名称，这是一个必需选项，其中保留字包括subgrid、cb、rn。
• index ：设置排序时所使用的索引名称，这个index名称会作为sidx参数（prmNames中设置的）传递到Server。
• label ：当jqGrid的colNames选项数组为空时，为各列指定题头。如果colNames和此项都为空时，则name选项值会成为题头。
• width ：设置列的宽度，目前只能接受以px为单位的数值，默认为150。
• sortable ：设置该列是否可以排序，默认为true。
• search ：设置该列是否可以被列为搜索条件，默认为true。
• resizable ：设置列是否可以变更尺寸，默认为true。
• hidden ：设置此列初始化时是否为隐藏状态，默认为false。
• formatter ：预设类型或用来格式化该列的自定义函数名。常用预设格式有：integer、date、currency、number等（具体参见文档 ）。

  }