jqGrid的屬性列表

jqGrid的屬性不少，其實很大部分的屬性，使用其默認值就能夠了。可是詳細瞭解一下屬性的含義以及做用，對咱們定製本身的grid是有幫助的。

如下內容描述格式是：

• 屬性名稱

    參數值類型
    描述內容(可能有多行)
    默認值
    是否可修改(表示grid建立完成以後，該屬性是否可以被修改。也就是說，是否grid的初始化的屬性值可以被修改)
————詳細屬性列表————

• ajaxGridOptions

    object
    本選項用來設置全局的Ajax設置。注意：這個選項會覆蓋當前全部的ajax設置，包括ajax的error、complete以及beforeSend事件。
    默認值:empty object
    該屬性能夠修改

• ajaxSelectOptions

    object
    本選項用來設置select元素的ajax全局設置。在searchoptions選項或者editoptions選項屬性設置中，能夠經過設置dataUrl來獲取生成一個select的下拉框內容的URL。jqGrid經過ajax的方式訪問這個URL來自動獲取可選擇值。
    注意：這裏要求經過dataUrl返回的結果是形如<select><option value =」1」>One</option><option value=」2」>Two</option></select>這種格式的字符串。固然，其實也能夠直接返回1：One；2：Two這種格式的數據，可是要經過另一個選項進行處理，處理以後仍是要變成上面的字符串。好比searchOptions中，就有一個屬性是buildSelect，就是用來幹這事兒的。
    默認值:empty object
    該屬性能夠修改

• altclass

    string
    用來設置jqGrid的交替行的class。只有設置了altRows爲true纔有效。
    默認值:ui-priority-secondary
    該屬性能夠修改. Requires reload

• altRows

    boolean
    設置jqGrid顯示爲斑馬線樣式。就是隔行用不一樣的背景色區分開。
    默認值:false
    該屬性能夠修改. After reload

• autoencode

    boolean
    設置爲true，會對從服務器返回的數據以及編輯模式下提交的數據進行HTML編碼。好比，把小於符號轉換成&lt;
    默認值:false
    該屬性能夠修改

• autowidth

    boolean
    設置爲true，grid的寬度會根據父元素的寬度自動從新計算。注意，這個值是在初始化的時候設定好了，若是要在運行中設置寬度，須要經過setGridWidth方法來修改。
    默認值:false
    該屬性不能修改

• caption

    string
    設置Grid的標題.
    默認值:empty string
    該屬性不能修改.Method avail.

• cellLayout

    integer
    本選項設置單元格的padding + border寬度. 通常狀況下不要去修改。
    默認值:5
    該屬性不能修改

• cellEdit

    boolean
    設置Cell Editing模式是否啓用。
    默認值:false
    該屬性能夠修改

• cellsubmit

    string
    肯定Cell Editing模式下，內容保存到遠程服務器仍是本地數組。'remote' 或者 'clientArray'。
    默認值:'remote'
    該屬性能夠修改

• cellurl

    string
    肯定Cell Editing模式下，訪問的URL。
    默認值:null
    該屬性能夠修改

• colModel

    array
    重要的屬性。用來設置列名稱。
    默認值:empty array
    該屬性不能修改

• colNames

    array[]
    重要的屬性。用來設置Grid每個列的屬性，一個列做爲一個數組元素設置。Name屬性是必須的。
    注意：這裏的數組長度（也就是列數）必須和colModel數組的長度一致。更詳細的內容，須要單獨說明。
    默認值:empty array[]
    該屬性不能修改

• datastr

    string
    若是datatype屬性設置爲xmlstring或者jsonstring的狀況下，本屬性用來設置其值。
    默認值:null
    該屬性能夠修改

• datatype

    string
    肯定grid中顯示的數據源格式。
    xml – xml數據;
    xmlstring – 被當作字符串的xml數據；
    json – JSON格式數據 ；
    jsonstring – 被當作字符串的JSON數據；
    local – 定義在客戶端的數組數據；
    javascript – javascript的數據
    function – 客戶定義函數用來獲取數據；
    默認值:xml
    該屬性能夠修改

• deselectAfterSort

    boolean
    只有當datatype設置爲local纔有效。當排序以後，是否從新選擇排序以前選中的行(多行)。
    默認值:true
    該屬性能夠修改

• direction

    string
    肯定grid中文本顯示的方向。默認ltr表示從左道右。還有一個可選值是rtl表示從右到左。
    本選項只在FireFox 3.x和IE >=6的瀏覽器有效。當前Safai和Google Chrome、Opera不徹底支持「rtl」。FireFox默認設置是不支持RTL的，可是能夠經過修改FireFox的layout.scrollbar.side設置爲1來支持。本屬性是在jqGrid v3.6版本中新增長的。
    默認值:ltr
    該屬性不能修改

