jqGrid报表插件——参数配置

jqGrid表格插件——参数配置

jQuery学习之：jqGrid表格插件——参数配置

?

导航栏的属性

属性名类型说明默认值是否可以被修改lastpageinteger只读属性，总页数0NOpagermixed导航栏对象，必须是一个有效的html元素，位置可以随意空字符串NOpagerposstring定义导航栏的位置，默认分为三部分：翻页，导航工具及记录信息centerNOpgbuttonsboolean是否显示翻页按钮trueNOpginputboolean是否显示跳转页面的输入框trueNOpgtextstring页面信息，第一个值是当前页第二个值是总页数语言包YESreccountinteger只读属性，实际记录数，千万不能跟records 参数搞混了，通常情况下他们是相同的，假如我们定义rowNum=15，但我们从服务器端返回的记录为20即records=20，而reccount=15，表格中也显示15条记录。0NOrecordposstring定义记录信息的位置，可选值：left, center, rightrightNOrecordsinteger只读属性，从服务器端返回的记录数noneNOrecordtextstring显示记录的信息，只有当viewrecords为true时起效，且记录数必须大于0语言包yesrowListarray[]可以改变表格可以显示的记录数，格式为[10,20,30]空array[]norowNuminteger设置表格可以显示的记录数20yesviewrecordsboolean是否要显示总记录数信息falseno?????

?

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

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

?

?

详细参数说明

属性类型说明默认值addboolean是否启用新增功能，当点击按钮时会触发editGridRow事件trueaddiconstring给新增功能设置图标，只有UI theme里的图标才可以使用ui-icon-plusaddtextstring新增按钮上的文字空addtitlestring当鼠标移到新增按钮上时显示的提示新增一行alertcapstring当我们edit,delete or view一行记录时出现的提示信息警告alerttextstring当edit,delete or view一行记录时的文本提示请选择一行记录closeOnEscapeboolean是否可以使用esc键关闭对话框truedelboolean是否启用删除功能，启用时会触发事件delGridRowtruedeliconstring设置删除按钮的图标，只有UI theme里的图标才可以使用ui-icon-trashdeltextstring设置到删除按钮上的文字信息空deltitlestring当鼠标移到删除按钮上时出现的提示删除锁选择的行editboolean是否启用可编辑功能，当编辑时会触发事件editGridRowtrueediticonstring设置编辑按钮的图标，只有UI theme里的图标才可以使用ui-icon-penciledittextstring编辑按钮上文字空edittitlestring当鼠标移到编辑按钮上出现的提示信息编辑所选择的行positionstring定义按钮位置，可选值left, center and right.leftrefreshboolean是否启用刷新按钮，当点击刷新按钮时会触发trigger(“reloadGrid”)事件，而且会清空搜索条件值truerefreshiconstring设置刷新图标，只有UI theme里的图标才可以使用ui-icon-refreshrefreshtextstring刷新按钮上文字信息空refreshtitlestring当鼠标移到刷新按钮上的提示信息重新加载refreshstatestring指明表格如何刷新。firstpage：从第一页开始刷新；current：只刷新当前页内容firstpageafterRefreshfunction当点击刷新按钮之后触发此事件nullsearchboolean是否启用搜索按钮，会触发searchGrid 事件truesearchhiconstring设置搜索按钮的图标，只有UI theme里的图标才可以使用ui-icon-searchsearchtextstring搜索按钮上的文字空searchtitlestring当鼠标移到搜索按钮上的提示信息搜索viewboolean是否启用查看按钮，会触发事件viewGridRowfalseviewiconstring设置查看按钮的图标，只有UI theme里的图标才可以使用ui-icon-documentviewtextstring查看按钮上文字空viewtitlestring当鼠标移到查看按钮上的提示信息查看所选记录????

?

在$("#tableId").jqGrid(optional);中，optional对象包含如下的属性：（属性按字母顺序排列）

