合作(zuò)
咨詢
建站(zhàn)咨詢
jqGrid中文說明(míng)文檔——選項設置
- 作(zuò)者：admin
- 發表時(shí)間(jiān)：2013-07-02 14:17:08
- 來(lái)源：未知
jqGrid提供了大(dà)量的選項設置，開(kāi)發者可(kě)以通(tōng)過設置選項對應值來(lái)控制(zhì)jqGrid，比如表格的寬度、高(gāo)度、數(shù)據類型以及列名稱等等都是通(tōng)過選項設置來(lái)完成的。jqGrid的選項一般是名稱：值（name:value）的形式，也可(kě)以是對象(object)及數(shù)組（array）的形式配置。
jqGrid選項(Option)
調用jqGrid隻需要執行(xíng)以下代碼:
jQuery("#grid_id").jqGrid(options);
options即jqGrid的選項設置，請(qǐng)參照以下表格。
| 屬性 | 類型 | 描述 | 默認值 |
| ajaxGridOptions | object | 此項用于設置當表格設置獲得(de)數(shù)據時(shí)，ajax的全局屬性，注意此項可(kě)能覆蓋所有(yǒu)當前的ajax設置（包括error, complete和(hé)beforeSend 事件）。 | empty |
| ajaxSelectOptions | object | 此項用于設置在editoptions或searchoptions對象中通(tōng)過dataUrl選擇元素時(shí)， ajax的全局屬性。 | empty |
| altclass | string | 交替行(xíng)的類。 此項僅當altRows設置為(wèi)true時(shí)有(yǒu)效。 | ui-priority-secondary |
| altRows | boolean | 設置為(wèi)交替行(xíng)表格 | false |
| autoencode | boolean | 當設置為(wèi)true時(shí)，對來(lái)自服務器(qì)的數(shù)據和(hé)提交數(shù)據進行(xíng)encodes編碼。如< 将被轉換為(wèi)< | false |
| autowidth | boolean | 當設置為(wèi)true時(shí)，表格寬度将自動匹配到父元素的寬度。這個(gè)匹配隻在表格建立時(shí)進行(xíng)，為(wèi)了使表格在父元素寬度變化時(shí)也随之變化，可(kě)以使用setGridWidth方法 | false |
| caption | string | 表格的标題。顯示在Header上(shàng)。若為(wèi)空(kōng)時(shí)将不會(huì)顯示。 | empty |
| cellLayout | integer | 該屬性确定單元格的padding + border 寬度。通(tōng)常不修改該屬性，但(dàn)若表格的CSS中改變了td元素，該屬性需要修改。 缺省值5表示paddingLef(2) + paddingRight(2) + borderLeft(1)=5 | 5 |
| cellEdit | boolean | 是否允許單元格編輯。 | false |
| cellsubmit | string | 确定單元格內(nèi)容保存方式是remote還(hái)是clientArray 。 | 'remote' |
| cellurl | string | 單元格保存的url。 | null |
| colModel | array | 描述列參數(shù)數(shù)組。這是表格最重要的部分，詳見colModel API. | null |
| colNames | array[] | 列名稱數(shù)組。該名稱将在Header中顯示。名稱以逗号分隔，數(shù)量應與colModel 數(shù)組數(shù)量相等 | empty |
| data | array | 以數(shù)組的形式保存本地數(shù)據。 | empty |
| datastr | string | 當datatype被設置為(wèi)xmlstring或jsonstring時(shí)，為(wèi)數(shù)據串。 | null |
| datatype | string |
定義表格希望獲得(de)的數(shù)據的類型，有(yǒu)效值有(yǒu)： Xml —xml數(shù)據 xmlstring—xml字符串 json—JSON數(shù)據 jsonstring—JSON字符串 local—客戶端數(shù)據（數(shù)組） javascript—javascript數(shù)據 function—函數(shù)返回數(shù)據 |
xml |
| deselectAfterSort | boolean | 隻适用于當datatype為(wèi)local時(shí)。當一個(gè)排序被應用時(shí)取消當前選定行(xíng)。 | true |
| direction | string | 表格中的書(shū)寫方向。“ltr”從左到右(缺省值)，“rtl”從右到左 | ltr |
| editurl | string | 定義行(xíng)內(nèi)編輯地址URL | null |
| emptyrecords | string | 當返回(或當前)數(shù)量為(wèi)零時(shí)顯示的信息此項隻用當viewrecords 設置為(wèi)true時(shí)才有(yǒu)效。 | |
| ExpandColClick | boolean | true時(shí)，點擊展開(kāi)行(xíng)的文字，treeGrid展開(kāi)或收攏 | true |
| ExpandColumn | string | 指定用于張開(kāi)treeGrid的列（名稱來(lái)自colModel），未設置即用第一列。此項隻有(yǒu)當treeGrid為(wèi)true時(shí)有(yǒu)效. | null |
| footerrow | boolean | 如果設置為(wèi)true時(shí)，将生(shēng)成一個(gè)表腳行(xíng)，列數(shù)等于colModel | false |
| forceFit | boolean | 如果設置為(wèi)true，改變列寬，相鄰列也将調整以适應整體(tǐ)表格，将不會(huì)出現水(shuǐ)平滾動條。 | false |
| gridstate | string | 表格的當前狀态。有(yǒu)visible或hidden | visible |
| gridview | boolean | 設置為(wèi)true将提高(gāo)5~10倍的顯示速度。但(dàn)不能再使用treeGrid, subGrid, 或afterInsertRow事件 | false |
| grouping | boolean | 是否設置表格組 | false |
| height | mixed | 表格高(gāo)度。可(kě)為(wèi)數(shù)值、百分比或auto | 150 |
| hiddengrid | boolean | 如果設置為(wèi)true，表格開(kāi)始被隐藏，數(shù)據不被載入，隻顯示标題。當第一次點擊顯示/隐藏按鈕顯示表格，數(shù)據從服務器(qì)載入。 | false |
| hidegrid | boolean | 是否允許顯示/隐藏按鈕可(kě)用。隻有(yǒu)标題不為(wèi)空(kōng)時(shí)可(kě)用。 | true |
| hoverrows | boolean | 表行(xíng)是否有(yǒu)鼠标懸停效果 | true |
| jsonReader | array | JSON數(shù)據結構數(shù)組 | |
| lastpage | integer | 請(qǐng)求返回的總頁數(shù) | 0 |
| lastsort | integer | 排序的列号（0開(kāi)始） | 0 |
| loadonce | boolean | 設置為(wèi)true時(shí)，表格隻一次讀取服務器(qì)數(shù)據（使用适當datatype），之後，datatype 自動變為(wèi)local ，所有(yǒu)進一步操作(zuò)都在客戶端完成，pager功能（若存在）将失效。 | false |
| loadtext | string | 數(shù)據請(qǐng)求和(hé)排序時(shí)顯示的文本 | Loading… |
| loadui | string | 此項控制(zhì)ajax進程進行(xíng)時(shí)的動作(zuò)。Disable—取消jqGrid的進程指示，可(kě)使用自定義的指示。 enable (缺省)—表格中間(jiān)顯示loading。 block – 顯示“Loading”信息，禁用頁面上(shàng)的所有(yǒu)功能，直到數(shù)據裝入完成。 | enable |
| mtype | string | 定義提交類型POST或GET | GET |
| multikey | string | 此屬性隻有(yǒu)當multiselect為(wèi)true時(shí)有(yǒu)效，定義多(duō)選時(shí)的組合鍵，可(kě)選值有(yǒu)： shiftKey ，altKey，ctrlKey | empty |
| multiboxonly | boolean | 此屬性隻有(yǒu)當multiselect為(wèi)true時(shí)有(yǒu)效，. Multiboxonly設置為(wèi)true時(shí)，隻有(yǒu)點擊checkbox時(shí)該行(xíng)才被選中，點擊其他列，将清除當前行(xíng)的選中。 | false |
| multiselect | boolean | 此屬性設為(wèi)true時(shí)啓用多(duō)行(xíng)選擇，出現複選框 | false |
| multiselectWidth | integer | 若multiselect 為(wèi)true時(shí)，定義多(duō)選列的寬度。 | 20 |
| page | integer | 設置請(qǐng)求初始頁的數(shù)量，此參數(shù)通(tōng)過URL從服務器(qì)接受數(shù)據 | 1 |
| pager | mixed |
定義分頁浏覽導航條。必須是一個(gè)HTML元素，如
|
empty |
| pagerpos | string | 定義表格浏覽導航條的位置，缺省情況下建立一個(gè)包括3部分的導航條：頁碼，導航按鈕和(hé)記錄信息。 | center |
| pgbuttons | boolean | 定義導航激活時(shí)導航按鈕是否顯示。 | true |
| pginput | boolean | 定義導航欄是否有(yǒu)頁碼輸入框。 | true |
| pgtext | string | 當前頁信息。第一個(gè)量為(wèi)當前頁，第二個(gè)量為(wèi)總頁數(shù)。 | |
| prmNames | array | 缺省情況下prmNames: { page:“page”,rows:“rows”, sort: “sidx”,order: “sord”, search:“_search”, nd:“nd”, npage:null} 以POST方式發送到服務器(qì)，字段為(wèi)： page，rows，sidx，sord，search，nd 例如要将sidx改為(wèi)mysort，可(kě)寫成： prmNames: {sort: “mysort”}. 這樣提交到服務器(qì)的字符串就變為(wèi)： page=1&rows=10&mysort=myindex&sord=asc 若将一些(xiē)參數(shù)設為(wèi)null，這些(xiē)參數(shù)将不再發往服務器(qì)。例如prmNames: { nd:null} 則nd參數(shù)将不被發送。 Npage參數(shù)參見scroll option. | none |
| postData | array | 此數(shù)組能直接傳遞到url。這個(gè)數(shù)組可(kě)使用這種形式{name1:value1…}。 | empty |
| reccount | integer | 隻讀屬性。定義表格顯示的行(xíng)數(shù)。切勿與records混淆。 | 0 |
| recordpos | string | 定義頁中記錄信息的位置，可(kě)以是left，center，right。 | right |
| recordpos | object | 交替行(xíng)的類 | true |
| records | integer | 隻讀屬性。定義從請(qǐng)求中獲得(de)的記錄數(shù) | none |
| recordtext | string |
可(kě)在頁面上(shàng)顯示的提示信息，此文字隻在viewrecords 為(wèi)true是有(yǒu)效，并且當記錄總數(shù)大(dà)于0時(shí)才顯示。 此文字中{}中的內(nèi)容表示： {0} 該頁顯示的第一個(gè)記錄的記錄号 {1} 該頁顯示的最後一個(gè)記錄的記錄号 {2} 獲得(de)的記錄總數(shù) |
|
| resizeclass | string | 列可(kě)變大(dà)小(xiǎo)時(shí)的類 | empty |
| rowList | array[] | 用于改變顯示行(xíng)數(shù)的下拉列表框的元素數(shù)組。 | empty |
| rownumbers | boolean | 若此屬性為(wèi)true，表格左側将添加一用于顯示行(xíng)數(shù)（從1開(kāi)始）的列。此時(shí)colModel自動擴展出一個(gè)名為(wèi)rn的元素。所以在colModel中不要定義rn。 | false |
| rowNum | integer | 表格中可(kě)見的記錄數(shù)。此參數(shù)通(tōng)過url傳遞給服務器(qì)供檢索數(shù)據用。注意：若此參數(shù)設置為(wèi)10，而服務器(qì)返回15條記錄，将隻有(yǒu)10條記錄被裝入。若此參數(shù)被設置為(wèi)-1，則此檢查失效 | 20 |
| rownumWidth | integer | 當rownumbers為(wèi)true時(shí)，定義顯示行(xíng)數(shù)的列的寬度。 | 25 |
| savedRow | array | 隻讀屬性。用于行(xíng)編輯和(hé)單元格編輯保存數(shù)據之前 | empty |
| scroll | boolean or integer | 創建動态滾動表格。當設為(wèi)啓用時(shí)，pager被禁用，可(kě)使用垂直滾動條來(lái)裝入數(shù)據。 | false |
| scrollOffset | integer | 定義垂直滾動條的寬度。 | 18 |
| scrollrows | boolean | 該項啓用時(shí)，用setSelection 選定一行(xíng)，表格将滾動到被選行(xíng)可(kě)見。 | false |
| selarrrow | array-[] | 隻讀屬性。當multiselect 為(wèi)true時(shí)，包含當前選定的行(xíng)。此為(wèi)一維數(shù)組，值為(wèi)表格中選定行(xíng)的ID。 | empty |
| selrow | string | 隻讀屬性。內(nèi)容是最後選定行(xíng)的ID。如火(huǒ)應用了排序或pagging，該值為(wèi)null。 | null |
| shrinkToFit | boolean or integer |
該項描述計(jì)算(suàn)每列相對于表格寬度的初始寬度的類型。 若為(wèi)true，并且設置了列寬度，則每列的寬度根據定義寬度縮放。 若為(wèi)false，并且設置了列寬度，表格寬度為(wèi)設置寬度，列寬度不會(huì)重新計(jì)算(suàn)，使用colModel中定義的值 |
true |
| sortable | object | 啓用此項，允許使用鼠标重新排序列。 | true |
| sortname | string | 從服務器(qì)讀取XML或JSON數(shù)據時(shí)初始的排序名，此名被加到URL中。 | empty |
| sortorder | string | 從服務器(qì)讀取XML或JSON數(shù)據時(shí)初始的排序類型，此類型被加到URL中。可(kě)選值為(wèi)asc或desc。 | asc |
| subGrid | boolean | 設置為(wèi)true，可(kě)使用子表格。啓用子表格，将在基本表的左邊将添加一列，并包含一個(gè)“+”圖像，用戶可(kě)以點擊擴展行(xíng)。 | false |
| subGridModel | array-[] | 該屬性用于描述子表格的模式，隻有(yǒu)subGrid 為(wèi)true時(shí)有(yǒu)效。它是一個(gè)用于描述子表格列的數(shù)組。 | empty |
| subGridType | mixed | 用于定義子表格裝入的數(shù)據類型，若不定義，則使用與父表格同樣的數(shù)據類型。 | null |
| subGridUrl | string | 該屬性用于定義子表格獲得(de)數(shù)據的URL。行(xíng)的ID将鍵入此URL中，若要添加其他參數(shù)，可(kě)使用subGridModel 中的選項。 | empty |
| subGridWidth | integer | 定義子表格的列寬 | 20 |
| toolbar | array | 該參數(shù)定義表格的工具欄。參數(shù)是一個(gè)包含兩個(gè)值的數(shù)組，第一個(gè)值使工具欄有(yǒu)效，第二個(gè)值相對位置（可(kě)以是top、bottom、both）。例如：設置toolbar為(wèi) [true,”both”]，将在表格的頭部和(hé)底部建立兩個(gè)工具欄，兩個(gè)工具欄位兩個(gè)DIV元素，頭部DIV元素的ID為(wèi)“t_表格ID”，底部DIV元素的ID為(wèi)“tb_表格ID”。若隻有(yǒu)一個(gè)工具欄（top或bottom）時(shí)，DIV的ID為(wèi)“t_表格ID”。 | [false,''] |
| toppager | boolean | 是否在表格上(shàng)部顯示分頁條。 | false |
| totaltime | integer | 隻讀參數(shù)。用于記錄裝入XML和(hé)JSON數(shù)據的時(shí)間(jiān)。 | 0 |
| treedatatype | mixed | 定義初始數(shù)據類型 | null |
| treeGrid | boolean | 啓用（禁用）TreeGrid。 | false |
| treeGridModel | string | 定義TreeGrid的方法。可(kě)以是nested或adjacency。 | nested |
| treeIcons | array | 此數(shù)組設置TreeGrid中使用的圖标。圖标應是UI theme中的有(yǒu)效圖标。缺省為(wèi) {plus:'ui-icon-triangle-1-e',minus:'ui-icon-triangle-1-s',leaf:'ui-icon-radio-off'} | |
| treeReader | array | 擴展表格的colModel。這裏定義的字段将添加到colModel的尾部并隐藏。服務器(qì)将返回這些(xiē)字段的值。 | |
| tree_root_level | numeric | 确定treeGrid相對于根元素的級别。 | 0 |
| url | string | 請(qǐng)求數(shù)據的url地址 | null |
| userData | array | 此數(shù)組保存請(qǐng)求的自定義信息，可(kě)随時(shí)使用 | empty |
| userDataOnFooter | boolean | 到為(wèi)true時(shí)， userData直接放置在頁腳。 | false |
| viewrecords | boolean | 是否在浏覽導航欄顯示記錄總數(shù) | false |
| viewsortcols | array |
定義表頭中排序圖标的外觀和(hé)行(xíng)為(wèi)。缺省為(wèi)[false,'vertical',true]。 第一個(gè)參數(shù)設定是否顯示所有(yǒu)定義了排序的列旁顯示圖标。缺省的false表示隻有(yǒu)當前排序列旁的圖标顯示。設為(wèi)true可(kě)使所有(yǒu)可(kě)排序列都顯示圖标。 第二個(gè)參數(shù)設定排序圖标如何放置。vertical為(wèi)垂直放置，horizontal為(wèi)水(shuǐ)平放置。 第三個(gè)參數(shù)設定點擊功能。True表示表頭點擊排序，false表示隻點擊排序圖标排序。若将此參數(shù)設為(wèi)false時(shí)，請(qǐng)确保第一個(gè)參數(shù)為(wèi)true，否則将無法排序。 |
|
| width | number | 若為(wèi)設置，表格的寬度為(wèi)colModel 中定義的所有(yǒu)列寬度的總和(hé)。若設置了該項，每列的初始寬度按照shrinkToFit 設置的值 | none |
| xmlReader | array | 描述預期的XML數(shù)據結構的數(shù)組。 |
ColModel API
colModel屬性以數(shù)組的形式定義各個(gè)表格列。這是jqGrid中很(hěn)重要的部分。語法為(wèi)：
jQuery("#gridid").jqGrid({
...
colModel: [ {name:'name1', index:'index1'...}, {...}, ... ],
...
});
| 屬性 | 類型 | 描述 | 默認值 |
| align | string | 定義表格單元格（非表頭）的對齊方式，可(kě)取值：left, center, right. | left |
| classes | string | 此屬性用于定義列的類名，當有(yǒu)多(duō)個(gè)類名時(shí)，用空(kōng)格間(jiān)隔，例如：“class1 class2”。在表格的CSS中，有(yǒu)一個(gè)預定義的類ui-ellipsis用于定義特定的行(xíng) | empty |
| datefmt | string | 日期格式，可(kě)用/，-和(hé).。作(zuò)為(wèi)間(jiān)隔符。y、Y、yyyy用于4位年，YY、yy用于2位的月，d、dd用于日期 | Y-m-d |
| defval | string | 搜索字段的缺省值，此參數(shù)隻用于自定義搜索是的初始值。 | empty |
| editable | boolean | 定義字段是否可(kě)編輯，用于單元格編輯、行(xíng)編輯和(hé)表單模式 | false |
| editoptions | array | 根據edittype 參數(shù)定義可(kě)用的值數(shù)組 | empty |
| editrules | array | 設置可(kě)編輯字段的補充規則 | empty |
| edittype | string | 定義行(xíng)編輯和(hé)表單模式的編輯類型，可(kě)以是text、textarea、select、checkbox、 password、button、image和(hé)file。 | text |
| fixed | boolean | 若設為(wèi)true，即使shrinkToFit設置為(wèi)true，列寬也不允許重新計(jì)算(suàn)。GridWidth方法改變表格寬度時(shí)，列寬也不會(huì)改變。 | false |
| formoptions | array | 定義表單編輯的各種選項 | empty |
| hidedlg | boolean | 若設置為(wèi)true，該列将不出現在模式對話(huà)框中，用戶可(kě)以此控制(zhì)列的顯示或隐藏 | false |
| hidden | boolean | 定義初始化時(shí)，列是否隐藏。 | false |
| index | string | 通(tōng)過sidx參數(shù)設置排序時(shí)的索引名。 | empty |
| key | boolean | 在未從服務器(qì)獲得(de)ID的情況下，該列可(kě)設置為(wèi)行(xíng)ID。隻有(yǒu)一列可(kě)設置該屬性，若出現多(duō)列，表格隻采用将第一個(gè)設置了該屬性的列，其他列忽略。 | false |
| label | string | 當colNames數(shù)組為(wèi)空(kōng)時(shí)，定義此列的标題。若colNames數(shù)組和(hé)此屬性都為(wèi)空(kōng)，标題為(wèi)該列的name屬性值。 | none |
| name | string | 設置列在表格中的唯一名稱，此屬性是必須的。或者使用保留字subgrid、cb和(hé)rn. | Required |
| resizable | boolean | 定義是否可(kě)變列寬 | true |
| sortable | boolean | 定義是否可(kě)以排序 | true |
| sorttype | mixed | 當datatype為(wèi)local時(shí)，用于定義排序列類型。可(kě)取int/integer（整數(shù)）、float/number/currency（小(xiǎo)數(shù)）、date（日期）、text（文本） | text |
| title | boolean | 當設置為(wèi)false時(shí)，鼠标滑向單元格時(shí)不顯示title屬性 | true |
| width | number | 設置列的初始寬度，可(kě)用pixels和(hé)百分比 | 150 |
聯系我們
一切良好工作(zuò)的開(kāi)始，都需相互之間(jiān)的溝通(tōng)搭橋，歡迎咨詢。
