js表格框架36中文api.doc

《js表格框架36中文api.doc》由会员分享，可在线阅读，更多相关《js表格框架36中文api.doc（66页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、【精品文档】如有侵权，请联系网站删除，仅供学习与交流js表格框架36中文api.精品文档.Jqgrid 中文文档jqGrid学习 - 原理2jqGrid学习之 - 皮肤2jqGrid学习2jQuery学习之：jqGrid表格插件参数配置4jqGrid学习 -自定义搜索14jqGrid学习 - 搜索工具栏16jqGrid学习 - 搜索17jqGrid学习 - 自定义格式化类型19jqGrid学习 - 格式化21jqGrid学习 - 自定义按钮26jqGrid学习 - 翻页（2）28jqGrid学习 - 翻页33jqGrid学习 - 配置json35jqGrid学习 - 方法37jqGrid学习

2、- 事件45jqGrid学习 - 数据48jqGrid学习 - ColModel API55jqGrid学习 - 参数（2）57jqGrid学习 - jqGrid参数63jqGrid学习 - 第一个实例63使用jqGrid修改数据并检查69jqGrid学习 - 原理jqGrid是典型的B/S架构，服务器端只是提供数据管理，客户端只提供数据显示。换句话说，jqGrid可以以一种更加简单的方式来展现你数据库的信息，而且也可以把客户端数据传回给服务器端。 对于jqGrid我们所关心的就是：必须有一段代码把一些页面信息保存到数据库中，而且也能够把响应信息返回给客户端。jqGrid是用ajax来实现对请

3、求与响应的处理。 大小: 18.3 KB jqGrid学习之 - 皮肤jqGrid皮肤 从3.5版本开始，jqGrid完全支持jquery UI的theme。我们可以从 也并不需要把所有的css文件都引入进来，只需导入核心css文件“ui.theme.css ” 以及“ui.core.css”即可，文件位于目录development-bundle/themes下。 jqGrid学习jqGrid学习之 - 安装 jqGrid安装很简单，只需把相应的css、js文件加入到页面中即可。 按照官网文档： * /myproject/css/ o ui.jqgrid.css o /ui-lightness

4、/ + /images/ + jquery-ui-1.7.2.custom.css * /myproject/js/ o /i18n/ + grid.locale-bg.js + list of all language files + . o Changes.txt o jquery-1.3.2.min.js o jquery.jqGrid.min.js 目录结构如上。 在页面中写法： Java代码 1. 2. 3. 4. 5. MyFirstGrid 6. 7. 8. 9. 10. html,body 11. margin:0; 12. padding:0; 13. font-size:7

5、5%; 14. 15. 16. 17. 18. 19. 20. My First Gridhtml, body margin: 0; padding: 0; font-size: 75%;需要说明的是，jquery-ui的字体大小与jqgrid字体大小不一致，故需要在页面上在加上一段 style来指定页面上文字大小。jQuery学习之：jqGrid表格插件参数配置由于jqGrid功能强大，配置比较复杂，在第一个例子中，对于jqGrid的配置参数没有进行什么解释。从现在开始，会陆续介绍jqGrid的参数。这 些参数的详细介绍请查看官方文档。由于本人英语水平有限，翻译不好，请多原谅。（为了保证连贯

