參數名稱 | 參數類型 | 描述 | 預設值 | 是否可以被修改 |
ajaxGridOptions | object | 對ajax參數進行全局設定,可以覆寫ajax事件:error,complete 和 beforeSend | 空值 | 是 |
ajaxGridOptions | object | 對ajax參數進行全局設定 | 空值 | 是 |
ajaxSelectOptions | object | 對ajax的select參數進行全局設定,設定editoptions跟searchoptions 參數的select屬性值 | 空值 | 是 |
altclass | String | 用來指定行顯示的css,可以編輯自己的css檔案,隻有當altRows設為 ture時起作用 | ui-priority-secondary | 是,但需要重新加載 |
altRows | boolean | 設定表格 zebra-striped 值 | false | 是,需重新加載 |
autoencode | boolean | 當為 ture 時對url進行編碼 | false | 是 |
autowidth | boolean | 如果為ture時,則當表格在首次被建立時會根據父元素比例重新調整表格寬度。如果父元素寬度改變,為了使表格寬度能夠自動調整則需要實作函數:setGridWidth | false | 否 |
caption | String | 定義表格名稱 | 空值 | 否,但是可以用api修改 |
cellLayout | integer | 定義了單元格padding + border 寬度。通常不必修改此值。初始值為5,paddingLef⇒2+paddingRight⇒2+borderLeft⇒1=5 | 5 | 否 |
cellEdit | boolean | 啟用或者禁用單元格編輯功能 | false | 是 |
cellsubmit | String | 定義了單元格内容儲存位置:"remote","clientArray" | 'remote' | 是 |
cellurl | String | 單元格送出的url | 空值 | 是 |
colModel | array | 描述列資訊的數組 | 空值 | 否 |
colNames | array[] | 放置列名稱的數組,必須與colModel大小相同 | 空數組 | 否 |
datastr | String | xmlstring或者jsonstring | 空值 | 是 |
datatype | string | 表格可以被接受的資料類型:xml,xmlstring,json,local,function | xml | 是 |
deselectAfterSort | boolean | 隻有當datatype為local時起作用。當排序時不選擇目前行 | true | 是 |
direction | string | 表格中文字的顯示方向,從左向右(ltr)或者從右向左(rtr)。 | ltr | 否 |
editurl | string | 定義對form編輯時的url | 空值 | 是 |
emptyrecords | string | 當傳回的資料行數為0時顯示的資訊。隻有當屬性 viewrecords 設定為ture時起作用 | 在語言包中 | 是 |
ExpandColClick | boolean | 當為true時,點選展開行的文本時,treeGrid就能展開或者收縮,不僅僅是點選圖檔 | true | 否 |
ExpandColumn | string | 指定那列來展開tree grid,預設為第一列,隻有在treeGrid為true時起作用 | 空值 | 否 |
footerrow | boolean | 當為true時,會在翻頁欄之上增加一行 | false | 否 |
forceFit | boolean | 當為ture時,調整列寬度不會改變表格的寬度。當shrinkToFit 為false時,此屬性會被忽略 | false | 否 |
gridstate | string | 定義目前表格的狀态:'visible' or 'hidden' | visible | 否 |
gridview | boolean | 構造一行資料後添加到grid中,如果設為true則是将整個表格的資料都構造完成後再添加到grid中,但treeGrid, subGrid, or afterInsertRow 不能用 | false | 是 |
height | mixed | 表格高度,可以是數字,像素值或者百分比 | 150 | 否 |
hiddengrid | boolean | 當為ture時,表格不會被顯示,隻顯示表格的标題。隻有當點選顯示表格的那個按鈕時才會去初始化表格資料。隻有當caption 屬性不為空而且hidegrid為ture時才起作用 | false | 否 |
hidegrid | boolean | 啟用或者禁用控制表格顯示、隐藏的按鈕,隻有當caption 屬性不為空時起效 | true | 否 |
hoverrows | boolean | 當為false時mouse hovering會被禁用 | false | 是 |
jsonReader | array | 描述json 資料格式的數組, | 否 |
lastpage | integer | 隻讀屬性,定義了總頁數 | 否 |
lastsort | integer | 隻讀屬性,定義了最後排序列的索引,從0開始 | 否 |
loadonce | boolean | 如果為ture則資料隻從伺服器端抓取一次,之後所有操作都是在用戶端執行,翻頁功能會被禁用 | false | 否 |
loadtext | string | 當請求或者排序時所顯示的文字内容 | Loading.... | 否 |
loadui | string | 當執行ajax請求時要幹什麼。disable禁用ajax執行提示;enable預設,當執行ajax請求時的提示; block啟用Loading提示,但是阻止其他操作 | enable | 是 |
mtype | string | 請求的類型:("POST" or "GET") | GET | 是 |
multikey | string | 隻有在multiselect設定為ture時起作用,定義使用那個key來做多選。shiftKey,altKey,ctrlKey | 空值 | 是 |
multiboxonly | boolean | 隻有當multiselect = true.起作用,當multiboxonly 為ture時隻有選擇checkbox才會起作用, | false | 是 |
multiselect | boolean | 定義是否可以多選 | false | 否 |
multiselectWidth | integer | 當multiselect為true時設定multiselect列寬度 | 20 | 否 |
page | integer | 設定初始的頁碼 | 1 | 是 |
pager | mixed | 指定分頁欄對象,必須為一個有效的html元素。可以是'pager', '#pager', jQuery('#pager').推薦用'#pager' | 空值 | 否 |
pagerpos | string | 指定分頁欄的位置 | center | 否 |
pgbuttons | boolean | 是否顯示翻頁按鈕 | true | 否 |
pginput | boolean | 是否顯示跳轉頁面的輸入框 | true | 否 |
pgtext | string | 目前頁資訊 | 語言包中設定 | 是 |
prmNames | array | Default valuesprmNames: {page:"page",rows:"rows", sort: "sidx",order: "sord", search:"_search", nd:"nd", npage:null} 當參數為null時不會被發到伺服器端 | none | 是 |
postData | array | 此數組内容直接指派到url上,參數類型:{name1:value1…} | 空array | 是 |
reccount | integer | 隻讀屬性,定義了grid中确切的行數。通常情況下與records屬性相同,但有一種情況例外,假如rowNum=15,但是從伺服器端傳回的記錄數是20,那麼records值是20,但reccount值仍然為15,而且表格中也隻顯示15條記錄。 | 否 |
recordpos | string | 定義了記錄資訊的位置: left, center, right | right | 否 |
records | integer | 隻讀屬性,定義了傳回的記錄數 | none | 否 |
recordtext | string | 顯示記錄數資訊。{0} 為記錄數開始,{1}為記錄數結束。 viewrecords為ture時才能起效,且總記錄數大于0時才會顯示此資訊 | 語言包 | 是 |
resizeclass | string | 定義一個class到一個列上用來顯示列寬度調整時的效果 | 空值 | 否 |
rowList | array[] | 一個數組用來調整表格顯示的記錄數,此參數值會替代rowNum參數值傳給伺服器端。如果為空則不顯示,設定格式:[10,20,30]。 | [] | 否 |
rownumbers | boolean | 如果為ture則會在表格左邊新增一列,顯示行順序号,從1開始遞增。此列名為'rn'. | false | 否 |
rowNum | integer | 設定表格中顯示的記錄數,參數會被自動傳到背景。如果此參數設為10,但是從伺服器端傳回15條記錄,那麼在表格中隻會顯示10條記錄。如果設為-1則禁用此檢查 | 20 | 是 |
rownumWidth | integer | 如果rownumbers為true,則可以設定column的寬度 | 25 | 否 |
savedRow | array | 隻讀屬性,隻用在編輯模式下儲存資料 | 空值 | 否 |
scroll | boolean or integer | 建立一個動态滾動的表格,當為true時,翻頁欄被禁用,使用垂直滾動條加載資料,且在首次通路伺服器端時将加載所有資料到用戶端。當此參數為數字時,表格隻控制可見的幾行,所有資料都在這幾行中加載 | false | 否 |
scrollOffset | integer | 設定垂直滾動條寬度 | 18 | 否 |
scrollrows | boolean | 當為true時讓所選擇的行可見 | false | 是 |
selarrrow | array-[] | 隻讀屬性,用來存放目前選擇的行 | empty array [] | 否 |
selrow | string | 隻讀屬性,最後選擇行的id | null | 否 |
shrinkToFit | boolean | 此屬性用來說明當初始化列寬度時候的計算類型,如果為ture,則按比例初始化列寬度。如果為false,則列寬度使用colModel指定的寬度 | true | 否 |
sortable | boolean | 是否可排序 | false | 否 |
sortname | string | 排序列的名稱,此參數會被傳到背景 | 空字元串 | 是 |
sortorder | string | 排序順序,升序或者降序(asc or desc) | asc | 是 |
subGrid | boolean | 是否使用suggrid | false | 否 |
subGridModel | array-[] | subgrid模型 | empty array | 否 |
subGridType | mixed | 如果為空則使用表格的dataType | null | 是 |
subGridUrl | string | 加載subgrid資料的url,jqGrid會把每行的id值加到url中 | 空值 | 是 |
subGridWidth | integer | subgrid列的寬度 | 20 | 否 |
toolbar | array | 表格的工具欄。數組中有兩個值,第一個為是否啟用,第二個指定工具欄位置(相對于body layer),如:[true,"both"] 。工具欄位置可選值:"top","bottom", "both". 如果工具欄在上面,則工具欄id為"t_"+表格id;如果在下面則為 "tb_"+表格id;如果隻有一個工具欄則為 "t_"+表格id | [false,''] | 否 |
totaltime | integer | 隻讀屬性,計算加載資料的時間。目前支援xml跟json資料 | 否 |
treedatatype | mixed | 資料類型,通常情況下與datatype相同,不會變 | null | 否 |
treeGrid | boolean | 啟用或者禁用treegrid模式 | false | 否 |
treeGridModel | string | treeGrid所使用的方法 | nested | 否 |
treeIcons | array | 樹的圖示,預設值:{plus:'ui-icon-triangle-1-e',minus:'ui-icon-triangle-1-s',leaf:'ui-icon-radio-off'} | 否 |
treeReader | array | 擴充表格的colModel且加在colModel定義的後面 | 否 |
tree_root_level | numeric | root元素的級别, | 否 |
url | string | url | null | 是 |
userData | array | 從request中取得的一些使用者資訊 | empty array | 否 |
userDataOnFooter | boolean | 當為true時把userData放到底部,用法:如果userData的值與colModel的值相同,那麼此列就顯示正确的值,如果不等那麼此列就為空 | false | 是 |
viewrecords | boolean | 是否要顯示總記錄數 | false | 否 |
viewsortcols | array | 定義排序列的外觀跟行為。資料格式:[false,'vertical',true].第一個參數是說,是否都要顯示排序列的圖示,false就是隻顯示目前排序列的圖示;第二個參數是指圖示如何顯示,vertical:排序圖示垂直放置,horizontal:排序圖示水準放置;第三個參數指單擊功能,true:單擊列可排序,false:單擊圖示排序。說明:如果第三個參數為false則第一個參數必須為ture否則不能排序 | 否 |
width | number | 如果設定則按此設定為主,如果沒有設定則按colModel中定義的寬度計算 | none | 否 |
xmlReader | array | 對xml資料結構的描述 | 否 |