2016-12-02 17:46:11 +01:00
<!doctype html>
2013-10-16 13:13:30 +02:00
< html >
2016-12-02 17:46:11 +01:00
< head >
< meta charset = "utf-8" >
< link rel = "shortcut icon" type = "image/ico" href = "http://www.datatables.net/favicon.ico" / >
< meta name = "viewport" content = "initial-scale=1.0, maximum-scale=2.0" / >
< title > DataTables example - Custom HTTP variables< / title >
< link rel = "stylesheet" type = "text/css" href = "../../media/css/jquery.dataTables.css" > < link rel = "stylesheet" type = "text/css" href = "../resources/syntax/shCore.css" > < link rel = "stylesheet" type = "text/css" href = "../resources/demo.css" >
< style type = "text/css" class = "init" >
< / style >
< script type = "text/javascript" language = "javascript" src = "//code.jquery.com/jquery-1.12.0.min.js" > < / script > < script type = "text/javascript" language = "javascript" src = "../../media/js/jquery.dataTables.js" > < / script > < script type = "text/javascript" language = "javascript" src = "../resources/syntax/shCore.js" > < / script > < script type = "text/javascript" language = "javascript" src = "../resources/demo.js" > < / script >
< script type = "text/javascript" language = "javascript" class = "init" >
2013-10-16 13:13:30 +02:00
$(document).ready(function() {
2015-08-10 15:57:47 +02:00
$('#example').DataTable( {
2013-10-16 13:13:30 +02:00
"processing": true,
"serverSide": true,
"ajax": {
"url": "scripts/server_processing.php",
"data": function ( d ) {
d.myKey = "myValue";
// d.custom = $('#myInput').val();
// etc
}
}
} );
} );
2016-12-02 17:46:11 +01:00
< / script >
< / head >
< body class = "dt-example " >
< div class = "container" >
< section >
< h1 > DataTables example < span > Custom HTTP variables< / span > < / h1 >
< div class = "info" >
< p > It can often be useful to send extra information to the server when utilising DataTables' server-side processing option. This is done by using the < a href = "//datatables.net/reference/option/ajax" > < code class = "option" title = "DataTables initialisation option" > ajax< / code > < / a > option's < code > data< / code > parameter which can be used in one of two different ways:< / p >
< ul class = "markdown" >
< li > < code > object< / code > - An object data to send to the server. This is useful for adding static data to the request.< / li >
< li > < code > function< / code > - A function which will manipulate the data object to send to the server, adding values as required. Using the < code > data< / code > parameter as a function allows the additional data to evaluated and added to the request at the time the request is made.< / li >
< / ul >
< p > The example below shows server-side processing being used with an extra parameter being sent to the server by using the < code > ajax.data< / code > option as a function.< / p >
< / div >
< table id = "example" class = "display" cellspacing = "0" width = "100%" > < thead > < tr > < th > First name< / th > < th > Last name< / th > < th > Position< / th > < th > Office< / th > < th > Start date< / th > < th > Salary< / th > < / tr > < / thead > < tfoot > < tr > < th > First name< / th > < th > Last name< / th > < th > Position< / th > < th > Office< / th > < th > Start date< / th > < th > Salary< / th > < / tr > < / tfoot > < / table >
< ul class = "tabs" >
< li class = "active" > Javascript< / li >
< li > HTML< / li >
< li > CSS< / li >
< li > Ajax< / li >
< li > Server-side script< / li >
2015-09-25 10:50:54 +02:00
< / ul >
2016-12-02 17:46:11 +01:00
< div class = "tabs" >
< div class = "js" >
< p > The Javascript shown below is used to initialise the table shown in this example:< / p >
< code class = "multiline language-js" > $(document).ready(function() {
2015-08-10 15:57:47 +02:00
$('#example').DataTable( {
2013-10-16 13:13:30 +02:00
" processing" : true,
" serverSide" : true,
" ajax" : {
" url" : " scripts/server_processing.php" ,
" data" : function ( d ) {
d.myKey = " myValue" ;
// d.custom = $('#myInput').val();
// etc
}
}
} );
2013-12-19 15:03:24 +01:00
} );< / code >
2016-12-02 17:46:11 +01:00
< p > In addition to the above code, the following Javascript library files are loaded for use in this example:< / p >
< ul > < li > < a href = "//code.jquery.com/jquery-1.12.0.min.js" > //code.jquery.com/jquery-1.12.0.min.js< / a > < / li > < li > < a href = "../../media/js/jquery.dataTables.js" > ../../media/js/jquery.dataTables.js< / a > < / li > < / ul >
2013-10-16 13:13:30 +02:00
< / div >
2016-12-02 17:46:11 +01:00
< div class = "table" >
< p > The HTML shown below is the raw HTML table element, before it has been enhanced by DataTables:< / p >
2013-10-16 13:13:30 +02:00
< / div >
2016-12-02 17:46:11 +01:00
< div class = "css" >
< div >
< p > 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:< / p >
< code class = "multiline language-css" > < / code >
< / div >
< p > The following CSS library files are loaded for use in this example to provide the styling of the table:< / p >
< ul > < li > < a href = "../../media/css/jquery.dataTables.css" > ../../media/css/jquery.dataTables.css< / a > < / li > < / ul >
2013-10-16 13:13:30 +02:00
< / div >
2016-12-02 17:46:11 +01:00
< div class = "ajax" >
< p > 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.< / p >
2013-10-16 13:13:30 +02:00
< / div >
2016-12-02 17:46:11 +01:00
< div class = "php" >
< p > 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 < a href = "//datatables.net/manual/server-side" > the protocol described in the DataTables documentation< / a > .< / p >
2013-10-16 13:13:30 +02:00
< / div >
2016-12-02 17:46:11 +01:00
< / div >
< / section >
< / div >
< section >
< div class = "footer" >
< div class = "gradient" > < / div >
< div class = "liner" >
< h2 > Other examples< / h2 >
< div class = "toc" >
< div class = "toc-group" > < h3 > < a href = "../basic_init/index.html
">Basic initialisation< / a > < / h3 > < ul class = "toc" > < li > < a href = "../basic_init/zero_configuration.html
">Zero configuration< / a > < / li > < li > < a href = "../basic_init/filter_only.html
">Feature enable / disable< / a > < / li > < li > < a href = "../basic_init/table_sorting.html
">Default ordering (sorting)< / a > < / li > < li > < a href = "../basic_init/multi_col_sort.html
">Multi-column ordering< / a > < / li > < li > < a href = "../basic_init/multiple_tables.html
">Multiple tables< / a > < / li > < li > < a href = "../basic_init/hidden_columns.html
">Hidden columns< / a > < / li > < li > < a href = "../basic_init/complex_header.html
">Complex headers (rowspan and colspan)< / a > < / li > < li > < a href = "../basic_init/dom.html
">DOM positioning< / a > < / li > < li > < a href = "../basic_init/flexible_width.html
">Flexible table width< / a > < / li > < li > < a href = "../basic_init/state_save.html
">State saving< / a > < / li > < li > < a href = "../basic_init/alt_pagination.html
">Alternative pagination< / a > < / li > < li > < a href = "../basic_init/scroll_y.html
">Scroll - vertical< / a > < / li > < li > < a href = "../basic_init/scroll_y_dynamic.html
">Scroll - vertical, dynamic height< / a > < / li > < li > < a href = "../basic_init/scroll_x.html
">Scroll - horizontal< / a > < / li > < li > < a href = "../basic_init/scroll_xy.html
">Scroll - horizontal and vertical< / a > < / li > < li > < a href = "../basic_init/comma-decimal.html
">Language - Comma decimal place< / a > < / li > < li > < a href = "../basic_init/language.html
">Language options< / a > < / li > < / ul > < / div > < div class = "toc-group" > < h3 > < a href = "../advanced_init/index.html
">Advanced initialisation< / a > < / h3 > < ul class = "toc" > < li > < a href = "../advanced_init/events_live.html
">DOM / jQuery events< / a > < / li > < li > < a href = "../advanced_init/dt_events.html
">DataTables events< / a > < / li > < li > < a href = "../advanced_init/column_render.html
">Column rendering< / a > < / li > < li > < a href = "../advanced_init/length_menu.html
">Page length options< / a > < / li > < li > < a href = "../advanced_init/dom_multiple_elements.html
">Multiple table control elements< / a > < / li > < li > < a href = "../advanced_init/complex_header.html
">Complex headers with column visibility< / a > < / li > < li > < a href = "../advanced_init/object_dom_read.html
">Read HTML to data objects< / a > < / li > < li > < a href = "../advanced_init/html5-data-options.html
">HTML5 data-* attributes - table options< / a > < / li > < li > < a href = "../advanced_init/html5-data-attributes.html
">HTML5 data-* attributes - cell data< / a > < / li > < li > < a href = "../advanced_init/language_file.html
">Language file< / a > < / li > < li > < a href = "../advanced_init/defaults.html
">Setting defaults< / a > < / li > < li > < a href = "../advanced_init/row_callback.html
">Row created callback< / a > < / li > < li > < a href = "../advanced_init/row_grouping.html
">Row grouping< / a > < / li > < li > < a href = "../advanced_init/footer_callback.html
">Footer callback< / a > < / li > < li > < a href = "../advanced_init/dom_toolbar.html
">Custom toolbar elements< / a > < / li > < li > < a href = "../advanced_init/sort_direction_control.html
">Order direction sequence control< / a > < / li > < / ul > < / div > < div class = "toc-group" > < h3 > < a href = "../styling/index.html
">Styling< / a > < / h3 > < ul class = "toc" > < li > < a href = "../styling/display.html
">Base style< / a > < / li > < li > < a href = "../styling/no-classes.html
">Base style - no styling classes< / a > < / li > < li > < a href = "../styling/cell-border.html
">Base style - cell borders< / a > < / li > < li > < a href = "../styling/compact.html
">Base style - compact< / a > < / li > < li > < a href = "../styling/hover.html
">Base style - hover< / a > < / li > < li > < a href = "../styling/order-column.html
">Base style - order-column< / a > < / li > < li > < a href = "../styling/row-border.html
">Base style - row borders< / a > < / li > < li > < a href = "../styling/stripe.html
">Base style - stripe< / a > < / li > < li > < a href = "../styling/bootstrap.html
">Bootstrap 3< / a > < / li > < li > < a href = "../styling/foundation.html
">Foundation< / a > < / li > < li > < a href = "../styling/jqueryUI.html
">jQuery UI ThemeRoller< / a > < / li > < li > < a href = "../styling/bootstrap4.html
">Bootstrap 4 (Tech. preview)< / a > < / li > < li > < a href = "../styling/semanticui.html
">Semantic UI (Tech. preview)< / a > < / li > < li > < a href = "../styling/material.html
">Material Design (Tech. preview)< / a > < / li > < li > < a href = "../styling/uikit.html
">UIKit (Tech. preview)< / a > < / li > < / ul > < / div > < div class = "toc-group" > < h3 > < a href = "../data_sources/index.html
">Data sources< / a > < / h3 > < ul class = "toc" > < li > < a href = "../data_sources/dom.html
">HTML (DOM) sourced data< / a > < / li > < li > < a href = "../data_sources/ajax.html
">Ajax sourced data< / a > < / li > < li > < a href = "../data_sources/js_array.html
">Javascript sourced data< / a > < / li > < li > < a href = "../data_sources/server_side.html
">Server-side processing< / a > < / li > < / ul > < / div > < div class = "toc-group" > < h3 > < a href = "../api/index.html
">API< / a > < / h3 > < ul class = "toc" > < li > < a href = "../api/add_row.html
">Add rows< / a > < / li > < li > < a href = "../api/multi_filter.html
">Individual column searching (text inputs)< / a > < / li > < li > < a href = "../api/multi_filter_select.html
">Individual column searching (select inputs)< / a > < / li > < li > < a href = "../api/highlight.html
">Highlighting rows and columns< / a > < / li > < li > < a href = "../api/row_details.html
">Child rows (show extra / detailed information)< / a > < / li > < li > < a href = "../api/select_row.html
">Row selection (multiple rows)< / a > < / li > < li > < a href = "../api/select_single_row.html
">Row selection and deletion (single row)< / a > < / li > < li > < a href = "../api/form.html
">Form inputs< / a > < / li > < li > < a href = "../api/counter_columns.html
">Index column< / a > < / li > < li > < a href = "../api/show_hide.html
">Show / hide columns dynamically< / a > < / li > < li > < a href = "../api/api_in_init.html
">Using API in callbacks< / a > < / li > < li > < a href = "../api/tabs_and_scrolling.html
">Scrolling and Bootstrap tabs< / a > < / li > < li > < a href = "../api/regex.html
">Search API (regular expressions)< / a > < / li > < / ul > < / div > < div class = "toc-group" > < h3 > < a href = "../ajax/index.html
">Ajax< / a > < / h3 > < ul class = "toc" > < li > < a href = "../ajax/simple.html
">Ajax data source (arrays)< / a > < / li > < li > < a href = "../ajax/objects.html
">Ajax data source (objects)< / a > < / li > < li > < a href = "../ajax/deep.html
">Nested object data (objects)< / a > < / li > < li > < a href = "../ajax/objects_subarrays.html
">Nested object data (arrays)< / a > < / li > < li > < a href = "../ajax/orthogonal-data.html
">Orthogonal data< / a > < / li > < li > < a href = "../ajax/null_data_source.html
">Generated content for a column< / a > < / li > < li > < a href = "../ajax/custom_data_property.html
">Custom data source property< / a > < / li > < li > < a href = "../ajax/custom_data_flat.html
">Flat array data source< / a > < / li > < li > < a href = "../ajax/defer_render.html
">Deferred rendering for speed< / a > < / li > < / ul > < / div > < div class = "toc-group" > < h3 > < a href = "./index.html
">Server-side< / a > < / h3 > < ul class = "toc active" > < li > < a href = "./simple.html
">Server-side processing< / a > < / li > < li class = "active" > < a href = "./custom_vars.html
">Custom HTTP variables< / a > < / li > < li > < a href = "./post.html
">POST data< / a > < / li > < li > < a href = "./ids.html
">Automatic addition of row ID attributes< / a > < / li > < li > < a href = "./object_data.html
">Object data source< / a > < / li > < li > < a href = "./row_details.html
">Row details< / a > < / li > < li > < a href = "./select_rows.html
">Row selection< / a > < / li > < li > < a href = "./jsonp.html
">JSONP data source for remote domains< / a > < / li > < li > < a href = "./defer_loading.html
">Deferred loading of data< / a > < / li > < li > < a href = "./pipeline.html
">Pipelining data to reduce Ajax calls for paging< / a > < / li > < / ul > < / div > < div class = "toc-group" > < h3 > < a href = "../plug-ins/index.html
">Plug-ins< / a > < / h3 > < ul class = "toc" > < li > < a href = "../plug-ins/api.html
">API plug-in methods< / a > < / li > < li > < a href = "../plug-ins/sorting_auto.html
">Ordering plug-ins (with type detection)< / a > < / li > < li > < a href = "../plug-ins/sorting_manual.html
">Ordering plug-ins (no type detection)< / a > < / li > < li > < a href = "../plug-ins/range_filtering.html
">Custom filtering - range search< / a > < / li > < li > < a href = "../plug-ins/dom_sort.html
">Live DOM ordering< / a > < / li > < / ul > < / div >
2013-10-16 13:13:30 +02:00
< / div >
2016-12-02 17:46:11 +01:00
< div class = "epilogue" >
< p >
Please refer to the < a href = "http://www.datatables.net" > DataTables documentation< / a > for full information about its API properties and methods.< br >
Additionally, there are a wide range of < a href = "http://www.datatables.net/extensions" > extensions< / a > and < a href = "http://www.datatables.net/plug-ins" > plug-ins< / a > which extend the capabilities of DataTables.
< / p >
< p class = "copyright" >
DataTables designed and created by < a href = "http://www.sprymedia.co.uk" > SpryMedia Ltd< / a > © 2007-2016< br >
DataTables is licensed under the < a href = "http://www.datatables.net/mit" > MIT license< / a > .
< / p >
2015-09-25 11:08:52 +02:00
< / div >
< / div >
2013-10-16 13:13:30 +02:00
< / div >
2016-12-02 17:46:11 +01:00
< / section >
< / body >
2013-10-16 13:13:30 +02:00
< / html >