jqGrid 属性中文详解(一)

以下内容描述格式是：属性名称

　　参数值类型

　　描述内容(可能有多行)

　　默认值

　　是否可修改(表示grid创建完成之后，该属性是否能够被修改。也就是说，是否grid的初始化的属性值能够被修改)

　　————详细属性列表————

　　ajaxGridOptions

　　object

　　本选项用来设置全局的Ajax设置。注意：这个选项会覆盖当前所有的ajax设置，包括ajax的error、complete以及beforeSend事件。

　　默认值:empty object

　　该属性可以修改

　　ajaxSelectOptions

　　object

　　本选项用来设置select元素的ajax全局设置。在searchoptions选项或者editoptions选项属性设置中，可以通过设置 dataUrl来获取生成一个select的下拉框内容的URL。jqGrid通过ajax的方式访问这个URL来自动获取可选择值。

　　注意：这里要求通过dataUrl返回的结果是形如<select><option value =http://blog.soso.com/qz.q/”1”>One</option><option value=”2”>Two</option></select>这种格式的字符串。当然，其实也可以直接返回 1：One；2：Two这种格式的数据，但是要通过另外一个选项进行处理，处理之后还是要变成上面的字符串。比如searchOptions中，就有一个属性是buildSelect，就是用来干这事儿的。

　　默认值:empty object

　　该属性可以修改

　　altclass

　　string

　　用来设置jqGrid的交替行的class。只有设置了altRows为true才有效。

　　默认值:ui-priority-secondary

　　该属性可以修改. Requires reload

　　altRows

　　boolean

　　设置jqGrid显示为斑马线样式。就是隔行用不同的背景色区分开。

　　默认值:false

　　该属性可以修改. After reload

　　autoencode

　　boolean

　　设置为true，会对从服务器返回的数据以及编辑模式下提交的数据进行HTML编码。比如，把小于符号转换成<

　　默认值:false

　　该属性可以修改

　　autowidth

　　boolean

　　设置为true，grid的宽度会根据父元素的宽度自动重新计算。注意，这个值是在初始化的时候设定好了，如果要在运行中设置宽度，需要通过setGridWidth方法来修改。

　　默认值:false

　　该属性不能修改

　　caption

　　string

　　设置Grid的标题.

　　默认值:empty string

　　该属性不能修改.Method avail.

　　cellLayout

　　integer

　　本选项设置单元格的padding + border宽度. 一般情况下不要去修改。

　　默认值:5

　　该属性不能修改

　　cellEdit

　　boolean

　　设置Cell Editing模式是否启用。

　　默认值:false

　　该属性可以修改

　　cellsubmit

　　string

　　确定Cell Editing模式下，内容保存到远程服务器还是本地数组。'remote' 或者 'clientArray'。

　　默认值:'remote'

　　该属性可以修改

　　cellurl

　　string

　　确定Cell Editing模式下，访问的URL。

　　默认值:null

　　该属性可以修改

　　colModel

　　array

　　重要的属性。用来设置列名称。

　　默认值:empty array

　　该属性不能修改

　　colNames

　　array[]

　　重要的属性。用来设置Grid每一个列的属性，一个列作为一个数组元素设置。Name属性是必须的。

　　注意：这里的数组长度（也就是列数）必须和colModel数组的长度一致。更详细的内容，需要单独说明。

　　默认值:empty array[]

　　该属性不能修改

　　datastr

　　string

　　如果datatype属性设置为xmlstring或者jsonstring的情况下，本属性用来设置其值。

　　默认值:null

　　该属性可以修改

　　datatype

　　string

　　确定grid中显示的数据源格式。

　　xml xml数据;

　　xmlstring 被当做字符串的xml数据；

　　json JSON格式数据；

　　jsonstring 被当做字符串的JSON数据；

　　local 定义在客户端的数组数据；

　　javascript javascript的数据

　　function 客户定义函数用来获取数据；

　　默认值:xml

　　该属性可以修改

　　deselectAfterSort

　　boolean

　　只有当datatype设置为local才有效。当排序之后，是否重新选择排序之前选中的行(多行)。

　　默认值:true

　　该属性可以修改

　　direction

　　string

　　确定grid中文本显示的方向。默认ltr表示从左道右。还有一个可选值是rtl表示从右到左。

　　本选项只在FireFox 3.x和IE >=6的浏览器有效。当前Safai和Google Chrome、Opera不完全支持“rtl”。FireFox默认设置是不支持RTL的，但是可以通过修改FireFox的 layout.scrollbar.side设置为1来支持。本属性是在jqGrid v3.6版本中新增加的。

　　默认值:ltr

　　该属性不能修改

　　editurl

　　string

　　设置编辑的URL地址。

