Gallery

Modules

Documentation

Context Navigation

YUI Library is not responsible for bugs or support with this module. It is available as a free service. For support please contact the module owner with the provided links.

Grouped DataTable (gallery-grouped-table)

Last Updated: 11/8/11

+ 1 -

Greg Hinch

YUI Contributor

See 14 more by this user.

Created: 11/8/11
Project: YUI 3
License: YUI BSD
YUI Version: 3.4.1
Free for use.

This plugin allows you to present groups of rows under a single heading, keyed by a given attribute of the records contained within.

Download
Docs
Homepage
Bugs
Source
Example
Forum
History

By adding the plugin to any DataTable instance and specifying the key to group by, the table will automatically render in groups. The value for "groupBy" can also be a function which will receive a copy of each record in the table and should return a string key to group by. Additionally, a "groupLabelRenderer" can be specified to apply custom formatting to the groups.

Code Sample

YUI().use('gallery-grouped-table', 'datasource-local', function(Y) {
  var table = new Y.DataTable({
    columnset : [{key : 'firstName'}, {key : 'lastName'}, {key : 'workplace'}],
    plugins : [
      {fn : Y.Plugin.GroupedDataTable, cfg : {
        groupBy : 'workplace'
      }}
    ]
  });
 
  // Add data to table ...
 
  table.render(); // Rows will be in groups by "workplace"
});