custom_data_property.html 14 KB

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