jqGrid|初始化|參數
阿新 • • 發佈：2018-03-09
submit toe ble taf 定義 json grid 加載 arch
| 名稱 | 類型 | 描述 | 默認值 | 可修改 |
| url | string | 獲取數據的地址 | ||
| datatype | string | 從服務器端返回的數據類型，默認xml。可選類型：xml，local，json，jsonnp，script，xmlstring，jsonstring，clientside | ||
| mtype | string | ajax提交方式。POST或者GET，默認GET | ||
| colNames | Array | 列顯示名稱，是一個數組對象 | ||
| colModel | Array | 常用到的屬性：name 列顯示的名稱；index 傳到服務器端用來排序用的列名稱；width 列寬度；align |
||
| pager | string | 定義翻頁用的導航欄，必須是有效的html元素。翻頁工具欄可以放置在html頁面任意位置 | ||
| rowNum | int | 在grid上顯示記錄條數，這個參數是要被傳遞到後臺 | ||
| rowList | array | 一個下拉選擇框，用來改變顯示記錄數，當選擇時會覆蓋rowNum參數傳遞到後臺 | ||
| sortname | string | 默認的排序列。可以是列名稱或者是一個數字，這個參數會被提交到後臺 | ||
| viewrecords | boolean | 定義是否要顯示總記錄數 | ||
| caption | string | 表格名稱 | ||
| [a1] | object | 對ajax參數進行全局設置，可以覆蓋ajax事件 | null | 是 |
| [a2] | object | 對ajax的select參數進行全局設置 | null | 是 |
| altclass | String | 用來指定行顯示的css，可以編輯自己的css文件，只有當altRows設為 ture時起作用 | ui-priority-secondary | |
| altRows | boolean | 設置表格 zebra-striped 值 | ||
| autoencode | boolean | 對url進行編碼 | false | 是 |
| autowidth | boolean | 如果為ture時，則當表格在首次被創建時會根據父元素比例重新調整表格寬度。如果父元素寬度改變，為了使表格寬度能夠自動調整則需要實現函數：setGridWidth | false | 否 |
| cellLayout | integer | 定義了單元格padding + border 寬度。通常不必修改此值。初始值為 | 5 | 是 |
| cellEdit | boolean | 啟用或者禁用單元格編輯功能 | false | 是 |
| cellsubmit | String | 定義了單元格內容保存位置 | ‘remote’ | 是 |
| cellurl | String | 單元格提交的url | 空值 | 是 |
| datastr | String | xmlstring或者jsonstring | 空值 | 是 |
| 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時起作用 | 空值 | 否 |
| [a3] | 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時，表格不會被顯示，只顯示表格的標題。只有當點擊顯示表格的那個按鈕時才會去初始化表格數據。 | false | 否 |
| hidegrid | boolean | 啟用或者禁用控制表格顯示、隱藏的按鈕，只有當caption 屬性不為空時起效 | true | 否 |
| hoverrows | boolean | 當為false時mouse hovering會被禁用 | false | 是 |
| jsonReader | array | 描述json 數據格式的數組 | 否 | |
| lastpage | integer | 只讀屬性，定義了總頁數 | 0 | 否 |
| lastsort | integer | 只讀屬性，定義了最後排序列的索引，從0開始 | 0 | 否 |
| loadonce | boolean | 如果為ture則數據只從服務器端抓取一次，之後所有操作都是在客戶端執行，翻頁功能會被禁用 | false | 否 |
| loadtext | string | 當請求或者排序時所顯示的文字內容 | Loading.... | 否 |
| loadui | string | 當執行ajax請求時要幹什麽。disable禁用ajax執行提示；enable默認，當執行ajax請求時的提示； block啟用Loading提示，但是阻止其他操作 | enable | 是 |
| 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 | 是 |
| 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條記錄。 | 0 | 否 |
| recordpos | string | 定義了記錄信息的位置： left, center, right | right | 否 |
| records | integer | 只讀屬性，定義了返回的記錄數 | none | 否 |
| recordtext | string | 顯示記錄數信息。{0} 為記錄數開始，{1}為記錄數結束。viewrecords為ture時才能起效，且總記錄數大於0時才會顯示此信息 |
|
|
| resizeclass | string | 定義一個class到一個列上用來顯示列寬度調整時的效果 | 空值 | 否 |
| rowList | array | 一個數組用來調整表格顯示的記錄數，此參數值會替代rowNum參數值傳給服務器端。 | [] | 否 |
| rownumbers | boolean | 如果為ture則會在表格左邊新增一列，顯示行順序號，從1開始遞增。此列名為‘rn‘. | false | 否 |
| rownumWidth | integer | 如果rownumbers為true，則可以設置column的寬度 | 25 | 否 |
| savedRow | array | 只讀屬性，只用在編輯模式下保存數據 | 空值 | 否 |
| scroll | boolean | 創建一個動態滾動的表格，當為true時，翻頁欄被禁用，使用垂直滾動條加載數據，且在首次訪問服務器端時將加載所有數據到客戶端。當此參數為數字時，表格只控制可見的幾行，所有數據都在這幾行中加載 | false | 否 |
| scrollOffset | integer | 設置垂直滾動條寬度 | 18 | 否 |
| scrollrows | boolean | 當為true時讓所選擇的行可見 | false | 是 |
| selarrrow | array | 只讀屬性，用來存放當前選擇的行 | 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模型 | 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數據 | 0 | 否 |
| 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 | r oot元素的級別， | 0 | 否 |
| userData | array | 從request中取得的一些用戶信息 | 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數據結構的描述 | 否 |
jqGrid|初始化|參數