fnAddDataAndDisplay
Add data and shift the paging to display it immediately
- Author: Allan Jardine
Add a new row to the table and display it on the screen by jumping the
pagination to the required location. This function also returns an object
with the added TR
element and it's index in aoData
such that you
could provide an effect (fade for example) to show which row has been added.
This function is a drop in replacement for fnAddData
with one important
exception, it will only take a 1D array or an object, and not a 2D array
(i.e. it will not add multiple rows like fnAddData
).
Use
This plug-in can be obtained and used in multiple different ways.
Browser
This plug-in is available on the DataTables CDN:
The plug-in will then automatically register itself against a global DataTables instance. This file can also be used if you are using an AMD loader such as Require.js.
Note that if you are using multiple plug-ins, it can be beneficial in terms of performance to combine the plug-ins into a single file and host it on your own server, rather than making multiple requests to the DataTables CDN.
NPM
The plug-ins are all available on NPM (which can also be used with Yarn or any other Javascript package manager) as part of the datatables.net-plugins
package. To use this plug-in, first install the plug-ins package:
npm install datatables.net-plugins
ES modules
Then, if you are using ES modules, import datatables.net
, any other DataTables extensions you need, and the plug-in:
import DataTable from 'datatables.net';
import 'datatables.net-plugins/api/fnAddDataAndDisplay.mjs';
CommonJS
If you are using a CommonJS loader for Node (e.g. with older versions of Webpack, or non-module Node code) use the following method to require
the plug-in:
var $ = require('jquery');
var DataTable = require('datatables.net');
require('datatables.net-plugins/api/fnAddDataAndDisplay.js');
Example
$(document).ready(function() {
var table = $('#example').dataTable();
table.fnAddDataAndDisplay( [ 1, 2, 3, 4, 5, ... ] );
} );
Version control
If you have any ideas for how this plug-in can be improved, or spot anything that is in error, it is available on GitHub and pull requests are very welcome!
- This plug-in: fnAddDataAndDisplay.js
- Full DataTables plug-ins repository: DataTables/Plugins