jqGridapi中文说明.docx

1、jqGridapi中文说明jqGrid api 中文说明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/myproj

2、ect/js/ /i18n/ grid.locale-bg.js list of all language files . Changes.txt jquery-1.3.2.min.js jquery.jqGrid.min.js在页面中写法：Java代码MyFirstGridhtml,bodymargin:0;padding:0;font-size:75%;.需要说明的是，jquery-ui的字体大小与jqgrid字体大小不一致，故需要在页面上在加上一段style来指定页面上文字大小。jqGrid皮肤从3.5版本开始，jqGrid完全支持jquery UI的theme。我们可以从也并不需要把所

3、有的css文件都引入进来，只需导入核心css文件“ui.theme.css” 以及“ui.core.css”即可，文件位于目录development-bundle/themes下。jqGrid原理jqGrid是典型的B/S架构，服务器端只是提供数据管理，客户端只提供数据显示。换句话说，jqGrid可以以一种更加简单的方式来展现你数据库的信息，而且也可以把客户端数据传回给服务器端。对于jqGrid我们所关心的就是：必须有一段代码把一些页面信息保存到数据库中，而且也能够把响应信息返回给客户端。jqGrid是用ajax来实现对请求与响应的处理。jqGrid参数名称类型描述默认值可修改urlstrin

4、g获取数据的地址datatypestring从服务器端返回的数据类型，默认xml。可选类型：xml，local，json，jsonnp，script，xmlstring，jsonstring，clientsidemtypestringajax提交方式。POST或者GET，默认GETcolNamesArray列显示名称，是一个数组对象colModelArray常用到的属性：name列显示的名称；index传到服务器端用来排序用的列名称；width列宽度；align对齐方式；sortable是否可以排序pagerstring定义翻页用的导航栏，必须是有效的html元素。翻页工具栏可以放置在html

5、页面任意位置rowNumint在grid上显示记录条数，这个参数是要被传递到后台rowListarray一个下拉选择框，用来改变显示记录数，当选择时会覆盖rowNum参数传递到后台sortnamestring默认的排序列。可以是列名称或者是一个数字，这个参数会被提交到后台viewrecordsboolean定义是否要显示总记录数captionstring表格名称ajaxGridOptionsa1object对ajax参数进行全局设置，可以覆盖ajax事件null是ajaxSelectOptionsa2object对ajax的select参数进行全局设置null是altclassString用来

6、指定行显示的css，可以编辑自己的css文件，只有当altRows设为ture时起作用ui-priority-secondaryaltRowsboolean设置表格zebra-striped值autoencodeboolean对url进行编码false是autowidthboolean如果为ture时，则当表格在首次被创建时会根据父元素比例重新调整表格宽度。如果父元素宽度改变，为了使表格宽度能够自动调整则需要实现函数：setGridWidthfalse否cellLayoutinteger定义了单元格padding + border宽度。通常不必修改此值。初始值为5是cellEditboolea

7、n启用或者禁用单元格编辑功能false是cellsubmitString定义了单元格内容保存位置remote是cellurlString单元格提交的url空值是datastrStringxmlstring或者jsonstring空值是deselectAfterSortboolean只有当datatype为local时起作用。当排序时不选择当前行true是directionstring表格中文字的显示方向，从左向右（ltr）或者从右向左（rtr）ltr否editurlstring定义对form编辑时的url空值是emptyrecordsstring当返回的数据行数为0时显示的信息。只有当属性vi

8、ewrecords设置为ture时起作用是ExpandColClickboolean当为true时，点击展开行的文本时，treeGrid就能展开或者收缩，不仅仅是点击图片true否ExpandColumnstring指定那列来展开tree grid，默认为第一列，只有在treeGrid为true时起作用空值否footerrowa3boolean当为true时，会在翻页栏之上增加一行false否forceFitboolean当为ture时，调整列宽度不会改变表格的宽度。当shrinkToFit为false时，此属性会被忽略false否gridstatestring定义当前表格的状态：visibl

