diff --git a/docs/example-options-headers.html b/docs/example-options-headers.html index 9d790eb7..d320ca16 100644 --- a/docs/example-options-headers.html +++ b/docs/example-options-headers.html @@ -50,7 +50,7 @@
NOTE!
"filter-select-nosort"
will now leave the select options unsorted.filter_saveFilters
option was added (default set to false
); this demo has it set to true
to provide an example.$r
providing a jQuery object of the current row being searched by the filter.filter_saveFilters
option was added (default set to false
); this demo has it set to true
to provide an example.$r
providing a jQuery object of the current row being searched by the filter.data-value
set to <30
which sets the default (starting) filter value (see filter_defaultAttrib for more details).filter_functions
was added in version 2.3.6.{page}
tag in the pager output
option is replaced by this value.page
option or from local storage if the savePages
option is true
. It is then updated by user interaction with the page selector (targetted by the cssGoto
option or programmically by the pageSet
or pageAndSize
method.
+ Initially, this value is set by either the pager page
option or from local storage if the savePages
option is true
. It is then updated by user interaction with the page selector (targeted by the cssGoto
option or programmically by the pageSet
or pageAndSize
method.
size
option or from local storage if the savePages
option is true
. It is then updated by user interaction with the size selector (targetted by the cssPageSize
option or programmically by the pageSize
or pageAndSize
method.
+ Initially, this value is set by either the pager size
option or from local storage if the savePages
option is true
. It is then updated by user interaction with the size selector (targeted by the cssPageSize
option or programmically by the pageSize
or pageAndSize
method.
table
- table DOM element (or jQuery object) of table.toggle
- Boolean flag.$ths
- jQuery object of targetted header cells (optional; if excluded all header cells are targetted).$ths
- jQuery object of targeted header cells (optional; if excluded all header cells are targeted).toggle
option to add (true
) or remove (false
) process indicators. Include any specific header cells within the $ths
variable with which to add the process indicator. When $ths
is not defined and a sort is applied, the currently sorted header cells will show process indicators.$.tablesorter.bindEvents( table, $headers );
table
- table DOM element (or jQuery object) of table.$headers
- jQuery object of targetted cells.$headers
- jQuery object of targeted cells.sort
event, left click (only) to sort, ignoring long clicks (> 250ms), pressing enter to trigger a sort (must have focus and a tabindex
attribute) and cancelling selection of text (if the option is set).$.tablesorter.getColumnData( table, object, key );+
table
- table DOM element (or jQuery object).object
- object containing zero-based column indexes or column class names as a key (e.g. table.config.headers
or table.config.widgetOptions.filter_functions
; any data found as the value (of the key : value
pair) will be returned.key
- key to be Object key; this can be a zero-based column index or header class name/id."event"
. And you want to use the textExtraction
function for that column, then you would use this function as follows:
+ var table = $('table')[0], +textExtractionFunction = $.tablesorter.getColumnData( table, table.config.textExtraction, ".event" );+ The
".event"
key can be replaces with a zero-based column index, if the textExtraction
option is set up using indexes.
+
+ This function is sometimes used in conjunction with the getData
function. This function is called first because the getData function uses the result in the configHeaders
parameter - the config.headers
option result from this function would be an object and not a function.
+ $.tablesorter.getData(headerCell, configHeaders, key);
headerCell
- table DOM element (or jQuery object) of targetted header cell.headerCell
- table DOM element (or jQuery object) of targeted header cell.configHeaders
- table.config.headers option for the current column.key
- get value for this option name, e.g. "sorter".table
- table DOM element (or jQuery object) of table.column
- zero-based column index.options
- array of options, jQuery object of option elements, or HTML string of option elements to apply to the targetted select.options
- array of options, jQuery object of option elements, or HTML string of option elements to apply to the targeted select.replace
- a boolean value, which if true
all options will be replaced; if false
the options will be appended to the current list of options.onlyAvail
- an optional boolean flag, which will be ignored if the options
parameter is defined or is an empty string; otherwise it is the value passed to the function which finds all table column values; if true
, only the available options will be diplayed.$.tablesorter.addHeaderResizeEvent(table, disable, { timer : 250 });
table
- table DOM element (or jQuery object) of table.disable
- boolean flag, if false
events for the targetted table are disabled.disable
- boolean flag, if false
events for the targeted table are disabled.timer
- currently only the timer option is available for modification.