瞭解DataTables

官方網站:http://www.datatables.net/

簡介:DataTables是一個jQuery的表格插件。這是一個高度靈活的工具,依據的基礎逐步增強,這將增加先進的互動控制,支持任何HTML表格。

主要特點:

 

  • 自動分頁處理

  • 即時表格數據過濾

  • 數據排序以及數據類型自動檢測

  • 自動處理列寬度

  • 可通過CSS定製樣式

  • 支持隱藏列

  • 易用

  • 可擴展性和靈活性

  • 國際化

  • 動態創建表格

  • 免費的 

參數初始化:

 

bAutoWidth 

 

是否啓用自動適應列寬

默認值:True

示例代碼: 

$(document).ready(function(){
  $('#example').dataTable({
    "bAutoWidth": false
  });
});


 bDeferRender 

 是否啓用延遲加載:當你使用AJAX數據源時,可以提升速度。

 默認值:False

示例代碼:

$(document).ready(function(){
  var oTable = $('#example').dataTable({
    "sAjaxSource":"sources/arrays.txt",
    "bDeferRender":true
  });
});


bFilter 

是否啓用內置搜索功能:可以跨列搜索。

默認值:True 

示例代碼:

 $(document).ready(function(){
  $('#example').dataTable({
    "bFilter":false
  });
});

 

bInfo  

 是否顯示錶格相關信息:例如翻頁信息等。

默認值:True 

示例代碼: 

$(document).ready(function(){
  $('#example').dataTable({
    "bInfo":false
  });
});

 

bJQueryUI

是否啓用  jQuery UI 皮膚插件支持

默認值:False

示例代碼: 

$(document).ready(function(){
  $('#example').dataTable({
    "bJQueryUI":true
  });
});


 bLengthChange

是否允許用戶,在下拉列表自定義選擇分頁大小(10, 25, 50 and 100),需要分頁支持

默認值:True

示例代碼: 

 $(document).ready(function(){
  $('#example').dataTable({
    "bLengthChange": false
  });
});

 

bPaginate 

是否開啓分頁

默認值:Ture

示例代碼:

 $(document).ready(function (){ 
  $('#example').dataTable({
    "bPaginate":false
  });
});


bProcessing 

 是否啓用進度顯示,進度條等等,對處理大量數據很有用處。

默認值:false

示例代碼: 

$(document).ready(function(){
  $('#example').dataTable({
    "bProcessing":true
  });
});

 

bScrollInfinite  

是否開啓內置滾動條,並且顯示所有數據

默認值:fasle 

 示例代碼: 

$(document).ready(function(){
  $('#example').dataTable({
    "bScrollInfinite":true,
    "bScrollCollapse":true,
    "sScrollY": "200px"
  });
});


 bServerSide

是否啓用服務器處理數據源,必須sAjaxSource指明數據源位置

默認值:False

示例代碼:

$(document).ready(function(){
  $('#example').dataTable({
    "bServerSide":true,
    "sAjaxSource":"xhr.php"
  });
});


 bSort 

是否開啓列排序功能,如果想禁用某一列排序,可以在每列設置使用bSortable參數

 默認值:True

示例代碼: 

$(document).ready(function(){
  $('#example').dataTable({
    "bSort":false
  });
});


bSortClasses  

 開關,指定當當前列在排序時,是否增加classes ‘sorting_1′, ‘sorting_2′ and ‘sorting_3’,打開後,在處理大數據時,性能有所損失

 默認值:False

示例代碼:

$(document).ready(function(){
  $('#example').dataTable({
    "bSortClasses":false
  });
});


bStateSave  

 是否開啓cookies保存當前狀態信息

 默認值:false

 示例代碼:

$(document).ready(function(){
  $('#example').dataTable({
    "bStateSave": true
  });
});


sScrollX 

是否開啓水平滾動條

默認值:空 (字符串類型)

 示例代碼:

$(document).ready(function(){
  $('#example').dataTable({
    "sScrollX":"100%",
    "bScrollCollapse": true
  });
});


sScrollY

 是否開啓垂直滾動條,滾動條大小受限於Datatable的高度大小

默認值:空(字符串類型)

示例代碼:

$(document).ready(function(){
  $('#example').dataTable({
    "sScrollY":"200px",
    "bPaginate":false
  });
});