9、e or hiddenvisible否gridviewboolean构造一行数据后添加到grid中，如果设为true则是将整个表格的数据都构造完成后再添加到grid中，但treeGrid, subGrid, or afterInsertRow不能用false是heightmixed表格高度，可以是数字，像素值或者百分比150否hiddengridboolean当为ture时，表格不会被显示，只显示表格的标题。只有当点击显示表格的那个按钮时才会去初始化表格数据。false否hidegridboolean启用或者禁用控制表格显示、隐藏的按钮，只有当caption属性不为空时起效true否hover

10、rowsboolean当为false时mouse hovering会被禁用false是jsonReaderarray描述json数据格式的数组否lastpageinteger只读属性，定义了总页数0否lastsortinteger只读属性，定义了最后排序列的索引，从0开始0否loadonceboolean如果为ture则数据只从服务器端抓取一次，之后所有操作都是在客户端执行，翻页功能会被禁用false否loadtextstring当请求或者排序时所显示的文字内容Loading.否loaduistring当执行ajax请求时要干什么。disable禁用ajax执行提示；enable默认，当执行a

11、jax请求时的提示；block启用Loading提示，但是阻止其他操作enable是multikeystring只有在multiselect设置为ture时起作用，定义使用那个key来做多选。shiftKey，altKey，ctrlKey空值是multiboxonlyboolean只有当multiselect = true.起作用，当multiboxonly为ture时只有选择checkbox才会起作用false是multiselectboolean定义是否可以多选false否multiselectWidthinteger当multiselect为true时设置multiselect列宽度20

12、否pageinteger设置初始的页码1是pagerposstring指定分页栏的位置center否pgbuttonsboolean是否显示翻页按钮true否pginputboolean是否显示跳转页面的输入框true否pgtextstring当前页信息是prmNamesarrayDefault valuesprmNames: page:“page”,rows:“rows”, sort: “sidx”,order: “sord”, search:“_search”, nd:“nd”, npage:null当参数为null时不会被发到服务器端none是postDataarray此数组内容直接赋值

13、到url上，参数类型：name1:value1空array是reccountinteger只读属性，定义了grid中确切的行数。通常情况下与records属性相同，但有一种情况例外，假如rowNum=15，但是从服务器端返回的记录数是20，那么records值是20，但reccount值仍然为15，而且表格中也只显示15条记录。0否recordposstring定义了记录信息的位置：left, center, rightright否recordsinteger只读属性，定义了返回的记录数none否recordtextstring显示记录数信息。0为记录数开始，1为记录数结束。viewrecor

14、ds为ture时才能起效，且总记录数大于0时才会显示此信息resizeclassstring定义一个class到一个列上用来显示列宽度调整时的效果空值否rowListarray一个数组用来调整表格显示的记录数，此参数值会替代rowNum参数值传给服务器端。否rownumbersboolean如果为ture则会在表格左边新增一列，显示行顺序号，从1开始递增。此列名为rn.false否rownumWidthinteger如果rownumbers为true，则可以设置column的宽度25否savedRowarray只读属性，只用在编辑模式下保存数据空值否scrollboolean创建一个动态滚动的

15、表格，当为true时，翻页栏被禁用，使用垂直滚动条加载数据，且在首次访问服务器端时将加载所有数据到客户端。当此参数为数字时，表格只控制可见的几行，所有数据都在这几行中加载false否scrollOffsetinteger设置垂直滚动条宽度18否scrollrowsboolean当为true时让所选择的行可见false是selarrrowarray只读属性，用来存放当前选择的行array否selrowstring只读属性，最后选择行的idnull否shrinkToFitboolean此属性用来说明当初始化列宽度时候的计算类型，如果为ture，则按比例初始化列宽度。如果为false，则列宽度使用c

16、olModel指定的宽度true否sortableboolean是否可排序false否sortnamestring排序列的名称，此参数会被传到后台空字符串是sortorderstring排序顺序，升序或者降序（asc or desc）asc是subGridboolean是否使用suggridfalse否subGridModelarraysubgrid模型array否subGridTypemixed如果为空则使用表格的dataTypenull是subGridUrlstring加载subgrid数据的url，jqGrid会把每行的id值加到url中空值是subGridWidthintegersub

