webapp/resources/datatables-1.9.4/examples/server_side/custom_vars.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html>
   3         <head>
   4                 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
   5                 <link rel="shortcut icon" type="image/ico" href="http://www.datatables.net/media/images/favicon.ico" />
   6
   7                 <title>DataTables example</title>
   8                 <style type="text/css" title="currentStyle">
   9                         @import "../../media/css/demo_page.css";
  10                         @import "../../media/css/demo_table.css";
  11                 </style>
  12                 <script type="text/javascript" language="javascript" src="../../media/js/jquery.js"></script>
  13                 <script type="text/javascript" language="javascript" src="../../media/js/jquery.dataTables.js"></script>
  14                 <script type="text/javascript" charset="utf-8">
  15                         $(document).ready(function() {
  16                                 $('#example').dataTable( {
  17                                         "bProcessing": true,
  18                                         "bServerSide": true,
  19                                         "sAjaxSource": "scripts/server_processing.php",
  20                                         "fnServerParams": function ( aoData ) {
  21                                                 aoData.push( { "name": "more_data", "value": "my_value" } );
  22                                         }
  23                                 } );
  24                         } );
  25                 </script>
  26         </head>
  27         <body id="dt_example">
  28                 <div id="container">
  29                         <div class="full_width big">
  30                                 DataTables server-side processing example
  31                         </div>
  32
  33                         <h1>Preamble</h1>
  34                         <p>It can often be useful to send a little bit of extra information to the server when utilising DataTables' server-side processing option. This can be done by using the <a href="http://datatables.net/ref#fnServerParams">fnServerParams</a> callback function which is called whenever an XHR is sent to the server. fnServerParams Takes a single parameter, the array of name/value pairs of parameters that are to be sent to the server. You can manipulate this as you require - typically adding another parameter, as shown in this example.</p>
  35
  36                         <h1>Live example</h1>
  37                         <div id="dynamic">
  38 <table cellpadding="0" cellspacing="0" border="0" class="display" id="example">
  39         <thead>
  40                 <tr>
  41                         <th width="20%">Rendering engine</th>
  42                         <th width="25%">Browser</th>
  43                         <th width="25%">Platform(s)</th>
  44                         <th width="15%">Engine version</th>
  45                         <th width="15%">CSS grade</th>
  46                 </tr>
  47         </thead>
  48         <tbody>
  49                 <tr>
  50                         <td colspan="5" class="dataTables_empty">Loading data from server</td>
  51                 </tr>
  52         </tbody>
  53         <tfoot>
  54                 <tr>
  55                         <th>Rendering engine</th>
  56                         <th>Browser</th>
  57                         <th>Platform(s)</th>
  58                         <th>Engine version</th>
  59                         <th>CSS grade</th>
  60                 </tr>
  61         </tfoot>
  62 </table>
  63                         </div>
  64                         <div class="spacer"></div>
  65
  66
  67                         <h1>Initialisation code</h1>
  68                         <pre class="brush: js;">$(document).ready(function() {
  69         $('#example').dataTable( {
  70                 "bProcessing": true,
  71                 "bServerSide": true,
  72                 "sAjaxSource": "scripts/server_processing.php"
  73                 "fnServerParams": function ( aoData ) {
  74                         aoData.push( { "name": "more_data", "value": "my_value" } );
  75                 }
  76         } );
  77 } );</pre>
  78                         <style type="text/css">
  79                                 @import "../examples_support/syntax/css/shCore.css";
  80                         </style>
  81                         <script type="text/javascript" language="javascript" src="../examples_support/syntax/js/shCore.js"></script>
  82
  83                         <h1>Server response</h1>
  84                         <p>The code below shows the latest JSON data that has been returned from the server in response to the Ajax request made by DataTables. This will update as further requests are made.</p>
  85                         <pre id="latest_xhr" class="brush: js;"></pre>
  86
  87
  88                         <h1>Other examples</h1>
  89                         <div class="demo_links">
  90                                 <h2>Basic initialisation</h2>
  91                                 <ul>
  92                                         <li><a href="../basic_init/zero_config.html">Zero configuration</a></li>
  93                                         <li><a href="../basic_init/filter_only.html">Feature enablement</a></li>
  94                                         <li><a href="../basic_init/table_sorting.html">Sorting data</a></li>
  95                                         <li><a href="../basic_init/multi_col_sort.html">Multi-column sorting</a></li>
  96                                         <li><a href="../basic_init/multiple_tables.html">Multiple tables</a></li>
  97                                         <li><a href="../basic_init/hidden_columns.html">Hidden columns</a></li>
  98                                         <li><a href="../basic_init/complex_header.html">Complex headers - grouping with colspan</a></li>
  99                                         <li><a href="../basic_init/dom.html">DOM positioning</a></li>
 100                                         <li><a href="../basic_init/flexible_width.html">Flexible table width</a></li>
 101                                         <li><a href="../basic_init/state_save.html">State saving</a></li>
 102                                         <li><a href="../basic_init/alt_pagination.html">Alternative pagination styles</a></li>
 103                                         <li>Scrolling: <br>
 104                                                 <a href="../basic_init/scroll_x.html">Horizontal</a> /
 105                                                 <a href="../basic_init/scroll_y.html">Vertical</a> /
 106                                                 <a href="../basic_init/scroll_xy.html">Both</a> /
 107                                                 <a href="../basic_init/scroll_y_theme.html">Themed</a> /
 108                                                 <a href="../basic_init/scroll_y_infinite.html">Infinite</a>
 109                                         </li>
 110                                         <li><a href="../basic_init/language.html">Change language information (internationalisation)</a></li>
 111                                         <li><a href="../basic_init/themes.html">ThemeRoller themes (Smoothness)</a></li>
 112                                 </ul>
 113
 114                                 <h2>Advanced initialisation</h2>
 115                                 <ul>
 116                                         <li>Events: <br>
 117                                                 <a href="../advanced_init/events_live.html">Live events</a> /
 118                                                 <a href="../advanced_init/events_pre_init.html">Pre-init</a> /
 119                                                 <a href="../advanced_init/events_post_init.html">Post-init</a>
 120                                         </li>
 121                                         <li><a href="../advanced_init/column_render.html">Column rendering</a></li>
 122                                         <li><a href="../advanced_init/html_sort.html">Sorting without HTML tags</a></li>
 123                                         <li><a href="../advanced_init/dom_multiple_elements.html">Multiple table controls (sDom)</a></li>
 124                                         <li><a href="../advanced_init/length_menu.html">Defining length menu options</a></li>
 125                                         <li><a href="../advanced_init/complex_header.html">Complex headers and hidden columns</a></li>
 126                                         <li><a href="../advanced_init/dom_toolbar.html">Custom toolbar (element) around table</a></li>
 127                                         <li><a href="../advanced_init/highlight.html">Row highlighting with CSS</a></li>
 128                                         <li><a href="../advanced_init/row_grouping.html">Row grouping</a></li>
 129                                         <li><a href="../advanced_init/row_callback.html">Row callback</a></li>
 130                                         <li><a href="../advanced_init/footer_callback.html">Footer callback</a></li>
 131                                         <li><a href="../advanced_init/sorting_control.html">Control sorting direction of columns</a></li>
 132                                         <li><a href="../advanced_init/language_file.html">Change language information from a file (internationalisation)</a></li>
 133                                         <li><a href="../advanced_init/defaults.html">Setting defaults</a></li>
 134                                         <li><a href="../advanced_init/localstorage.html">State saving with localStorage</a></li>
 135                                         <li><a href="../advanced_init/dt_events.html">Custom events</a></li>
 136                                 </ul>
 137
 138                                 <h2>API</h2>
 139                                 <ul>
 140                                         <li><a href="../api/add_row.html">Dynamically add a new row</a></li>
 141                                         <li><a href="../api/multi_filter.html">Individual column filtering (using "input" elements)</a></li>
 142                                         <li><a href="../api/multi_filter_select.html">Individual column filtering (using "select" elements)</a></li>
 143                                         <li><a href="../api/highlight.html">Highlight rows and columns</a></li>
 144                                         <li><a href="../api/row_details.html">Show and hide details about a particular record</a></li>
 145                                         <li><a href="../api/select_row.html">User selectable rows (multiple rows)</a></li>
 146                                         <li><a href="../api/select_single_row.html">User selectable rows (single row) and delete rows</a></li>
 147                                         <li><a href="../api/editable.html">Editable rows (with jEditable)</a></li>
 148                                         <li><a href="../api/form.html">Submit form with elements in table</a></li>
 149                                         <li><a href="../api/counter_column.html">Index column (static number column)</a></li>
 150                                         <li><a href="../api/show_hide.html">Show and hide columns dynamically</a></li>
 151                                         <li><a href="../api/api_in_init.html">API function use in initialisation object (callback)</a></li>
 152                                         <li><a href="../api/tabs_and_scrolling.html">DataTables scrolling and tabs</a></li>
 153                                         <li><a href="../api/regex.html">Regular expression filtering</a></li>
 154                                 </ul>
 155                         </div>
 156
 157                         <div class="demo_links">
 158                                 <h2>Data sources</h2>
 159                                 <ul>
 160                                         <li><a href="../data_sources/dom.html">DOM</a></li>
 161                                         <li><a href="../data_sources/js_array.html">Javascript array</a></li>
 162                                         <li><a href="../data_sources/ajax.html">Ajax source</a></li>
 163                                         <li><a href="../data_sources/server_side.html">Server side processing</a></li>
 164                                 </ul>
 165
 166                                 <h2>Server-side processing</h2>
 167                                 <ul>
 168                                         <li><a href="../server_side/server_side.html">Obtain server-side data</a></li>
 169                                         <li><a href="../server_side/custom_vars.html">Add extra HTTP variables</a></li>
 170                                         <li><a href="../server_side/post.html">Use HTTP POST</a></li>
 171                                         <li><a href="../server_side/ids.html">Automatic addition of IDs and classes to rows</a></li>
 172                                         <li><a href="../server_side/object_data.html">Reading table data from objects</a></li>
 173                                         <li><a href="../server_side/row_details.html">Show and hide details about a particular record</a></li>
 174                                         <li><a href="../server_side/select_rows.html">User selectable rows (multiple rows)</a></li>
 175                                         <li><a href="../server_side/jsonp.html">JSONP for a cross domain data source</a></li>
 176                                         <li><a href="../server_side/editable.html">jEditable integration with DataTables</a></li>
 177                                         <li><a href="../server_side/defer_loading.html">Deferred loading of Ajax data</a></li>
 178                                         <li><a href="../server_side/pipeline.html">Pipelining data (reduce Ajax calls for paging)</a></li>
 179                                 </ul>
 180
 181                                 <h2>Ajax data source</h2>
 182                                 <ul>
 183                                         <li><a href="../ajax/ajax.html">Ajax sourced data (array of arrays)</a></li>
 184                                         <li><a href="../ajax/objects.html">Ajax sourced data (array of objects)</a></li>
 185                                         <li><a href="../ajax/defer_render.html">Deferred DOM creation for extra speed</a></li>
 186                                         <li><a href="../ajax/null_data_source.html">Empty data source columns</a></li>
 187                                         <li><a href="../ajax/custom_data_property.html">Use a data source other than aaData (the default)</a></li>
 188                                         <li><a href="../ajax/objects_subarrays.html">Read column data from sub-arrays</a></li>
 189                                         <li><a href="../ajax/deep.html">Read column data from deeply nested properties</a></li>
 190                                 </ul>
 191
 192                                 <h2>Plug-ins</h2>
 193                                 <ul>
 194                                         <li><a href="../plug-ins/plugin_api.html">Add custom API functions</a></li>
 195                                         <li><a href="../plug-ins/sorting_plugin.html">Sorting and automatic type detection</a></li>
 196                                         <li><a href="../plug-ins/sorting_sType.html">Sorting without automatic type detection</a></li>
 197                                         <li><a href="../plug-ins/paging_plugin.html">Custom pagination controls</a></li>
 198                                         <li><a href="../plug-ins/range_filtering.html">Range filtering / custom filtering</a></li>
 199                                         <li><a href="../plug-ins/dom_sort.html">Live DOM sorting</a></li>
 200                                         <li><a href="../plug-ins/html_sort.html">Automatic HTML type detection</a></li>
 201                                 </ul>
 202                         </div>
 203
 204
 205                         <div id="footer" class="clear" style="text-align:center;">
 206                                 <p>
 207                                         Please refer to the <a href="http://www.datatables.net/usage">DataTables documentation</a> for full information about its API properties and methods.<br>
 208                                         Additionally, there are a wide range of <a href="http://www.datatables.net/extras">extras</a> and <a href="http://www.datatables.net/plug-ins">plug-ins</a> which extend the capabilities of DataTables.
 209                                 </p>
 210
 211                                 <span style="font-size:10px;">
 212                                         DataTables designed and created by <a href="http://www.sprymedia.co.uk">Allan Jardine</a> &copy; 2007-2011<br>
 213                                         DataTables is dual licensed under the <a href="http://www.datatables.net/license_gpl2">GPL v2 license</a> or a <a href="http://www.datatables.net/license_bsd">BSD (3-point) license</a>.
 214                                 </span>
 215                         </div>
 216                 </div>
 217         </body>
 218 </html>