当前位置：Gxlcms > JavaScript > jqGrid中文文档之选项设置

jqGrid中文文档之选项设置

时间：2021-07-01 10:21:17 帮助过：12人阅读

jqGrid提供了大量的选项设置，开发者可以通过设置选项对应值来控制jqGrid，比如表格的宽度、高度、数据类型以及列名称等等都是通过选项设置来完成的。jqGrid的选项一般是名称：值（name:value）的形式，也可以是对象(object)及数组（array）的形式配置。

jqGrid选项(Option)

调用jqGrid只需要执行以下代码:

jQuery("#grid_id").jqGrid(options);

options即jqGrid的选项设置，请参照以下表格。

属性 类型 描述 默认值
ajaxGridOptions object 此项用于设置当表格设置获得数据时，ajax的全局属性，注意此项可能覆盖所有当前的ajax设置（包括error, complete和beforeSend 事件）。 empty
ajaxSelectOptions object 此项用于设置在editoptions或searchoptions对象中通过dataUrl选择元素时， ajax的全局属性。 empty
altclass string 交替行的类。 此项仅当altRows设置为true时有效。 ui-priority-secondary
altRows boolean 设置为交替行表格 false
autoencode boolean 当设置为true时，对来自服务器的数据和提交数据进行encodes编码。如< 将被转换为< false
autowidth boolean 当设置为true时，表格宽度将自动匹配到父元素的宽度。这个匹配只在表格建立时进行，为了使表格在父元素宽度变化时也随之变化，可以使用setGridWidth方法 false
caption string 表格的标题。显示在Header上。若为空时将不会显示。 empty
cellLayout integer 该属性确定单元格的padding + border 宽度。通常不修改该属性，但若表格的CSS中改变了td元素，该属性需要修改。 缺省值5表示paddingLef(2) + paddingRight(2) + borderLeft(1)=5 5
cellEdit boolean 是否允许单元格编辑。 false
cellsubmit string 确定单元格内容保存方式是remote还是clientArray 。 'remote'
cellurl string 单元格保存的url。 null
colModel array 描述列参数数组。这是表格最重要的部分，详见colModel API. null
colNames array[] 列名称数组。该名称将在Header中显示。名称以逗号分隔，数量应与colModel 数组数量相等 empty
data array 以数组的形式保存本地数据。 empty
datastr string 当datatype被设置为xmlstring或jsonstring时，为数据串。 null
datatype string 定义表格希望获得的数据的类型，有效值有：
Xml —xml数据
xmlstring—xml字符串
json—JSON数据
jsonstring—JSON字符串
local—客户端数据（数组）
javascript—javascript数据
function—函数返回数据
 		 xml
deselectAfterSort boolean 只适用于当datatype为local时。当一个排序被应用时取消当前选定行。 true
direction string 表格中的书写方向。“ltr”从左到右(缺省值)，“rtl”从右到左 ltr
editurl string 定义行内编辑地址URL null
emptyrecords string 当返回(或当前)数量为零时显示的信息此项只用当viewrecords 设置为true时才有效。  
ExpandColClick boolean true时，点击展开行的文字，treeGrid展开或收拢 true
ExpandColumn string 指定用于张开treeGrid的列（名称来自colModel），未设置即用第一列。此项只有当treeGrid为true时有效. null
footerrow boolean 如果设置为true时，将生成一个表脚行，列数等于colModel false
forceFit boolean 如果设置为true，改变列宽，相邻列也将调整以适应整体表格，将不会出现水平滚动条。 false
gridstate string 表格的当前状态。有visible或hidden visible
gridview boolean 设置为true将提高5~10倍的显示速度。但不能再使用treeGrid, subGrid, 或afterInsertRow事件 false
grouping boolean 是否设置表格组 false
height mixed 表格高度。可为数值、百分比或auto 150
hiddengrid boolean 如果设置为true，表格开始被隐藏，数据不被载入，只显示标题。当第一次点击显示/隐藏按钮显示表格，数据从服务器载入。 false
hidegrid boolean 是否允许显示/隐藏按钮可用。只有标题不为空时可用。 true
hoverrows boolean 表行是否有鼠标悬停效果 true
jsonReader array JSON数据结构数组  
lastpage integer 请求返回的总页数 0
lastsort integer 排序的列号（0开始） 0
loadonce boolean 设置为true时，表格只一次读取服务器数据（使用适当datatype），之后，datatype 自动变为local ，所有进一步操作都在客户端完成，pager功能（若存在）将失效。 false
loadtext string 数据请求和排序时显示的文本 Loading…
loadui string 此项控制ajax进程进行时的动作。Disable—取消jqGrid的进程指示，可使用自定义的指示。 enable (缺省)—表格中间显示loading。 block – 显示“Loading”信息，禁用页面上的所有功能，直到数据装入完成。 enable
mtype string 定义提交类型POST或GET GET
multikey string 此属性只有当multiselect为true时有效，定义多选时的组合键，可选值有： shiftKey ，altKey，ctrlKey empty
multiboxonly boolean 此属性只有当multiselect为true时有效，. Multiboxonly设置为true时，只有点击checkbox时该行才被选中，点击其他列，将清除当前行的选中。 false
multiselect boolean 此属性设为true时启用多行选择，出现复选框 false
multiselectWidth integer 若multiselect 为true时，定义多选列的宽度。 20
page integer 设置请求初始页的数量，此参数通过URL从服务器接受数据 1
pager mixed 定义分页浏览导航条。必须是一个HTML元素，如<div id="page"></div> empty
pagerpos string 定义表格浏览导航条的位置，缺省情况下建立一个包括3部分的导航条：页码，导航按钮和记录信息。 center
pgbuttons boolean 定义导航激活时导航按钮是否显示。 true
pginput boolean 定义导航栏是否有页码输入框。 true
pgtext string 当前页信息。第一个量为当前页，第二个量为总页数。  
prmNames array 缺省情况下prmNames: { page:“page”,rows:“rows”, sort: “sidx”,order: “sord”, search:“_search”, nd:“nd”, npage:null} 以POST方式发送到服务器，字段为： page，rows，sidx，sord，search，nd 例如要将sidx改为mysort，可写成： prmNames: {sort: “mysort”}. 这样提交到服务器的字符串就变为： page=1&rows=10&mysort=myindex&sord=asc 若将一些参数设为null，这些参数将不再发往服务器。例如prmNames: { nd:null} 则nd参数将不被发送。 Npage参数参见scroll option. none
postData array 此数组能直接传递到url。这个数组可使用这种形式{name1:value1…}。 empty
reccount integer 只读属性。定义表格显示的行数。切勿与records混淆。 0
recordpos string 定义页中记录信息的位置，可以是left，center，right。 right
recordpos object 交替行的类 true
records integer 只读属性。定义从请求中获得的记录数 none
recordtext string 可在页面上显示的提示信息，此文字只在viewrecords 为true是有效，并且当记录总数大于0时才显示。
此文字中{}中的内容<

人气教程排行

本站所有资源全部来源于网络，若本站发布的内容侵害到您的隐私或者利益，请联系我们删除！