objects.html 14 KB

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