17、grid列的宽度20否toolbararray表格的工具栏。数组中有两个值，第一个为是否启用，第二个指定工具栏位置（相对于body layer），如：true,”both”。工具栏位置可选值：“top”,”bottom”, “both”.如果工具栏在上面，则工具栏id为“t_”+表格id；如果在下面则为“tb_”+表格id；如果只有一个工具栏则为“t_”+表格idfalse,否totaltimeinteger只读属性，计算加载数据的时间。目前支持xml跟json数据0否treedatatypemixed数据类型，通常情况下与datatype相同，不会变null否treeGridboolean启

18、用或者禁用treegrid模式false否treeGridModelstringtreeGrid所使用的方法Nested否treeIconsarray树的图标，默认值：plus:ui-icon-triangle-1-e,minus:ui-icon-triangle-1-s,leaf:ui-icon-radio-off否treeReaderarray扩展表格的colModel且加在colModel定义的后面否tree_root_levelnumericr oot元素的级别，0否userDataarray从request中取得的一些用户信息array否userDataOnFooterboolean

19、当为true时把userData放到底部，用法：如果userData的值与colModel的值相同，那么此列就显示正确的值，如果不等那么此列就为空false是viewrecordsboolean是否要显示总记录数false否viewsortcolsarray定义排序列的外观跟行为。数据格式：false,vertical,true.第一个参数是说，是否都要显示排序列的图标，false就是只显示当前排序列的图标；第二个参数是指图标如何显示，vertical：排序图标垂直放置，horizontal：排序图标水平放置；第三个参数指单击功能，true：单击列可排序，false：单击图标排序。说明：如果第

20、三个参数为false则第一个参数必须为ture否则不能排序否widthnumber如果设置则按此设置为主，如果没有设置则按colModel中定义的宽度计算none否xmlReaderarray对xml数据结构的描述否Jqgrid学习 -ColModel APIColModel 是jqGrid里最重要的一个属性，设置表格列的属性。属性数据类型备注默认值alignstringleft, center, right.leftclassesstring设置列的css。多个class之间用空格分隔，如：class1 class2。表格默认的css属性是ui-ellipsisempty stringdat

21、efmtstring”/”, ”-”, and ”.”都是有效的日期分隔符。y,Y,yyyy年YY, yy月m,mm for monthsd,dd日.ISO Date (Y-m-d)defvalstring查询字段的默认值空editableboolean单元格是否可编辑falseeditoptionsarray编辑的一系列选项。name:_department_id,index:_department_id,width:200,editable:true,edittype:select,editoptions: dataUrl:”$ctx/admin/deplistforstu.action”

22、,这个是演示动态从服务器端获取数据。emptyeditrulesarray编辑的规则name:age,index:age, width:90,editable:true,editrules: edithidden:true,required:true,number:true,minValue:10,maxValue:100,设定年龄的最大值为100，最小值为10，而且为数字类型，并且为必输字段。emptyedittypestring可以编辑的类型。可选值：text, textarea, select, checkbox, password, button, image and file.tex

23、tfixedboolean列宽度是否要固定不可变falseformoptionsarray对于form进行编辑时的属性设置emptyformatoptionsarray对某些列进行格式化的设置noneformattermixed对列进行格式化时设置的函数名或者类型name:sex,index:sex, align:center,width:60,editable:true,edittype:select,editoptions: value:0:待定;1:男;2:女,formatter:function(cellvalue, options, rowObject)var temp = “”re

24、turn temp;,/返回性别的图标。nonehidedlgboolean是否显示或者隐藏此列falsehiddenboolean在初始化表格时是否要隐藏此列falseindexstring索引。其和后台交互的参数为sidxemptyjsonmapstring定义了返回的json数据映射nonekeyboolean当从服务器端返回的数据中没有id时，将此作为唯一rowid使用只有一个列可以做这项设置。如果设置多于一个，那么只选取第一个，其他被忽略falselabelstring如果colNames为空则用此值来作为列的显示名称，如果都没有设置则使用name值nonenamestring表格列的名称，所有关键字，保留字都不能作为名称使用包括subgrid, cb and rn.Requiredresizableboolean是否可以被resizabletruesearchb