ProgramLanguage/Script/JavaScript/jQuery

DataTable

API

名称備考
$
_
fnAddDataデータを追加します。
fnAdjustColumnSizingすべての列幅を調節する。
fnClearTableすべてのレコードをクリアする。
fnClosefnOpen メソッドで追加された行を削除する。
fnDeleteRow行を削除する。
fnDestroy表を破棄する。
fnDraw表を再描画する。
fnFilter文字列に一致した行を表示する。
fnGetData指定した行のすべての列の値、または、指定されたセルの値を示します。
fnGetNodes指定した行のDOMツリーを示します。
行を指定しない場合は、すべての行のDOMツリーを配列で定義して示します。
fnGetPosition行番号、または列番号を示します。
行番号は内部的な番号のみですが、列番号は描画上と内部的な番号の二種類が示されます。
fnIsOpenfnOpen メソッドで新規行が描画されている状態であるかを示します。
fnOpen指定された行の後に新しい行が追加されます。
追加された行は描画上のものであり、fnAddData のようにデータを動的に追加する機能とは違います。
fnPageChange指定したページに移動します。
fnSetColumnVis列を表示するかどうかを設定する。
fnSettings設定情報を取得する。
fnSort行を並べ替えます。
fnSortListener指定されたオブジェクトのアクションイベントで行が並べ替えられるよう設定します。
例えば、ボタンがクリックされた時に行を並べ替えたいときに使用します。
fnUpdate指定された行のすべての列の値、または、指定されたセルの値を更新する。
fnVersionCheck互換性を保証するためにプラグインが使用しているDataTablesのバージョンをチェックする。

fnAddData(array | object, boolean)

mData
1D array of data
1件のデータを追加する場合は、配列に列の値を設定して受け渡します。 (mDataPropで列名を定義していない場合に使用します。)
2D array of arrays
2次元配列 複数件のデータを追加する場合は、配列に1D array of dataを設定して受け渡します。 (mDataPropで列名を定義していない場合に使用します。)
object
1件のデータを追加する場合は、JSON形式で列の値を設定して受け渡します。 (mDataPropで列名が定義済みの場合に使用します。)
array of objects
複数件のデータを追加する場合は、配列にobjectを設定して受け渡します。 (mDataPropで列名が定義済みの場合に使用します。)
bRedraw
型:boolean
表を再描画する場合は true。それ以外の場合は false
既定値は true です。
 
array
 

fnAdjustColumnSizing(boolean)

bRedraw
型:boolean
表を再描画する場合は true。それ以外の場合は false
既定値は true です。
 

fnClearTable(boolean)

bRedraw
型:boolean
表を再描画する場合は true。それ以外の場合は false
既定値は true です。
 

fnClose(node)

nTr
型:node
削除したい行を TR要素 で指定します。
 
int
0 なら正常終了
1 なら異常終了(対象行が見つからない場合に発生する)
 

fnDeleteRow(int | node, function, boolean)

mTarget
型:int
削除したい行を 0 から始まる数値で指定します。
ここで指定する数値は aoData で保持しているデータの行番号であり、描画上の行番号とは並べ替えやフィルタリングの関係で一致しない場合があります。

型:node
削除したい行を TR要素 で指定します。
fnCallBack
型:function
行を削除した後に実行したい function を指定します。
fnCallBack.call( this, oSettings, oData );
bRedraw
型:boolean
表を再描画する場合は true。それ以外の場合は false
既定値は true です。
 
oData
 

fnDestroy(boolean)

bRemove
型:boolean
既定値は false です。
 

fnDraw(boolean)

bComplete
型:boolean
不明
 

fnFilter(string, int, boolean, boolean, boolean, boolean)

sInput
型:string
比較する文字列を指定します。
iColumn
型:int
比較したい列を 0 から始まる数値で指定します。
すべての列と比較したい場合は null を指定します。
bRegex
型:boolean
正規表現を使用する場合は true。それ以外の場合は false
既定値は false です。
bSmart
型:boolean
不明
既定値は true です。
bShowGlobal
型:boolean
比較に使用した値をinput boxに設定する場合は true。それ以外の場合は false
既定値は true です。
bCaseInsensitive
型:boolean
大文字・小文字を区別せずに比較する場合はtrue。それ以外の場合は false
 

