diff --git a/docs/example-widget-grouping.html b/docs/example-widget-grouping.html index da78f207..abae7bbf 100644 --- a/docs/example-widget-grouping.html +++ b/docs/example-widget-grouping.html @@ -137,6 +137,7 @@
group_separator
option & group-separator-#
header class name.group_callback
& group_complete
options. See options section below for details.group_collapsible
(true
) - when true
, the group headers become clickable and collapse the rows below it.group_collapsed
(false
) - when true
and group_collapsible
is also true
, all groups will start collapsed (v2.11).group_count
(" ({num})"
) - allows you to add custom formatting, or remove, the group count within the group header. Set it to false
or an empty string to remove the count.group_callback
(null
) - use this function to further modify the group header to include more information (i.e. group totals). Parameters include ($cell, $rows, column, table
). See the example below for more details v2.12.
group_months
([ "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" ]
) - Month names.group_week
([ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ]
) - Named days of the week.group_time
([ "AM", "PM" ]
) - Time of day.$cell
- current group header table cell (jQuery object).$rows
- current group rows (jQuery object).column
- current table column being grouped (zero-based index).table
- current table (DOM).group_complete
("groupingComplete"
) - event triggered on the table when the grouping widget has finished work v2.12.group_formatter
(null
) - use this function to modify the group header text before it gets applied. It provides various parameters (txt, col, table, c, wo
) to make it work for any of the table columns and data. See the comments in the example below for more details.
txt
- current text of the group header.wo
- table widget options from table.config.widgetOptions
.group_callback
(null
) - use this function to further modify the group header to include more information (i.e. group totals). Parameters include ($cell, $rows, column, table
). See the example below for more details v2.12.
+ group_separator
("-"
) - when the group-separator
class name is added, it uses the setting from this option to split the table cell content for grouping v2.12.1.$cell
- current group header table cell (jQuery object).$rows
- current group rows (jQuery object).column
- current table column being grouped (zero-based index).table
- current table (DOM).group_months
([ "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" ]
) - Month names.group_week
([ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ]
) - Named days of the week.group_time
([ "AM", "PM" ]
) - Time of day.group_complete
("groupingComplete"
) - event triggered on the table when the grouping widget has finished work v2.12."group-word"
(same as "group-word-1"
) - group the rows using the first word it finds in the column's parsed data."group-word-n"
("n"
can be any number) - group the rows using the nth word in the column*."group-separator"
(same as "group-separator-1"
) - group the rows using the text between the start and first separator that it finds in the column's parsed data (v2.12.1)."group-separator-n"
("n"
can be any number) - group the rows using the nth separated group in the column (v2.12.1)*."group-letter"
(same as "group-letter-1"
) - group the rows using the first letter it finds in the column's parsed data."group-letter-n"
("n"
can be any number) - group the rows using letters 1 through n (if n = 2, then it's the first 2 letters) in the column's parsed data."group-number"
(same as "group-number-1"
) - group the rows by the number it finds in the column (step of one).