jqgrid属性和方法.doc

属性名称参数值类型描述内容默认值可修改ajaxGridOptionsObject本选项用来设置全局的Ajax设置。注意：这个选项会覆盖当前所有的ajax设置，包括ajax的error、complete以及beforeSend事件empty object可以ajaxSelectOptionsobject本选项用来设置select元素的ajax全局设置。在searchoptions选项或者editoptions选项属性设置中，可以通过设置dataUrl来获取生成一个select的下拉框内容的URL。jqGrid通过ajax的方式访问这个URL来自动获取可选择值Empty object可以altclassstring用来设置jqGrid的交替行的class。只有设置了altRows为true才有效ui-priority-secondary可以Requires reloadaltRowsboolean设置jqGrid显示为斑马线样式。就是隔行用不同的背景色区分开false可以After reload autoencodeboolean设置为true，会对从服务器返回的数据以及编辑模式下提交的数据进行HTML编码。比如，把小于符号转换成<False可以autowidthboolean设置为true，grid的宽度会根据父元素的宽度自动重新计算。注意，这个值是在初始化的时候设定好了，如果要在运行中设置宽度，需要通过setGridWidth方法来修改False不可以captionString设置grid的标题empty string不可以cellLayoutinteger设置单元格的padding + border宽度. 一般情况下不要去修改5不可以cellEditboolean设置Cell Editing模式是否启用false可以cellsubmitstring确定Cell Editing模式下，内容保存到远程服务器还是本地数组。remote 或者 clientArrayremote可以cellurlstring确定Cell Editing模式下，访问的URLnull可以colModelarray重要的属性。用来设置列名称empty array不可以colNamesarray用来设置Grid每一个列的属性，一个列作为一个数组元素设置。Name属性是必须的。 注意：这里的数组长度（也就是列数）必须和colModel数组的长度一致empty array不可以datastrstring如果datatype属性设置为xmlstring或者jsonstring的情况下，本属性用来设置其值null可以datatypestring确定grid中显示的数据源格式。 xml xml数据; xmlstring 被当做字符串的xml数据； json JSON格式数据 ； jsonstring 被当做字符串的JSON数据； local 定义在客户端的数组数据； javascript javascript的数据 function 客户定义函数用来获取数据Xml可以deselectAfterSortboolean只有当datatype设置为local才有效。当排序之后，是否重新选择排序之前选中的行(多行)。True可以directionstring确定grid中文本显示的方向。默认ltr表示从左道右。还有一个可选值是rtl表示从右到左。 本选项只在FireFox 3.x和IE =6的浏览器有效。当前Safai和Google Chrome、Opera不完全支持“rtl”。FireFox默认设置是不支持RTL的，但是可以通过修改FireFox的layout.scrollbar.side设置为1来支持。本属性是在jqGrid v3.6版本中新增加的ltr不可以editurlstring设置编辑的URL地址null可以emptyrecordsstring设置当查询记录条数是0的情况下，jqGrid上显示的信息。只有当viewrecords选项设置为true才有效see lang file可以ExpandColClickboolean设置为true，当我们点击treeGrid的文本时候，会展开或者收缩内容True不可以ExpandColumnstring制定到底那一列(colModel的name名称来指定)用来展开树形grid.如果没有设置，默认是第一列。只有当treeGrid选项设置为true才有效Null不可以footerrowboolean如果设置为true，则会在grid的底部，导航条之上显示一个只有一行的table。列的数量和colModel定义的数量一致False不可以forceFitboolean如果设置为true，并且用户改变了列宽度，那么右边临近的列宽度会自动调整以适应grid的整体宽度。这种情况下，是没有水平滚动条的。 注意：本选项与shrinkToFit选项不相容。如果shrinkToFit设置为false，那么forceFit的设置将被忽略False不可以gridstatestring设置grid的状态。有两个可选值visible和hiddenvisible不可以gridviewboolean在包括jqGrid v3.4.X之前的版本中，读取大数据集会存在速度问题。主要原因就是每一个单元格都是用了5-6条jQuery调用被插入到grid中。现在我们可以通过设置gridview 选项为true来解决这个问题。这时候，我们用一个jQuery追加一次插入整行的数据。比以前快了3-5倍。 当然，使用也有限制，设置为true之后，不能使用treeGrid，subGrid或者afterInsertRow事件False可以heightmixedGrid的高度设置。如果设置为100%那么高度可以自适应。不过要注意，假设我们设置每页显示的条数是50条记录，设置height=100%,可能后面的一些记录显示不出来。默认情况下，grid是没有垂直滚动条的150不可以hiddengridboolean设置为true，grid初始显示是隐藏的。隐藏情况下，数据没有加载(没有向服务器的请求)，只显示标题。当grid第一次显示的时候，才提交服务器请求并显示数据False不可以hidegridboolean设置grid的隐藏/显示按钮是否可用true不可以hoverrowsboolean设置为false，在grid的数据行中鼠标悬浮被禁用false可以jsonReaderarray定义json数据的格式描述信息。我们默认期望的数据格式是：默认的数据根节点名称是rows，当前页的名称是page。假设我们服务器返回的数据，root的名称不是rows而是datas，page的名称不是page而是currentPage，那么可以如下重新定义jsonReader来读取数据： jsonReader: root:”datas”, page:”currentPage” 无不可以lastpageinteger只读属性，指定请求总共可以返回多少页0不可以Loadonceboolean如果设置为true，grid只从服务器加载一次数据。加载数据完成之后，datatype就被指定为local，并且以后所有的操作都是基于客户端的操作，同时，导航功能也会被禁用false不可以loadtextstring请求或者排序数据的时候，显示在页面上的等待信息内容Loading不可以loaduistring本选项控制在一个ajax请求执行过程中做什么。 disable jqGrid的指示信息不可用。 enable - 显示 “Loading”信息。 block 可以显示“Loading”信息，同时阻止grid的所有操作直到ajax请求完成。注意，这会禁止所有的排序、导航或者任何工具条的操作enable可以mtypeString确定请求方式。“POST”或“GET”GET可以multikeystring只有当multiselect选项设置为true的时候才有意义。定义使用哪一个键来做多选。可选值: shiftKey/altKey/ctrlKeyempty string可以multiboxonlyboolean只有当multiselect = true时起作用，如果multiselect设置为true，那么点击行任何位置都可以选中行。当multiboxonly设置为ture之后，就只有点击行前面的checkbox才会选中行。如果点击其它没有被选中的行，那么点中的行被选择，其它行取消选择。(Yahoo模式)false可以multiselectboolean定义grid中的数据行是否可以被多选。会在grid的最左边增加一列checkbox的选择框False不可以multiselectWidthinteger当multiselect为true时设置multiselect列宽度20不可以pageinteger设置初始的页码。这个参数会被自动添加到URL后面，传递到后台服务器处理程序中1可以pagermixed 指定导航条对象，这里要使用jQuery的语法来指定一个实际存在的html元素对象。大部分情况下，都是指定一个div对象的ID。empty string. Currently不可以pagerposstring确定pager在grid中的位置。默认情况下，pager被分成三个部分。一部分用来显示pager，一部分用作导航条按钮，一部分用来显示记录信息center不可以pgbuttonsboolean确定是否显示pager的按钮True不可以pginputboolean确定是否显示允许用户直接输入页码进行跳转的输入框True不可以pgtextstring显示关于当前页状态的信息。第一个参数是当前页码，第二个参数是总共的页数See lang file不可以prmNamesarray定制传递到服务器上的Post数据的字段名称。默认值是： prmNames: page:“page”,rows:“rows”, sort: “sidx”,order: “sord”, search:“_search”, nd:“nd”, npage:null 默认的情况下，上传的数据如下url所示： URL?page=1&rows=10&sidx=myindex&sord=asc 如果我们设置一下本属性sort:”mysort”那么实际调用的URL地址如下： URL?page=1&rows=10&mysort=myindex&sord=asc 通过这个属性的设置，可以改变字段的名称可以postDataarray设置直接通过url传递到服务器的其他参数。本属性的调用方式是传递一个形如name1:value,name2:value2的数组empty array可以reccountinteger只读属性。确定grid中显示的记录数量。不要把这个属性和records参数混淆了。records参数确定每页最多可以显示的数据条数。0不可以recordposstring确定记录条数信息在pager上面的位置。可能的值是left, center, rightRight不可以recordsinteger只读属性。确定从请求返回的记录条数None不可以recordtextstring显示在pager上面的信息。在viewrecords属性被设置为true时有效。只有在总数量大于0的时候才显示。 这是一个用n格式化的显示字符串。其中第一个参数0代表记录的起始位置（grid显示的第一条记录在所有记录中的位置），第二个参数1表示grid最后一条记录在总记录中的位置，第三个参数2代表总的记录条数可以resizeclassstring为列指定一个调整宽度时候的现实风格classempty string可以rowListarray本参数用来为grid生成一个可供选择的调整每页显示记录条数的下拉菜单。在grid中选择修改这个值，jqGrid会用新的选择值来修改rowNum参数并传递到服务器端。可以设置的格式如 10,20,30empty array不可以rownumbersboolean如果设置为true，则会在grid的左边增加一列，增加的列用来显示记录行数，记录从1开始显示。这种情况下，colModel被一个name为rn的列自动扩展。由此，我们要注意了，在我们自己定义的列中，不要使用name=rn这种名称false不可以rowNuminteger设置每一个grid的页做多显示多少条记录。 这个参数会通过url参数传递到服务器端进行分页处理。 注意，如果你设置了页面最多显示10条记录，也就是rowNum=10，但是服务器端返回了15条记录，页面上也只会显示10条记录。 设置本值为-1表示页面显示记录没有限制20可以rownumWidthinteger如果rownumbers设置为true，本属性用来设置该列的宽度25不可以savedRowarray只读属性。本属性用在Inline Editing和Cell Editing模式下，用来在编辑行或者单元格之前保存数据empty array不可以scrollboolean or integer创建一个动态滚动的grid。如果本属性可用，pager元素被禁用，改用垂直滚动条来动态加载数据。当设置为true时，grid会在第一次加载的时候，把所有的数据取出到客户端，当scroll被设置为一个数字，grid将只显示可见的几行数据false不可以scrollOffsetinteger设置垂直滚动条宽度18不可以scrollrowsboolean设置为true，当我们用setSelection选中记录时，grid会自动滚动到选中的行记录，让该行记录可见。假设grid有垂直滚动条，当我们在Form Editing编辑模式下修改记录，用编辑页的前后导航按钮定位记录的时候，当导航到一个隐藏的行记录的时候，grid会自动滚动以使让选中的行记录变成可见False可以selarrrowArray只读属性。在multiselect=true的情况下，确定当前选中的所有行。数组中包含的值只是选中列的id，用逗号隔开。比如1,3,4,5表示选中了id为1、3、4、5的行empty array 不可以selrowstring只读属性。最后选中行的id。如果重新排序或者进行了导航，这个值为null。（也就是没有选中任何行的意思！） 这个属性很重要，很多时候，假设我们要对选中的行的数据进行一些处理，那么就必须要用到这个属性。大家可以看看jqGrid的Demo中有很多例子都用到这个属性Null不可以shrinkToFitboolean确定初始化时候每列的宽度的算法。如果设置为true，表示每列的宽度按照所有列设定的宽度值的和与grid设定的宽度按比例进行缩放。如果设置为false，则列宽按照colModel中设定的宽度显示True不可以sortableboolean设置grid是否可以按照列进行排序。这个属性用到了jQuery UI的sortable插件。要确保加载了相应的文件，同时要确保下载jqGrid的时候，包含了grid.jqueryui.js包False不可以sortnamestring当使用xml或者json数据类型时，设置默认的排序字段名称。这个参数会被增加到url上传递到服务器端empty string可以sortorderstring当使用xml或者json数据类型时，设置默认的排序方式。可选值asc或descAsc可以subGridboolean设置是否能使用subgridFalse不可以subGridModelArray设置subGrid的描述信息。只在subGrid设置为true才有效。具体可设置的属性需要参考subGrid的文档empty array不可以subGridTypemixed允许通过一个service来加载subgrid。如果没有设置，则采用父grid的datatypenull可以subGridUrlString加载subgrid数据的url，jqGrid会把每行的id值当作参数加到url中。只有在subGrid=true是才有效。如果需要传递额外的参数，请使用subGridModel中的params选项empty string可以subGridWidthinteger设置subGrid列的宽度20不可以toolbararrayGrid的工具栏。数组中有两个值，第一值指示toolbar是否可用，第二个值定义了toolbar相对于body Layer的位置，可能的值包括“top”,”bottom”, “both” 当我们设置值为true,”both”，会创建两个工具栏，一个在table的顶部，一个在table的底部。 顶部的工具栏的div的id等于”t_”+grid的Id。底部的工具栏的div的id等于”tb_” +grid的Id。 注意：当只创建一个工具栏的时候，不管位置是在顶部还是底部，工具栏的div的id都等于”t_”+grid的Idfalse,不可以totaltimeinteger只读属性。计算加载数据的时间。目前只支持加载xml以及json格式数据。从请求完成开始计算时间，到加载完最后一行记录截至0不可以treedatatypemixed树形grid情况下，datatype。通常与grid自身定义的datatype保持一致。很少会改变Null不可以treeGridboolean开启或者禁用树形grid的模式。False不可以treeGridModelstring确定treeGrid的方法。可能是nested(用父id判断，例如级别左边界右边界false：该节点有子节点，true反之是否展开)或 adjacency(用父id判断，例如级别父idfalse：该节点有子节点，true反之是否展开)nested不可以treeIconsarray树形grid使用的图标。默认值是plus:ui-icon-triangle-1-e,minus:ui-icon-triangle-1-s,leaf:ui-icon-radio-off无不可以treeReaderarray扩展grid的colModel且加在colModel定义的后面这意味着从服务器返回的数据必须包含这些字段值无不可以tree_root_levelnumerictreeGrid root元素的级别0不可以urlstring请求的URL地址Null可以userDataarray本属性包含一些从request中获取的自定义的信息。比如不想直接显示在grid中的一些数据empty array不可以userDataOnFooterboolean如果设置为true，则直接把userData中的数据显示在grid的页脚。规则是：如果userData数据包含和colModel中name一样的名字，那么userData的值就显示在该列。否则，什么都不显示False可以viewrecordsboolean确定是否显示总的记录条数。False不可以viewsortcolsarray本参数主要用来定义出现在标题附近的排序图标的不同的外观和行为。 参数数组的组成如下： false,vertical,true. 第一个参数确定，如果所有的列排序属性都是true，是否所有的图标都能同时看到。默认值false表示只有最后排序列的图标可见。 第二个参数确定图标的位置。可能的值是vertical 表示排序图标一个在另一个的上面。horizontal 表示水平放置两个图标。 第三个参数确定鼠标点击事件功能。设置为true，表示，表示点击列标题可排序；设置为false表示只能点击图标才能排序。 重要提示：如果设置第三个参数为false，那么必须要设置第一个参数为true，否则，排序功能可能丢失。无不可以widthnumber设置grid的宽度。如果本属性没有设置，则按照各个列定义在colModel中的宽度总和作为grid的宽度。如果设置了本值，则grid中每一个列的初始宽度按照shrinkToFit参数定义来确定。None不可以xmlReaderarray对xml的数据格式的说明。参考jsonReader的描述无不可以方法：方法名参数返回值说明addJSONDatadatanone使用传来的data数据填充表格。使用方法：var mygrid = jQuery(”#”+grid_id)0;var myjsongrid = eval(”(”+jsonresponse.responseText+”)”); mygrid.addJSONData(myjsongrid); myjsongrid = null; jsonresponse =null;addRowDatarowid,data, position, srcrowid成功为true, 否则为false根据参数插入一行新的数据，rowid为新行的id，data为新行的数据，position为新增行的位置，srcrowid为新增行的参考位置。data数据格式：name1:value1,name2: value2 name为在colModel中指定的名称addXMLDatadatanone根据传来的数据填充表格。用法：var mygrid = jQuery(”#”+grid_id)0; mygrid.addXmlData(xmlresponse.responseXML);clearGridDataclearfooterjqGrid对象清除表格当前加载的数据。如果clearfooter为true时则此方法删除表格最后一行的数据delRowDatarowid成功为true否则为false根据rowid删除行，但不会从服务器端删除数据footerDataaction,data, formatjgGrid对象设置或者取得底部数据。action：“get”或者“set”，默认为“get”，如果为“get”返回值为name:value，name为colModel中名称。如果为“set”则值为name：value，name是colModel中的名称。format：默认为true，当为true时，在设置新值时会调用formatter格式化数值getCellrowid, iCol单元格内容返回指定rowid，iCol的单元格内容，iCol既可以是当前列在colModel中的位置索引也可以是name值。注意：在编辑行或者单元格时不能使用此方法，此时返回的并不是改变的值，而是原始值getColcolname, returntype, mathoperationarray 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, countgetDataIDsnonearray返回当前grid里所有数据的idgetGridParamnamemixed value返回请求的参数信息getIndrowid,rowcontentmixed如果rowcontent为false，返回行所在的索引位置，id为行id。rowcontent默认为false。如果rowconent为ture则返回的为行对象，如果找不到行则返回falsegetRowDatarowid or nonearray返回指定行的数据，返回数据类型为name:value，name为colModel中的名称，value为所在行的列的值，如果根据rowid找不到则返回空。在编辑模式下不能用此方法来获取数据，它得到的并不是编辑后的值hideColcolnameorcolnamesjqGrid对象如果参数为一个列名则隐藏此列，如果给定的是数组则隐藏指定的所有列。格式： “name1”,”name2”remapColumnspermutation, updateCells, keepHeadernone调整表格列的显示顺序,permutation为当前列的顺序，假如值是1,0,2，那么第一列就会在第二位显示。如果updateCells为ture则是对单元格数据进行重新排序，如果keepHeader为true则对header数据显示位置进行调整resetSelectionnonejqGrid对象选择或者反选行数据，在多选模式下也同样起作用setCaptioncaptionjqGrid对象设置表格的标题setCellrowid,colname, data, class, propertiesjqGrid对象改变单元格的值。rowid：当前行id；colname：列名称，也可以是列的位置索引，从0开始；data：改变单元格的内容，如果为空则不更新；class：如果是string则会使用addClass方法将其加入到单元格的css中，如果是array则会直接加到style属性中；properties：设置单元格属性setGridParamobjectjqGrid对象设置grid的参数。有些参数的修改必须要重新加载grid才可以生效，这个方法可以覆盖事件setGridHeightnew_heightjqGrid对象动态改变grid的高度，只能对单元格的高度进行设置而不能对表格的高度进行动态修改。new_height：可以是象素值，百分比或者”auto”setGridWidthnew_width,shrinkjqGrid对象动态改变表格的宽度。new_width:表格宽度，象素值；shrink：true或者false，作用同shrinkToFitsetLabelcolname, data, class, propertiesjqGrid对象给指定列设置一个新的显示名称。colname：列名称，也可以是列的位置索引，从0开始；data：列显示名称，如果为空则不修改；class：如果是string则会使用addClass方法将其加入到单元格的css中，如果是array则会直接加到style属性中；properties：设置label的属性setRowDatarowid,data, cssprop成功true否则false更新行的值，rowid为行id。data值格式：name1:value1,name2: value2 name为colModel中名称；cssprop：如果是string则会使用addClass方法将其加入到行的css中，如果是array或者对象则会直接加到style属性中setSelectionrowid,onselectrowjqGrid对象选择或反选指定行。如果onselectrow为ture则会触发事件onSelectRow，onselectrow默认为tureshowColcolnamejqGrid显示列。colname可以是数组“name1”,”name2”,但是name1或者name2必须是colModel中的nametrigger(“reloadGrid”)nonejqGrid对象重新加载当前表格，也会向服务器发起新的请求updateColumnsnonenone同步表格的宽度，用在表格拖拽时，用法：var mygrid=jQuery(”#grid_id”)0;mygrid.updateColumns();以上是jqGrid的绑定方法，一下是一些通用方法（相当于静态方法）。其使用方法为.jQuery.jgrid.jqGridFunction( parameter1,.parameterN );.jqGridFunction是一个函数。parameter1,parameterN 是对应的变量。函数名参数返回值说明ajaxOptions空对象none这个函数可以改变jqgrid中用到的ajax请求参数，这个函数可以覆盖当前所有ajax请求设置。从3.6版本开始起有3个级别的ajax设置：第一个级别就是在模块中设置ajax请求；第二个级别就是通过此函数设置；第三级别的设置是控制全局ajax请求的设置：jQuery.extend(jQuery.ajax(methodspecific options, ajaxOptions,ThirdLevelajaxSettinds); 当然我们也可以单独设置ajax的参数jqIDstring解析后的string转义字符串，把两个反斜杠()转化为单个反斜杠()jgrid.htmlDecodestring转换后string把转码后的字符串还原jgrid.htmlEncodestring编码后的string把字符串编码jgrid.formatstring格式化后string简单字符串模板。用法：Example jQuery.jqgformat(“Pleaseenter a value between 0 and 1.”, 4result: “Please enter a value between 4 and 8.”jgrid.getCellIndexcellindex这个方法是用来修复在ie7里的一个bugjgrid.stringToDocxmlstringxmlDoc把xmlstring转换为dom对象jgrid.stripHtmlcontentnew_content去掉html标签返回标签中内容jgrid.parsejsonstring对象把一个jsonstring转换为json对象，方法名参数返回值说明filterGridgrid_id,paramsHTML对象构造jqGrid的查询界面。grid_id:表格id；params：参数filterToolbarparamsjqGrid对象同上。不同的是搜索输入框在header层下方getColPropcolnamearray返回指定列的属性集合。name为colModel中名称GridDestroygrid_id成功true否则false从dom上删除此gridGridUnloadgrid_id成功true否则false跟GridDestroy不同的是table对象跟pager对象并不会被删除，以便下次使用setGridStatestatejqGrid对象设置grid的状态，显示或者隐藏。这个方法不会触发onHeaderClick 事件。setColPropcolname, propertiesjqGrid对象设置新的属性，对于动态改变列属性是非常有用的，但是有些属性的修改并不会起效。用法：jQuery(”#grid_id”).setColProp(colname,editoptions:value:“True:False”); sortGridcolname, reloadjqGrid对象按指定列进行排序。效果同setGridParam(sortname:myname).trigger(reloadGrid).如果reload为true则会重新加载数据updateGridRowsdata,rowidname,jsonreader成功true否则为false修改表格中某行的数据，data数据格式：name:value,name1:value1,name:value,name2:value2，name为colModel中的名称；rowidname某行的名称。jsonreader：boolean值，默认false。如果为true则是定义数据的格式，data的值并不是name：value形式而只是value事件：事件参数备注afterInsertRowro