custom_vars.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <link rel="shortcut icon" type="image/ico" href="http://www.datatables.net/favicon.ico">
  6. <meta name="viewport" content="initial-scale=1.0, maximum-scale=2.0">
  7. <title>DataTables example - Custom HTTP variables</title>
  8. <link rel="stylesheet" type="text/css" href="../../media/css/jquery.dataTables.css">
  9. <link rel="stylesheet" type="text/css" href="../resources/syntax/shCore.css">
  10. <link rel="stylesheet" type="text/css" href="../resources/demo.css">
  11. <style type="text/css" class="init">
  12. </style>
  13. <script type="text/javascript" language="javascript" src="../../media/js/jquery.js"></script>
  14. <script type="text/javascript" language="javascript" src="../../media/js/jquery.dataTables.js"></script>
  15. <script type="text/javascript" language="javascript" src="../resources/syntax/shCore.js"></script>
  16. <script type="text/javascript" language="javascript" src="../resources/demo.js"></script>
  17. <script type="text/javascript" language="javascript" class="init">
  18. $(document).ready(function() {
  19. $('#example').dataTable( {
  20. "processing": true,
  21. "serverSide": true,
  22. "ajax": {
  23. "url": "scripts/server_processing.php",
  24. "data": function ( d ) {
  25. d.myKey = "myValue";
  26. // d.custom = $('#myInput').val();
  27. // etc
  28. }
  29. }
  30. } );
  31. } );
  32. </script>
  33. </head>
  34. <body class="dt-example">
  35. <div class="container">
  36. <section>
  37. <h1>DataTables example <span>Custom HTTP variables</span></h1>
  38. <div class="info">
  39. <p>It can often be useful to send extra information to the server when utilising DataTables'
  40. server-side processing option. This is done by using the <a href=
  41. "//datatables.net/reference/option/ajax"><code class="option" title=
  42. "DataTables initialisation option">ajax<span>DT</span></code></a> option's <code>data</code> parameter
  43. which can be used in one of two different ways:</p>
  44. <ul class="markdown">
  45. <li><code>object</code> - An object data to send to the server. This is useful for adding static
  46. data to the request.</li>
  47. <li><code>function</code> - A function which will manipulate the data object to send to the server,
  48. adding values as required. Using the <code>data</code> parameter as a function allows the
  49. additional data to evaluated and added to the request at the time the request is made.</li>
  50. </ul>
  51. <p>The example below shows server-side processing being used with an extra parameter being sent to the
  52. server by using the <code>ajax.data</code> option as a function.</p>
  53. </div>
  54. <table id="example" class="display" cellspacing="0" width="100%">
  55. <thead>
  56. <tr>
  57. <th>Name</th>
  58. <th>Position</th>
  59. <th>Office</th>
  60. <th>Extn.</th>
  61. <th>Start date</th>
  62. <th>Salary</th>
  63. </tr>
  64. </thead>
  65. <tfoot>
  66. <tr>
  67. <th>Name</th>
  68. <th>Position</th>
  69. <th>Office</th>
  70. <th>Extn.</th>
  71. <th>Start date</th>
  72. <th>Salary</th>
  73. </tr>
  74. </tfoot>
  75. </table>
  76. <ul class="tabs">
  77. <li class="active">Javascript</li>
  78. <li>HTML</li>
  79. <li>CSS</li>
  80. <li>Ajax</li>
  81. <li>Server-side script</li>
  82. </ul>
  83. <div class="tabs">
  84. <div class="js">
  85. <p>The Javascript shown below is used to initialise the table shown in this
  86. example:</p><code class="multiline brush: js;">$(document).ready(function() {
  87. $('#example').dataTable( {
  88. &quot;processing&quot;: true,
  89. &quot;serverSide&quot;: true,
  90. &quot;ajax&quot;: {
  91. &quot;url&quot;: &quot;scripts/server_processing.php&quot;,
  92. &quot;data&quot;: function ( d ) {
  93. d.myKey = &quot;myValue&quot;;
  94. // d.custom = $('#myInput').val();
  95. // etc
  96. }
  97. }
  98. } );
  99. } );</code>
  100. <p>In addition to the above code, the following Javascript library files are loaded for use in this
  101. example:</p>
  102. <ul>
  103. <li><a href="../../media/js/jquery.js">../../media/js/jquery.js</a></li>
  104. <li><a href="../../media/js/jquery.dataTables.js">../../media/js/jquery.dataTables.js</a></li>
  105. </ul>
  106. </div>
  107. <div class="table">
  108. <p>The HTML shown below is the raw HTML table element, before it has been enhanced by
  109. DataTables:</p>
  110. </div>
  111. <div class="css">
  112. <div>
  113. <p>This example uses a little bit of additional CSS beyond what is loaded from the library
  114. files (below), in order to correctly display the table. The additional CSS used is shown
  115. below:</p><code class="multiline brush: js;"></code>
  116. </div>
  117. <p>The following CSS library files are loaded for use in this example to provide the styling of the
  118. table:</p>
  119. <ul>
  120. <li><a href=
  121. "../../media/css/jquery.dataTables.css">../../media/css/jquery.dataTables.css</a></li>
  122. </ul>
  123. </div>
  124. <div class="ajax">
  125. <p>This table loads data by Ajax. The latest data that has been loaded is shown below. This data
  126. will update automatically as any additional data is loaded.</p>
  127. </div>
  128. <div class="php">
  129. <p>The script used to perform the server-side processing for this table is shown below. Please note
  130. that this is just an example script using PHP. Server-side processing scripts can be written in any
  131. language, using <a href="//datatables.net/manual/server-side">the protocol described in the
  132. DataTables documentation</a>.</p>
  133. </div>
  134. </div>
  135. </section>
  136. </div>
  137. <section>
  138. <div class="footer">
  139. <div class="gradient"></div>
  140. <div class="liner">
  141. <h2>Other examples</h2>
  142. <div class="toc">
  143. <div class="toc-group">
  144. <h3><a href="../basic_init/index.html">Basic initialisation</a></h3>
  145. <ul class="toc">
  146. <li><a href="../basic_init/zero_configuration.html">Zero configuration</a></li>
  147. <li><a href="../basic_init/filter_only.html">Feature enable / disable</a></li>
  148. <li><a href="../basic_init/table_sorting.html">Default ordering (sorting)</a></li>
  149. <li><a href="../basic_init/multi_col_sort.html">Multi-column ordering</a></li>
  150. <li><a href="../basic_init/multiple_tables.html">Multiple tables</a></li>
  151. <li><a href="../basic_init/hidden_columns.html">Hidden columns</a></li>
  152. <li><a href="../basic_init/complex_header.html">Complex headers (rowspan and
  153. colspan)</a></li>
  154. <li><a href="../basic_init/dom.html">DOM positioning</a></li>
  155. <li><a href="../basic_init/flexible_width.html">Flexible table width</a></li>
  156. <li><a href="../basic_init/state_save.html">State saving</a></li>
  157. <li><a href="../basic_init/alt_pagination.html">Alternative pagination</a></li>
  158. <li><a href="../basic_init/scroll_y.html">Scroll - vertical</a></li>
  159. <li><a href="../basic_init/scroll_x.html">Scroll - horizontal</a></li>
  160. <li><a href="../basic_init/scroll_xy.html">Scroll - horizontal and vertical</a></li>
  161. <li><a href="../basic_init/scroll_y_theme.html">Scroll - vertical with jQuery UI
  162. ThemeRoller</a></li>
  163. <li><a href="../basic_init/comma-decimal.html">Language - Comma decimal place</a></li>
  164. <li><a href="../basic_init/language.html">Language options</a></li>
  165. </ul>
  166. </div>
  167. <div class="toc-group">
  168. <h3><a href="../advanced_init/index.html">Advanced initialisation</a></h3>
  169. <ul class="toc">
  170. <li><a href="../advanced_init/events_live.html">DOM / jQuery events</a></li>
  171. <li><a href="../advanced_init/dt_events.html">DataTables events</a></li>
  172. <li><a href="../advanced_init/column_render.html">Column rendering</a></li>
  173. <li><a href="../advanced_init/length_menu.html">Page length options</a></li>
  174. <li><a href="../advanced_init/dom_multiple_elements.html">Multiple table control
  175. elements</a></li>
  176. <li><a href="../advanced_init/complex_header.html">Complex headers (rowspan /
  177. colspan)</a></li>
  178. <li><a href="../advanced_init/html5-data-attributes.html">HTML5 data-* attributes</a></li>
  179. <li><a href="../advanced_init/language_file.html">Language file</a></li>
  180. <li><a href="../advanced_init/defaults.html">Setting defaults</a></li>
  181. <li><a href="../advanced_init/row_callback.html">Row created callback</a></li>
  182. <li><a href="../advanced_init/row_grouping.html">Row grouping</a></li>
  183. <li><a href="../advanced_init/footer_callback.html">Footer callback</a></li>
  184. <li><a href="../advanced_init/dom_toolbar.html">Custom toolbar elements</a></li>
  185. <li><a href="../advanced_init/sort_direction_control.html">Order direction sequence
  186. control</a></li>
  187. </ul>
  188. </div>
  189. <div class="toc-group">
  190. <h3><a href="../styling/index.html">Styling</a></h3>
  191. <ul class="toc">
  192. <li><a href="../styling/display.html">Base style</a></li>
  193. <li><a href="../styling/no-classes.html">Base style - no styling classes</a></li>
  194. <li><a href="../styling/cell-border.html">Base style - cell borders</a></li>
  195. <li><a href="../styling/compact.html">Base style - compact</a></li>
  196. <li><a href="../styling/hover.html">Base style - hover</a></li>
  197. <li><a href="../styling/order-column.html">Base style - order-column</a></li>
  198. <li><a href="../styling/row-border.html">Base style - row borders</a></li>
  199. <li><a href="../styling/stripe.html">Base style - stripe</a></li>
  200. <li><a href="../styling/bootstrap.html">Bootstrap</a></li>
  201. <li><a href="../styling/foundation.html">Foundation</a></li>
  202. <li><a href="../styling/jqueryUI.html">jQuery UI ThemeRoller</a></li>
  203. </ul>
  204. </div>
  205. <div class="toc-group">
  206. <h3><a href="../data_sources/index.html">Data sources</a></h3>
  207. <ul class="toc">
  208. <li><a href="../data_sources/dom.html">HTML (DOM) sourced data</a></li>
  209. <li><a href="../data_sources/ajax.html">Ajax sourced data</a></li>
  210. <li><a href="../data_sources/js_array.html">Javascript sourced data</a></li>
  211. <li><a href="../data_sources/server_side.html">Server-side processing</a></li>
  212. </ul>
  213. </div>
  214. <div class="toc-group">
  215. <h3><a href="../api/index.html">API</a></h3>
  216. <ul class="toc">
  217. <li><a href="../api/add_row.html">Add rows</a></li>
  218. <li><a href="../api/multi_filter.html">Individual column searching (text inputs)</a></li>
  219. <li><a href="../api/multi_filter_select.html">Individual column searching (select
  220. inputs)</a></li>
  221. <li><a href="../api/highlight.html">Highlighting rows and columns</a></li>
  222. <li><a href="../api/row_details.html">Child rows (show extra / detailed
  223. information)</a></li>
  224. <li><a href="../api/select_row.html">Row selection (multiple rows)</a></li>
  225. <li><a href="../api/select_single_row.html">Row selection and deletion (single
  226. row)</a></li>
  227. <li><a href="../api/form.html">Form inputs</a></li>
  228. <li><a href="../api/counter_columns.html">Index column</a></li>
  229. <li><a href="../api/show_hide.html">Show / hide columns dynamically</a></li>
  230. <li><a href="../api/api_in_init.html">Using API in callbacks</a></li>
  231. <li><a href="../api/tabs_and_scrolling.html">Scrolling and jQuery UI tabs</a></li>
  232. <li><a href="../api/regex.html">Search API (regular expressions)</a></li>
  233. </ul>
  234. </div>
  235. <div class="toc-group">
  236. <h3><a href="../ajax/index.html">Ajax</a></h3>
  237. <ul class="toc">
  238. <li><a href="../ajax/simple.html">Ajax data source (arrays)</a></li>
  239. <li><a href="../ajax/objects.html">Ajax data source (objects)</a></li>
  240. <li><a href="../ajax/deep.html">Nested object data (objects)</a></li>
  241. <li><a href="../ajax/objects_subarrays.html">Nested object data (arrays)</a></li>
  242. <li><a href="../ajax/orthogonal-data.html">Orthogonal data</a></li>
  243. <li><a href="../ajax/null_data_source.html">Generated content for a column</a></li>
  244. <li><a href="../ajax/custom_data_property.html">Custom data source property</a></li>
  245. <li><a href="../ajax/custom_data_flat.html">Flat array data source</a></li>
  246. <li><a href="../ajax/defer_render.html">Deferred rendering for speed</a></li>
  247. </ul>
  248. </div>
  249. <div class="toc-group">
  250. <h3><a href="./index.html">Server-side</a></h3>
  251. <ul class="toc active">
  252. <li><a href="./simple.html">Server-side processing</a></li>
  253. <li class="active"><a href="./custom_vars.html">Custom HTTP variables</a></li>
  254. <li><a href="./post.html">POST data</a></li>
  255. <li><a href="./ids.html">Automatic addition of row ID attributes</a></li>
  256. <li><a href="./object_data.html">Object data source</a></li>
  257. <li><a href="./row_details.html">Row details</a></li>
  258. <li><a href="./select_rows.html">Row selection</a></li>
  259. <li><a href="./jsonp.html">JSONP data source for remote domains</a></li>
  260. <li><a href="./defer_loading.html">Deferred loading of data</a></li>
  261. <li><a href="./pipeline.html">Pipelining data to reduce Ajax calls for paging</a></li>
  262. </ul>
  263. </div>
  264. <div class="toc-group">
  265. <h3><a href="../plug-ins/index.html">Plug-ins</a></h3>
  266. <ul class="toc">
  267. <li><a href="../plug-ins/api.html">API plug-in methods</a></li>
  268. <li><a href="../plug-ins/sorting_auto.html">Ordering plug-ins (with type
  269. detection)</a></li>
  270. <li><a href="../plug-ins/sorting_manual.html">Ordering plug-ins (no type
  271. detection)</a></li>
  272. <li><a href="../plug-ins/range_filtering.html">Custom filtering - range search</a></li>
  273. <li><a href="../plug-ins/dom_sort.html">Live DOM ordering</a></li>
  274. </ul>
  275. </div>
  276. </div>
  277. <div class="epilogue">
  278. <p>Please refer to the <a href="http://www.datatables.net">DataTables documentation</a> for full
  279. information about its API properties and methods.<br>
  280. Additionally, there are a wide range of <a href="http://www.datatables.net/extras">extras</a> and
  281. <a href="http://www.datatables.net/plug-ins">plug-ins</a> which extend the capabilities of
  282. DataTables.</p>
  283. <p class="copyright">DataTables designed and created by <a href=
  284. "http://www.sprymedia.co.uk">SpryMedia Ltd</a> &#169; 2007-2014<br>
  285. DataTables is licensed under the <a href="http://www.datatables.net/mit">MIT license</a>.</p>
  286. </div>
  287. </div>
  288. </div>
  289. </section>
  290. </body>
  291. </html>