| 配置項(xiàng) |
類型 |
描述 |
默認(rèn)值 |
能否改變 |
| ajaxGridOptions |
object |
jqGrid使用ajax請(qǐng)求數(shù)據(jù)時(shí)的全局配置。配置了這個(gè)對(duì)象可能會(huì)覆蓋當(dāng)前的jquery ajax配置，包括error，complete和beforeSend事件 |
empty object |
Yes |
| ajaxSelectOptions |
object |
用于配置editoptions或者searchoptions配置中select對(duì)象通過dataUrl動(dòng)態(tài)獲取用的。 |
empty object |
Yes |
| altclass |
string |
隔行顯示的樣式，只有當(dāng)altRows參數(shù)設(shè)置為true時(shí)才起作用
|
ui-priority-secondary |
Yes. Requires reload |
| altRows |
boolean |
是否隔行顯示。說的白一些就是第一行顯示白色背景，第二行藍(lán)色背景，依次交替顯示。 |
false |
Yes. After reload |
| autoencode |
boolean |
是否編碼服務(wù)器返回內(nèi)容或者提交到服務(wù)器的內(nèi)容中包含的html代碼，設(shè)置為true時(shí)，<會(huì)被編碼為< |
false |
Yes |
| autowidth |
boolean |
設(shè)置為true時(shí)，將會(huì)重新計(jì)算表格相對(duì)于父元素的寬度。這個(gè)步驟只在表格建立是執(zhí)行。如果建立之后表格父元素寬度改變，需要表格自動(dòng)調(diào)整寬度，可以使用setGridWidth方法來實(shí)現(xiàn) |
false |
No |
| caption |
string |
表格的標(biāo)題，顯示在標(biāo)題列中。如果配置為空，將不會(huì)顯示標(biāo)題。標(biāo)題位置查看：jqGrid布局結(jié)構(gòu) |
empty string |
No.Method avail. |
| cellLayout |
integer |
單元格td（padding+border）寬度。一般不需要配置，但是如果修改過了表格的css文件，那么需要配置這個(gè)。初始值為paddingLef(2) + paddingRight (2) + borderLeft (1) = 5 |
5 |
No |
| cellEdit |
boolean |
是否允許編輯單元格，查看jqGrid單元格編輯配置，事件及方法配置獲得更多詳細(xì)介紹。 |
false |
Yes |
| cellsubmit |
string |
配置單元格內(nèi)容保存位置。可以為remote或者clientArray。查看jqGrid單元格編輯配置，事件及方法配置獲得更多詳細(xì)介紹。 |
'remote' |
Yes |
| cellurl |
string |
cellsubmit設(shè)置為remote時(shí)，將會(huì)提交修改的數(shù)據(jù)到這個(gè)頁面進(jìn)行保存，如執(zhí)行保存到數(shù)據(jù)庫之類的操作。 查看jqGrid單元格編輯配置，事件及方法配置獲得更多詳細(xì)介紹。 |
null |
Yes |
| cmTemplate |
object |
這里定義的屬性覆蓋默認(rèn)的colModel配置值。如默認(rèn)的colModel配置中列都是可以排序的，配置{sortable:false}后，那么所有的列都不可以排序，除非colModel中配置過sortable為true |
null |
No |
| colModel |
array |
JSON數(shù)組對(duì)象描述列的參數(shù)。對(duì)于jqGrid來說很重要，具體配置查看：jqGrid colModel配置參數(shù) |
empty array |
No |
| colNames |
array |
定義表頭內(nèi)容顯示的字符串?dāng)?shù)組。注意此數(shù)組長度要和colModel配置的數(shù)組長度一致。標(biāo)題位置查看：jqGrid布局結(jié)構(gòu) |
empty array[] |
No |
| data |
array |
傳遞給表格作為數(shù)據(jù)源的本地?cái)?shù)組?？梢灾苯又赶蛞粋€(gè)已經(jīng)定義的數(shù)組。 當(dāng)數(shù)據(jù)量大并且關(guān)聯(lián)時(shí)這個(gè)可以替代addRowData方法。 |
empty array |
Yes |
| datastr |
string |
當(dāng)datatype設(shè)置為 xmlstring 或者
jsonstring時(shí)，對(duì)應(yīng)的xml字符串或者json字符串 |
null |
Yes |
| datatype |
string |
定義填充表格的數(shù)據(jù)格式。可用類型：
xml （xml格式的數(shù)據(jù)源）,
xmlstring (xml格式的字符串),
json (json格式的數(shù)據(jù)源),
jsonstring (json格式的字符串),
local (客戶端已經(jīng)存在的數(shù)組數(shù)據(jù)), javascript (javascript數(shù)據(jù)源),
function (檢索數(shù)據(jù)的函數(shù)),或者客戶端通過數(shù)據(jù)數(shù)組手動(dòng)加載的數(shù)據(jù) 和配置為這些值的相關(guān)參考：jqGrid自定義數(shù)據(jù)
|
xml |
Yes |
| deepempty |
boolean |
當(dāng)事件或者一個(gè)插件作用于單元格時(shí)需要設(shè)置為true。此配置實(shí)用 jQuery empty作用于行和行的子元素.。會(huì)有速度開銷，但是可以防止內(nèi)存泄露?？膳判虻男谢蛘吡屑せ顣r(shí)也需要設(shè)置為true。 |
false |
Yes |
| deselectAfterSort |
boolean |
僅當(dāng)datatype為local時(shí)適用。執(zhí)行排序時(shí)取消選擇已經(jīng)選擇的行 |
true |
Yes |
| direction |
string |
定義表格中的文本方向（dir屬性）。默認(rèn)為 ltr (左到右)。當(dāng)設(shè)置為rtl (右到左) 將會(huì)自動(dòng)改變文字方向。一個(gè)頁面上可能存在2個(gè)或者更多的表格，那么可以設(shè)置一個(gè)方向?yàn)閘tr而另外一個(gè)為rtl。僅在Firefox 3+和ie6+支持。目前的safari，chrome和opera沒有完全支持rtl方向。
默認(rèn)firefox是不啟用rtl方向的，需要修改firefox的配置文件才行【操作步驟：在地址欄輸入about:config，點(diǎn)擊確認(rèn)進(jìn)入配置窗口，在搜索欄輸入layout.scrollbar.side，雙擊此項(xiàng)目，將0修改為1，確定完成firefox rtl方向開啟】。 |
ltr |
No |
| editurl |
string |
定義行編輯或者表單編輯時(shí)完成編輯后保存數(shù)據(jù)的動(dòng)態(tài)頁地址?？梢栽O(shè)置為客戶端數(shù)組（clientArray ）然后手動(dòng)提交數(shù)據(jù)到服務(wù)器。 參考：jqGrid行編輯配置 |
null |
Yes |
| emptyrecords |
string |
當(dāng)表格沒有數(shù)據(jù)時(shí)顯示的提示信息，僅當(dāng)viewrecords配置為true時(shí)有效。 |
see lang file |
Yes |
| ExpandColClick |
boolean |
設(shè)置為true時(shí)，當(dāng)我們點(diǎn)擊展開列任意文本內(nèi)容都會(huì)展開或者收縮樹形控件（see treeGrid)），這樣就不一定需要點(diǎn)擊圖標(biāo)來實(shí)現(xiàn)展開收縮。 |
true |
No |
| ExpandColumn |
string |
指定哪列（使用colModel配置的name）用戶放置樹形表格。如果不指定默認(rèn)第一列。 僅當(dāng)treeGrid設(shè)置為
true.時(shí)可用 |
null |
No |
| footerrow |
boolean |
設(shè)置為true將會(huì)在表格內(nèi)容和導(dǎo)航之間插入一個(gè)包含一行的頁腳表格，此行的列數(shù)和colModel配置的數(shù)量一致。 |
false |
No |
| forceFit |
boolean |
設(shè)置為true后，一列的寬度會(huì)改變，相鄰的列（此列右邊的列)）將會(huì)重新調(diào)整，這樣整體表格的寬度將維持原來的長度。 (例如，減少第二列的寬度30p那么第三列寬度將會(huì)增加30px).，這樣就不會(huì)出現(xiàn)水平滾動(dòng)條。注意：這個(gè)配置和shrinkToFit不兼容，如果shrinkToFit設(shè)置為 false,
forceFit配置將會(huì)被忽略。 |
false |
No |
| gridstate |
string |
確定表格狀態(tài)（如當(dāng)使用hiddengrid，hidegrid和caption配置），有 visible 或者 hidden 兩種狀態(tài)。 |
visible |
No |
| gridview |
boolean |
在之前的版本包括3.4.X，讀取大量關(guān)聯(lián)數(shù)據(jù)(數(shù)量>= 100 ) 會(huì)產(chǎn)生效率問題。.產(chǎn)生這個(gè)問題的原因是每次插入單元格到表格中執(zhí)行了5~6jquery 調(diào)用?，F(xiàn)在問題解決了，我們用jQuery append一次插入整行數(shù)據(jù)，速度提升了3~5倍。一次插入所有數(shù)據(jù)會(huì)有什么結(jié)果？ 設(shè)置為true的結(jié)果是速度提示5~10倍。當(dāng)然，設(shè)置為true后，是有一些限制的，將不能使用treeGrid，subGrid和afterInsertRow事件，如果你不使用這3個(gè)配置可以設(shè)置為true，那么速度會(huì)大大提升。 |
false |
Yes |
| grouping |
boolean |
啟用表格分組。更多詳情查看：
Grouping page. |
false |
Yes |
| headertitles |
boolean |
設(shè)置為true將會(huì)添加到表頭的那title屬性 |
false |
No |
| height |
mixed |
表格高度。可以為數(shù)字（單位px），百分比（只能設(shè)置為100%）或者auto。 |
150 |
No.Method avail. |
| hiddengrid |
boolean |
設(shè)置為true初始化時(shí)將隱藏起來。數(shù)據(jù)不會(huì)加載（不發(fā)送請(qǐng)求），僅標(biāo)題欄顯示。當(dāng)顯示/隱藏按鈕第一次被點(diǎn)擊時(shí)顯示表格，發(fā)送請(qǐng)求道服務(wù)器加載數(shù)據(jù)，表格顯示。此配置僅當(dāng)caption不為空并且hidegrid配置為true時(shí)有效。 |
false |
No |
| hidegrid |
boolean |
是否啟用show/hide表格按鈕。按鈕顯示在標(biāo)題欄的最右邊。 (jqGrid布局結(jié)構(gòu)).。僅當(dāng)caption屬性不為空時(shí)有效。 |
true |
No |
| hoverrows |
boolean |
鼠標(biāo)移動(dòng)到數(shù)據(jù)行上時(shí)是否變換背景色 |
true |
Yes |
| idPrefix |
string |
設(shè)置了這個(gè)配置，將會(huì)給每行的id（tr的id）增加此前綴 |
empty |
Yes |
| ignoreCase |
boolean |
默認(rèn)查詢和排序是區(qū)分大小寫的。如果查詢或者排序不區(qū)分大小寫可以設(shè)置為true |
false |
Yes |
| inlineData |
empty object |
行編輯時(shí)提交到服服務(wù)器的附加數(shù)據(jù) |
{} |
Yes |
| jsonReader |
array |
配置對(duì)象描述需要的json數(shù)據(jù)源結(jié)構(gòu)。更多詳情查看：
Retrieving Data JSON Data |
|
No |
| lastpage |
integer |
指定請(qǐng)求返回的總頁數(shù)。如果datatype為函數(shù)，表格實(shí)例對(duì)象需要調(diào)用setGridParam({lastpage:數(shù)字}) 來指定最大頁數(shù) |
0 |
No |
| lastsort |
integer |
只讀屬性。存儲(chǔ)最后一次排序的列下標(biāo)（從0開始） |
0 |
No |
| loadonce |
boolean |
設(shè)置為true將會(huì)只從服務(wù)器獲取一次數(shù)據(jù)。請(qǐng)求完畢后，datatype參數(shù)將會(huì)自動(dòng)變?yōu)閘ocal，之后所有操作將會(huì)在客戶端完成。pager配置的方法（如果配置過）將會(huì)被禁用。 |
false |
No |
| loadtext |
string |
加載數(shù)據(jù)時(shí)的等待信息。從語言文件中加載 |
Loading… |
No |
| loadui |
string |
這個(gè)配置控制ajax請(qǐng)求數(shù)據(jù)過程中要做什么。 disable - 禁用jqGridd進(jìn)度指示器。這樣你可以使用自己自定義的進(jìn)度
enable (默認(rèn)) -在jqGrid中間顯示loadtext配置的信息 block -中間顯示loadtext配置的信息，并且顯示一個(gè)半透明遮蓋層遮蓋住整個(gè)表格，不允許對(duì)表格進(jìn)行任何操作【如分頁，排序得操作】直到ajax請(qǐng)求完成后會(huì)自動(dòng)隱藏遮蓋層和loadtext信息。 |
enable |
Yes |
| mtype |
string |
配置ajax發(fā)送請(qǐng)求的類型（POST或者GET） |
GET |
Yes |
| multikey |
string |
此配置僅當(dāng)multiselect設(shè)置為true時(shí)有效果。定義選擇多條記錄時(shí)需要按下的按鍵。可用的值為：shiftKey ，
altKey，ctrlKey |
empty string |
Yes |
| multiboxonly |
boolean |
此配置僅當(dāng)multiselect設(shè)置為true時(shí)有效果。multiselect為true，點(diǎn)擊某行的任何地方都可以選擇此行，但是multiboxonly
設(shè)置為 true，只有勾選checkbox 才會(huì)選中行，點(diǎn)擊其他行非checkbox控件將會(huì)取消已經(jīng)選擇的行并且選中點(diǎn)擊的行。
譯者注：經(jīng)測(cè)試，配置了multikey后，multiboxonly設(shè)置為true，當(dāng)按住配置的multikey可以不必點(diǎn)擊checkbox，點(diǎn)擊行的其他地方也可以選擇點(diǎn)擊的行，并且不會(huì)取消已經(jīng)選擇過的行。 |
false |
Yes |
| multiselect |
boolean |
配置為true后可以選擇多行數(shù)據(jù)，并且每行最左邊新增一列顯示checkbox。 |
false |
No |
| multiselectWidth |
integer |
定義多選checkbox列的寬度，multiselect為true時(shí)有效 |
20 |
No |
| multiSort |
boolean |
僅當(dāng)datatype為local時(shí)有效，是否允許多重排序。sidx包含發(fā)送給服務(wù)器端排序的內(nèi)容。.排序的字段 用逗號(hào)分隔，如“field1 asc, field2 desc …, fieldN”。注意最后的字段不包含asc 或者desc。設(shè)置為ture時(shí)通過sord參數(shù)獲取 |
false |
Yes |
| page |
integer |
發(fā)送請(qǐng)求的初始化頁數(shù)，發(fā)到到服務(wù)器以便檢索返回?cái)?shù)據(jù)使用 |
1 |
Yes |
| pager |
mixed |
定義導(dǎo)航條顯示容器。為一個(gè)有效的HTML元素，元素的id，或者元素jquery的id選擇器，jQuery包轉(zhuǎn)后的對(duì)象，如pager,
#pager, jQuery('#pager')，建議傳遞#pager。 See
Pager |
empty string. Currently only one pagebar is possible. |
No |
| pagerpos |
string |
定義導(dǎo)航內(nèi)容所在位置。默認(rèn)導(dǎo)航容器被分為3個(gè)部分，操作按鈕，導(dǎo)航信息，記錄信息，如下圖?？捎弥担簂eft，center，right 
|
center |
No |
| pgbuttons |
boolean |
定義上一頁，下一頁4個(gè)如上圖所示的箭頭導(dǎo)航按鈕是否顯示。僅當(dāng)pager配置設(shè)置對(duì)時(shí)可用。 |
true |
No |
| pginput |
boolean |
定義上圖的“Page輸入框 Of”是否顯示 |
true |
No |
| pgtext |
string |
配置當(dāng)前頁信息，格式如“Page {0} of {1}” 第一個(gè)參數(shù)為當(dāng)前頁，第二個(gè)為總頁數(shù) |
See lang file |
Yes |
| prmNames |
array |
默認(rèn)值為：{page:"page",rows:"rows", sort:"sidx", order:"sord", search:"_search", nd:"nd", id:"id", oper:"oper", editoper:"edit", addoper:"add", deloper:"del", subgridid:"id", npage:null, totalrows:"totalrows"}
，post提交到服務(wù)器。
例如，使用這個(gè)配置可以改變排序字段鍵名稱從sidx修改為mysort.prmNames: {sort:"mysort"}.，提交到服務(wù)器的參數(shù)為
myurl.php?page=1&rows=10&mysort=myindex&sord=asc ，而不是
myurl.php?page=1&rows=10&sidx=myindex&sord=asc ，php可以通過
$POST['mysort'] 獲取到需要根據(jù)哪個(gè)字段排序。當(dāng)某個(gè)對(duì)象設(shè)置為null，將不會(huì)發(fā)送到服務(wù)器。如
prmNames: {nd:null} ，nd 參數(shù)不會(huì)發(fā)送到服務(wù)器。npage 參數(shù)請(qǐng)參考scroll option。 這些參數(shù)解釋和默認(rèn)值如下
- page：當(dāng)前頁數(shù)鍵名稱 (默認(rèn)值：page)
- rows：顯示多少行鍵名稱 (默認(rèn)值：rows)，鍵值為rowNum配置
- sort： 排序鍵名稱 (默認(rèn)值：sidx)，鍵值為sortname配置
- order：升降排序鍵名稱 (默認(rèn)值：sord)，鍵值為sortorder配置
- search： 搜索指示鍵名稱 (默認(rèn)值：_search)
- nd：時(shí)間戳鍵名稱(防止ajax在ie下get緩存用的） (默認(rèn)值：nd)
- id： 在編輯模式下提交是id鍵名稱 (默認(rèn)值：id)
- oper：操作方式鍵名稱(默認(rèn)值：oper)
- editoper：編輯操作名稱 (默認(rèn)值：edit)
- addoper：添加操作名稱 (默認(rèn)值：add)
- deloper： 刪除操作名稱 (默認(rèn)值：del)
- totalrows：需要從服務(wù)器獲取總數(shù)據(jù)鍵名稱 - 參考 rowTotal配置 (默認(rèn)值：totalrows)，鍵值為rowTotal配置
- subgridid：點(diǎn)擊加載子表格數(shù)據(jù)時(shí)傳遞的鍵名稱 (默認(rèn)值：id)
- npage：滾動(dòng)加載數(shù)據(jù)鍵名稱（默認(rèn)不發(fā)送），鍵值為scroll配置為數(shù)字 描紅部分組合成：oper=(edit|add|del)參數(shù)對(duì)，通過獲取oper參數(shù)知道客戶端進(jìn)行了哪種操作
|
none |
Yes |
| postData |
array |
此配置將直接附加到url后面作為參數(shù)。格式為JSON對(duì)象，如 {name1:value1…} |
empty array |
Yes |
| reccount |
integer |
只讀屬性。只是表格中顯示的實(shí)際行數(shù)。不要和records弄混淆了，盡管一些情況下他們是一致的，但是有些情況下不是。例如，
rowNum設(shè)置為15，但是服務(wù)器返回了20條記錄，records為20，但是reccount為15（表格只顯示15條記錄而不是20條） |
0 |
No |
| recordpos |
string |
定義記錄信息的文字的位置。如上圖所示的“View 1-4 of 8”?？捎弥担?/span>left,
center, right. |
right |
No |
| records |
integer |
只讀屬性。指示服務(wù)器實(shí)際返回的數(shù)據(jù)量 |
none |
No |
| recordtext |
string |
導(dǎo)航條記錄信息內(nèi)容。總記錄數(shù)大于0并且viewrecords設(shè)置為true才會(huì)顯示。
格式如：View {0} - {1} of {2}。 {0} - 顯示第一條數(shù)據(jù)記錄號(hào) {1} - 顯示最后一條數(shù)據(jù)記錄號(hào) {2} - 服務(wù)器返回的總記錄 |
see lang file |
Yes |
| resizeclass |
string |
附加一個(gè)樣式給列，這樣只有附加了這個(gè)樣式的列才可以改變 |
empty string |
No |
| rowList |
array[] |
select下拉導(dǎo)航可用的值，數(shù)字?jǐn)?shù)組，如 [10,20,30] |
empty arrray |
No |
| rownumbers |
boolean |
設(shè)置為true將在表格左邊新增一列，顯示行號(hào)，從1開始。設(shè)置為true后colModel將會(huì)自動(dòng)增加一個(gè)name為rn的新元素，所以配置colModel時(shí)不要配置某列name值為rn。 |
false |
No |
| rowNum |
integer |
設(shè)置表格要顯示多少條記錄。此參數(shù)將會(huì)傳遞到服務(wù)器以便獲取檢索返回需要的數(shù)據(jù)。注意：如果設(shè)置為10，但是服務(wù)器返回15條記錄，那么只有10條記錄被加載到表格中 |
20 |
Yes |
| rowTotal |
integer |
設(shè)置這個(gè)參數(shù)提供給服務(wù)器需要加載多少條數(shù)據(jù)。注意rowNum指示多少條記錄顯示在表格內(nèi)，而rowTotal指示我們可以操作的總記錄數(shù)。設(shè)置這個(gè)值后一個(gè)附加的參數(shù)totalrows將會(huì)發(fā)送到服務(wù)器。服務(wù)器端可以檢查這個(gè)值是否可用，以便使用這個(gè)值替換掉rows參數(shù)。通通常這個(gè)參數(shù)可以聯(lián)合loadonce被設(shè)置為true。 |
null |
Yes |
| rownumWidth |
integer |
設(shè)置行號(hào)的寬度，僅當(dāng)rownumbers設(shè)置為true |
25 |
No |
| savedRow |
array |
只讀屬性，用于存儲(chǔ)在行和單元格被編輯之前的原始數(shù)據(jù)。 查看：jqGrid單元格編輯配置，事件及方法 ，jqGrid行編輯配置 |
empty array |
No |
searchdata |
array {} |
This property contain the searched data in pair name:value. 已經(jīng)廢棄此配置。 |
empty array{} |
Yes |
| scroll |
boolean or integer |
創(chuàng)建動(dòng)態(tài)滾動(dòng)表格。配置了此項(xiàng)后導(dǎo)航容器被禁用，可以通過水平滾動(dòng)條來加載數(shù)據(jù)。 設(shè)為true表格將保留所有項(xiàng)目從開始的到最近訪問的。設(shè)置為數(shù)字（如1），表格僅保留可見的行。這樣我們只加載部分?jǐn)?shù)據(jù)而不用擔(dān)心內(nèi)存泄露。附加的參數(shù)npage將會(huì)發(fā)往服務(wù)器，如果設(shè)置了npage，表格有些時(shí)候會(huì)后會(huì)請(qǐng)求超過1頁以上的數(shù)據(jù)。如果沒配置npage，將會(huì)發(fā)送多個(gè)get請(qǐng)求。 |
false |
No |
| scrollOffset |
integer |
設(shè)置垂直滾動(dòng)條的寬度。不同的瀏覽器垂直滾動(dòng)條寬度不一樣（很難在所有瀏覽器下計(jì)算），可變的。 |
18 |
No.Method avail. |
| scrollTimeout |
integer (milliseconds) |
控制滾動(dòng)事件延時(shí)時(shí)間當(dāng)scroll配置為1。 |
200 |
Yes |
| scrollrows |
boolean |
設(shè)置為true時(shí)，通過setSelection選中某行將會(huì)滾動(dòng)表格使選中的行可見。表格有水平滾動(dòng)條，當(dāng)使用表格編輯，通過上一條或者嚇一跳導(dǎo)航按鈕導(dǎo)向時(shí)將會(huì)很有用。 |
false |
Yes |
| selarrrow |
array |
只讀屬性，存儲(chǔ)當(dāng)前選中的行。為一維數(shù)組，存儲(chǔ)選中的行的id。 |
empty array [] |
No |
| selrow |
string |
只讀屬性，包含最后一次選中的行的id。如果排序或者分頁過，將會(huì)設(shè)置為null |
null |
No |
| shrinkToFit |
boolean or integer |
設(shè)置了此配置，將會(huì)參考每列配置的列寬，對(duì)列寬進(jìn)行重新計(jì)算。 1）設(shè)置為true，列的寬度也設(shè)置過，將會(huì)依據(jù)配置的列寬進(jìn)行縮放。如我們定義2列寬度分別為80和120px，但是表格寬度為300px，那么列寬將會(huì)變寬以便填充整個(gè)表格，增加的額外寬度依據(jù)他們的配置的寬度來計(jì)算，計(jì)算方法如下 第一列實(shí)際寬度為：(300/(80+120)(原來配置列寬總和))*80(第一列的寬度) = 120 第二列實(shí)際寬度為：(300/(80+120)(原來配置列寬總和))*120(s第二列的寬度) = 180 新的列寬總和為300px，和表格總寬度一樣。
2）如果設(shè)置為false并且配置jqGrid的width參數(shù)，列寬將不會(huì)改變，如1）的例子，列一寬度為80，列二維120，表格總寬度300保持不變。 3)設(shè)置為一個(gè)數(shù)字，列寬將會(huì)依據(jù)此數(shù)字重新計(jì)算。(the width is calculated according to it. - The effect of using an integer can be elaborated.) |
true |
No |
| sortable |
boolean |
設(shè)置為true，允許通過鼠標(biāo)拖拽重新對(duì)列進(jìn)行排序。這個(gè)選項(xiàng)依賴 jQuery UI sortable部件，所以需要在head標(biāo)簽內(nèi)容加載sortable部件。所以下載jqGrid時(shí)需要選擇jQuery UI擴(kuò)展選項(xiàng)如果你需要此功能。注意：
colModel配置中也有一個(gè)配置為sortable，這個(gè)指示此列是否允許點(diǎn)擊列表頭進(jìn)行排序。 |
false |
No |
| sortname |
string |
當(dāng)加載服務(wù)器xml或者json數(shù)據(jù)需要依據(jù)那列進(jìn)行排序，此配置作為參數(shù)附加到url中。設(shè)置了這個(gè)值并且和colModel配置的index一致，對(duì)應(yīng)的列表頭將會(huì)增加一個(gè)圖標(biāo)指示表格已經(jīng)通過此列排序過。此圖標(biāo)也指示了是那種排序，升序或者降序，參考sortorder對(duì)象。 |
empty string |
Yes |
| sortorder |
string |
從服務(wù)器獲取xml或者json數(shù)據(jù)的初始化排序方向（降序或者升序）。附加到url參數(shù)中，可選值：asc 或者 desc. |
asc |
Yes |
| subGrid |
boolean |
是否啟用subGrid。設(shè)置為true，在表格左邊會(huì)增加一列。這列包含一個(gè)+號(hào)圖片，用戶可以點(diǎn)擊這個(gè)圖片展開這行，默認(rèn)所有行是收縮的。 詳細(xì)查看：
Subgrid |
false |
No |
| subGridOptions |
object |
subGrid相關(guān)配置，詳細(xì)查看：Subgrid. |
see
Subgrid |
Yes |
| subGridModel |
array-[] |
描述subGrid的colModel模型，僅當(dāng)subGrid設(shè)置為true有效。詳細(xì)查看：
Subgrid |
empty array |
No |
| subGridType |
mixed |
subGrid數(shù)據(jù)源類型，如果沒有設(shè)置，將啟用父表格配置datatype |
null |
Yes |
| subGridUrl |
string |
subGrid設(shè)置為true時(shí)有效。配置subgrid從哪個(gè)頁面加載數(shù)據(jù)。 jqGrid會(huì)將此行的id作為參數(shù)附加到url上。如果需要附加額外參數(shù)，配置subGridModel中的params選項(xiàng)。 詳細(xì)查看：
Subgrid |
empty string |
Yes |
| subGridWidth |
integer |
subGrid設(shè)置為true時(shí)有效，定義subGrid的寬度。 |
20 |
No |
| toolbar |
array |
定義表格工具欄。為2個(gè)值的數(shù)組。第一個(gè)值定義是否啟用工具欄，第二個(gè)值定義工具欄相對(duì)于表格內(nèi)容的位置，可用值有：top,
bottom, both。當(dāng)設(shè)置toolbar: [true,"both"] ，2個(gè)工具欄被創(chuàng)建（div），一個(gè)在內(nèi)容頂部，一個(gè)在內(nèi)容底部。頂部 工具欄div的id格式如t_選擇器id（不包含#），。底部工具欄div的id格式如tb_選擇器id（不包含#），如果只有一個(gè)工具欄（位置參數(shù)為top或者bottom），id格式為t_選擇器id（不包含#）。
|
[false, ''] |
No |
| toppager |
boolean |
設(shè)置為true，導(dǎo)航條將放置在表格頂部，標(biāo)題欄下（如果存在）。如果定義了pager， 2個(gè)都會(huì)顯示并且內(nèi)容同步更新。此導(dǎo)航條id為選擇器id（不包含#）_toppager |
false |
No |
| totaltime |
integer |
只讀屬性，指示記錄加載的時(shí)間。加載xml或者json數(shù)據(jù)時(shí)可用。計(jì)算方式為請(qǐng)求結(jié)束到最后一行數(shù)據(jù)添加到表格。 |
0 |
No |
| treedatatype |
mixed |
樹形表格數(shù)據(jù)源類型，詳細(xì)參考 datatype。通常不需要修改這個(gè)。在處理過程中這個(gè)等介于datatype |
null |
No |
| treeGrid |
boolean |
允許treegrid數(shù)據(jù)格式，詳細(xì)查看： Tree Grid |
false |
No |
| treeGridModel |
string |
指定treeGrid的方法，可用值有：nested或者adjacency. 詳細(xì)查看：
Tree Grid |
nested |
No |
| treeIcons |
array |
此對(duì)象指定treegrid使用的圖標(biāo)。圖標(biāo)名稱需要是UI主題中定義過的。默認(rèn)值為 {plus:'ui-icon-triangle-1-e',minus:'ui-icon-triangle-1-s',leaf:'ui-icon-radio-off'} |
|
No |
| treeReader |
array |
擴(kuò)展grid配置中的colModel 。這些字段描述將添加到colModel最后并且隱藏。這意味著從服務(wù)器返回的數(shù)據(jù)需要包含這些字段定義的值。詳細(xì)查看： Tree Grid
|
|
No |
| tree_root_level |
numeric |
當(dāng)treeGrid為true時(shí)指定根元素從哪層開始。 |
0 |
No |
| url |
string |
jqGrid數(shù)據(jù)源url地址。可以設(shè)置為clientArray(客戶端數(shù)據(jù))手動(dòng)發(fā)送數(shù)據(jù)到服務(wù)器。 參考：jqGrid行編輯配置 |
null |
Yes |
| userData |
array |
保存請(qǐng)求的自定義信息，以便隨時(shí)使用 |
empty array |
No |
| userDataOnFooter |
boolean |
設(shè)置為true，將直接放置userData數(shù)據(jù)到頁腳。規(guī)則如下 如果userData中包含的name和colModel中配置的任何一個(gè)name一致，數(shù)據(jù)將會(huì)顯示在此列中。 如果不包含任何值將不會(huì)放置。 |
false |
Yes |
| viewrecords |
boolean |
是否在導(dǎo)航條顯示顯示recordtext/emptyrecords配置的信息。 |
false |
No |
| viewsortcols |
array |
定義表頭排序圖標(biāo)的外觀和行為（up/down箭頭），默認(rèn)值為 viewsortcols : [false,'vertical',true]. 1）第一個(gè)值定義排序圖標(biāo)是否在在所有可排序的列的表頭中顯示，設(shè)置為true可以讓用戶知道此列可以進(jìn)行排序，默認(rèn)值為false，只有當(dāng)此列表頭為最后一次排序時(shí)被點(diǎn)擊才會(huì)顯示.圖標(biāo)。設(shè)置為true所有可排序的列表頭都會(huì)顯示圖標(biāo) 2）第二個(gè)定義圖標(biāo)的位置。vertical為垂直放置 ，horizontal：水平放置
3）T第三個(gè)定義排序點(diǎn)擊功能。設(shè)置為true點(diǎn)擊此列表頭任意位置執(zhí)行排序，不單點(diǎn)擊箭頭圖標(biāo)。設(shè)置為false那么要執(zhí)行排序只能點(diǎn)擊箭頭圖標(biāo)
備注：如果第三個(gè)參數(shù)設(shè)置為false，那么第一個(gè)參數(shù)一定要設(shè)置為true。如果不這樣，箭頭圖標(biāo)不顯示，那么就不知道點(diǎn)擊那里進(jìn)行排序了。 |
[false,'vertical',true] |
No |
| width |
number |
表格寬度。未設(shè)置那么長度為colModel配置的所有列總和.設(shè)置了這個(gè)值，colModel配置的實(shí)際寬度將依據(jù)shrinkToFit配置和配置的初始化寬度值。 |
none |
No. Method avail. |
| xmlReader |
array |
配置對(duì)象描述需要的xml數(shù)據(jù)結(jié)構(gòu)。詳細(xì)參考：jqGrid XML數(shù)據(jù)源讀取器選項(xiàng)配置 |
|
No |