6、性，翻译时引用了 ，在此感谢。但在他的基础上增加了一些内容。） 上有很多jqGrid的API，大家可以查看。在$(#tableId).jqGrid(optional);中，optional对象包含如下的属性：（属性按字母顺序排列）参数名称参数类型描述默认值是否可以被修改ajaxGridOptionsobject对ajax参数进行全局设置，可以覆盖ajax事件：error，complete 和 beforeSend 空值是ajaxGridOptionsobject对ajax参数进行全局设置空值是ajaxSelectOptionsobject对ajax的select参数进行全局设置，设置edito

7、ptions跟searchoptions 参数的select属性值空值是altclassString用来指定行显示的css，可以编辑自己的css文件，只有当altRows设为 ture时起作用ui-priority-secondary是，但需要重新加载altRowsboolean设置表格 zebra-striped 值false是，需重新加载autoencodeboolean当为 ture 时对url进行编码false是autowidthboolean如果为ture时，则当表格在首次被创建时会根据父元素比例重新调整表格宽度。如果父元素宽度改变，为了使表格宽度能够自动调整则需要实现函数：setG

8、ridWidth false否captionString定义表格名称空值否，但是可以用api修改cellLayoutinteger定义了单元格padding + border 宽度。通常不必修改此值。初始值为5，paddingLef2+paddingRight2+borderLeft1=55否cellEditboolean启用或者禁用单元格编辑功能false是cellsubmitString定义了单元格内容保存位置：“remote”，“clientArray”remote是cellurlString单元格提交的url空值是colModelarray描述列信息的数组空值否colNamesarra

9、y放置列名称的数组，必须与colModel大小相同空数组否datastrStringxmlstring或者jsonstring空值是datatypestring表格可以被接受的数据类型：xml，xmlstring，json，local，function xml是deselectAfterSortboolean只有当datatype为local时起作用。当排序时不选择当前行true是directionstring表格中文字的显示方向，从左向右（ltr）或者从右向左（rtr）。ltr否editurlstring定义对form编辑时的url空值是emptyrecordsstring当返回的数据行数为

10、0时显示的信息。只有当属性 viewrecords 设置为ture时起作用在语言包中是ExpandColClickboolean当为true时，点击展开行的文本时，treeGrid就能展开或者收缩，不仅仅是点击图片true否ExpandColumnstring指定那列来展开tree grid，默认为第一列，只有在treeGrid为true时起作用空值否footerrowboolean当为true时，会在翻页栏之上增加一行false否forceFitboolean当为ture时，调整列宽度不会改变表格的宽度。当shrinkToFit 为false时，此属性会被忽略false否gridstates

11、tring定义当前表格的状态：visible or hiddenvisible否gridviewboolean构造一行数据后添加到grid中，如果设为true则是将整个表格的数据都构造完成后再添加到grid中，但treeGrid, subGrid, or afterInsertRow 不能用false是heightmixed表格高度，可以是数字，像素值或者百分比150否hiddengridboolean当为ture时，表格不会被显示，只显示表格的标题。只有当点击显示表格的那个按钮时才会去初始化表格数据。只有当caption 属性不为空而且hidegrid为ture时才起作用false否hide

12、gridboolean启用或者禁用控制表格显示、隐藏的按钮，只有当caption 属性不为空时起效true否hoverrowsboolean当为false时mouse hovering会被禁用false是jsonReaderarray描述json 数据格式的数组，否lastpageinteger只读属性，定义了总页数0否lastsortinteger只读属性，定义了最后排序列的索引，从0开始0否loadonceboolean如果为ture则数据只从服务器端抓取一次，之后所有操作都是在客户端执行，翻页功能会被禁用false否loadtextstring当请求或者排序时所显示的文字内容Loadin

13、g.否loaduistring当执行ajax请求时要干什么。disable 禁用ajax执行提示；enable 默认，当执行ajax请求时的提示； block 启用Loading提示，但是阻止其他操作enable是mtypestring请求的类型：(“POST” or “GET”)GET是multikeystring只有在multiselect设置为ture时起作用，定义使用那个key来做多选。shiftKey ，altKey ，ctrlKey 空值是multiboxonlyboolean只有当multiselect = true.起作用，当multiboxonly 为ture时只有选择che

14、ckbox才会起作用，false是multiselectboolean定义是否可以多选false否multiselectWidthinteger当multiselect为true时设置multiselect列宽度20否pageinteger设置初始的页码1是pagermixed指定分页栏对象，必须为一个有效的html元素。可以是pager, #pager, jQuery(#pager).推荐用#pager空值否pagerposstring指定分页栏的位置center否pgbuttonsboolean是否显示翻页按钮true否pginputboolean是否显示跳转页面的输入框true否pgte

15、xtstring当前页信息语言包中设置是prmNamesarrayDefault valuesprmNames: page:“page”,rows:“rows”, sort: “sidx”,order: “sord”, search:“_search”, nd:“nd”, npage:null 当参数为null时不会被发到服务器端none是postDataarray此数组内容直接赋值到url上，参数类型：name1:value1空array是reccountinteger只读属性，定义了grid中确切的行数。通常情况下与records属性相同，但有一种情况例外，假如rowNum=15，但是从服

16、务器端返回的记录数是20，那么records值是20，但reccount值仍然为15，而且表格中也只显示15条记录。0否recordposstring定义了记录信息的位置： left, center, rightright否recordsinteger只读属性，定义了返回的记录数none否recordtextstring显示记录数信息。0 为记录数开始，1为记录数结束。 viewrecords为ture时才能起效，且总记录数大于0时才会显示此信息语言包是resizeclassstring定义一个class到一个列上用来显示列宽度调整时的效果空值否rowListarray一个数组用来调整表格显示

17、的记录数，此参数值会替代rowNum参数值传给服务器端。如果为空则不显示，设置格式：10,20,30。否rownumbersboolean如果为ture则会在表格左边新增一列，显示行顺序号，从1开始递增。此列名为rn.false否rowNuminteger设置表格中显示的记录数，参数会被自动传到后台。如果此参数设为10，但是从服务器端返回15条记录，那么在表格中只会显示10条记录。如果设为-1则禁用此检查20是rownumWidthinteger如果rownumbers为true，则可以设置column的宽度25否savedRowarray只读属性，只用在编辑模式下保存数据空值否scrollb

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

19、果为ture，则按比例初始化列宽度。如果为false，则列宽度使用colModel指定的宽度true否sortableboolean是否可排序false否sortnamestring排序列的名称，此参数会被传到后台空字符串是sortorderstring排序顺序，升序或者降序（asc or desc）asc是subGridboolean是否使用suggridfalse否subGridModelarray-subgrid模型empty array否subGridTypemixed如果为空则使用表格的dataTypenull是subGridUrlstring加载subgrid数据的url，jqGr

20、id会把每行的id值加到url中空值是subGridWidthintegersubgrid列的宽度20否toolbararray表格的工具栏。数组中有两个值，第一个为是否启用，第二个指定工具栏位置（相对于body layer），如：true,”both” 。工具栏位置可选值：“top”,”bottom”, “both”. 如果工具栏在上面，则工具栏id为“t_”+表格id；如果在下面则为 “tb_”+表格id；如果只有一个工具栏则为 “t_”+表格idfalse, 否totaltimeinteger只读属性，计算加载数据的时间。目前支持xml跟json数据0否treedatatypemixed

21、数据类型，通常情况下与datatype相同，不会变null否treeGridboolean启用或者禁用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_levelnumericroot元素的级别，0否urlstringurlnu

22、ll是userDataarray从request中取得的一些用户信息empty array否userDataOnFooterboolean当为true时把userData放到底部，用法：如果userData的值与colModel的值相同，那么此列就显示正确的值，如果不等那么此列就为空false是viewrecordsboolean是否要显示总记录数false否viewsortcolsarray定义排序列的外观跟行为。数据格式：false,vertical,true.第一个参数是说，是否都要显示排序列的图标，false就是只显示当前排序列的图标；第二个参数是指图标如何显示，vertical：排序

23、图标垂直放置，horizontal：排序图标水平放置；第三个参数指单击功能，true：单击列可排序，false：单击图标排序。说明：如果第三个参数为false则第一个参数必须为ture否则不能排序否widthnumber如果设置则按此设置为主，如果没有设置则按colModel中定义的宽度计算none否xmlReaderarray对xml数据结构的描述否另外 还列出了常用的参数。如下：url获取数据的地址datatype从服务器端返回的数据类型，默认xml。可选类型：xml，local，json，jsonnp，script，xmlstring，jsonstring，clientsidemtype

24、ajax提交方式。POST或者GET，默认GETcolNames列显示名称，是一个数组对象。colModel对显示列属性的设置，是一个数组对象。常用到的属性：name 列显示的名称；index 传到服务器端用来排序用的列名称；width 列宽度；align 对齐方式；sortable 是否可以排序pager定义翻页用的导航栏，必须是有效的html元素。翻页工具栏可以放置在html页面任意位置rowNum在grid上显示记录条数，这个参数是要被传递到后台rowList一个下拉选择框，用来改变显示记录数，当选择时会覆盖rowNum参数传递到后台sortname默认的排序列。可以是列名称或者是一个数

25、字，这个参数会被提交到后台viewrecords定义是否要显示总记录数caption表格名称另外，“是否可以被修改”的意思是：在表格创建后，参数是否能够或不能够被修改。换言之，在表格中的初始默认值能否被修改。 设置全局参数： 有时，我们想改变参数的默认值，且希望这种改变能够同时运用于多个表格。此时，我们可以使用 jQuery 的 extend 函数实现。 这里给一个例子：假设你想有一个行交替变色的表格，且希望所有的表格都是如此，并且，你不想每次（每构建一个表格）都配置相同的参数。这时你可以使用这种方式，只需配置一次即可。 Html代码 1. 2. 3. 4. 5. MyFirstGrid6.

26、7. 8. 9. html,body 10. margin:0; 11. padding:0; 12. font-size:75%; 13. 14. 15. 16. 17. 18. /HerewesetagloballythealtRowsoption 19. jQuery.extend(jQuery.jgrid.defaults,altRows:true); 20. 21. 22. jQuery(document).ready(function() 23. jQuery(#list).jqGrid( 24. url:example.php, My First Gridhtml, body m

27、argin: 0; padding: 0; font-size: 75%;/ Here we set a globally the altRows optionjQuery.extend(jQuery.jgrid.defaults, altRows:true );jQuery(document).ready(function() jQuery(#list).jqGrid( url:example.php,你也可以增加其他你想设置的参数。 覆盖全局参数： 在上面的例子中，我们学习了如何为你的应用程序中所有的表格设置共用的参数。然而，有些表格可能需要用其他的参数值，即需要对我们上，面设置的全局参数

28、进行改变，以用于特定的表格。这时，我们可以把相应的参数改过来，即在特定的表格重新配置一次相应的属性。例如： Html代码 1. 2. 3. 4. 5. MyFirstGrid6. 7. 8. 9. html,body 10. margin:0; 11. padding:0; 12. font-size:75%; 13. 14. 15. 16. 17. 18. /HerewesetagloballythealtRowsoption 19. jQuery.extend(jQuery.jgrid.defaults,altRows:true); 20. 21. 22. jQuery(document)

29、.ready(function() 23. jQuery(#list).jqGrid( 24. url:example.php, 25. /herewedonotwantzebraforthisgrid 26. altRows:false, jqGrid学习 -自定义搜索定义自己的查询 Java代码 1. JS中使用 Java代码 1. jQuery(#mysearch).filterGrid(#grid_id,options);jQuery(#mysearch).filterGrid(#grid_id,options);grid_id:表格id options：参数 参数描述默认值gridMod