Skip to content
YajraBox

Laravel DataTables
Icon

WARNING You're browsing the documentation for an upcoming version of Laravel DataTables. The documentation and features of this release are subject to change.

Index Column

In some cases, you need to track the index of the records on your response. To achieve this, you can add an index column on your response by using addIndexColumn api.

use DataTables;
 
Route::get('user-data', function() {
    $model = App\User::query();
 
    return DataTables::eloquent($model)
                ->addIndexColumn()
                ->toJson();
});

Using addIndexColumn will add another column on your response with a column name that is set on index_column configuration. The default index column name is DT_RowIndex.

If you want to customize the index used by the DT_RowIndex, you can use setRowId('COLUMN') to change the index number.

use DataTables;
 
Route::get('user-data', function() {
    $model = App\User::query();
 
    return DataTables::eloquent($model)
                ->setRowId('id')
                ->toJson();
});

Be careful with this option, an index should be unique and an integer to be useful for DataTables.

Edit this page on GitHub