1
0
mirror of https://github.com/DataTables/DataTables.git synced 2024-11-29 11:24:10 +01:00
DataTables/examples/api/highlight.html

226 lines
20 KiB
HTML
Raw Normal View History

<!doctype html>
<html>
<head>
<meta charset="utf-8">
<link rel="shortcut icon" type="image/ico" href="http://www.datatables.net/favicon.ico" />
<meta name="viewport" content="initial-scale=1.0, maximum-scale=2.0" />
<title>DataTables example - Highlighting rows and columns</title>
<link rel="stylesheet" type="text/css" href="../../media/css/jquery.dataTables.css"><link rel="stylesheet" type="text/css" href="../resources/syntax/shCore.css"><link rel="stylesheet" type="text/css" href="../resources/demo.css">
<style type="text/css" class="init">
td.highlight {
background-color: whitesmoke !important;
}
</style>
<script type="text/javascript" language="javascript" src="//code.jquery.com/jquery-1.12.0.min.js"></script><script type="text/javascript" language="javascript" src="../../media/js/jquery.dataTables.js"></script><script type="text/javascript" language="javascript" src="../resources/syntax/shCore.js"></script><script type="text/javascript" language="javascript" src="../resources/demo.js"></script>
<script type="text/javascript" language="javascript" class="init">
$(document).ready(function() {
var table = $('#example').DataTable();
$('#example tbody')
.on( 'mouseenter', 'td', function () {
var colIdx = table.cell(this).index().column;
$( table.cells().nodes() ).removeClass( 'highlight' );
$( table.column( colIdx ).nodes() ).addClass( 'highlight' );
} );
} );
</script>
</head>
<body class="dt-example ">
<div class="container">
<section>
<h1>DataTables example <span>Highlighting rows and columns</span></h1>
<div class="info">
<p>Highlighting rows and columns have be quite useful for drawing attention to where the user's cursor is in a table, particularly if you have a lot of narrow columns. Of course the highlighting of a row is easy enough using CSS, but for column highlighting, you need to use a little bit of Javascript.</p>
<p>This example shows that in action on DataTable by making use of the <a href="//datatables.net/reference/api/cell().index()"><code class="api" title="DataTables API method">cell().index()</code></a> method to get the index of the column that is to be operated on, and then the <a href="//datatables.net/reference/api/cells().nodes()"><code class="api" title="DataTables API method">cells().nodes()</code></a> and <a href="//datatables.net/reference/api/column().nodes()"><code class="api" title="DataTables API method">column().nodes()</code></a> methods to remove old classes and apply the new highlighted class, respectively.</p>
</div>
<table id="example" class="row-border hover order-column" cellspacing="0" width="100%"><thead><tr><th>Name</th><th>Position</th><th>Office</th><th>Age</th><th>Start date</th><th>Salary</th></tr></thead><tfoot><tr><th>Name</th><th>Position</th><th>Office</th><th>Age</th><th>Start date</th><th>Salary</th></tr></tfoot><tbody><tr><td>Tiger Nixon</td><td>System Architect</td><td>Edinburgh</td><td>61</td><td>2011/04/25</td><td>$320,800</td></tr><tr><td>Garrett Winters</td><td>Accountant</td><td>Tokyo</td><td>63</td><td>2011/07/25</td><td>$170,750</td></tr><tr><td>Ashton Cox</td><td>Junior Technical Author</td><td>San Francisco</td><td>66</td><td>2009/01/12</td><td>$86,000</td></tr><tr><td>Cedric Kelly</td><td>Senior Javascript Developer</td><td>Edinburgh</td><td>22</td><td>2012/03/29</td><td>$433,060</td></tr><tr><td>Airi Satou</td><td>Accountant</td><td>Tokyo</td><td>33</td><td>2008/11/28</td><td>$162,700</td></tr><tr><td>Brielle Williamson</td><td>Integration Specialist</td><td>New York</td><td>61</td><td>2012/12/02</td><td>$372,000</td></tr><tr><td>Herrod Chandler</td><td>Sales Assistant</td><td>San Francisco</td><td>59</td><td>2012/08/06</td><td>$137,500</td></tr><tr><td>Rhona Davidson</td><td>Integration Specialist</td><td>Tokyo</td><td>55</td><td>2010/10/14</td><td>$327,900</td></tr><tr><td>Colleen Hurst</td><td>Javascript Developer</td><td>San Francisco</td><td>39</td><td>2009/09/15</td><td>$205,500</td></tr><tr><td>Sonya Frost</td><td>Software Engineer</td><td>Edinburgh</td><td>23</td><td>2008/12/13</td><td>$103,600</td></tr><tr><td>Jena Gaines</td><td>Office Manager</td><td>London</td><td>30</td><td>2008/12/19</td><td>$90,560</td></tr><tr><td>Quinn Flynn</td><td>Support Lead</td><td>Edinburgh</td><td>22</td><td>2013/03/03</td><td>$342,000</td></tr><tr><td>Charde Marshall</td><td>Regional Director</td><td>San Francisco</td><td>36</td><td>2008/10/16</td><td>$470,600</td></tr><tr><td>Haley Kennedy</td><td>Senior Marketing Designer</td><td>London</td><td>43</td><td>2012/12/18</td><td>$313,500</td></tr><tr><td>Tatyana Fitzpatrick</td><td>Regional Director</td><td>London</td><td>19</td><td>2010/03/17</td><td>$385,750</td></tr><tr><td>Michael Silva</td><td>Marketing Designer</td><td>London</td><td>66</td><td>2012/11/27</td><td>$198,500</td></tr><tr><td>Paul Byrd</td><td>Chief Financial Officer (CFO)</td><td>New York</td><td>64</td><td>2010/06/09</td><td>$725,000</td></tr><tr><td>Gloria Little</td><td>Systems Administrator</td><td>New York</td><td>59</td><td>2009/04/10</td><td>$237,500</td></tr><tr><td>Bradley Greer</td><td>Software Engineer</td><td>London</td><td>41</td><td>2012/10/13</td><td>$132,000</td></tr><tr><td>Dai Rios</td><td>Personnel Lead</td><td>Edinburgh</td><td>35</td><td>2012/09/26</td><td>$217,500</td></tr><tr><td>Jenette Caldwell</td><td>Development Lead</td><td>New York</td><td>30</td><td>2011/09/03</td><td>$345,000</td></tr><tr><td>Yuri Berry</td><td>Chief Marketing Officer (CMO)</td><td>New York</td><td>40</td><td>2009/06/25</td><td>$675,000</td></tr><tr><td>Caesar Vance</td><td>Pre-Sales Support</td><td>New York</td><td>21</td><td>2011/12/12</td><td>$106,450</td></tr><tr><td>Doris Wilder</td><td>Sales Assistant</td><td>Sidney</td><td>23</td><td>2010/09/20</td><td>$85,600</td></tr><tr><td>Angelica Ramos</td><td>Chief Executive Officer (CEO)</td><td>London</td><td>47</td><td>2009/10/09</td><td>$1,200,000</td></tr><tr><td>Gavin Joyce</td><td>Developer</td><td>Edinburgh</td><td>42</td><td>2010/12/22</td><td>$92,575</td></tr><tr><td>Jennifer Chang</td><td>Regional Director</td><td>Singapore</td><td>28</td><td>2010/11/14</td><td>$357,650</td></tr><tr><td>Brenden Wagner</td><td>Software Engineer</td><td>San Francisco</td><td>28</td><td>2011/06/07</td><td>$206,850</td></tr><tr><td>Fiona Green</td><td>Chief Operating Officer (COO)</td><td>San Francisco</td><td>48</td><td>2010/03/11</td><td>$850,000</td></tr><tr><td>Shou Itou</td><td>Regional Marketing</td><td>Tokyo</td><td>20</td><td>2011/08/14</td><td>$163,000</td></tr><tr><td>Michelle House</td><td>Integration Specialist</td><td>Sidney</td><td>37</td><td>2
<ul class="tabs">
<li class="active">Javascript</li>
<li>HTML</li>
<li>CSS</li>
<li>Ajax</li>
<li>Server-side script</li>
</ul>
<div class="tabs">
<div class="js">
<p>The Javascript shown below is used to initialise the table shown in this example:</p>
<code class="multiline language-js">$(document).ready(function() {
var table = $('#example').DataTable();
$('#example tbody')
.on( 'mouseenter', 'td', function () {
var colIdx = table.cell(this).index().column;
$( table.cells().nodes() ).removeClass( 'highlight' );
$( table.column( colIdx ).nodes() ).addClass( 'highlight' );
} );
} );</code>
<p>In addition to the above code, the following Javascript library files are loaded for use in this example:</p>
<ul><li><a href="//code.jquery.com/jquery-1.12.0.min.js">//code.jquery.com/jquery-1.12.0.min.js</a></li><li><a href="../../media/js/jquery.dataTables.js">../../media/js/jquery.dataTables.js</a></li></ul>
</div>
<div class="table">
<p>The HTML shown below is the raw HTML table element, before it has been enhanced by DataTables:</p>
</div>
<div class="css">
<div>
<p>This example uses a little bit of additional CSS beyond what is loaded from the library files (below), in order to correctly display the table. The additional CSS used is shown below:</p>
<code class="multiline language-css">td.highlight {
background-color: whitesmoke !important;
}</code>
</div>
<p>The following CSS library files are loaded for use in this example to provide the styling of the table:</p>
<ul><li><a href="../../media/css/jquery.dataTables.css">../../media/css/jquery.dataTables.css</a></li></ul>
</div>
<div class="ajax">
<p>This table loads data by Ajax. The latest data that has been loaded is shown below. This data will update automatically as any additional data is loaded.</p>
</div>
<div class="php">
<p>The script used to perform the server-side processing for this table is shown below. Please note that this is just an example script using PHP. Server-side processing scripts can be written in any language, using <a href="//datatables.net/manual/server-side">the protocol described in the DataTables documentation</a>.</p>
</div>
</div>
</section>
</div>
<section>
<div class="footer">
<div class="gradient"></div>
<div class="liner">
<h2>Other examples</h2>
<div class="toc">
<div class="toc-group"><h3><a href="../basic_init/index.html
">Basic initialisation</a></h3><ul class="toc"><li><a href="../basic_init/zero_configuration.html
">Zero configuration</a></li><li><a href="../basic_init/filter_only.html
">Feature enable / disable</a></li><li><a href="../basic_init/table_sorting.html
">Default ordering (sorting)</a></li><li><a href="../basic_init/multi_col_sort.html
">Multi-column ordering</a></li><li><a href="../basic_init/multiple_tables.html
">Multiple tables</a></li><li><a href="../basic_init/hidden_columns.html
">Hidden columns</a></li><li><a href="../basic_init/complex_header.html
">Complex headers (rowspan and colspan)</a></li><li><a href="../basic_init/dom.html
">DOM positioning</a></li><li><a href="../basic_init/flexible_width.html
">Flexible table width</a></li><li><a href="../basic_init/state_save.html
">State saving</a></li><li><a href="../basic_init/alt_pagination.html
">Alternative pagination</a></li><li><a href="../basic_init/scroll_y.html
">Scroll - vertical</a></li><li><a href="../basic_init/scroll_y_dynamic.html
">Scroll - vertical, dynamic height</a></li><li><a href="../basic_init/scroll_x.html
">Scroll - horizontal</a></li><li><a href="../basic_init/scroll_xy.html
">Scroll - horizontal and vertical</a></li><li><a href="../basic_init/comma-decimal.html
">Language - Comma decimal place</a></li><li><a href="../basic_init/language.html
">Language options</a></li></ul></div><div class="toc-group"><h3><a href="../advanced_init/index.html
">Advanced initialisation</a></h3><ul class="toc"><li><a href="../advanced_init/events_live.html
">DOM / jQuery events</a></li><li><a href="../advanced_init/dt_events.html
">DataTables events</a></li><li><a href="../advanced_init/column_render.html
">Column rendering</a></li><li><a href="../advanced_init/length_menu.html
">Page length options</a></li><li><a href="../advanced_init/dom_multiple_elements.html
">Multiple table control elements</a></li><li><a href="../advanced_init/complex_header.html
">Complex headers with column visibility</a></li><li><a href="../advanced_init/object_dom_read.html
">Read HTML to data objects</a></li><li><a href="../advanced_init/html5-data-options.html
">HTML5 data-* attributes - table options</a></li><li><a href="../advanced_init/html5-data-attributes.html
">HTML5 data-* attributes - cell data</a></li><li><a href="../advanced_init/language_file.html
">Language file</a></li><li><a href="../advanced_init/defaults.html
">Setting defaults</a></li><li><a href="../advanced_init/row_callback.html
">Row created callback</a></li><li><a href="../advanced_init/row_grouping.html
">Row grouping</a></li><li><a href="../advanced_init/footer_callback.html
">Footer callback</a></li><li><a href="../advanced_init/dom_toolbar.html
">Custom toolbar elements</a></li><li><a href="../advanced_init/sort_direction_control.html
">Order direction sequence control</a></li></ul></div><div class="toc-group"><h3><a href="../styling/index.html
">Styling</a></h3><ul class="toc"><li><a href="../styling/display.html
">Base style</a></li><li><a href="../styling/no-classes.html
">Base style - no styling classes</a></li><li><a href="../styling/cell-border.html
">Base style - cell borders</a></li><li><a href="../styling/compact.html
">Base style - compact</a></li><li><a href="../styling/hover.html
">Base style - hover</a></li><li><a href="../styling/order-column.html
">Base style - order-column</a></li><li><a href="../styling/row-border.html
">Base style - row borders</a></li><li><a href="../styling/stripe.html
">Base style - stripe</a></li><li><a href="../styling/bootstrap.html
">Bootstrap 3</a></li><li><a href="../styling/foundation.html
">Foundation</a></li><li><a href="../styling/jqueryUI.html
">jQuery UI ThemeRoller</a></li><li><a href="../styling/bootstrap4.html
">Bootstrap 4 (Tech. preview)</a></li><li><a href="../styling/semanticui.html
">Semantic UI (Tech. preview)</a></li><li><a href="../styling/material.html
">Material Design (Tech. preview)</a></li><li><a href="../styling/uikit.html
">UIKit (Tech. preview)</a></li></ul></div><div class="toc-group"><h3><a href="../data_sources/index.html
">Data sources</a></h3><ul class="toc"><li><a href="../data_sources/dom.html
">HTML (DOM) sourced data</a></li><li><a href="../data_sources/ajax.html
">Ajax sourced data</a></li><li><a href="../data_sources/js_array.html
">Javascript sourced data</a></li><li><a href="../data_sources/server_side.html
">Server-side processing</a></li></ul></div><div class="toc-group"><h3><a href="./index.html
">API</a></h3><ul class="toc active"><li><a href="./add_row.html
">Add rows</a></li><li><a href="./multi_filter.html
">Individual column searching (text inputs)</a></li><li><a href="./multi_filter_select.html
">Individual column searching (select inputs)</a></li><li class="active"><a href="./highlight.html
">Highlighting rows and columns</a></li><li><a href="./row_details.html
">Child rows (show extra / detailed information)</a></li><li><a href="./select_row.html
">Row selection (multiple rows)</a></li><li><a href="./select_single_row.html
">Row selection and deletion (single row)</a></li><li><a href="./form.html
">Form inputs</a></li><li><a href="./counter_columns.html
">Index column</a></li><li><a href="./show_hide.html
">Show / hide columns dynamically</a></li><li><a href="./api_in_init.html
">Using API in callbacks</a></li><li><a href="./tabs_and_scrolling.html
">Scrolling and Bootstrap tabs</a></li><li><a href="./regex.html
">Search API (regular expressions)</a></li></ul></div><div class="toc-group"><h3><a href="../ajax/index.html
">Ajax</a></h3><ul class="toc"><li><a href="../ajax/simple.html
">Ajax data source (arrays)</a></li><li><a href="../ajax/objects.html
">Ajax data source (objects)</a></li><li><a href="../ajax/deep.html
">Nested object data (objects)</a></li><li><a href="../ajax/objects_subarrays.html
">Nested object data (arrays)</a></li><li><a href="../ajax/orthogonal-data.html
">Orthogonal data</a></li><li><a href="../ajax/null_data_source.html
">Generated content for a column</a></li><li><a href="../ajax/custom_data_property.html
">Custom data source property</a></li><li><a href="../ajax/custom_data_flat.html
">Flat array data source</a></li><li><a href="../ajax/defer_render.html
">Deferred rendering for speed</a></li></ul></div><div class="toc-group"><h3><a href="../server_side/index.html
">Server-side</a></h3><ul class="toc"><li><a href="../server_side/simple.html
">Server-side processing</a></li><li><a href="../server_side/custom_vars.html
">Custom HTTP variables</a></li><li><a href="../server_side/post.html
">POST data</a></li><li><a href="../server_side/ids.html
">Automatic addition of row ID attributes</a></li><li><a href="../server_side/object_data.html
">Object data source</a></li><li><a href="../server_side/row_details.html
">Row details</a></li><li><a href="../server_side/select_rows.html
">Row selection</a></li><li><a href="../server_side/jsonp.html
">JSONP data source for remote domains</a></li><li><a href="../server_side/defer_loading.html
">Deferred loading of data</a></li><li><a href="../server_side/pipeline.html
">Pipelining data to reduce Ajax calls for paging</a></li></ul></div><div class="toc-group"><h3><a href="../plug-ins/index.html
">Plug-ins</a></h3><ul class="toc"><li><a href="../plug-ins/api.html
">API plug-in methods</a></li><li><a href="../plug-ins/sorting_auto.html
">Ordering plug-ins (with type detection)</a></li><li><a href="../plug-ins/sorting_manual.html
">Ordering plug-ins (no type detection)</a></li><li><a href="../plug-ins/range_filtering.html
">Custom filtering - range search</a></li><li><a href="../plug-ins/dom_sort.html
">Live DOM ordering</a></li></ul></div>
</div>
<div class="epilogue">
<p>
Please refer to the <a href="http://www.datatables.net">DataTables documentation</a> for full information about its API properties and methods.<br>
Additionally, there are a wide range of <a href="http://www.datatables.net/extensions">extensions</a> and <a href="http://www.datatables.net/plug-ins">plug-ins</a> which extend the capabilities of DataTables.
</p>
<p class="copyright">
DataTables designed and created by <a href="http://www.sprymedia.co.uk">SpryMedia Ltd</a> &copy; 2007-2016<br>
DataTables is licensed under the <a href="http://www.datatables.net/mit">MIT license</a>.
</p>
</div>
</div>
</div>
</section>
</body>
</html>