`
什么向往
  • 浏览: 80137 次
  • 性别: Icon_minigender_1
  • 来自: 西安
社区版块
存档分类
最新评论

jqgrid的参数说明

阅读更多


JQGrid是一个在jquery基础上做的一个表格控件，以ajax的方式和服务器端通信。
 JQGrid Demo 是一个在线的演示项目。在这里，可以知道jqgrid可以做什么事情。

下面是转自其他人blog的一个学习资料，与其说是学习资料，说成查询帮助文档更加合适。

jqGrid学习之 ------------- 安装

jqGrid安装很简单，只需把相应的css、js文件加入到页面中即可。
按照官网文档:

/myproject/css/
            ui.jqgrid.css
            /ui-lightness/
                  /images/
                  jquery-ui-1.7.2.custom.css

 /myproject/js/
            /i18n/
                  grid.locale-bg.js
                  list of all language files
                  ….
            Changes.txt
            jquery-1.3.2.min.js
            jquery.jqGrid.min.js

 

在页面中写法：

 

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">  

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">  

<head>  

<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />  

<title>My First Grid</title>  

   

<link rel="stylesheet" type="text/css" media="screen" href="css/ui-lightness/jquery-ui-1.7.1.custom.css " />  

<link rel="stylesheet" type="text/css" media="screen" href="js/src/css/ui.jqgrid.css " />  

<link rel="stylesheet" type="text/css" media="screen" href="js/src/css/jquery.searchFilter.css " />  

<style>  

html, body {  

   margin: 0;  

    padding: 0;  

    font-size: 75%;  

}  

</style>   

   

<script src="js/jquery-1.3.2.min.js " type="text/javascript"></script>  

<script src="js/src/grid.loader.js " type="text/javascript"></script>  

   

</head>  

<body>  

...  

</body>  

</html>
 

需要说明的是，jquery-ui的字体大小与jqgrid字体大小不一致，故需要在页面上在加上一段
style来指定页面上文字大小。


 

jqGrid皮肤

从3.5版本开始，jqGrid完全支持jquery UI的theme。我们可以从http://jqueryui.com/themeroller/ 下载我们所需要的theme。当然，你也可以编辑自己的theme。jqGrid
也并不需要把所有的css文件都引入进来，只需导入核心css文件“ui.theme.css ” 以及“ui.core.css ”即可，文件位于目录development-bundle/themes下。

jqGrid原理

jqGrid是典型的B/S架构，服务器端只是提供数据管理，客户端只提供数据显示。换句话说，jqGrid可以以一种更加简单的方式来展现你数据库的信息，而且也可以把客户端数据传回给服务器端。
对于jqGrid我们所关心的就是：必须有一段代码把一些页面信息保存到数据库中，而且也能够把响应信息返回给客户端。jqGrid是用ajax来实现对请求与响应的处理。

 

jqGrid参数

名称

类型

描述

默认值

可修改

url

string

获取数据的地 址

 

 

datatype

string

从服务器端返回的数据类型，默认 xml 。可选类型： xml ， local ， json ， jsonnp ， script ， xmlstring ， jsonstring ， clientside

 

 

mtype

string

ajax 提交方式。 POST 或者 GET ，默认 GET

 

 

colNames

Array

列显示名称，是一个数组对 象

 

 

colModel

Array

常用到的属性： name 列显示的名称； index 传到服务器端用来排序用的列名称； width 列宽度； align 对齐方式； sortable  是否可以排 序

 

 

pager

string

定义翻页用的导航栏，必须是有效的 html 元素。翻页工具栏可以放置在 html 页面任意位 置

 

 

rowNum

int

在 grid 上显示记录条数，这个参数是要被传递到后 台

 

 

rowList

array

一个下拉选择框，用来改变显示记录数，当选择时会覆盖 rowNum 参数传递到后 台

 

 

sortname

string

默认的排序列。可以是列名称或者是一个数字，这个参数会被提交到后 台

 

 

viewrecords

boolean

定义是否要显示总记录 数

 

 

caption

string

表格名 称

 

 

ajaxGridOptions [a1]  

object

对 ajax 参数进行全局设置，可以覆盖 ajax 事 件

null

是

ajaxSelectOptions [a2]  

object

对 ajax 的 select 参数进行全局设 置

null

是

altclass

String

用来指定行显示的 css ，可以编辑自己的 css 文件，只有当 altRows 设为 ture 时起作 用

ui-priority-secondary

 

altRows

boolean

设置表格 zebra-striped 值

 

 

autoencode

boolean

对 url 进行编 码

false

是

autowidth

boolean

如果为 ture 时，则当表格在首次被创建时会根据父元素比例重新调整表格宽度。如果父元素宽度改变，为了使表格宽度能够自动调整则需要实现函数： setGridWidth

false

否

cellLayout

integer

定义了单元格 padding + border 宽度。通常不必修改此值。初始值 为

5

是

cellEdit

boolean

启用或者禁用单元格编辑功 能

false

是

cellsubmit

String

定义了单元格内容保存位 置

‘remote’

是

cellurl

String

单元格提交的 url

空值

是

datastr

String

xmlstring 或者 jsonstring

空值

是

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 [a3]  

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 时，表格不会被显示，只显示表格的标题 。 只有当点击显示表格的那个按钮时才会去初始化表格数据 。

false

否

hidegrid

boolean

启用或者禁用控制表格显示、隐藏的按钮，只有当 caption 属性不为空时起 效

true

否

hoverrows

boolean

当为 false 时 mouse hovering 会被禁 用

false

是

jsonReader

array

描述 json 数据格式的数 组

 

否

lastpage

integer

只读属性，定义了总页 数

0

否

lastsort

integer

只读属性，定义了最后排序列的索引，从 0 开 始

0

否

loadonce

boolean

如果为 ture 则数据只从服务器端抓取一次，之后所有操作都是在客户端执行，翻页功能会被禁 用

false

否

loadtext

string

当请求或者排序时所显示的文字内 容

Loading....

否

loadui

string

当执行 ajax 请求时要干什么。 disable 禁用 ajax 执行提示； enable 默认，当执行 ajax 请求时的提示； block 启用 Loading 提示，但是阻止其他操 作

enable

是

multikey

string

只有在 multiselect 设置为 ture 时起作用，定义使用那个 key 来做多选。 shiftKey ， altKey ， ctrlKey

空值

是

multiboxonly

boolean

只有当 multiselect = true. 起作用，当 multiboxonly 为 ture 时只有选择 checkbox 才会起作 用

false

是

multiselect

boolean

定义是否可以多 选

false

否

multiselectWidth

integer

当 multiselect 为 true 时设置 multiselect 列宽 度

20

否

page

integer

设置初始的页 码

1

是

pagerpos

string

指定分页栏的位 置

center

否

pgbuttons

boolean

是否显示翻页按 钮

true

否

pginput

boolean

是否显示跳转页面的输入 框

true

否

pgtext

string

当前页信 息

 

是

prmNames

array

Default valuesprmNames: {page:“page”,rows:“rows”, sort: “sidx”,order: “sord”, search:“_search”, nd:“nd”, npage:null} 当参数为 null 时不会被发到服务器 端

none

是

postData

array

此数组内容直接赋值到 url 上，参数类型： {name1:value1…}

空array

是

reccount

integer

只读属性，定义了 grid 中确切的行数。通常情况下与 records 属性相同，但有一种情况例外，假如 rowNum=15 ，但是从服务器端返回的记录数是 20 ，那么 records 值是 20 ，但 reccount 值仍然为 15 ，而且表格中也只显示 15 条记录 。

0

否

recordpos

string

定义了记录信息的位置： left, center, right

right

否

records

integer

只读属性，定义了返回的记录 数

none

否

recordtext

string

显示记录数信息。 {0} 为记录数开始， {1} 为记录数结束。 viewrecords 为 ture 时才能起效，且总记录数大于 0 时才会显示此信 息

 

 

resizeclass

string

定义一个 class 到一个列上用来显示列宽度调整时的效 果

空值

否

rowList

array

一个数组用来调整表格显示的记录数，此参数值会替代 rowNum 参数值传给服务器端 。

[]

否

rownumbers

boolean

如果为 ture 则会在表格左边新增一列，显示行顺序号，从 1 开始递增。此列名为 'rn'.

false

否

rownumWidth

integer

如果 rownumbers 为 true ，则可以设置 column 的宽 度

25

否

savedRow

array

只读属性，只用在编辑模式下保存数 据

空值

否

scroll

boolean

创建一个动态滚动的表格，当为 true 时，翻页栏被禁用，使用垂直滚动条加载数据，且在首次访问服务器端时将加载所有数据到客户端。当此参数为数字时，表格只控制可见的几行，所有数据都在这几行中加 载

false

否

scrollOffset

integer

设置垂直滚动条宽 度

18

否

scrollrows

boolean

当为 true 时让所选择的行可 见

false

是

selarrrow

array

只读属性，用来存放当前选择的 行

array

否

selrow

string

只读属性，最后选择行的 id

null

否

shrinkToFit

boolean

此属性用来说明当初始化列宽度时候的计算类型，如果为 ture ，则按比例初始化列宽度。如果为 false ，则列宽度使用 colModel 指定的宽 度

true

否

sortable

boolean

是否可排 序

false

否

sortname

string

排序列的名称，此参数会被传到后 台

空字符串

是

sortorder

string

排序顺序，升序或者降序（ asc or desc ）

asc

是

subGrid

boolean

是否使用 suggrid

false

否

subGridModel

array

subgrid 模 型

array

否

subGridType

mixed

如果为空则使用表格的 dataType

null

是

subGridUrl

string

加载 subgrid 数据的 url ， jqGrid 会把每行的 id 值加到 url 中

空值

是

subGridWidth

integer

subgrid 列的宽 度

20

否

toolbar

array

表格的工具栏。数组中有两个值，第一个为是否启用，第二个指定工具栏位置（相对于 body layer ），如： [true,”both”] 。工具栏位置可选值： “top”,”bottom”, “both”. 如果工具栏在上面，则工具栏 id 为 “t_”+ 表格 id ；如果在下面则为 “tb_”+ 表格 id ；如果只有一个工具栏则为 “t_”+ 表格 id

[false,'']

否

totaltime

integer

只读属性，计算加载数据的时间。目前支持 xml 跟 json 数 据

0

否

treedatatype

mixed

数据类型，通常情况下与 datatype 相同，不会 变

null

否

treeGrid

boolean

启用或者禁用 treegrid 模 式

false

否

treeGridModel

string

treeGrid 所使用的方 法

Nested

否

treeIcons

array

树的图标，默认值： {plus:'ui-icon-triangle-1-e',minus:'ui-icon-triangle-1-s',leaf:'ui-icon-radio-off'}

 

否

treeReader

array

扩展表格的 colModel 且加在 colModel 定义的后 面

 

否

tree_root_level

numeric

r oot 元素的级别 ，

0

否

userData

array

从 request 中取得的一些用户信 息

array

否

userDataOnFooter

boolean

当为 true 时把 userData 放到底部，用法：如果 userData 的值与 colModel 的值相同，那么此列就显示正确的值，如果不等那么此列就为 空

false

是

viewrecords

boolean

是否要显示总记录 数

false

否

viewsortcols

array

定义排序列的外观跟行为。数据格式： [false,'vertical',true]. 第一个参数是说，是否都要显示排序列的图标， false 就是只显示 当前排序列的图标；第二个参数是指图标如何显示， vertical ：排序图标垂直放置， horizontal ：排序图标水平放置；第三个参数指单击功 能， true ：单击列可排序， false ：单击图标排序。说明：如果第三个参数为 false 则第一个参数必须为 ture 否则不能排 序

 

否

width

number

如果设置则按此设置为主，如果没有设置则按 colModel 中定义的宽度计 算

none

否

xmlReader

array

对 xml 数据结构的描 述

 

否

 

Jqgrid学习 -------ColModel API

ColModel 是jqGrid里最重要的一个属性，设置表格列的属性。

 

属性

数据类型

备注

默认值

align

string

left, center, right.

left

classes

string

设置列的 css 。多个 class 之间用空格分隔，如： 'class1 class2' 。表格默认的 css 属性是 ui-ellipsis

empty string

datefmt

string

”/”, ”-”, and ”.” 都是有效的日期分隔符。 y,Y,yyyy 年 YY, yy 月 m,mm for monthsd,dd 日 .

ISO Date (Y-m-d)

defval

string

查询字段的默认 值

空

editable

boolean

单元格是否可编 辑

false

editoptions

array

编辑的一系列选项 。 {name:’__department_id’,index:’__department_id’,width:200,editable:true,edittype:’select’,editoptions: {dataUrl:”${ctx}/admin/deplistforstu.action”}}, 这个是演示动态从服务器端获取数据 。

empty

editrules

array

编辑的规则 {name:’age’,index:’age’, width:90,editable:true,editrules: {edithidden:true,required:true,number:true,minValue:10,maxValue:100}}, 设定 年龄的最大值为 100 ，最小值为 10 ，而且为数字类型，并且为必输字段 。

empty

edittype

string

可以编辑的类型。可选值： text, textarea, select, checkbox, password, button, image and file.

text

fixed

boolean

列宽度是否要固定不可 变

false

formoptions

array

对于 form 进行编辑时的属性设 置

empty

formatoptions

array

对某些列进行格式化的设 置

none

formatter

mixed

对列进行格式化时设置的函数名或者类 型

{name:’sex’,index:’sex’, align:’center’,width:60,editable:true,edittype:’select’,editoptions: {value:’0: 待定 ;1: 男 ;2: 女 ’},formatter:function(cellvalue, options, rowObject){
var temp = “<img src=’${ctx}/jquery-ui-1.7.2.custom/css/img/”
if(cellvalue==1){
temp = temp +”user-white.png”;
} else if(cellvalue==2){
temp = temp +”user-white-female.png”;
} else {
temp = temp + “user-silhouette.png”;
}
temp = temp + “‘ border=’0 ′ / >”
return temp;
}},// 返回性别的图标 。

none

hidedlg

boolean

是否显示或者隐藏此 列

false

hidden

boolean

在初始化表格时是否要隐藏此 列

false

index

string

索引。其和后台交互的参数为 sidx

empty

jsonmap

string

定义了返回的 json 数据映 射

none

key

boolean

当从服务器端返回的数据中没有 id 时，将此作为唯一 rowid 使 用 只有一个列可以做这项设置。如果设置多于一个，那么只选取第一个，其他被忽 略

false

label

string

如果 colNames 为空则用此值来作为列的显示名称，如果都没有设置则使用 name 值

none

name

string

表格列的名称，所有关键字，保留字都不能作为名称使用包括 subgrid, cb and rn.

Required

resizable

boolean

是否可以被 resizable

true

search

boolean

在搜索模式下，定义此列是否可以作为搜索 列

true

searchoptions

array

设置搜索参 数

empty

sortable

boolean

是否可排 序

true

sorttype

string

用在当 datatype 为 local 时，定义搜索列的类型，可选值： int/integer - 对 integer 排序 float/number/currency - 排序数字 date - 排序日期 text - 排序文 本

text

stype

string

定义搜索元素的类 型

text

surl

string

搜索数据时的 url

empty

width

number

默认列的宽度，只能是象素值，不能是百分 比

150

xmlmap

string

定义当前列跟返回的 xml 数据之间的映射关 系

none

unformat

function

‘unformat’ 单元格 值

null

 

 

Jqgrid学习 -------数据

jqGrid可支持的数据类型：xml、json、jsonp、local or clientSide、xmlstring、jsonstring
、script、function (…)。

 

 

Json数据

需要定义jsonReader来跟服务器端返回的数据做对应，其默认值：

 

 jsonReader : {  

      root: "rows",  

      page: "page",  

      total: "total",  

      records: "records",  

      repeatitems: true,  

      cell: "cell",  

      id: "id",  

      userdata: "userdata",  

      subgrid: {root:"rows",   

         repeatitems: true,   

        cell:"cell"  

      }
 

 

这样服务器端返回的数据格式：

 

  {   

    total: "xxx",   

    page: "yyy",   

    records: "zzz",  

    rows : [  

      {id:"1", cell:["cell11", "cell12", "cell13"]},  

      {id:"2", cell:["cell21", "cell22", "cell23"]},  

        ...  

    ]  

  }
 

 

jsonReader 的属性

 

total

总页数

page

当前页

records

查询出的记录数

rows

包含实际数据的数组

id

行 id

cell

当前行的所有单元格

 

自定义：

 

 jQuery("#gridid").jqGrid({  

 ...  

    jsonReader : {  
       root:"invdata",  

       page: "currpage",  

       total: "totalpages",  

       records: "totalrecords",  

       cell: "invrow"  

    },  

 ...  

 }); 

   totalpages: "xxx",   

   currpage: "yyy",  

   totalrecords: "zzz",  

   invdata : [  

     {id:"1", invrow:["cell11", "cell12", "cell13"]},  

     {id:"2", invrow:["cell21", "cell22", "cell23"]},  

       ...  

   ]

 

 

repeatitems  指明每行的数据是可以重复的，如果设为false，则会从返回的数据中按名字来搜索元素，这个名字就是colModel中的名字

 

 jsonReader : {  

       root:"invdata",  

       page: "currpage",  

       total: "totalpages",  

       records: "totalrecords",  

       repeatitems: false,  

       id: "0"  

    }

  totalpages: "xxx",   

   currpage: "yyy",  

   totalrecords: "zzz",  

   invdata : [  

     {invid:"1",invdate:"cell11", amount:"cell12", tax:"cell13", total:"1234", note:"somenote"},  

     {invid:"2",invdate:"cell21", amount:"cell22", tax:"cell23", total:"2345", note:"some note"},  

       ...  

   ]
 

此例中，id属性值为“invid”。
一旦当此属性设为false时，我们就不必把所有在 colModel 定义的 name 值都赋值。因为是按 name 来进行搜索元素的 ，所以他的排序也不是按colModel中指定的排序结果。

 

 

 

用户数据（ user data ）
在某些情况下，我们需要从服务器端返回一些参数但并不想直接把他们显示到表格中，而是想在别的地方显示，那么我们就需要用到userdata标签 

jsonReader: {  

   ...  

   userdata: "userdata",  

   ...  

 } 

{   

   total: "xxx",   

   page: "yyy",   

   records: "zzz",   

   userdata: {totalinvoice:240.00, tax:40.00},   

   rows : [   

     {id:"1", cell:["cell11", "cell12", "cell13"]},   

     {id:"2", cell:["cell21", "cell22", "cell23"]},   

     ...   

   ]   

 }
 

在客户端我们可以有下面两种方法得到这些额外信息：

1.      jQuery("grid_id").getGridParam('userData')  

2.      jQuery("grid_id").getUserData()  

3.      jQuery("grid_id").getUserDataItem( key )  

 

 

Jqgrid学习 -------事件 

 var lastSel;  

 jQuery("#gridid").jqGrid({  

 ...  

    onSelectRow: function(id){   

       if(id && id!==lastSel){   

          jQuery('#gridid').restoreRow(lastSel);   

          lastSel=id;   

       }   

       jQuery('#gridid').editRow(id, true);   

    },  

 ...  

 })
 

 

 

事件

参数

备注

afterInsertRow

rowidrowdatarowelem

当插入每行时触发。 rowid 插入当前行的 id ； rowdata 插入行的数据，格式为 name: value ， name 为 colModel 中的名 字

beforeRequest

none

向服务器端发起请求之前触发此事件但如果 datatype 是一个 function 时例 外

beforeSelectRow

rowid, e

当用户点击当前行在未选择此行时触发。 rowid ：此行 id ； e ：事件对象。返回值为 ture 或者 false 。如果返回 true 则选择完成，如果返回 false 则不会选择此行也不会触发其他事 件

gridComplete

none

当表格所有数据都加载完成而且其他的处理也都完成时触发此事件，排序，翻页同样也会触发此事 件

loadComplete

xhr

当从服务器返回响应时执行， xhr ： XMLHttpRequest 对 象

loadError

xhr,status,error

如果请求服务器失败则调用此方法。 xhr ： XMLHttpRequest 对象； satus ：错误类型，字符串类型； error ： exception 对 象

onCellSelect

rowid,iCol,cellcontent,e

当点击单元格时触发。 rowid ：当前行 id ； iCol ：当前单元格索引； cellContent ：当前单元格内容； e ： event 对 象

ondblClickRow

rowid,iRow,iCol,e

双击行时触发。 rowid ：当前行 id ； iRow ：当前行索引位置； iCol ：当前单元格位置索引； e:event 对 象

onHeaderClick

gridstate

当点击显示 / 隐藏表格的那个按钮时触发； gridstate ：表格状态，可选值： visible or hidden

onPaging

pgButton

点击翻页按钮填充数据之前触发此事件，同样当输入页码跳转页面时也会触发此事 件

onRightClickRow

rowid,iRow,iCol,e

在行上右击鼠标时触发此事件。 rowid ：当前行 id ； iRow ：当前行位置索引； iCol ：当前单元格位置索引； e ： event 对 象

onSelectAll

aRowids,status

multiselect 为 ture ，且点击头部的 checkbox 时才会触发此事件。 aRowids ：所有选中行的 id 集合，为一个数组。 status ： boolean 变量说明 checkbox 的选择状态， true 选中 false 不选中。无论 checkbox 是否选择， aRowids 始终有 值

onSelectRow

rowid,status

当选择行时触发此事件。 rowid ：当前行 id ； status ：选择状 态 ，当 multiselect 为 true 时此参数才可 用

onSortCol

index,iCol,sortorder

当点击排序列但是数据还未进行变化时触发此事件。 index ： name 在 colModel 中位置索引； iCol ：当前单元格位置索引； sortorder ：排序状态： desc 或者 asc

resizeStart

event, index

当开始改变一个列宽度时触发此事件。 event ： event 对象； index ：当前列在 colModel 中位置索 引

resizeStop

newwidth, index

当列宽度改变之后触发此事件。 newwidth ：列改变后的宽度； index ：当前列在 colModel 中的位置索 引

serializeGridData

postData

向服务器发起请求时会把数据进行序列化，用户自定义数据也可以被提交到服务器 端

 

 

Jqgrid学习 -------方法

 

jqGrid的方法，从3.6开始已经完全兼容jQuery UI库。

 

jQuery("#grid_id").jqGridMethod( parameter1,...parameterN );

jQuery("#grid_id").setGridParam({...}).hideCol("somecol").trigger("reloadGrid");
 

 

如果使用新的API：

 

jQuery("#grid_id").jqGrid('method', parameter1,...parameterN );

jQuery("#grid_id").jqGrid('setGridParam',{...}).jqGrid('hideCol',"somecol").trigger("reloadGrid");
 

jqGrid配置使用新的api

 

 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">  

 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">  

 <head>  

 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />  

 <title>My First Grid</title>  

    

 <link rel="stylesheet" type="text/css" media="screen" href="css/ui-lightness/jquery-ui-1.7.1.custom.css" />  

 <link rel="stylesheet" type="text/css" media="screen" href="css/ui.jqgrid.css" />  

    

<script src="js/jquery-1.3.2.min.js" type="text/javascript"></script>  
<script src="js/i18n/grid.locale-en.js" type="text/javascript"></script>  

<script type="text/javascript">  

     jQuery.jgrid.no_legacy_api = true;  

 </script>  

 <script src="js/jquery.jqGrid.min.js" type="text/javascript"></script>  

    

 </head>  

<body>  

 ...  

 </body>  

 </html>
 

 

jqGrid方法

方法名

参数

返回值

说明

addJSONData

data

none

使用传来的 data 数据填充表格。使用方法：

var mygrid = jQuery(”#”+grid_id)[0];

var myjsongrid = eval(”(”+jsonresponse.responseText+”)”); mygrid.addJSONData(myjsongrid);

myjsongrid = null;

jsonresponse =null;

addRowData

rowid,data, position, srcrowid

成功为 true, 否则为 false

根据参数插入一行新的数据， rowid 为新行的 id ， data 为新行的数据， position 为新增行的位置， srcrowid 为新增行的参考位置。 data 数据格式： {name1:value1,name2: value2…} name 为在 colModel 中指定的名 称

addXMLData

data

none

根据传来的数据填充表格。用法： var mygrid = jQuery(”#”+grid_id)[0]; mygrid.addXmlData(xmlresponse.responseXML);

clearGridData

clearfooter

jqGrid 对 象

清除表格当前加载的数据。如果 clearfooter 为 true 时则此方法删除表格最后一行的数 据

delRowData

rowid

成功为 true 否则为 false

根据 rowid 删除行，但不会从服务器端删除数 据

footerData

action,data, format

jgGrid 对 象

设置或者取得底部数据。 action ： “get” 或者 “set” ，默认为 “get” ，如果为 “get” 返回值为 name:value ， name 为 colModel 中名称。如果为 “set” 则值为 name ： value ， name 是 colModel 中的名称。 format ：默认为 true ，当为 true 时，在设置新值时会调用 formatter 格式化数 值

getCell

rowid, iCol

单元格内 容

返回指定 rowid ， iCol 的单元格内容， iCol 既可以是当前列在 colModel 中的位置索引也可以是 name 值。注意：在编辑行或者单元格时不能使用此方法，此时返回的并不是改变的值，而是原始 值

getCol

colname, returntype, mathoperation

array[] or value

返回列的值。 colname 既可以是当前列在 colModel 中的位置索引也可以是 name 值。 returntype 指定返回数据的类型，默认为 false 。当为 false 时，返回的数组中只包含列的值，当为 true 时返回数组是对象数组，具体格式 {id:rowid, value:cellvalue} ， id 为行的 id ， value 为列的值。如： [{id:1,value:1},{id:2,value:2}…] 。 mathoperation 可选值为 'sum, 'avg', 'count'

getDataIDs

none

array[]

返回当前 grid 里所有数据的 id

getGridParam

name

mixed value

返回请求的参数信 息

getInd

rowid,rowcontent

mixed

如果 rowcontent 为 false ，返回行所在的索引位置， id 为行 id 。 rowcontent 默认为 false 。如果 rowconent 为 ture 则返回的为行对象，如果找不到行则返回 false

getRowData

rowid or none

array[]

返回指定行的数据，返回数据类型为 name:value ， name 为 colModel 中的名称， value 为所在行的列的值，如果根据 rowid 找不到则返回空。在编辑模式下不能用此方法来获取数据，它得到的并不是编辑后的 值

hideCol

colnameor[colnames]

jqGrid 对 象

如果参数为一个列名则隐藏此列，如果给定的是数组则隐藏指定的所有列。格式： [“name1”,”name2”]

remapColumns

permutation, updateCells, keepHeader

none

调整表格列的显示顺序 ,permutation 为当前列的顺序，假如值是 [1,0,2] ，那么第一列就会在第二位显示。如果 updateCells 为 ture 则是对单元格数据进行重新排序，如果 keepHeader 为 true 则对 header 数据显示位置进行调 整

resetSelection

none

jqGrid 对 象

选择或者反选行数据，在多选模式下也同样起作 用

setCaption

caption

jqGrid 对 象

设置表格的标 题

setCell

rowid,colname, data, class, properties

jqGrid 对 象

改变单元格的值。 rowid ：当前行 id ； colname ：列名称，也可以是列的位置索引，从 0 开始； data ：改变单元格的内容，如果为空则不更 新； class ：如果是 string 则会使用 addClass 方法将其加入到单元格的 css 中，如果是 array 则会直接加到 style 属性 中； properties ：设置单元格属 性

setGridParam

object

jqGrid 对 象

设置 grid 的参数。有些参数的修改必须要重新加载 grid 才可以生效，这个方法可以覆盖事 件

setGridHeight

new_height

jqGrid 对 象

动态改变 grid 的高度，只能对单元格的高度进行设置而不能对表格的高度进行动态修改。 new_height ：可以是象素值，百分比或者 "auto"

setGridWidth

new_width,shrink

jqGrid 对 象

动态改变表格的宽度。 new_width: 表格宽度，象素值； shrink ： true 或者 false ，作用同 shrinkToFit

setLabel

colname, data, class, properties

jqGrid 对 象

给指定列设置一个新的显示名称。 colname ：列名称，也可以是列的位置索引，从 0 开始； data ：列显示名称，如果为空则不修改； class ：如果是 string 则会使用 addClass 方法将其加入到单元格的 css 中，如果是 array 则会直接加到 style 属性中； properties ：设置 label 的属 性

setRowData

rowid,data, cssprop

成功 true 否则 false

更新行的值， rowid 为行 id 。 data 值格式： {name1:value1,name2: value2…} name 为 colModel 中名称； cssprop ：如果是 string 则会使用 addClass 方法将其加入到行的 css 中，如果是 array 或者对象 则会直接加到 style 属性 中

setSelection

rowid,onselectrow

jqGrid 对 象

选择或反选指定行。如果 onselectrow 为 ture 则会触发事件 onSelectRow ， onselectrow 默认为 ture

showCol

colname

jqGrid

显示列。 colname 可以是数组 [“name1”,”name2”], 但是 name1 或者 name2 必须是 colModel 中的 name

trigger(“reloadGrid”)

none

jqGrid 对 象

重新加载当前表格，也会向服务器发起新的请 求

updateColumns

none

none

同步表格的宽度，用在表格拖拽时，用法： var mygrid=jQuery(”#grid_id”)[0];mygrid.updateColumns();

 

jqGrid的通用方法和设置
这些方法并不和jqGrid对象绑定，可以随意使用：

 

jQuery.jgrid.jqGridFunction( parameter1,...parameterN );
 

 

函数名

参数

返回值

说明

ajaxOptions

空对 象

none

这个函数可以改变 jqgrid 中用到的 ajax 请求参数，这个函数可以覆盖当前所有 ajax 请求设置。从 3.6 版本开始起有 3 个级别的 ajax 设置：第一 个级别就是在模块中设置 ajax 请求；第二个级别就是通过此函数设置；第三级别的设置是控制全局 ajax 请求的设 置： jQuery.extend(jQuery.ajax({method specific options}, ajaxOptions, ThirdLevelajaxSettinds)); 当然我们也可以单独设置 ajax 的参 数

jqID

string

解析后的 string

转义字符串，把两个反斜杠 (\\) 转化为单个反斜杠 (\)

jgrid.htmlDecode

string

转换后 string

把转码后的字符串还 原

jgrid.htmlEncode

string

编码后的 string

把字符串编 码

jgrid.format

string

格式化后 string

简单字符串模板。用法： Example jQuery.jqgformat(“Please enter a value between {0} and {1}.”, 4,result : “Please enter a value between 4 and 8.”

jgrid.getCellIndex

cell

index

这个方法是用来修复在 ie7 里的一个 bug

jgrid.stringToDoc

xmlstring

xmlDoc

把 xmlstring 转换为 dom 对 象

jgrid.stripHtml

content

new_content

去掉 html 标签返回标签中内 容

jgrid.parse

jsonstring

对 象

把一个 jsonstring 转换为 json 对 象

 

 

jqGrid的方法

方法名

参数

返回值

说明

filterGrid

grid_id,params

HTML 对 象

构造 jqGrid 的查询界面。 grid_id: 表格 id ； params ：参 数

filterToolbar

params

jqGrid 对 象

同上。不同的是搜索输入框在 header 层下 方

getColProp

colname

array

返回指定列的属性集合。 name 为 colModel 中名 称

GridDestroy

grid_id

boolean

从 dom 上删除此 grid

GridUnload

grid_id

boolean

跟 GridDestroy 不同的是 table 对象跟 pager 对象并不会被删除，以便下次使 用

setGridState

state

jqGrid 对 象

设置 grid 的状态，显示或者隐藏。这个方法不会触发 onHeaderClick 事件 。

setColProp

colname, properties

jqGrid 对 象

设置新的属性，对于动态改变列属性是非常有用的，但是有些属性的修改并不会起效。用法： jQuery(”#grid_id”).setColProp('colname',{editoptions:{value:“True:False”}});

sortGrid

colname, reload

jqGrid 对 象

按指定列进行排序。效果同 setGridParam({sortname:'myname'}).trigger('reloadGrid'). 如果 reload 为 true 则会重新加载数 据

updateGridRows

data,rowidname,jsonreader

boolean

修改表格中某行的数据， data 数据格式： [{name:value,name1:value1…}, {name:value,name2:value2…}] ， name 为 colModel 中的名称； rowidname 某行的名称。 jsonreader ： boolean 值，默认 false 。如果为 true 则是定义数据的格式， data 的值并不是 name ： value 形式而只是 value


Jqgrid学习 -------配置 json

IE8，FF3以及Chrome 3已经支持JSON，配置：

 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">  

 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">  

 <head>  

 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />  

 <title>My First Grid</title>  

    

 <link rel="stylesheet" type="text/css" media="screen" href="css/ui-lightness/jquery-ui-1.7.1.custom.css" />  

 <link rel="stylesheet" type="text/css" media="screen" href="css/ui.jqgrid.css" />  

   

 <script src="js/jquery-1.3.2.min.js" type="text/javascript"></script>  

 <script src="js/i18n/grid.locale-en.js" type="text/javascript"></script>  

 <script type="text/javascript">  

     jQuery.jgrid.useJSON = true;  

 </script>  

 <script src="js/jquery.jqGrid.min.js" type="text/javascript"></script>  

    

 </head>  

 <body>  

 ...  

 </body>  

 </html>
 

 

这段代码要放到语言包之后jqGrid.js文件之前。
如果浏览器不支持JSON，那么我们只能用eval函数解析json。

 

 

 <script type="text/javascript">  

    jQuery.extend(jQuery.jgrid,{  

       parse:function(jsstring) {  

          return JSON.parse(jsstring);  

       }  

    });  

 </script>

  

 

Jqgrid学习 -------翻页

 

jqGrid的翻页要定义在html里，通常是在grid的下面，且是一个div对象： 

 <table id="list"></table>   

    <div id="gridpager"></div>

jQuery("#grid_id").jqGrid({  

 ...  

    pager : '#gridpager',  

 ...  

});
 

 

不必给翻页设置任何的css属性。在jqGrid里定义的翻页可以是：:pager : '#gridpager', pager : 'gridpager' or pager : jQuery('#gridpager'). 推荐使用前两个，当使用其他方式时jqGrid的导入导出功能时会引起错误。

导航栏的属性：

 

 $.jgrid = {  

     defaults : {  

         recordtext: "View {0} - {1} of {2}",  

             emptyrecords: "No records to view",  

         loadtext: "Loading...",  

         pgtext : "Page {0} of {1}"  

    },  

...  

}
 

如果想改变这些设置：

 

1．   

 jQuery.extend(jQuery.jgrid.defaults,{emptyrecords: "Nothing to display",...});
 

 

 

2．    

jQuery("#grid_id").jqGrid({  

...  

               pager : '#gridpager',  

               emptyrecords: "Nothing to display",  

                 ...  

                 });
 

 

导航栏的属性：

 

属性名

类型

说明

默认值

是否可以被修改

lastpage

integer

只读属性，总页 数

0

NO

pager

mixed

导航栏对象，必须是一个有效的 html 元素，位置可以随 意

空字符 串

NO

pagerpos

string

定义导航栏的位置，默认分为三部分：翻页，导航工具及记录信 息

center

NO

pgbuttons

boolean

是否显示翻页按 钮

true

NO

pginput

boolean

是否显示跳转页面的输入 框

true

NO

pgtext

string

页面信息，第一个值是当前页第二个值是总页 数

语言 包

YES

reccount

integer

只读属性，实际记录数，千万不能跟 records 参数搞混了，通常情况下他们是相同的，假如我们定义 rowNum=15 ，但我们从服务器端返回的记录为 20 即 records=20 ，而 reccount=15 ，表格中也显示 15 条记 录

0

NO

recordpos

string

定义记录信息的位置，可选值： left, center, right

right

NO

records

integer

只读属性，从服务器端返回的记录 数

none

NO

recordtext

string

显示记录的信息，只有当 viewrecords 为 true 时起效，且记录数必须大于 0

语言 包

yes

rowList

array

可以改变表格可以显示的记录数，格式为 [10,20,30]

array

no

rowNum

integer

设置表格可以显示的记录 数

20

yes

viewrecords

boolean

是否要显示总记录数信 息

false

no

 

jQuery("#grid_id").setGridParam({rowNum:10}).trigger("reloadGrid");  

 

跟翻页相关的事件只有一个：onPaging

 

onPaging

pgButton

当点击翻页按钮但还为展现数据时触发此事件，当然这跳转栏输入页码改变页时也同样触发此事件。参数 pgButton 可选值： first,last,prev,next

 

 

 

jqGrid的翻页导航是一个方法，你可以事先定义一些其他操作，比如：编辑、新增、删除及搜索。也可以增加自定义的函数。导航工具栏是定义到翻页控件上的。定义如下：

 

   <table id="list"></table>   

   <div id="gridpager"></div>   

 

  

 jQuery("#grid_id").jqGrid({  

 ...  

    pager : '#gridpager',  

 ...  

 });  

 jQuery("#grid_id").navGrid('#gridpager',{parameters},prmEdit, prmAdd, prmDel, prmSearch, prmView);
 

 

grid_id ：表格id
gridpager ：导航栏id
parameters ：参数列表
prmEdit, prmAdd, prmDel, prmSearch, prmView ：事件

 

 $.jgrid = {  

 ...  

    search : {  

     caption: "Search...",  

      Find: "Find",  

      Reset: "Reset",  

      odata : ['equal', 'not equal', 'less', 'less or equal','greater','greater or equal', 'begins with','does not begin with','is in','is not in','ends with','does not end with','contains','does not contain'],  

      groupOps: [ { op: "AND", text: "all" }, { op: "OR", text: "any" } ],  

      matchText: " match",  

      rulesText: " rules"  

    },  

    edit : {  

      addCaption: "Add Record",  

      editCaption: "Edit Record",  

      bSubmit: "Submit",  

      bCancel: "Cancel",  

      bClose: "Close",  

      saveData: "Data has been changed! Save changes?",  

      bYes : "Yes",  

      bNo : "No",  

      bExit : "Cancel",  

   },  

   view : {  

     caption: "View Record",  

     bClose: "Close"  

   },  

   del : {  

     caption: "Delete",  

     msg: "Delete selected record(s)?",  

     bSubmit: "Delete",  

     bCancel: "Cancel"  

   },  

   nav : {  

     edittext: "",  

     edittitle: "Edit selected row",  

     addtext:"",  

     addtitle: "Add new row",  

     deltext: "",  

     deltitle: "Delete selected row",  

     searchtext: "",  

     searchtitle: "Find records",  

     refreshtext: "",  

     refreshtitle: "Reload Grid",  

     alertcap: "Warning",  

     alerttext: "Please, select row",  

     viewtext: "",  

     viewtitle: "View selected row"  

   },  

 ...

 

 

属性

类型

说明

默认值

add

boolean

是否启用新增功能，当点击按钮时会触发 editGridRow 事 件

true

addicon

string

给新增功能设置图标，只有 UI theme 里的图标才可以使 用

ui-icon-plus

addtext

string

新增按钮上的文 字

空

addtitle

string

当鼠标移到新增按钮上时显示的提 示

新增一 行

alertcap

string

当我们 edit,delete or view 一行记录时出现的提示信 息

警 告

alerttext

string

当 edit,delete or view 一行记录时的文本提 示

请选择一行记 录

closeOnEscape

boolean

是否可以使用 esc 键关闭对话 框

true

del

boolean

是否启用删除功能，启用时会触发事件 delGridRow

true

delicon

string

设置删除按钮的图标，只有 UI theme 里的图标才可以使 用

ui-icon-trash

deltext

string

设置到删除按钮上的文字信 息

空

deltitle

string

当鼠标移到删除按钮上时出现的提 示

删除锁选择的 行

edit

boolean

是否启用可编辑功能，当编辑时会触发事件 editGridRow

true

editicon

string

设置编辑按钮的图标，只有 UI theme 里的图标才可以使 用

ui-icon-pencil

edittext

string

编辑按钮上文 字

空

edittitle

string

当鼠标移到编辑按钮上出现的提示信 息

编辑所选择的 行

position

string

定义按钮位置，可选值 left, center and right.

left

refresh

boolean

是否启用刷新按钮，当点击刷新按钮时会触发 trigger(“reloadGrid”) 事件，而且会清空搜索条件 值

true

refreshicon

string

设置刷新图标，只有 UI theme 里的图标才可以使 用

ui-icon-refresh

refreshtext

string

刷新按钮上文字信 息

空

refreshtitle

string

当鼠标移到刷新按钮上的提示信 息

重新加 载

refreshstate

string

指明表格如何刷新。 firstpage ：从第一页开始刷新； current ：只刷新当前页内 容

firstpage

afterRefresh

function

当点击刷新按钮之后触发此事 件

null

search

boolean

是否启用搜索按钮，会触发 searchGrid 事 件

true

searchhicon

string

设置搜索按钮的图标，只有 UI theme 里的图标才可以使 用

ui-icon-search

searchtext

string

搜索按钮上的文 字

空

searchtitle

string

当鼠标移到搜索按钮上的提示信 息

搜 索

view

boolean

是否启用查看按钮，会触发事件 viewGridRow

false

viewicon

string

设置查看按钮的图标，只有 UI theme 里的图标才可以使 用

ui-icon-document

viewtext

string

查看按钮上文 字

空

viewtitle

string

当鼠标移到查看按钮上的提示信 息

查看所选记 录

 

 

 jQuery("#grid_id").jqGrid({  

 ...  

    pager : '#gridpager',  

 ...  

 }).navGrid('#gridpager',{view:true, del:false},   

 {}, // use default settings for edit  

 {}, // use default settings for add  

 {},  // delete instead that del:false we need this  

 {multipleSearch : true}, // enable the advanced searching  

 {closeOnEscape:true} /* allow the view dialog to be closed when user press ESC key*/  

 );
 

Jqgrid学习 -------自定义按钮

 

jQuery("#grid_id").navGrid("#pager",...).navButtonAdd("#pager",{parameters});
 

 

新的API

 

jQuery("#grid_id").jqGrid('navGrid',"#pager",...).jqGrid('navButtonAdd',"#pager",{parameters});
 

默认参数

 

{ caption:"NewButton", buttonicon:"ui-icon-newwin", onClickButton:null, position: "last", title:"", cursor: "pointer"}
 

caption：按钮名称，可以为空，string类型
buttonicon：按钮的图标，string类型，必须为UI theme图标
onClickButton：按钮事件，function类型，默认null
position：first或者last，按钮位置
title：string类型，按钮的提示信息
cursor：string类型，光标类型，默认为pointer
id：string类型，按钮id

 

 

如果设置多个按钮：

 

 jQuery("#grid_id")  

 .navGrid('#pager',{edit:false,add:false,del:false,search:false})  

 .navButtonAdd('#pager',{  

    caption:"Add",   

    buttonicon:"ui-icon-add",   

    onClickButton: function(){   

      alert("Adding Row");  

    },   

    position:"last"  

 })  

 .navButtonAdd('#pager',{  

    caption:"Del",   

    buttonicon:"ui-icon-del",   

    onClickButton: function(){   

       alert("Deleting Row");  

    },   

    position:"last"  

 });
 

按钮间的分隔

 

jQuery("#grid_id").navGrid("#pager",...).navButtonAdd("#pager",{parameters}).navSeparatorAdd("#pager",{separator_parameters}};
 

 

默认参数：

 

{sepclass : “ui-separator”,sepcontent: ''}

 

sepclass：ui-jqgrid的属性名
sepcontent：分隔符的内容.

 

Jqgrid学习 -------格式化

jqGrid的格式化是定义在语言包中

 

 $jgrid = {  

 ...  

    formatter : {  

      integer : {thousandsSeparator: " ", defaultValue: '0'},  

      number : {decimalSeparator:".", thousandsSeparator: " ", decimalPlaces: 2, defaultValue: '0.00'},  

      currency : {decimalSeparator:".", thousandsSeparator: " ", decimalPlaces: 2, prefix: "", suffix:"", defaultValue: '0.00'},  

      date : {  

        dayNames: [  

          "Sun", "Mon", "Tue", "Wed", "Thr", "Fri", "Sat",  

          "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"  

        ],  

        monthNames: [  

          "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec",  

          "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"  

        ],  

        AmPm : ["am","pm","AM","PM"],  

        S: function (j) {return j < 11 || j > 13 ? ['st', 'nd', 'rd', 'th'][Math.min((j - 1) % 10, 3)] : 'th'},  

        srcformat: 'Y-m-d',  

        newformat: 'd/m/Y',  

        masks : {  

          ISO8601Long:"Y-m-d H:i:s",  

          ISO8601Short:"Y-m-d",  

          ShortDate: "n/j/Y",  

          LongDate: "l, F d, Y",  

          FullDateTime: "l, F d, Y g:i:s A",  

          MonthDay: "F d",  

          ShortTime: "g:i A",  

          LongTime: "g:i:s A",  

          SortableDateTime: "Y-m-d\\TH:i:s",  

          UniversalSortableDateTime: "Y-m-d H:i:sO",  

          YearMonth: "F, Y"  

        },  

        reformatAfterEdit : false  

      },  

      baseLinkUrl: '',  

      showAction: '',  

      target: '',  

      checkbox : {disabled:true},  

      idName : 'id'  

    }  

 ...
 

这些设置可以通过colModel中的formatoptions参数修改

 

 jQuery("#grid_id").jqGrid({  

 ...  

    colModel : [  

    ...  

       {name:'myname', ... formatter:'number', ...},  

    ...  

    ],  

 ...  

 });
 

此实例是对名为“myname”的列进行格式化，格式化类是“number”，假如初始值为“1234.1”则格式化后显示为“1 234.10” 。

 

 

如果给某列进行格式化： 

 jQuery("#grid_id").jqGrid({  

...  

    colModel : [  

    ...  

       {name:'myname', ... formatter:'currency', formatoptions:{decimalSeparator:",", thousandsSeparator: ",", decimalPlaces: 2, prefix: "$ "} } ,  

    ...  

    ],  

 ...  

 });
 

 

这个设置会覆盖语言包中的设置。

 

 

select类型的格式化实例：

原始数据 

 jQuery("#grid_id").jqGrid({  

 ...  

    colModel : [ {name:'myname', edittype:'select', editoptions:{value:"1:One;2:Two"}} ... ],  

 ...  

 });
 

使用格式化后 

 jQuery("#grid_id").jqGrid({  

 ...  

    colModel : [ {name:'myname', edittype:'select', formatter:'select', editoptions:{value:"1:One;2:Two"}} ... ]  

 ...  

 });
 

结果是，表格的数据值为1或者2但是现实的是One或者Two。

对超链接使用select类型的格式化： 

 jQuery("#grid_id").jqGrid({  

 ...  

    colModel: [ {name:'myname', edittype:'select', formatter:'select', formatoptions:{baseLinkUrl:'someurl.php', addParam: '&action=edit'}, ...}   

       ...   

    ]  

 ...  

 });
 

得到 http://localhost/someurl.php?id=123&action=edit  

 

如果想改变id值则 

 jQuery("#grid_id").jqGrid({  

 ...  

    colModel: [ {name:'myname', edittype:'select', formatter:'select', formatoptions:{baseLinkUrl:'someurl.php', addParam: '&action=edit', idName:'myid'}, ...}   

       ...   

    ]  

 ...  

 });
 

得到 http://localhost/someurl.php?myid=123&action=edit

 

Jqgrid学习 -------自定义格式化 

 jQuery("#grid_id").jqGrid({  

 ...  

    colModel: [   

       ...   

       {name:'price', index:'price', width:60, align:"center", editable: true, formatter:currencyFmatter},  

       ...  

    ]  

 ...  

 });  

    

 function currencyFmatter (cellvalue, options, rowObject)  

 {  

   // do something here  

    return new_format_value  

 }
 

cellvalue：要被格式化的值
options：对数据进行格式化时的参数设置，格式为：
{ rowId: rid, colModel: cm}
rowObject：行数据

 

 

数据的反格式化跟格式化用法相似. 

 jQuery("#grid_id").jqGrid({  

 ...  

    colModel: [   

       ...   

       {name:'price', index:'price', width:60, align:"center", editable: true, formatter:currencyFmatter, unformat:unformatCurrency},  

       ...  

    ]  

 ...  

 });  

    

 function currencyFmatter (cellvalue, options, rowObject)  

 {  

    

    return "$"+cellvalue;  

 }  

 function  unformatCurrency (cellvalue, options)  

 {  

    

    return cellvalue.replace("$","");  

 }
 

表格中数据实际值为123.00，但是显示的是$123.00; 我们使用getRowData ，getCell 方法取得的值是123.00。

 


创建通用的格式化函数 

 <script type="text/javascript">  

 jQuery.extend($.fn.fmatter , {  

     currencyFmatter : function(cellvalue, options, rowdata) {  

     return "$"+cellvalue;  

 }  

 });  

 jQuery.extend($.fn.fmatter.currencyFmatter , {  

     unformat : function(cellvalue, options) {  

     return cellvalue.replace("$","");  

 }  

 });  

    

· </script>
 

具体使用： 

 jQuery("#grid_id").jqGrid({  

 ...  

    colModel: [   

       ...   

       {name:'price', index:'price', width:60, align:"center", editable: true, formatter:currencyFmatter},  

       ...  

    ]  

 ...  

 })
 

Jqgrid学习 -------搜索

表格中所有的列都可以作为搜索条件。
所用到的语言包文件 

 $.jgrid = {  

 ...  

    search : {  

      caption: "Search...",  

      Find: "Find",  

      Reset: "Reset",  

      odata : ['equal', 'not equal', 'less', 'less or equal','greater','greater or equal', 'begins with','does not begin with','is in','is not in','ends with','does not end with','contains','does not contain'],  

      groupOps: [ { op: "AND", text: "all" }, { op: "OR", text: "any" } ],  

      matchText: " match",  

      rulesText: " rules"  

    }
 

colModel 设置

可选参数

类型

说明

默认值

search

boolean

是否是搜索 列

true

stype

string

搜索类型， text 类型或者 select 类 型

text

searchoptions

object

对搜索条件进行一些设 置

 

 

searchoptions 参数

属性

类型

说明

dataUrl

string

只有当搜索类型为 select 才起 效

buildSelect

function

只有当 dataUrl 设置时此参数才起效，通过一个 function 来构建下拉 框

dataInit

function

初始化时调用，用法： dataInit: function(elem) {do something} 通常用在日期的选择上 . Example:dataInit : function (elem) {$(elem).datepicker();}

dataEvents

array

事件列表，用法： dataEvents: [{ type: 'click', data: { i: 7 }, fn: function(e) { console.log(e.data.i); }},{ type: 'keypress', fn: function(e) { console.log('keypress'); } }]

attr

object

设置属性值。 attr : { title: “Some title” }

searchhidden

boolean

默认情况下，隐藏值不是搜索列。为了使隐藏值可以作为搜索列则将此设为 true

sopt

array

此参数只用到单列搜索上，说明搜索条件。可用值： ['eq','ne','lt','le','gt','ge','bw','bn','in','ni','ew','en','cn','nc'] 意 思为 ['equal','not equal', 'less', 'less or equal','greater','greater or equal', 'begins with','does not begin with','is in','is not in','ends with','does not end with','contains','does not contain']

defaultValue

string

默认 值

value

mixed

只用在搜索类型为 select 下。可以是 string 或者 object ，如果为 string 则格式为 value:label ，且以 “ ； ” 结尾；如果为 object 格式为 editoptions:{value:{1:'One';2:'Two'}} 

 jQuery("#grid_id").jqGrid({  

 ...  

    colModel: [   

       ...   

       {name:'price', index:'price', width:60, search:true, stype:'text', searchoptions:{dataInit:datePick, attr:{title:'Select Date'}} },  

       ...  

    ]  

 ...  

 });  

 datePick = function(elem)  

 {  

    jQuery(elem).datepicker();  

 }
 

需要说明的：
所有的搜索都是使用url来到服务器端查询数据。
当执行搜索时会用查询数据填充postData array
发送到服务器端搜索字符串的名称为_search
当点击刷新按钮时不会使用搜索条件
每个搜索方法都有自己的数据清空方法

 

Jqgrid学习 -------搜索工具栏

搜索工具栏只是在列标题下面构造一个输入框。且使用表格的url进行搜索记录，发到服务器端数据格式为name:value，而且是附加在postData之后。

 

jQuery("#grid_id").filterToolbar(options);  

jQuery("#grid_id").jqGrid('filterToolbar',options);  

 

 

options：参数

可选参数

类型

描述

默认值

autosearch

boolean

查询规则，如果是 text 类型则是当按下回车键才去执行查询；如果是 select 类型的查询则当值改变时就去执行查 询

true

beforeSearch

function

执行查询之前触发此事 件

null

afterSearch

function

查询完成后触发事 件

null

beforeClear

function

清空查询条件值时触发事 件

null

afterClear

function

清空查询条件后触发事 件

null

 

方法：

方法

描述

triggerToolbar

执行查询时调用此方法

clearToolbar

当清空查询条件值时触发此函数

toggleToolbar

Toggeles工具栏

Jqgrid学习 -------自定义搜索

<div id="mysearch"></div>

jQuery("#mysearch").filterGrid('#grid_id',options);

 

options：参数

参数

描述

默认值

gridModel

当 为ture我们会使用colModel中的属性构造查询条件，所用到的参数：name, index, edittype, editoptions, search.还有一个参数：defval：查询条件的默认值；surl：当edittype:'select'时获取select数据的url，格 式：<select><option value='val1'> Value1 </option><option value='val2'> Value2 </option>…<option value='valn'> ValueN </option></select>

false

gridNames

gridModel为true时起效，设置查询列的名称

false

filterModel

gridModel 为false时起效，格式：{label:'LableFild', name: 'colname', stype: 'select', defval: 'default_value', surl: 'someurl', sopt:{optins for the select}}。label：字段显示名称；name：列名；stype：输入框类型，text或者select；surl：获取select数据的地 址，要求的内容为html格式：<select><option value='val1'> Value1 </option><option value='val2'> Value2 </option>…<option value='valn'> ValueN </option></select>；sopt：同editoptions 

[]

formtype

定义表单如何被构造，'horizontal' or 'vertical'

 

autosearch

如果为true:当点击回车键触发查询；当select值变化时触发查询

 

formclass

可以使用的css

filterform

tableclass

可以使用到table上的css

filtertable

buttonclass

按钮上使用的css

filterbutton

searchButton

搜索按钮

Search

clearButton

清空数据的按钮

Clear

enableSearch

启用禁用搜索按钮

false

enableClear

启用禁用清空按钮

false

beforeSearch

搜索之前触发的事件

null

afterSearch

搜索完成之后触发的事件

null

beforeClear

清空数据之前触发的事件

null

afterClear

清空数据之后触发事件

null

url

搜索数据的url

‘’

marksearched

当为true时，每次查询之后所有查询的列都标记为可查询列

true

 

分享到：
| jsp放在web-inf下的注意事项
评论
发表评论

您还没有登录,请您登录后再发表评论

相关推荐

Magicbox
Global site tag (gtag.js) - Google Analytics