默认值:null

　　该属性可以修改

　　emptyrecords

　　string

　　设置当查询记录条数是0的情况下，jqGrid上显示的信息。只有当viewrecords选项设置为true才有效。

　　默认值:see lang file

　　该属性可以修改

　　ExpandColClick

　　boolean

　　设置为true，当我们点击treeGrid的文本时候，会展开或者收缩内容

　　默认值:true

　　该属性不能修改

　　ExpandColumn

　　string

　　制定到底那一列(colModel的name名称来指定)用来展开树形grid.如果没有设置，默认是第一列。只有当treeGrid选项设置为true才有效。

　　默认值:null

　　该属性不能修改

　　footerrow

　　boolean

　　如果设置为true，则会在grid的底部，导航条之上显示一个只有一行的table。列的数量和colModel定义的数量一致。

　　默认值:false

　　该属性不能修改

　　forceFit

　　boolean

　　如果设置为true，并且用户改变了列宽度，那么右边临近的列宽度会自动调整以适应grid的整体宽度。这种情况下，是没有水平滚动条的。

　　注意：本选项与shrinkToFit选项不相容。如果shrinkToFit设置为false，那么forceFit的设置将被忽略。

　　默认值:false

　　该属性不能修改

　　gridstate

　　string

　　设置grid的状态。有两个可选值'visible'和'hidden'

　　默认值:visible

　　该属性不能修改

　　gridview

　　boolean

　　在包括jqGrid v3.4.X之前的版本中，读取大数据集会存在速度问题。主要原因就是每一个单元格都是用了5-6条jQuery调用被插入到grid中。现在我们可以通过设置gridview 选项为true来解决这个问题。这时候，我们用一个jQuery追加一次插入整行的数据。比以前快了3-5倍。

　　当然，使用也有限制，设置为true之后，不能使用treeGrid，subGrid或者afterInsertRow事件。

　　默认值:false

　　该属性可以修改

　　height

　　mixed

　　Grid的高度设置。如果设置为’100%’那么高度可以自适应。不过要注意，假设我们设置每页显示的条数是50条记录，设置height=’100%’,可能后面的一些记录显示不出来。默认情况下，grid是没有垂直滚动条的。

　　默认值:150

　　该属性不能修改.Method avail.

　　hiddengrid

　　boolean

　　设置为true，grid初始显示是隐藏的。隐藏情况下，数据没有加载(没有向服务器的请求)，只显示标题。当grid第一次显示的时候，才提交服务器请求并显示数据。

　　默认值:false

　　该属性不能修改

　　hidegrid

　　boolean

　　设置grid的隐藏/显示按钮是否可用。

　　默认值:true

　　该属性不能修改

　　hoverrows

　　boolean

　　设置为false，在grid的数据行中鼠标悬浮被禁用。

　　默认值:false

　　该属性可以修改

　　jsonReader

　　array

　　定义json数据的格式描述信息。我们默认期望的数据格式是：默认的数据根节点名称是rows，当前页的名称是page……。假设我们服务器返回的数据，root的名称不是rows而是datas，page的名称不是page而是currentPage，那么可以如下重新定义jsonReader来读取数据：

　　jsonReader:{

　　root:”datas”,

　　page:”currentPage”

　　}

　　默认值:无

　　该属性不能修改

　　lastpage

　　integer

　　只读属性，指定请求总共可以返回多少页。

　　默认值:0

　　该属性不能修改

　　lastsort

　　integer

　　只读属性。指定了最后排序列。从0开始计数。

　　默认值:0

　　该属性不能修改

　　loadonce

　　boolean

　　如果设置为true，grid只从服务器加载一次数据。加载数据完成之后，datatype就被指定为local，并且以后所有的操作都是基于客户端的操作，同时，导航功能也会被禁用。

　　默认值:false

　　该属性不能修改

　　loadtext

　　string

　　请求或者排序数据的时候，显示在页面上的等待信息内容。

　　默认值:Loading…

　　该属性不能修改

　　loadui

　　string

　　本选项控制在一个ajax请求执行过程中做什么。

　　disable jqGrid的指示信息不可用。

　　enable - 显示 “Loading”信息。

　　block 可以显示“Loading”信息，同时阻止grid的所有操作直到ajax请求完成。注意，这会禁止所有的排序、导航或者任何工具条的操作。

　　默认值:enable

　　该属性可以修改

　　mtype

　　string

　　确定请求方式。“POST”或“GET”

　　默认值:GET

　　该属性可以修改

　　multikey

　　string

　　只有当multiselect选项设置为true的时候才有意义。定义使用哪一个键来做多选。可选值: shiftKey/altKey/ctrlKey

　　默认值:empty string

　　该属性可以修改

