{hero}

order.listener()

Since: DataTables 1.10

Add an ordering listener to an element, for a given column.

Description

This method provides the ability to attach ordering listeners to any DOM element on the page. This is the same method as DataTables uses internally for the ordering listeners which are attached to the header cells for each column, and as such provides the same functionality (i.e. click to order, shift click to multi-column order etc).

Although not a common method to be used, it can be useful for allowing sorting to be triggered externally from the table (equally order() and its columns counterparts could also be used).

Note that unlike order() and columns().order() when the ordering listener attached by this function is activated, it will cause the table to redraw automatically - i.e. there is no need to call draw().

Type

function order.listener( node, column, callback )

Description:

Attach an ordering listener to a specified element

Parameters:
Returns:

DataTables API instance with the current order in the result set

Example

Sort on column 1, when '#sorter' element is clicked upon:

var table = $('#example').dataTable();

table.order.listener( '#sorter', 1 );

Related

The following options are directly related and may also be useful in your application development.