datatables.net-plugins/api/src/page.jumpToData().ts

Various small plug-ins for DataTables including feature, ordering, search and internationalisation plug-ins.

/*! © SpryMedia Ltd - datatables.net/license */

/**
 * It can be quite useful to jump straight to a page which contains a certain
 * piece of data (a user name for example). This plug-in provides exactly that
 * ability, searching for a given data parameter from a given column and
 * immediately shifting the paging of the table to jump to that point.
 *
 * If multiple data points match the requested data, the paging will be shifted
 * to show the first instance. If there are no matches, the paging will not
 * change.
 *
 * Note that unlike the core DataTables API methods, this plug-in will
 * automatically call `dt-api draw()` to redraw the table with the current page
 * shown.
 *
 * @name page.JumpToData()
 * @summary Jump to a page by searching for data from a column
 * @author [Allan Jardine](http://datatables.net)
 * @requires DataTables 1.10+
 *
 * @param {*} data Data to search for
 * @param {integer} column Column index
 * @returns {Api} DataTables API instance
 *
 * @example
 *    var table = $('#example').DataTable();
 *    table.page.jumpToData( "Allan Jardine", 0 );
 */

import DataTable from 'datatables.net';

declare module 'datatables.net' {
	interface ApiPage {
		/** Change ordering of the table to its data load order */
		jumpToData(data: any): Api<any>;
	}
}

DataTable.Api.register('page.jumpToData()', function (data, column) {
	var pos = this.column(column, { order: 'current' }).data().indexOf(data);

	if (pos >= 0) {
		var page = Math.floor(pos / this.page.info().length);
		this.page(page).draw(false);
	}

	return this;
});