参数名称参数类型描述默认值是否可以被修改ajaxGridOptionsobject对ajax参数进行全局设置，可以覆盖ajax事件：error，complete 和 beforeSend空值是ajaxGridOptionsobject对ajax参数进行全局设置空值是ajaxSelectOptionsobject对ajax的select参数进行全局设置，设置editoptions跟searchoptions 参数的select属性值空值是altclassString用来指定行显示的css，可以编辑自己的css文件，只有当altRows设为 ture时起作用ui-priority-secondary是，但需要重新加载altRowsboolean设置表格 zebra-striped 值false是，需重新加载autoencodeboolean当为 ture 时对url进行编码false是autowidthboolean如果为ture时，则当表格在首次被创建时会根据父元素比例重新调整表格宽度。如果父元素宽度改变，为了使表格宽度能够自动调整则需要实现函数：setGridWidthfalse否captionString定义表格名称空值否，但是可以用api修改cellLayoutinteger定义了单元格padding + border 宽度。通常不必修改此值。初始值为5，paddingLef?2+paddingRight?2+borderLeft?1=55否cellEditboolean启用或者禁用单元格编辑功能false是cellsubmitString定义了单元格内容保存位置：“remote”，“clientArray”‘remote’是cellurlString单元格提交的url空值是colModelarray描述列信息的数组空值否colNamesarray[]放置列名称的数组，必须与colModel大小相同空数组否datastrStringxmlstring或者jsonstring空值是datatypestring表格可以被接受的数据类型：xml，xmlstring，json，local，functionxml是deselectAfterSortboolean只有当datatype为local时起作用。当排序时不选择当前行true是directionstring表格中文字的显示方向，从左向右（ltr）或者从右向左（rtr）。ltr否editurlstring定义对form编辑时的url空值是emptyrecordsstring当返回的数据行数为0时显示的信息。只有当属性 viewrecords 设置为ture时起作用在语言包中是ExpandColClickboolean当为true时，点击展开行的文本时，treeGrid就能展开或者收缩，不仅仅是点击图片true否ExpandColumnstring指定那列来展开tree grid，默认为第一列，只有在treeGrid为true时起作用空值否footerrowboolean当为true时，会在翻页栏之上增加一行false否forceFitboolean当为ture时，调整列宽度不会改变表格的宽度。当shrinkToFit 为false时，此属性会被忽略false否gridstatestring定义当前表格的状态：'visible' or 'hidden'visible否gridviewboolean构造一行数据后添加到grid中，如果设为true则是将整个表格的数据都构造完成后再添加到grid中，但treeGrid, subGrid, or afterInsertRow 不能用false是heightmixed表格高度，可以是数字，像素值或者百分比150否hiddengridboolean当为ture时，表格不会被显示，只显示表格的标题。只有当点击显示表格的那个按钮时才会去初始化表格数据。只有当caption 属性不为空而且hidegrid为ture时才起作用false否hidegridboolean启用或者禁用控制表格显示、隐藏的按钮，只有当caption 属性不为空时起效true否hoverrowsboolean当为false时mouse hovering会被禁用false是jsonReaderarray描述json 数据格式的数组，
否lastpageinteger只读属性，定义了总页数0否lastsortinteger只读属性，定义了最后排序列的索引，从0开始0否loadonceboolean如果为ture则数据只从服务器端抓取一次，之后所有操作都是在客户端执行，翻页功能会被禁用false否loadtextstring当请求或者排序时所显示的文字内容Loading....否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时只有选择checkbox才会起作用，false是multiselectboolean定义是否可以多选false否multiselectWidthinteger当multiselect为true时设置multiselect列宽度20否pageinteger设置初始的页码1是pagermixed指定分页栏对象，必须为一个有效的html元素。可以是'pager', '#pager', jQuery('#pager').推荐用'#pager'空值否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此数组内容直接赋值到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}为记录数结束。 viewrecords为ture时才能起效，且总记录数大于0时才会显示此信息语言包是resizeclassstring定义一个class到一个列上用来显示列宽度调整时的效果空值否rowListarray[]一个数组用来调整表格显示的记录数，此参数值会替代rowNum参数值传给服务器端。如果为空则不显示，设置格式：[10,20,30]。[]否rownumbersboolean如果为ture则会在表格左边新增一列，显示行顺序号，从1开始递增。此列名为'rn'.false否rowNuminteger设置表格中显示的记录数，参数会被自动传到后台。如果此参数设为10，但是从服务器端返回15条记录，那么在表格中只会显示10条记录。如果设为-1则禁用此检查20是rownumWidthinteger如果rownumbers为true，则可以设置column的宽度25否savedRowarray只读属性，只用在编辑模式下保存数据空值否scrollboolean or integer创建一个动态滚动的表格，当为true时，翻页栏被禁用，使用垂直滚动条加载数据，且在首次访问服务器端时将加载所有数据到客户端。当此参数为数字时，表格只控制可见的几行，所有数据都在这几行中加载false否scrollOffsetinteger设置垂直滚动条宽度18否scrollrowsboolean当为true时让所选择的行可见false是selarrrowarray-[]只读属性，用来存放当前选择的行empty array []否selrowstring只读属性，最后选择行的idnull否shrinkToFitboolean此属性用来说明当初始化列宽度时候的计算类型，如果为ture，则按比例初始化列宽度。如果为false，则列宽度使用colModel指定的宽度true否sortableboolean是否可排序false否sortnamestring排序列的名称，此参数会被传到后台空字符串是sortorderstring排序顺序，升序或者降序（asc or desc）asc是subGridboolean是否使用suggridfalse否subGridModelarray-[]subgrid模型empty array否subGridTypemixed如果为空则使用表格的dataTypenull是subGridUrlstring加载subgrid数据的url，jqGrid会把每行的id值加到url中空值是subGridWidthintegersubgrid列的宽度20否toolbararray表格的工具栏。数组中有两个值，第一个为是否启用，第二个指定工具栏位置（相对于body layer），如：[true,”both”] 。工具栏位置可选值：“top”,”bottom”, “both”. 如果工具栏在上面，则工具栏id为“t_”+表格id；如果在下面则为 “tb_”+表格id；如果只有一个工具栏则为 “t_”+表格id[false,'']否totaltimeinteger只读属性，计算加载数据的时间。目前支持xml跟json数据0否treedatatypemixed数据类型，通常情况下与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否urlstringurlnull是userDataarray从request中取得的一些用户信息empty array否userDataOnFooterboolean当为true时把userData放到底部，用法：如果userData的值与colModel的值相同，那么此列就显示正确的值，如果不等那么此列就为空false是viewrecordsboolean是否要显示总记录数false否viewsortcolsarray定义排序列的外观跟行为。数据格式：[false,'vertical',true].第一个参数是说，是否都要显示排序列的图标，false就是只显示当前排序列的图标；第二个参数是指图标如何显示，vertical：排序图标垂直放置，horizontal：排序图标水平放置；第三个参数指单击功能，true：单击列可排序，false：单击图标排序。说明：如果第三个参数为false则第一个参数必须为ture否则不能排序
否widthnumber如果设置则按此设置为主，如果没有设置则按colModel中定义的宽度计算none否xmlReaderarray对xml数据结构的描述
否

?

?

?

参考：http://polaris1119.javaeye.com/blog/559634

http://a3mao.javaeye.com/blog/542542

查看更多 下一篇