屬性名稱取值範圍解釋
bAutoWidthtrue or false, default true是否自動計算表格各列寬度
bDeferRendertrue or false, default false用於渲染的一個參數
bFiltertrue or false, default true開關,是否啓用客戶端過濾功能
bInfotrue or false, default true開關,是否顯示錶格的一些信息
bJQueryUItrue or false, default false是否使用jquery ui themeroller的風格
bLengthChangetrue or false, default true開關,是否顯示一個每頁長度的選擇條(需要分頁器支持)
bPaginatetrue or false, default true開關,是否顯示(使用)分頁器
bProcessingtrue or false, defualt false開關,以指定當正在處理數據的時候,是否顯示“正在處理”這個提示信息
bScrollInfinitetrue or false, default false開關,以指定是否無限滾動(與sScrollY配合使用),在大數據量的時候很有用。當這個標誌爲true的時候,分頁器就默認關閉
bSorttrue or false, default true開關,是否讓各列具有按列排序功能
bSortClassestrue or false, default true開關,指定當當前列在排序時,是否增加classes ‘sorting_1′, ‘sorting_2′ and ‘sorting_3’,打開後,在處理大數據時,性能有所損失
bStateSavetrue or false, default false開關,是否打開客戶端狀態記錄功能。這個數據是記錄在cookies中的,打開了這個記錄後,即使刷新一次頁面,或重新打開瀏覽器,之前的狀態都是保存下來的
sScrollX‘disabled’ or  ‘100%’ 類似的字符串是否開啓水平滾動,以及指定滾動區域大小
sScrollY‘disabled’ or ‘200px’ 類似的字符串是否開啓垂直滾動,以及指定滾動區域大小
選項

aaSortingarray array[int,string], 如[], [[0,’asc’], [0,’desc’]]指定按多列數據排序的依據
aaSortingFixed同上同上。唯一不同點是不能被用戶的自定義配置衝突
aLengthMenudefault [10, 25, 50, 100],可以爲一維數組,也可爲二維數組,比如:[[10, 25, 50, -1], [10, 25, 50, “All”]]這個爲選擇每頁的條目數,當使用一個二維數組時,二維層面只能有兩個元素,第一個爲顯示每頁條目數的選項,第二個是關於這些選項的解釋
aoSearchColsdefault null, 類似:[null, {“sSearch”: “My filter”}, null,{“sSearch”: “^[0-9]”, “bEscapeRegex”: false}]給每個列單獨定義其初始化搜索列表特性(這一塊還沒搞懂)
asStripClassesdefault [‘odd’, ‘even’], 比如[‘strip1′, ‘strip2′, ‘strip3′]指定要被應用到各行的class風格,會自動循環
bDestroytrue or false, default false用於當要在同一個元素上執行新的dataTable綁定時,將之前的那個數據對象清除掉,換以新的對象設置
bRetrievetrue or false, default false用於指明當執行dataTable綁定時,是否返回DataTable對象
bScrollCollapsetrue or false, default false指定適當的時候縮起滾動視圖
bSortCellsToptrue or false, default false(未知的東東)
iCookieDuration整數,默認7200,單位爲秒指定用於存儲客戶端信息到cookie中的時間長度,超過這個時間後,自動過期
iDeferLoading整數,默認爲null延遲加載,它的參數爲要加載條目的數目,通常與bServerSide,sAjaxSource等配合使用
iDisplayLength整數,默認爲10用於指定一屏顯示的條數,需開啓分頁器
iDisplayStart整數,默認爲0用於指定從哪一條數據開始顯示到表格中去
iScrollLoadGap整數,默認爲100用於指定當DataTable設置爲滾動時,最多可以一屏顯示多少條數據
oSearch默認{ “sSearch”: “”, “bRegex”: false, “bSmart”: true }又是初始時指定搜索參數相關的,有點複雜,沒搞懂目前
sAjaxDataProp字符串,default ‘aaData’指定當從服務端獲取表格數據時,數據項使用的名字
sAjaxSourceURL字符串,default null指定要從哪個URL獲取數據
sCookiePrefix字符串,default ‘SpryMedia_DataTables_’當打開狀態存儲特性後,用於指定存儲在cookies中的字符串的前綴名字
sDomdefault lfrtip (when bJQueryUI is false) or <“H”lfr>t<“F”ip> (when bJQueryUI is true)這是用於定義DataTable佈局的一個強大的屬性,另開專門文檔來補充說明吧
sPaginationType‘full_numbers’ or ‘two_button’, default ‘two_button’用於指定分頁器風格
sScrollXInnerstring default ‘disabled’又是水平滾動相關的,沒搞懂啥意思


