Deferred loading of data
When using DataTables with server-side processing, the default behaviour is to have DataTables automatically make an Ajax call and load the data, removing anything which might have already been in the table. However, this behaviour might not always be desirable when the first page of the table has already been preloaded in the HTML (which you might do to ensure accessibility or for performance reasons).
This automatic Ajax call to get the first page of data can be overridden by using the deferLoading
initialisation property. It serves two purposes, firstly to indicate that deferred
loading is required, but also to tell DataTables how many records there are in the full table, in this case 57 (this allows the information element and
pagination to be displayed correctly).
In the example below, the HTML page already has the first 10 rows of data available it in, so we use deferLoading
to tell DataTables that
this data is available and that it should wait for user interaction (ordering, paging etc) before making an Ajax call.
First name | Last name | Position | Office | Start date | Salary |
---|---|---|---|---|---|
Airi | Satou | Accountant | Tokyo | 28th Nov 08 | $162,700 |
Angelica | Ramos | Chief Executive Officer (CEO) | London | 9th Oct 09 | $1,200,000 |
Ashton | Cox | Junior Technical Author | San Francisco | 12th Jan 09 | $86,000 |
Bradley | Greer | Software Engineer | London | 13th Oct 12 | $132,000 |
Brenden | Wagner | Software Engineer | San Francisco | 7th Jun 11 | $206,850 |
Brielle | Williamson | Integration Specialist | New York | 2nd Dec 12 | $372,000 |
Bruno | Nash | Software Engineer | London | 3rd May 11 | $163,500 |
Caesar | Vance | Pre-Sales Support | New York | 12th Dec 11 | $106,450 |
Cara | Stevens | Sales Assistant | New York | 6th Dec 11 | $145,600 |
Cedric | Kelly | Senior Javascript Developer | Edinburgh | 29th Mar 12 | $433,060 |
First name | Last name | Position | Office | Start date | Salary |
- Javascript
- HTML
- CSS
- Ajax
- Server-side script
- Comments
The Javascript shown below is used to initialise the table shown in this example:
$('#example').DataTable({
ajax: 'scripts/server_processing.php',
deferLoading: 57,
processing: true,
serverSide: true
});
new DataTable('#example', {
ajax: 'scripts/server_processing.php',
deferLoading: 57,
processing: true,
serverSide: true
});
In addition to the above code, the following Javascript library files are loaded for use in this example:
The HTML shown below is the raw HTML table element, before it has been enhanced by DataTables:
This example uses a little bit of additional CSS beyond what is loaded from the library files (below), in order to correctly display the table. The additional CSS used is shown below:
The following CSS library files are loaded for use in this example to provide the styling of the table:
This table loads data by Ajax. The latest data that has been loaded is shown below. This data will update automatically as any additional data is loaded.
The script used to perform the server-side processing for this table is shown below. Please note that this is just an example script using PHP. Server-side processing scripts can be written in any language, using the protocol described in the DataTables documentation.
Other examples
Basic initialisation
- Zero configuration
- Feature enable / disable
- Default ordering (sorting)
- Multi-column ordering
- Multiple tables
- Hidden columns
- Complex headers (rowspan and colspan)
- Flexible table width
- State saving
- Alternative pagination
- Data rendering
- Scroll - vertical
- Scroll - vertical, dynamic height
- Scroll - horizontal
- Scroll - horizontal and vertical
Advanced initialisation
- DOM / jQuery events
- DataTables events
- Column rendering
- Enter Key to Search
- Page length options
- Complex headers with column visibility
- Read HTML to data objects
- HTML5 data-* attributes - cell data
- HTML5 data-* attributes - table options
- Setting defaults
- Row created callback
- Row grouping
- Footer callback
- Order direction sequence control
- DOM element return from renderer
Styling
- Base style
- Base style - no styling classes
- Base style - cell borders
- Base style - compact
- Base style - hover
- Base style - order-column
- Base style - row borders
- Base style - stripe
- Bootstrap 3
- Bootstrap 4
- Bootstrap 5
- Foundation
- Fomantic-UI (formally Semantic-UI)
- Bulma
- jQuery UI ThemeRoller
- Material Design (Tech. preview)
- Tailwind CSS (Tech. preview)
- UIKit 3 (Tech. preview)
API
- Add rows
- Individual column searching (text inputs)
- Individual column searching (select inputs)
- Highlighting rows and columns
- Child rows (show extra / detailed information)
- Child rows with StateSave
- Row selection (multiple rows)
- Row selection and deletion (single row)
- Form inputs
- Index column
- Show / hide columns dynamically
- Using API in callbacks
- Scrolling and Bootstrap tabs
- Search API (regular expressions)
- HighCharts Integration