fnGetData(int | node, int)

mRow
int
値を取得したい行を 0 から始まる数値で指定します。
node
TR要素, TD要素, TH要素 を指定します。
iCol
型:int 値を取得したい列を 0 から始まる数値で指定します。 mRowに、TD要素 または TH要素 を指定した場合は無視されます。 mRowに、数値または TR要素 を指定した場合に iCol を省略するとすべての列が対象になります。
 
array
mDataPropで列名が定義していない場合に指定した行のすべての列の値を取得すると1次元配列で定義されます。
object
mDataPropで列名が定義済み場合に指定した行のすべての列の値を取得するとJSON形式のオブジェクトで定義されます。
string
指定したセルの値
 

fnGetNodes(int)

指定した行のDOMツリーを示します。 行を指定しない場合は、すべての行のDOMツリーを配列で定義して示します。

iRow
型:int DOMツリーを取得したい行を 0 から始まる数値で指定します。 省略した場合は、すべての行が対象となります。
 
node
指定された行のDOMツリー
array
すべての行のDOMツリー
 

fnGetPosition(node)

nNode
TR要素, TD要素, TH要素 のいずれかを指定します。
 
int
nNode = TR要素
nNode に該当する行番号 描画されている行番号とは異なるので注意すること
string
nNode = TD要素
カンマ区切りの文字列で nNode に該当するセルの行番号、描画上の列番号、内部的な列番号
 

fnIsOpen(node)

nTr
型:node
fnOpen メソッドで新規行が描画されている状態か確認したい行を TR要素 で指定します。
 
boolean
fnOpen メソッドで新規行が描画されている状態であれば true。それ以外の場合は false
 

fnOpen(node, string | node | jQuery, string)

nTr
型:node
追加したい行の直前にある行を TR要素 で指定します。
mHtml
型:string
追加した行に描画したい文字列を指定します
全ての列が結合された状態になります。

型:node
不明

型:jQuery
不明
sClass
型:string
新しく追加された TD要素 に指定するクラス
 
node
 

fnPageChange(string | int, boolean)

mAction
型:string
最初のページに移動する場合は first、現在ページより1ページ戻る場合は previous, 現在ページより1ページ進む場合は next, 最後のページに移動する場合は lastを指定します。

型:int
移動したいページを数値で指定します。0を指定すると最初のページに移動します。
bRedraw
型:boolean
表を再描画する場合は true。それ以外の場合は false
既定値は true です。
 

fnSetColumnVis(int, boolean, boolean)

iCol
型:int
表示を変更したい列を 0 から始まる数値で指定します。
bShow
型:boolean
列を表示する場合は true。それ以外の場合は false
bRedraw
型:boolean
表を再描画する場合は true。それ以外の場合は false
既定値は true です。
 

fnSettings()

models.oSettings
 

fnSort(array)

aaSort
型:array
配列の0番目に並べ替えに使用する列を 0 から始まる数値で指定します。
配列の1番目に並べ替える方向を指定します。昇順なら asc。降順なら desc
 

fnSortListener(node, int, function)

nNode
型:node INPUT:BUTTON要素などを指定します。 他にどのような要素を指定できるか調べていません。
iColumn
型:int 並べ替えに使用する列を 0 から始まる数値で指定します。
fnCallback
型:function 並べ替えが終了した後に呼び出される関数を指定します。 パラメータを指定することはできません。 省略可能です。
 

fnUpdate(object | array | string, node | int, int, boolean, boolean)

