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