jQuery学习笔记--jqGrid的属性列表

 

jqGrid的属性很多，其实很大部分的属性，使用其默认值就可以了。但是详细了解一下属性的含义以及作用，对我们定制自己的grid是有帮助的。

 

 

具体的options参考，可以访问jqGrid文档关于option的章节（?id=wiki:options）。其中有几个是比较常用的，重点介绍一下：

 

 

 

url ：jqGrid控件通过这个参数得到需要显示的数据，具体的返回值可以使XML也可以是Json。

datatype ：这个参数用于设定将要得到的数据类型。我最常用的是“json”，其余的类型还包括：xml、xmlstring、local、javascript、function。

mtype : 定义使用哪种方法发起请求，GET或者POST。

height ：Grid的高度，可以接受数字、%值、auto，默认值为150。

width ：Grid的宽度，如果未设置，则宽度应为所有列宽的之和；如果设置了宽度，则每列的宽度将会根据shrinkToFit选项的设置，进行设置。

shrinkToFit ：此选项用于根据width计算每列宽度的算法。默认值为true。如果shrinkToFit为true且设置了width值，则每列宽度会根据width成比例缩放；如果shrinkToFit为false且设置了width值，则每列的宽度不会成比例缩放，而是保持原有设置，而Grid将会有水平滚动条。

autowidth ：默认值为false。如果设为true，则Grid的宽度会根据父容器的宽度自动重算。重算仅发生在Grid初始化的阶段；如果当父容器尺寸变化了，同时也需要变化Grid的尺寸的话，则需要在自己的代码中调用setGridWidth方法来完成。

pager ：定义页码控制条Page Bar

sortname ：指定默认的排序列，可以是列名也可以是数字。此参数会在被传递到Server端。

viewrecords ：设置是否在Pager Bar显示所有记录的总数。

caption ：设置Grid表格的标题，如果未设置，则标题区域不显示。

caption ：Grid的标题。如果设置了，则将显示在Grid的Header层。

rowNum ：用于设置Grid中一次显示的行数，默认值为20。正是这个选项将参数rows（prmNames中设置的）通过url选项设置的链接传递到Server。注意如果Server返回的数据行数超过了rowNum的设定，则Grid也只显示rowNum设定的行数。

rowList ：一个数组，用于设置Grid可以接受的rowNum值。例如[10,20,30]。

colNames ：字符串数组，用于指定各列的题头文本，与列的顺序是对应的。

colModel ：最重要的数组之一，用于设定各列的参数。（稍后详述）

prmNames ：这是一个数组，用于设置jqGrid将要向Server传递的参数名称。（稍后详述）

jsonReader ：这又是一个数组，用来设定如何解析从Server端发回来的json数据。（稍后详述）

 

详细描述：以下内容描述格式是：

 

属性名称

    参数值类型

    描述内容(可能有多行)

    默认值

    是否可修改(表示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 =”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编码。比如，把小于符号转换成&lt;

    默认值: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

  &nb补充：web前端 , JavaScript ,