• editurl

    string
    設置編輯的URL地址。
    默認值:null
    該屬性能夠修改

• emptyrecords

    string
    設置當查詢記錄條數是0的狀況下，jqGrid上顯示的信息。只有當viewrecords選項設置爲true纔有效。
    默認值:see lang file
    該屬性能夠修改

• ExpandColClick

    boolean
    設置爲true，當咱們點擊treeGrid的文本時候，會展開或者收縮內容
    默認值:true
    該屬性不能修改

• ExpandColumn

    string
    制定到底那一列(colModel的name名稱來指定)用來展開樹形grid.若是沒有設置，默認是第一列。只有當treeGrid選項設置爲true纔有效。
    默認值:null
    該屬性不能修改

• footerrow

    boolean
    若是設置爲true，則會在grid的底部，導航條之上顯示一個只有一行的table。列的數量和colModel定義的數量一致。
    默認值:false
    該屬性不能修改

• forceFit

    boolean
    若是設置爲true，而且用戶改變了列寬度，那麼右邊臨近的列寬度會自動調整以適應grid的總體寬度。這種狀況下，是沒有水平滾動條的。
    注意：本選項與shrinkToFit選項不相容。若是shrinkToFit設置爲false，那麼forceFit的設置將被忽略。
    默認值:false
    該屬性不能修改

• gridstate

    string
    設置grid的狀態。有兩個可選值'visible'和'hidden'
    默認值:visible
    該屬性不能修改

• gridview

    boolean
    在包括jqGrid v3.4.X以前的版本中，讀取大數據集會存在速度問題。主要緣由就是每個單元格都是用了5-6條jQuery調用被插入到grid中。如今咱們能夠經過設置gridview 選項爲true來解決這個問題。這時候，咱們用一個jQuery追加一次插入整行的數據。比之前快了3-5倍。
    固然，使用也有限制，設置爲true以後，不能使用treeGrid，subGrid或者afterInsertRow事件。
    默認值:false
    該屬性能夠修改

• height

    mixed
    Grid的高度設置。若是設置爲’100%’那麼高度能夠自適應。不過要注意，假設咱們設置每頁顯示的條數是50條記錄，設置height=’100%’,可能後面的一些記錄顯示不出來。默認狀況下，grid是沒有垂直滾動條的。
    默認值:150
    該屬性不能修改.Method avail.

• hiddengrid

    boolean
    設置爲true，grid初始顯示是隱藏的。隱藏狀況下，數據沒有加載(沒有向服務器的請求)，只顯示標題。當grid第一次顯示的時候，才提交服務器請求並顯示數據。
    默認值:false
    該屬性不能修改

• hidegrid

    boolean
    設置grid的隱藏/顯示按鈕是否可用。
    默認值:true
    該屬性不能修改

• hoverrows

    boolean
    設置爲false，在grid的數據行中鼠標懸浮被禁用。
    默認值:false
    該屬性能夠修改

• jsonReader

    array
    定義json數據的格式描述信息。咱們默認指望的數據格式是：默認的數據根節點名稱是rows，當前頁的名稱是page……。假設咱們服務器返回的數據，root的名稱不是rows而是datas，page的名稱不是page而是currentPage，那麼能夠以下從新定義jsonReader來讀取數據：

    jsonReader:{
      root:」datas」,
      page:」currentPage」
    }
    默認值:無
    該屬性不能修改

• lastpage

    integer
    只讀屬性，指定請求總共能夠返回多少頁。
    默認值:0
    該屬性不能修改

• lastsort

    integer
    只讀屬性。指定了最後排序列。從0開始計數。
    默認值:0
    該屬性不能修改

• loadonce

    boolean
    若是設置爲true，grid只從服務器加載一次數據。加載數據完成以後，datatype就被指定爲local，而且之後全部的操做都是基於客戶端的操做，同時，導航功能也會被禁用。
    默認值:false
    該屬性不能修改

• loadtext

    string
    請求或者排序數據的時候，顯示在頁面上的等待信息內容。
    默認值:Loading…
    該屬性不能修改

• loadui

    string
    本選項控制在一個ajax請求執行過程當中作什麼。
    disable – jqGrid的指示信息不可用。
    enable  - 顯示 「Loading」信息。
    block – 能夠顯示「Loading」信息，同時阻止grid的全部操做直到ajax請求完成。注意，這會禁止全部的排序、導航或者任何工具條的操做。
    默認值:enable
    該屬性能夠修改