mData
array
指定した行のすべての列の値を更新する場合は、配列に列の値を設定して受け渡します。 (mDataPropで列名を定義していない場合に使用します。)
object
指定した行のすべての列の値を更新する場合は、JSON形式で列の値を設定して受け渡します。 (mDataPropで列名が定義済みの場合に使用します。)
string
指定したセルの値を更新する場合は、文字列を受け渡します。
mRow
int
値を変更したい行を 0 から始まる数値で指定します。
node
TR要素を指定します。
iColumn
型:int 値を変更したい列を 0 から始まる数値で指定します。 mRowに、TD要素 または TH要素 を指定した場合は無視されます。 mRowに、数値または TR要素 を指定した場合に iColumn を省略するとすべての列が対象になります。
bRedraw
型:boolean
表を再描画する場合は true。それ以外の場合は false
既定値は true です。
bAction
型:
 
int
0 なら正常終了 1 なら異常終了
 

fnVersionCheck(string)

sVersion
型:string
バージョンを指定します。バージョンの形式は"X", "X.Y", "X.Y.Z"です。
 

Callbacks

名称備考
fnCookieCallback
fnCreatedRow
fnDrawCallback
fnFooterCallback
fnFormatNumber
fnHeaderCallback
fnInfoCallback
fnInitComplete
fnPreDrawCallback
fnRowCallback
fnServerData
fnServerParams
fnStateLoad
fnStateLoaded
fnStateLoadParams
fnStateSave
fnStateSaveParams

Columns

名称備考
aDataSort
asSorting
bSearchable列をフィルタリングの対象にするか否かを定義する。
trueならフィルタリングの対象として一致するデータが存在するかの検索対象となります。
falseなら検索対象外となり一致するデータが存在していても無視されます。
bSortable
bUseRendered
bVisible列を表示するか否かを定義する。
trueなら列が表示され、falseなら列が表示されない。

非表示にした列はHTMLタグが削除されている状態です。
したがって、非表示列にsubmit用のhidden項目を隠し持っていても送信されません。
fnCreatedCell
fnRender
iDataSort
mDataProp
sClass
sContentPadding
sDefaultContent
sName
sSortDataType
sTitle
sType並べ替えに使用する値の型を定義する。
型は"string", "numeric", "date" ,"html"
未指定の場合は"html"となる。
型が文字列だと"5"と"10"を比較した時"10"の方が小さいと判断されるので注意すること
sWidth列の幅を定義する。
"3em", "20px"などCSSと同様に定義できる。

Features

名称備考
bAutoWidth
bDeferRender
bFilter
bInfo
bJQueryUI
bLengthChange
bPaginate
bProcessing
bScrollInfinite
bServerSide
bSort
bSortClasses
bStateSave
sScrollX
sScrollY

Language

名称備考
oLanguage.oAria.sSortAscending
oLanguage.oAria.sSortDescending
oLanguage.oPaginate.sFirst
oLanguage.oPaginate.sLast
oLanguage.oPaginate.sNext
oLanguage.oPaginate.sPrevious
oLanguage.sEmptyTable
oLanguage.sInfo
oLanguage.sInfoEmpty
oLanguage.sInfoFiltered
oLanguage.sInfoPostFix
oLanguage.sInfoThousands
oLanguage.sLengthMenu
oLanguage.sLoadingRecords
oLanguage.sProcessing
oLanguage.sSearch
oLanguage.sUrl
oLanguage.sZeroRecords

Option

名称備考
aaData
aaSorting
aaSortingFixed
aLengthMenu
aoSearchCols
asStripeClasses

Options

名称備考
bDestroydataTableメソッドでインスタンスを生成するとき、既にインスタンスが生成されている場合は、そのインスタンスを破棄した後に、新たにインスタンスを生成する
bRetrievedataTableメソッドでインスタンスを生成するとき、既にインスタンスが生成されている場合はそのインスタンスを戻す
bScrollAutoCss
bScrollCollapse
bSortCellsTop
iCookieDuration
iDeferLoading
iDisplayLength
iDisplayStart
iScrollLoadGap
iTabIndex
oSearch
sAjaxDataProp
sAjaxSource
sCookiePrefix
sDom
sPaginationType
sScrollXInner
sServerMethod

Server-side

名称備考
bServerSide
fnServerData
fnServerParams
sAjaxDataProp
sAjaxSource
sServerMethod

トップ   一覧 検索 最終更新   ヘルプ   最終更新のRSS