　　multiboxonly

　　boolean

　　只有当multiselect = true时起作用，如果multiselect设置为true，那么点击行任何位置都可以选中行。当multiboxonly设置为ture之后，就只有点击行前面的checkbox才会选中行。如果点击其它没有被选中的行，那么点中的行被选择，其它行取消选择。(Yahoo模式)

 

默认值:false

　　该属性可以修改

　　multiselect

　　boolean

　　定义grid中的数据行是否可以被多选。会在grid的最左边增加一列checkbox的选择框。

　　默认值:false

　　该属性不能修改. see HOWTO

　　multiselectWidth

　　integer

　　当multiselect为true时设置multiselect列宽度

　　默认值:20

　　该属性不能修改

　　page

　　integer

　　设置初始的页码。这个参数会被自动添加到URL后面，传递到后台服务器处理程序中。

　　默认值:1

　　该属性可以修改

　　pager

　　mixed

　　指定导航条对象，这里要使用jQuery的语法来指定一个实际存在的html元素对象。大部分情况下，都是指定一个div对象的ID。

　　有几种方式指定：(假设div的id=nav)

　　jQuery(‘#nav’)

　　‘#nav’(推荐用这种方式调用)

　　‘nav’

　　默认值:empty string. Currently only one pagebar is possible.

　　该属性不能修改

　　pagerpos

　　string

　　确定pager在grid中的位置。默认情况下，pager被分成三个部分。一部分用来显示pager，一部分用作导航条按钮，一部分用来显示记录信息。

　　默认值:center

　　该属性不能修改

　　pgbuttons

　　boolean

　　确定是否显示pager的按钮。

　　默认值:true

　　该属性不能修改

　　pginput

　　boolean

　　确定是否显示允许用户直接输入页码进行跳转的输入框。

　　默认值:true

　　该属性不能修改

　　pgtext

　　string

　　显示关于当前页状态的信息。第一个参数是当前页码，第二个参数是总共的页数。

　　默认值:See lang file

　　该属性可以修改

　　prmNames

　　array

　　定制传递到服务器上的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

　　通过这个属性的设置，可以改变字段的名称。

　　默认值:none

　　该属性可以修改

　　postData

　　array

　　设置直接通过url传递到服务器的其他参数。本属性的调用方式是传递一个形如{name1:value,name2:value2…}的数组。

　　默认值:empty array

　　该属性可以修改

　　reccount

　　integer

　　只读属性。确定grid中显示的记录数量。不要把这个属性和records参数混淆了。records参数确定每页最多可以显示的数据条数。

　　默认值:0

　　该属性不能修改

　　recordpos

　　string

　　确定记录条数信息在pager上面的位置。可能的值是left, center, right

　　默认值:right

　　该属性不能修改

　　records

　　integer

　　只读属性。确定从请求返回的记录条数。

　　默认值:none

　　该属性不能修改

　　recordtext

　　string

　　显示在pager上面的信息。在viewrecords属性被设置为true时有效。只有在总数量大于0的时候才显示。

　　这是一个用{n}格式化的显示字符串。其中第一个参数{0}代表记录的起始位置（grid显示的第一条记录在所有记录中的位置），第二个参数{1}表示grid最后一条记录在总记录中的位置，第三个参数{2}代表总的记录条数。

　　比如：从{0}到{1}共{2}

　　默认值:see lang file

　　该属性可以修改

　　resizeclass

　　string

　　为列指定一个调整宽度时候的现实风格class。

　　默认值:empty string

　　该属性不能修改

　　rowList

　　array[]

　　本参数用来为grid生成一个可供选择的调整每页显示记录条数的下拉菜单。在grid中选择修改这个值，jqGrid会用新的选择值来修改rowNum参数并传递到服务器端。可以设置的格式如 [10,20,30]

　　默认值:empty array - []

　　该属性不能修改

　　rownumbers

　　boolean

　　如果设置为true，则会在grid的左边增加一列，增加的列用来显示记录行数，记录从1开始显示。这种情况下，colModel被一个name为rn的列自动扩展。由此，我们要注意了，在我们自己定义的列中，不要使用name=’rn’这种名称。

　　默认值:false

　　该属性不能修改

　　rowNum

　　integer

　　设置每一个grid的页做多显示多少条记录。

　　这个参数会通过url参数传递到服务器端进行分页处理。

　　注意，如果你设置了页面最多显示10条记录，也就是rowNum=10，但是服务器端返回了15条记录，页面上也只会显示10条记录。

　　设置本值为-1表示页面显示记录没有限制。

　　默认值:20

　　该属性可以修改

　　rownumWidth

　　integer

　　如果rownumbers设置为true，本属性用来设置该列的宽度。

　　默认值:25