• mtype

    string
    肯定請求方式。「POST」或「GET」
    默認值:GET
    該屬性能夠修改

• multikey

    string
    只有當multiselect選項設置爲true的時候纔有意義。定義使用哪個鍵來作多選。可選值: shiftKey/altKey/ctrlKey
    默認值:empty string
    該屬性能夠修改

• multiboxonly

    boolean
    只有當multiselect = true時起做用，若是multiselect設置爲true，那麼點擊行任何位置均可以選中行。當multiboxonly設置爲ture以後，就只有點擊行前面的checkbox纔會選中行。若是點擊其它沒有被選中的行，那麼點中的行被選擇，其它行取消選擇。(Yahoo模式)
    默認值:false
    該屬性能夠修改

• multiselect

    boolean
    定義grid中的數據行是否能夠被多選。會在grid的最左邊增長一列checkbox的選擇框。
    默認值:false
    該屬性不能修改. see HOWTO

• multiselectWidth

    integer
    當multiselect爲true時設置multiselect列寬度
    默認值:20
    該屬性不能修改

• page

    integer
    設置初始的頁碼。這個參數會被自動添加到URL後面，傳遞到後臺服務器處理程序中。
    默認值:1
    該屬性能夠修改

• pager

    mixed
    指定導航條對象，這裏要使用jQuery的語法來指定一個實際存在的html元素對象。大部分狀況下，都是指定一個div對象的ID。
    有幾種方式指定：(假設div的id=nav)
    jQuery(‘#nav’)
    ‘#nav’(推薦用這種方式調用)
    ‘nav’
    默認值:empty string. Currently only one pagebar is possible.
    該屬性不能修改

• pagerpos

    string
    肯定pager在grid中的位置。默認狀況下，pager被分紅三個部分。一部分用來顯示pager，一部分用做導航條按鈕，一部分用來顯示記錄信息。
    默認值:center
    該屬性不能修改

• pgbuttons

    boolean
    肯定是否顯示pager的按鈕。
    默認值:true
    該屬性不能修改

• pginput

    boolean
    肯定是否顯示容許用戶直接輸入頁碼進行跳轉的輸入框。
    默認值:true
    該屬性不能修改

• pgtext

    string
    顯示關於當前頁狀態的信息。第一個參數是當前頁碼，第二個參數是總共的頁數。
    默認值:See lang file
    該屬性能夠修改

• prmNames

    array
    定製傳遞到服務器上的Post數據的字段名稱。默認值是：
    prmNames: {page:「page」,rows:「rows」, sort: 「sidx」,order: 「sord」, search:「_search」, nd:「nd」, npage:null}
    默認的狀況下，上傳的數據以下url所示：
     URL?page=1&rows=10&sidx=myindex&sord=asc
    若是咱們設置一下本屬性{sort:」mysort」}那麼實際調用的URL地址以下：
    URL?page=1&rows=10&mysort=myindex&sord=asc
    經過這個屬性的設置，能夠改變字段的名稱。
    默認值:none
    該屬性能夠修改

• postData

    array
    設置直接經過url傳遞到服務器的其餘參數。本屬性的調用方式是傳遞一個形如{name1:value,name2:value2…}的數組。
    默認值:empty array
    該屬性能夠修改

• reccount

    integer
    只讀屬性。肯定grid中顯示的記錄數量。不要把這個屬性和records參數混淆了。records參數肯定每頁最多能夠顯示的數據條數。
    默認值:0
    該屬性不能修改

• recordpos

    string
    肯定記錄條數信息在pager上面的位置。可能的值是left, center, right
    默認值:right
    該屬性不能修改

• records

    integer
    只讀屬性。肯定從請求返回的記錄條數。
    默認值:none
    該屬性不能修改

• recordtext

    string
    顯示在pager上面的信息。在viewrecords屬性被設置爲true時有效。只有在總數量大於0的時候才顯示。
    這是一個用{n}格式化的顯示字符串。其中第一個參數{0}表明記錄的起始位置（grid顯示的第一條記錄在全部記錄中的位置），第二個參數{1}表示grid最後一條記錄在總記錄中的位置，第三個參數{2}表明總的記錄條數。
    好比：從{0}到{1}共{2}
    默認值:see lang file
    該屬性能夠修改

• resizeclass

    string
    爲列指定一個調整寬度時候的現實風格class。
    默認值:empty string
    該屬性不能修改

• rowList

    array[]
    本參數用來爲grid生成一個可供選擇的調整每頁顯示記錄條數的下拉菜單。在grid中選擇修改這個值，jqGrid會用新的選擇值來修改rowNum參數並傳遞到服務器端。能夠設置的格式如 [10,20,30]
    默認值:empty array - []
    該屬性不能修改

• rownumbers

    boolean
    若是設置爲true，則會在grid的左邊增長一列，增長的列用來顯示記錄行數，記錄從1開始顯示。這種狀況下，colModel被一個name爲rn的列自動擴展。由此，咱們要注意了，在咱們本身定義的列中，不要使用name=’rn’這種名稱。
    默認值:false
    該屬性不能修改

• rowNum

    integer
    設置每個grid的頁作多顯示多少條記錄。
    這個參數會經過url參數傳遞到服務器端進行分頁處理。
    注意，若是你設置了頁面最多顯示10條記錄，也就是rowNum=10，可是服務器端返回了15條記錄，頁面上也只會顯示10條記錄。
    設置本值爲-1表示頁面顯示記錄沒有限制。
    默認值:20
    該屬性能夠修改

• rownumWidth

    integer
    若是rownumbers設置爲true，本屬性用來設置該列的寬度。
    默認值:25
    該屬性不能修改

• savedRow

    array
    只讀屬性。本屬性用在Inline Editing和Cell Editing模式下，用來在編輯行或者單元格以前保存數據。
    默認值:empty array
    該屬性不能修改

• scroll

    boolean or integer
    建立一個動態滾動的grid。若是本屬性可用，pager元素被禁用，改用垂直滾動條來動態加載數據。當設置爲true時，grid會在第一次加載的時候，把全部的數據取出到客戶端，當scroll被設置爲一個數字，grid將只顯示可見的幾行數據。
    請注意，這裏有一個可選的擴展參數npage傳遞到服務器端。若是在prmNames數組中設置了npage的值，那麼grid將一次請求多頁數據。因此這裏服務器端的按頁獲取數據的方法須要特別注意處理。
    默認值:false
    該屬性不能修改

• scrollOffset

    integer
    設置垂直滾動條寬度。
    默認值:18
    該屬性不能修改.Method avail.

• scrollrows

    boolean
    設置爲true，當咱們用setSelection選中記錄時，grid會自動滾動到選中的行記錄，讓該行記錄可見。假設grid有垂直滾動條，當咱們在Form Editing編輯模式下修改記錄，用編輯頁的先後導航按鈕定位記錄的時候，當導航到一個隱藏的行記錄的時候，grid會自動滾動以使讓選中的行記錄變成可見。
    默認值:false
    該屬性能夠修改

• selarrrow

    array-[]
    只讀屬性。在multiselect=true的狀況下，肯定當前選中的全部行。數組中包含的值只是選中列的id，用逗號隔開。好比[1,3,4,5]表示選中了id爲一、三、四、5的行。
    默認值:empty array []
    該屬性不能修改

• selrow

    string
    只讀屬性。最後選中行的id。若是從新排序或者進行了導航，這個值爲null。（也就是沒有選中任何行的意思！）
    這個屬性很重要，不少時候，假設咱們要對選中的行的數據進行一些處理，那麼就必需要用到這個屬性。你們能夠看看jqGrid的Demo中有不少例子都用到這個屬性。
    默認值:null
    該屬性不能修改

• shrinkToFit

    boolean
    肯定初始化時候每列的寬度的算法。若是設置爲true，表示每列的寬度按照全部列設定的寬度值的和與grid設定的寬度按比例進行縮放。若是設置爲false，則列寬按照colModel中設定的寬度顯示。
    默認值:true
    該屬性不能修改

• sortable

    boolean
    設置grid是否能夠按照列進行排序。這個屬性用到了jQuery UI的sortable插件。要確保加載了相應的文件，同時要確保下載jqGrid的時候，包含了grid.jqueryui.js包。
    默認值:false
    該屬性不能修改

• sortname

    string
    當使用xml或者json數據類型時，設置默認的排序字段名稱。這個參數會被增長到url上傳遞到服務器端。
    默認值:empty string
    該屬性能夠修改

• sortorder

    string
    當使用xml或者json數據類型時，設置默認的排序方式。可選值asc或desc.
    默認值:asc
    該屬性能夠修改

• subGrid

    boolean
    設置是否能使用subgrid。
    默認值:false
    該屬性不能修改

• subGridModel

    array-[]
    設置subGrid的描述信息。只在subGrid設置爲true纔有效。具體可設置的屬性須要參考subGrid的文檔。
    默認值:empty array
    該屬性不能修改

• subGridType

    mixed
    容許經過一個service來加載subgrid。若是沒有設置，則採用父grid的datatype。
    默認值:null
    該屬性能夠修改

• subGridUrl

    string
    加載subgrid數據的url，jqGrid會把每行的id值看成參數加到url中。只有在subGrid=true是纔有效。若是須要傳遞額外的參數，請使用subGridModel中的params選項。
    默認值:empty string
    該屬性能夠修改

• subGridWidth

    integer
    設置subGrid列的寬度。
    默認值:20
    該屬性不能修改

• toolbar

    array
    Grid的工具欄。數組中有兩個值，第一值指示toolbar是否可用，第二個值定義了toolbar相對於body Layer的位置，可能的值包括「top」,」bottom」, 「both」
    當咱們設置值爲[true,」both」]，會建立兩個工具欄，一個在table的頂部，一個在table的底部。
    頂部的工具欄的div的id等於」t_」+grid的Id。底部的工具欄的div的id等於」tb_」 +grid的Id。 注意：當只建立一個工具欄的時候，無論位置是在頂部仍是底部，工具欄的div的id都等於」t_」+grid的Id。
    默認值:[false,'']
    該屬性不能修改

• totaltime

    integer
    只讀屬性。計算加載數據的時間。目前只支持加載xml以及json格式數據。從請求完成開始計算時間，到加載完最後一行記錄截至。
    默認值:0
    該屬性不能修改

• treedatatype

    mixed
    樹形grid狀況下，datatype。一般與grid自身定義的datatype保持一致。不多會改變。
    默認值:null
    該屬性不能修改

• treeGrid

    boolean
    開啓或者禁用樹形grid的模式。
    默認值:false
    該屬性不能修改

• treeGridModel

    string
    肯定treeGrid的方法。多是nested或 adjacency
    默認值:nested
    該屬性不能修改

• treeIcons

    array
    樹形grid使用的圖標。默認值是{plus:'ui-icon-triangle-1-e',minus:'ui-icon-triangle-1-s',leaf:'ui-icon-radio-off'}
    默認值：無
    該屬性不能修改

• treeReader

    array
    擴展grid的colModel且加在colModel定義的後面這意味着從服務器返回的數據必須包含這些字段值。
    默認值：無
    該屬性不能修改

• tree_root_level

    numeric
    treeGrid root元素的級別
    默認值:0
    該屬性不能修改

• url

    string
    請求的URL地址。
    默認值:null
    該屬性能夠修改

• userData

    array
    本屬性包含一些從request中獲取的自定義的信息。好比不想直接顯示在grid中的一些數據。
    默認值:empty array
    該屬性不能修改

• userDataOnFooter

    boolean
    若是設置爲true，則直接把userData中的數據顯示在grid的頁腳。規則是：若是userData數據包含和colModel中name同樣的名字，那麼userData的值就顯示在該列。不然，什麼都不顯示。
    The rules are as follow: If the userData array contain name which is equal to those of colModel then the value is placed in that column.If there are 該屬性不能修改 such values 該屬性不能修改thing is palced.
    默認值:false
    該屬性能夠修改

• viewrecords

    boolean
    肯定是否顯示總的記錄條數。
    默認值:false
    該屬性不能修改

• viewsortcols

    array
    本參數主要用來定義出如今標題附近的排序圖標的不一樣的外觀和行爲。
    參數數組的組成以下： [false,'vertical',true]. 第一個參數肯定，若是全部的列排序屬性都是true，是否全部的圖標都能同時看到。默認值false表示只有最後排序列的圖標可見。
    第二個參數肯定圖標的位置。可能的值是vertical 表示排序圖標一個在另外一個的上面。'horizontal' 表示水平放置兩個圖標。
    第三個參數肯定鼠標點擊事件功能。設置爲true，表示，表示點擊列標題可排序；設置爲false表示只能點擊圖標才能排序。
    重要提示：若是設置第三個參數爲false，那麼必需要設置第一個參數爲true，不然，排序功能可能丟失。
    默認值：無
    該屬性不能修改

• width

    number
    設置grid的寬度。若是本屬性沒有設置，則按照各個列定義在colModel中的寬度總和做爲grid的寬度。若是設置了本值，則grid中每個列的初始寬度按照shrinkToFit參數定義來肯定。
    默認值:none
    該屬性不能修改. Method avail.

• xmlReader

    array    對xml的數據格式的說明。參考jsonReader的描述。    默認值：無    該屬性不能修改