Datatables 1.10.x在命名上与1.9.x的有区别,新版的使用的是驼峰的命名规则,而之前的是采用匈牙利命名规则
当然,这些变化都是向下兼容的,你可以继续使用旧版本的api方法的参数和名称。 如果你要是用新版本的api方法,请参考下面表格的对照表,大多数的都是直接从匈牙利命名到驼峰命名,极个别重命名,还添加了新的属性名称。
现在可以这样创建一个Datatables:
$(...).dataTable()
创建一个Datatables并返回一个jquery对象(1.9-)
$(...).DataTable()
创建一个Datatables并返回一个新的Datatables API实例
两种方法都可以在1.10+版本中使用
匈牙利式 | 驼峰式 | 含义 |
---|---|---|
aaData |
dataDT
|
给表格显示数据 |
aaSorting |
orderDT
|
表格初始化排序 |
aaSortingFixed |
orderFixedDT
|
Ordering to always be applied to the table |
aDataSort |
columns.orderDataDT
|
定义多个列作为列的默认顺序 |
aLengthMenu |
lengthMenuDT
|
改变每页显示条数列表的选项 |
aTargets |
columnDefs.targetsDT
|
适用于指定一个特定的列 |
aoColumns |
columnsDT
|
列配置数组 |
aoColumnDefs |
columnDefsDT
|
列定义配置数组 |
aoSearchCols |
searchColsDT
|
给个别列定义搜索选项 |
asSorting |
columns.orderSequenceDT
|
指定排序 |
asStripeClasses |
stripeClassesDT
|
在表中设置斑马条纹类的行 |
bAutoWidth |
autoWidthDT
|
让Datatables自动计算宽度 |
bDeferRender |
deferRenderDT
|
延迟渲染可以提高Datatables的加载速度 |
bDestroy |
destroyDT
|
允许重新实例化Datatables |
bFilter |
searchingDT
|
开启搜索功能 |
bInfo |
infoDT
|
开启Datatables信息显示 |
bJQueryUI |
jQueryUIDT
|
使用jqueryui样式(需要引入jqueryui的css) |
bLengthChange |
lengthChangeDT
|
允许改变每页显示的数据条数 |
bPaginate |
pagingDT
|
允许表格分页 |
bProcessing |
processingDT
|
显示加载信息 |
bRetrieve |
retrieveDT
|
检索一个已存在的Datatables实例 |
bScrollAutoCss |
废弃 | |
bScrollCollapse |
scrollCollapseDT
|
开启滚动条 |
bScrollInfinite |
废弃 | |
bSearchable |
columns.searchableDT
|
定义列是否允许搜索 |
bServerSide |
serverSideDT
|
开启服务器模式 |
bSort |
orderingDT
|
是否启用Datatables排序 |
bSortable |
columns.orderableDT
|
开启或关闭某列的排序 |
bSortCellsTop |
orderCellsTopDT
|
Control which cell the order event handler will be applied to in a column |
bSortClasses |
orderClassesDT
|
排序列高亮显示 |
bStateSave |
stateSaveDT
|
允许浏览器缓存Datatables,以便下次恢复之前的状态 |
bUseRendered |
废弃 | Use columns.renderDT
|
bVisible |
columns.visibleDT
|
列是否显示 |
fnCookieCallback |
废弃 | |
fnCreatedCell |
columns.createdCellDT
|
单元格被创建回调函数,允许dom操作 |
fnCreatedRow |
createdRowDT
|
tr被创建回调函数 |
fnDrawCallback |
drawCallbackDT
|
表格重绘的时候回调函数 |
fnFooterCallback |
footerCallbackDT
|
foot显示回调函数 |
fnFormatNumber |
formatNumberDT
|
数字格式化回调函数 |
fnHeaderCallback |
headerCallbackDT
|
thead显示回调函数 |
fnInfoCallback |
infoCallbackDT
|
表格主要信息显示回调函数 |
fnInitComplete |
initCompleteDT
|
表格加载完成回调函数 |
fnPreDrawCallback |
preDrawCallbackDT
|
预绘制回调函数 |
fnRender |
废弃 | Use columns.renderDT
|
fnRowCallback |
rowCallbackDT
|
行重绘回调 |
fnServerData |
ajaxOption
|
从 Ajax 源加载数据的表的内容,ajax 作为function用法 |
fnServerParams |
ajax.dataOption
|
发送给服务器的参数 |
fnStateLoad |
stateLoadCallbackDT
|
定义在何处以及如何应加载已保存的状态的回调 |
fnStateLoaded |
stateLoadedDT
|
状态被读取回调 |
fnStateLoadParams |
stateLoadParamsDT
|
加载状态,数据操作回调 |
fnStateSave |
stateSaveCallbackDT
|
定义如何存和在哪里储表状态回调 |
fnStateSaveParams |
stateSaveParamsDT
|
状态保存,数据操作回调 |
iCookieDuration |
stateDurationDT
|
状态保存的有效期 |
iDataSort |
columns.orderDataDT
|
定义多个列作为列的默认顺序 |
iDeferLoading |
deferLoadingDT
|
延迟加载服务器端数据直到第二次重绘 |
iDisplayLength |
pageLengthDT
|
更改初始页面长度 (每页的行数) |
iDisplayStart |
displayStartDT
|
初始分页起始点 |
iScrollLoadGap |
废弃 | |
iTabIndex |
tabIndexDT
|
选项卡索引控件的键盘导航 |
mData |
columns.dataDT
|
从行数据对象/数组设置列的数据源 |
mRender |
columns.renderDT
|
Render (process) the data for use in the table |
oLanguage .oAria.sSortAscending |
language.aria.sortAscendingDT
|
用于WAI-ARIA(无障碍网页应用)属性 |
oLanguage .oAria.sSortDescending |
language.aria.sortDescendingDT
|
用于WAI-ARIA(无障碍网页应用)属性 |
oLanguage .oPaginate.sFirst |
language.paginate.firstDT
|
翻页中“首页”字符串 |
oLanguage .oPaginate.sLast |
language.paginate.lastDT
|
翻页中“尾页”字符串 |
oLanguage .oPaginate.sNext |
language.paginate.nextDT
|
翻页中“下一页”字符串 |
oLanguage .oPaginate.sPrevious |
language.paginate.previousDT
|
翻页中“上一页”字符串 |
oLanguage .sEmptyTable |
language.emptyTableDT
|
表格中没有数据时显示的字符串 |
oLanguage .sInfo |
language.infoDT
|
表格主要信息显示字符串 |
oLanguage .sInfoEmpty |
language.infoEmptyDT
|
当表格没有数据和搜索记录时,表格主要信息显示字符串 |
oLanguage .sInfoFiltered |
language.infoFilteredDT
|
当使用搜索功能后,表格主要信息出追加的字符 |
oLanguage .sInfoPostFix |
language.infoPostFixDT
|
追加到所有其他主要信息字符串之后 |
oLanguage .sInfoThousands |
language.thousandsDT
|
千分位分隔符 |
oLanguage .sLengthMenu |
language.lengthMenuDT
|
页面显示数据条数选项 |
oLanguage .sLoadingRecords |
language.loadingRecordsDT
|
当ajax加载数据时-加载信息显示字符串 |
oLanguage .sProcessing |
language.processingDT
|
显示正在处理字符串 |
oLanguage .sSearch |
language.searchDT
|
搜索框显示字符串 |
oLanguage .sUrl |
language.urlDT
|
从远程加载语言信息文件url |
oLanguage .sZeroRecords |
language.zeroRecordsDT
|
过滤后空的结果字符串 |
oSearch |
searchDT
|
设置一个在Datatables初始化时的搜索选项 |
sAjaxDataProp |
ajax.dataSrcDT
|
表数据的数据属性或操作方法 |
sAjaxSource |
ajax.urlOption
|
从 Ajax 源加载数据的表的内容 |
sCellType |
columns.cellTypeDT
|
要为列创建的单元格类型 |
sClass |
columns.classNameDT
|
指定单元格样式 |
sContentPadding |
contentPaddingDT
|
给文本内容添加填充被用来计算最合适的表格 |
sCookiePrefix |
废弃 | |
sDefaultContent |
columns.defaultContentDT
|
给列设置默认的,静态的内容 |
sDom |
domDT
|
按什么顺序定义表的控制元素在页面上出现 |
sName |
columns.nameDT
|
设置列的描述性名称 |
sPaginationType |
pagingTypeDT
|
分页按钮种类显示选项 |
sScrollX |
scrollXDT
|
水平滚动条 |
sScrollXInner |
scrollXInner |
没有文档在1.10中 |
sScrollY |
scrollYDT
|
垂直滚动条 |
sServerMethod |
ajax.typeOption
|
从 Ajax 源加载数据的表的内容的方式 |
sSortDataType |
columns.orderDataTypeDT
|
Live DOM sorting type assignment |
sTitle |
columns.titleDT
|
给列设置名称 |
sType |
columns.typeDT
|
设置用于筛选和排序字符串处理的列类型 |
sWidth |
columns.widthDT
|
设置列宽 |
以下是旧的api转换新的,新的api有很多,下面没有全部列出来。关于如何使用它,请参考api完整信息。
匈牙利式 | 驼峰式 | 含义 |
---|---|---|
$ |
$DT
|
Perform a jQuery selection action on the full table. |
_ |
row().data()DT ,
rows().data()DT ,
cell().data()DT
|
从行、列和单元格中获取数据 |
fnAddData |
row.add()DT ,
rows.add()DT
|
给表格添加一行或多行 |
fnAdjustColumnSizing |
columns.adjust()DT
|
重新计算列的宽度 |
fnClearTable |
clear()DT
|
清除表格的所有数据 |
fnClose |
row().child.hide()DT
|
隐藏父行的子行 |
fnDeleteRow |
row().remove()DT ,
rows().remove()DT
|
从Datatables删掉一行或或者更多 |
fnDestroy |
destroy()DT
|
从当前上下文销毁掉Datatables对象 |
fnDraw |
draw()DT
|
重绘表格 |
fnFilter |
search()DT ,
column().search()DT ,
columns().search()DT
|
从表格里搜索数据 |
fnGetData |
row().data()DT ,
rows().data()DT ,
cell().data()DT
|
从列,行,单元格中获取数据 |
fnGetNodes |
row().node()DT ,
rows().nodes()DT ,
cell().node()DT
|
从列,行和单元格里获取节点 |
fnGetPosition |
row().index()DT ,
cell.index()DT
|
获取有关选定的行、 列或单元格的索引信息 |
fnIsDataTable |
$.fn.dataTable.isDataTable()DT
|
检查表格的节点是不是Datatable对象 |
fnIsOpen |
row().child.isShown()DT
|
检查子行的父行是否可见 |
fnOpen |
row().child()DT
|
使父行的子行可见 |
fnPageChange |
page()DT
|
获取/设置表的当前页 |
fnSetColumnVis |
column().visible()DT
|
获取/设置单个所选列的可见性 |
fnSettings |
settings()DT
|
获取表的设置对象 |
fnSort |
order()DT ,
column().order()DT
|
选择指定列排序 |
fnSortListener |
order.listener()DT
|
给指定的列添加排序的监听 |
fnTables |
$.fn.dataTable.tables()DT
|
在本页得到所有的Datatables |
fnUpdate |
row().data()DT ,
cell().data()DT
|
设置行或单元格的数据 |
fnVersionCheck |
$.fn.dataTable.versionCheck()DT
|
版本号码的兼容性检查功能 |
Translation from DataTables.net, with permission