回調函數名稱參數返回值默認功能
fnCookieCallback1.string: Name of the cookie defined by DataTables
2.object: Data to be stored in the cookie
3.string: Cookie expires string
4.string: Path of the cookie to set
string: cookie formatted string (which should be encoded by using encodeURIComponent())null當每次cookies改變時,會觸發這個函數調用
fnDrawCallback在每次table被draw完後調用,至於做什麼就看着辦吧
fnFooterCallback1.node : “TR” element for the footer
2.array array strings : Full table data (as derived from the original HTML)
3.int : Index for the current display starting point in the display array
4.int : Index for the current display ending point in the display array
5.array int : Index array to translate the visual position to the full data array
用於在每次重畫的時候修改表格的腳部
fnFormatNumber1.int : number to be formattedString : formatted string for DataTables to show the number有默認的用於在大數字上,自動加入一些逗號,分隔開
fnHeaderCallback1.node : “TR” element for the header
2.array array strings : Full table data (as derived from the original HTML)
3.int : Index for the current display starting point in the display array
4.int : Index for the current display ending point in the display array
5.array int : Index array to translate the visual position to the full data array
用於在每次draw發生時,修改table的header
fnInfoCallback1.object: DataTables settings object
2.int: Starting position in data for the draw
3.int: End position in data for the draw
4.int: Total number of rows in the table (regardless of filtering)
5.int: Total number of rows in the data set, after filtering
6.string: The string that DataTables has formatted using it’s own rules
string: The string to be displayed in the information element.用於傳達table信息
fnInitComplete1.object:oSettings – DataTables settings object表格初始化完成後調用
fnPreDrawCallback1.object:oSettings – DataTables settings objectBoolean用於在開始繪製之前調用,返回false的話,會阻止draw事件發生;返回其它值,draw可以順利執行
fnRowCallback1.node : “TR” element for the current row
2.array strings : Raw data array for this row (as derived from the original HTML)
3.int : The display index for the current table draw
4.int : The index of the data in the full list of rows (after filtering)
node : “TR” element for the current row當創建了行,但還未繪製到屏幕上的時候調用,通常用於改變行的class風格
fnServerData1.string: HTTP source to obtain the data from (i.e. sAjaxSource)
2.array objects: A key/value pair object containing the data to send to the server
3.function: Function to be called on completion of the data get process that will draw the data on the page.
void$.getJSON用於替換默認發到服務端的請求操作
fnStateLoadCallback1.object:oSettings – DataTables settings object
2.object:oData – Object containing information retrieved from the state saving cookie which should be restored. For the exact properties please refer to the DataTables code.
Boolean – false if the state should not be loaded, true otherwise在cookies中的數據被加載前執行,可以方便地修改這些數據
fnStateSaveCallback1.object:oSettings – DataTables settings object
2.String:sValue – a JSON string (without the final closing brace) which should be stored in the state saving cookie.
String – the full string that should be used to save the state在狀態數據被存儲到cookies前執行,可以方便地做一些預操作



具體的參數意思可以參考官方文檔。這裏提一下fnServerParams。這個參數可以幫我們傳遞頁面的其他參數,這個例子中,我傳遞了關鍵字、起止日期信息,主要用於服務端的數據查找過濾。


用chrome看一下控件會向服務端傳遞什麼:



這是底部的分頁欄



當我點第二頁時,傳遞參數如下:


注意到iDisplayLength10,因爲我默認是每頁展示10條數據,這個值可以調整。當我點第二頁時,iDisplayStart0變到10。其實分頁就是這麼回事,前端告訴服務端,我需要那段數據,你給我找出來返回給我。


服務端的返回格式如下(PHP):

$ret = array(
                "sEcho" => intval($_GET['sEcho']),
                "iTotalRecords" => $data_count,
                "iTotalDisplayRecords" => $data_count,
                "aaData" => array()
            );


發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章