Introduction

DataTables is a plug-in for the jQuery Javascript library. It is a highly flexible tool, based upon the principle of progressive enhancement, which will add advanced interaction controls to any HTML table.

This version includes datatables 1.10.11 without the examples available in the source distribution of the plugin. It is provided with an @@example.datatables view.

Install

A genericsetup profile is provided to add jquery.dataTables to portal_javascript in a minified version with compression option set to none.

Upgrade

WARNING, with 10.0.4 JS, CSS from core plugins were all renamed in the upstream packaging, preprare to update your inclusions urls for plugins JS & CSS!

Key features of jquery.dataTables

• Variable-length pagination
• On-the-fly filtering
• Multi-column sorting with data type detection
• Smart handling of column widths
• Display data from almost any data source
• Scrolling options for table viewport
• Fully internationalisable
• jQueryUI ThemeRoller support
• Rock solid - backed by a suite of 1400+ unit tests
• Wide variety of plug-ins inc. TableTools, FixedHeader and KeyTable
• It's free!
• State saving
• Hidden columns
• Dynamic creation of tables
• Ajax auto-loading of data
• Custom DOM positioning
• Single-column filtering
• Alternative pagination types
• Non-destructive DOM interaction
• Sorting column(s) highlighting
• Extensive plug-in support
• Fully themeable by CSS
• Solid documentation
• 60+ pre-built examples
• Full support for Adobe AIR
• Source available at github

Plugins

This addon embed extras plugins:

• AutoFill 1.2.1
• ColReorder 1.1.2
• ColVis 1.1.1
• FixedColumns 3.0.2
• FixedHeader 2.1.2
• KeyTable 1.2.1
• Responsive 1.0.3
• Scroller 1.2.2
• TableTools 2.2.3

How to use tabletools

First include dependencies in your template, or register theses in portal_javascripts:

<link rel="stylesheet" type="text/css" media="screen" href="++resource++jquery.datatables/media/css/jquery.dataTables.css">
<link rel="stylesheet" type="text/css" media="screen" href="++resource++jquery.datatables/media/css/jquery.dataTables_themeroller.css">
<link rel="stylesheet" type="text/css" media="screen" href="++resource++jquery.datatables/extras/TableTools/media/css/dataTables.tableTools.min.css">
<script type="text/javascript" src="++resource++jquery.datatables.js"></script>
<script type="text/javascript" src="++resource++jquery.datatables/extras/TableTools/media/js/dataTables.TableTools.js"></script>
<style type="text/css">.clear{clear:both}</style>

Next you can create your datatable:

var oTable = $('#mydatatable').dataTable({
  "sDom": 'T<"clear">lfrtip',
  "oTableTools": {"sSwfPath": "++resource++jquery.datatables/extras/TableTools/media/swf/copy_csv_xls_pdf.swf"}
});

How to use translations

This addon provide translations of datatables. To use translations you have to init your datatables providing sUrl param:

$(document).ready(function() {
  $('#example').dataTable( {
      "oLanguage": {
          "sUrl": "@@collective.js.datatables.translation"
      }
  } );
} );

Credits

Companies

• Planet Makina Corpus
• Contact us

Authors

• JeanMichel FRANCOIS aka toutpt <[email protected]>

Contributors

• Nejc Zupan (zupo)
• Martijn Pieters
• Luca Fabbri (keul)
• Jens Klein (jensens)
• Mathieu Le Marec - Pasquet (kiorky) <[email protected]>
• Robert Niederreiter (rnix)
• Peter Holzer (agitator)