1 // These default options are for translation but can be used
2 // for any other datatables settings
4 // $("#table_id").dataTable($.extend(true, {}, dataTableDefaults, {
7 var dataTablesDefaults = {
10 "first" : __('First'),
13 "previous" : __('Previous'),
15 "emptyTable" : __('No data available in table'),
16 "info" : __('Showing _START_ to _END_ of _TOTAL_ entries'),
17 "infoEmpty" : __('No entries to show'),
18 "infoFiltered" : __('(filtered from _MAX_ total entries)'),
19 "lengthMenu" : __('Show _MENU_ entries'),
20 "loadingRecords" : __('Loading...'),
21 "processing" : __('Processing...'),
22 "search" : __('Search:'),
23 "zeroRecords" : __('No matching records found'),
25 "copyTitle" : __('Copy to clipboard'),
26 "copyKeys" : __('Press <i>ctrl</i> or <i>⌘</i> + <i>C</i> to copy the table data<br>to your system clipboard.<br><br>To cancel, click this message or press escape.'),
28 _: __('Copied %d rows to clipboard'),
29 1: __('Copied one row to clipboard'),
33 "dom": '<"dt-info"i><"top pager"<"table_entries"lp><"table_controls"fB>>tr<"bottom pager"ip>',
36 className: "dt_button_clear_filter",
37 titleAttr: __('Clear filter'),
39 text: '<i class="fa fa-lg fa-times"></i> <span class="dt-button-text">' + __('Clear filter') + '</span>',
40 available: function ( dt ) {
41 // The "clear filter" button is made available if this test returns true
42 if( dt.settings()[0].aanFeatures.f ){ // aanFeatures.f is null if there is no search form
46 action: function ( e, dt, node ) {
47 dt.search( "" ).draw("page");
48 node.addClass("disabled");
51 "lengthMenu": [[10, 20, 50, 100, -1], [10, 20, 50, 100, __('All')]],
54 initComplete: function( settings) {
55 var tableId = settings.nTable.id
56 var state = settings.oLoadedState;
57 state && toggledClearFilter(state.search.search, tableId);
58 // When the DataTables search function is triggered,
59 // enable or disable the "Clear filter" button based on
60 // the presence of a search string
61 $(this).on( 'search.dt', function ( e, settings ) {
62 toggledClearFilter(settings.oPreviousSearch.sSearch, tableId);
67 function toggledClearFilter(searchText, tableId){
68 if( searchText == "" ){
69 $("#" + tableId + "_wrapper").find(".dt_button_clear_filter").addClass("disabled");
71 $("#" + tableId + "_wrapper").find(".dt_button_clear_filter").removeClass("disabled");
76 // Return an array of string containing the values of a particular column
77 $.fn.dataTableExt.oApi.fnGetColumnData = function ( oSettings, iColumn, bUnique, bFiltered, bIgnoreEmpty ) {
78 // check that we have a column id
79 if ( typeof iColumn == "undefined" ) return new Array();
80 // by default we only wany unique data
81 if ( typeof bUnique == "undefined" ) bUnique = true;
82 // by default we do want to only look at filtered data
83 if ( typeof bFiltered == "undefined" ) bFiltered = true;
84 // by default we do not wany to include empty values
85 if ( typeof bIgnoreEmpty == "undefined" ) bIgnoreEmpty = true;
86 // list of rows which we're going to loop through
88 // use only filtered rows
89 if (bFiltered == true) aiRows = oSettings.aiDisplay;
91 else aiRows = oSettings.aiDisplayMaster; // all row numbers
94 var asResultData = new Array();
95 for (var i=0,c=aiRows.length; i<c; i++) {
97 var aData = this.fnGetData(iRow);
98 var sValue = aData[iColumn];
99 // ignore empty values?
100 if (bIgnoreEmpty == true && sValue.length == 0) continue;
101 // ignore unique values?
102 else if (bUnique == true && jQuery.inArray(sValue, asResultData) > -1) continue;
103 // else push the value onto the result data array
104 else asResultData.push(sValue);
109 // List of unbind keys (Ctrl, Alt, Direction keys, etc.)
110 // These keys must not launch filtering
111 var blacklist_keys = new Array(0, 16, 17, 18, 37, 38, 39, 40);
113 // Set a filtering delay for global search field
114 jQuery.fn.dataTableExt.oApi.fnSetFilteringDelay = function ( oSettings, iDelay ) {
116 * Inputs: object:oSettings - dataTables settings object - automatically given
117 * integer:iDelay - delay in milliseconds
118 * Usage: $('#example').dataTable().fnSetFilteringDelay(250);
119 * Author: Zygimantas Berziunas (www.zygimantas.com) and Allan Jardine
120 * License: GPL v2 or BSD 3 point style
121 * Contact: zygimantas.berziunas /AT\ hotmail.com
125 iDelay = (typeof iDelay == 'undefined') ? 250 : iDelay;
127 this.each( function ( i ) {
128 $.fn.dataTableExt.iApiIndex = i;
132 sPreviousSearch = null,
133 anControl = $( 'input', _that.fnSettings().aanFeatures.f );
135 anControl.unbind( 'keyup.DT' ).bind( 'keyup.DT', function(event) {
137 if (blacklist_keys.indexOf(event.keyCode) != -1) {
139 }else if ( event.keyCode == '13' ) {
140 $.fn.dataTableExt.iApiIndex = i;
141 _that.fnFilter( $(this).val() );
143 if (sPreviousSearch === null || sPreviousSearch != anControl.val()) {
144 window.clearTimeout(oTimerId);
145 sPreviousSearch = anControl.val();
146 oTimerId = window.setTimeout(function() {
147 $.fn.dataTableExt.iApiIndex = i;
148 _that.fnFilter( anControl.val() );
159 // Add a filtering delay on general search and on all input (with a class 'filter')
160 jQuery.fn.dataTableExt.oApi.fnAddFilters = function ( oSettings, sClass, iDelay ) {
162 this.fnSetFilteringDelay(iDelay);
163 var filterTimerId = null;
164 $(table).find("input."+sClass).keyup(function(event) {
165 if (blacklist_keys.indexOf(event.keyCode) != -1) {
167 }else if ( event.keyCode == '13' ) {
168 table.fnFilter( $(this).val(), $(this).attr('data-column_num') );
170 window.clearTimeout(filterTimerId);
172 filterTimerId = window.setTimeout(function() {
173 table.fnFilter($(input).val(), $(input).attr('data-column_num'));
177 $(table).find("select."+sClass).on('change', function() {
178 table.fnFilter($(this).val(), $(this).attr('data-column_num'));
182 // Sorting on html contains
183 // <a href="foo.pl">bar</a> sort on 'bar'
184 function dt_overwrite_html_sorting_localeCompare() {
185 jQuery.fn.dataTableExt.oSort['html-asc'] = function(a,b) {
186 a = a.replace(/<.*?>/g, "").replace(/\s+/g, " ");
187 b = b.replace(/<.*?>/g, "").replace(/\s+/g, " ");
188 if (typeof(a.localeCompare == "function")) {
189 return a.localeCompare(b);
191 return (a > b) ? 1 : ((a < b) ? -1 : 0);
195 jQuery.fn.dataTableExt.oSort['html-desc'] = function(a,b) {
196 a = a.replace(/<.*?>/g, "").replace(/\s+/g, " ");
197 b = b.replace(/<.*?>/g, "").replace(/\s+/g, " ");
198 if(typeof(b.localeCompare == "function")) {
199 return b.localeCompare(a);
201 return (b > a) ? 1 : ((b < a) ? -1 : 0);
205 jQuery.fn.dataTableExt.oSort['num-html-asc'] = function(a,b) {
206 var x = a.replace( /<.*?>/g, "" );
207 var y = b.replace( /<.*?>/g, "" );
210 return ((x < y) ? -1 : ((x > y) ? 1 : 0));
213 jQuery.fn.dataTableExt.oSort['num-html-desc'] = function(a,b) {
214 var x = a.replace( /<.*?>/g, "" );
215 var y = b.replace( /<.*?>/g, "" );
218 return ((x < y) ? 1 : ((x > y) ? -1 : 0));
222 $.fn.dataTableExt.oSort['num-html-asc'] = function(a,b) {
223 var x = a.replace( /<.*?>/g, "" );
224 var y = b.replace( /<.*?>/g, "" );
227 return ((x < y) ? -1 : ((x > y) ? 1 : 0));
230 $.fn.dataTableExt.oSort['num-html-desc'] = function(a,b) {
231 var x = a.replace( /<.*?>/g, "" );
232 var y = b.replace( /<.*?>/g, "" );
235 return ((x < y) ? 1 : ((x > y) ? -1 : 0));
241 * Natural Sort algorithm for Javascript - Version 0.7 - Released under MIT license
242 * Author: Jim Palmer (based on chunking idea from Dave Koelle)
243 * Contributors: Mike Grier (mgrier.com), Clint Priest, Kyle Adams, guillermo
244 * See: http://js-naturalsort.googlecode.com/svn/trunk/naturalSort.js
246 function naturalSort (a, b) {
247 var re = /(^-?[0-9]+(\.?[0-9]*)[df]?e?[0-9]?$|^0x[0-9a-f]+$|[0-9]+)/gi,
248 sre = /(^[ ]*|[ ]*$)/g,
249 dre = /(^([\w ]+,?[\w ]+)?[\w ]+,?[\w ]+\d+:\d+(:\d+)?[\w ]?|^\d{1,4}[\/\-]\d{1,4}[\/\-]\d{1,4}|^\w+, \w+ \d+, \d{4})/,
250 hre = /^0x[0-9a-f]+$/i,
252 // convert all to strings and trim()
253 x = a.toString().replace(sre, '') || '',
254 y = b.toString().replace(sre, '') || '',
256 xN = x.replace(re, '\0$1\0').replace(/\0$/,'').replace(/^\0/,'').split('\0'),
257 yN = y.replace(re, '\0$1\0').replace(/\0$/,'').replace(/^\0/,'').split('\0'),
258 // numeric, hex or date detection
259 xD = parseInt(x.match(hre), 10) || (xN.length != 1 && x.match(dre) && Date.parse(x)),
260 yD = parseInt(y.match(hre), 10) || xD && y.match(dre) && Date.parse(y) || null;
261 // first try and sort Hex codes or Dates
263 if ( xD < yD ) return -1;
264 else if ( xD > yD ) return 1;
265 // natural sorting through split numeric strings and default strings
266 for(var cLoc=0, numS=Math.max(xN.length, yN.length); cLoc < numS; cLoc++) {
267 // find floats not starting with '0', string or 0 if not defined (Clint Priest)
268 var oFxNcL = !(xN[cLoc] || '').match(ore) && parseFloat(xN[cLoc]) || xN[cLoc] || 0;
269 var oFyNcL = !(yN[cLoc] || '').match(ore) && parseFloat(yN[cLoc]) || yN[cLoc] || 0;
270 // handle numeric vs string comparison - number < string - (Kyle Adams)
271 if (isNaN(oFxNcL) !== isNaN(oFyNcL)) return (isNaN(oFxNcL)) ? 1 : -1;
272 // rely on string comparison if different types - i.e. '02' < 2 != '02' < '2'
273 else if (typeof oFxNcL !== typeof oFyNcL) {
277 if (oFxNcL < oFyNcL) return -1;
278 if (oFxNcL > oFyNcL) return 1;
283 jQuery.extend( jQuery.fn.dataTableExt.oSort, {
284 "natural-asc": function ( a, b ) {
285 return naturalSort(a,b);
288 "natural-desc": function ( a, b ) {
289 return naturalSort(a,b) * -1;
295 /* Plugin to allow sorting on data stored in a span's title attribute
297 * Ex: <td><span title="[% ISO_date %]">[% formatted_date %]</span></td>
299 * In DataTables config:
301 * { "sType": "title-string" },
303 * http://datatables.net/plug-ins/sorting#hidden_title_string
305 jQuery.extend( jQuery.fn.dataTableExt.oSort, {
306 "title-string-pre": function ( a ) {
307 var m = a.match(/title="(.*?)"/);
308 if ( null !== m && m.length ) {
309 return m[1].toLowerCase();
314 "title-string-asc": function ( a, b ) {
315 return ((a < b) ? -1 : ((a > b) ? 1 : 0));
318 "title-string-desc": function ( a, b ) {
319 return ((a < b) ? 1 : ((a > b) ? -1 : 0));
325 /* Plugin to allow text sorting to ignore articles
327 * In DataTables config:
329 * { "sType": "anti-the" },
331 * Based on the plugin found here:
332 * http://datatables.net/plug-ins/sorting#anti_the
333 * Modified to exclude HTML tags from sorting
334 * Extended to accept a string of space-separated articles
335 * from a configuration file (in English, "a," "an," and "the")
338 var config_exclude_articles_from_sort = __('a an the');
339 if (config_exclude_articles_from_sort){
340 var articles = config_exclude_articles_from_sort.split(" ");
342 for(i=0;i<articles.length;i++){
343 rpattern += "^" + articles[i] + " ";
344 if(i < articles.length - 1){ rpattern += "|"; }
346 var re = new RegExp(rpattern, "i");
349 jQuery.extend( jQuery.fn.dataTableExt.oSort, {
350 "anti-the-pre": function ( a ) {
351 var x = String(a).replace( /<[\s\S]*?>/g, "" );
353 var z = y.replace(re, "").toLowerCase();
357 "anti-the-asc": function ( a, b ) {
358 return ((a < b) ? -1 : ((a > b) ? 1 : 0));
361 "anti-the-desc": function ( a, b ) {
362 return ((a < b) ? 1 : ((a > b) ? -1 : 0));
368 // Remove string between NSB NSB characters
369 $.fn.dataTableExt.oSort['nsb-nse-asc'] = function(a,b) {
370 var pattern = new RegExp("\x88.*\x89");
371 a = a.replace(pattern, "");
372 b = b.replace(pattern, "");
373 return (a > b) ? 1 : ((a < b) ? -1 : 0);
375 $.fn.dataTableExt.oSort['nsb-nse-desc'] = function(a,b) {
376 var pattern = new RegExp("\x88.*\x89");
377 a = a.replace(pattern, "");
378 b = b.replace(pattern, "");
379 return (b > a) ? 1 : ((b < a) ? -1 : 0);
382 /* Define two custom functions (asc and desc) for basket callnumber sorting */
383 jQuery.fn.dataTableExt.oSort['callnumbers-asc'] = function(x,y) {
384 var x_array = x.split("<div>");
385 var y_array = y.split("<div>");
387 /* Pop the first elements, they are empty strings */
391 x_array = jQuery.map( x_array, function( a ) {
392 return parse_callnumber( a );
394 y_array = jQuery.map( y_array, function( a ) {
395 return parse_callnumber( a );
404 if ( !x ) { x = ""; }
405 if ( !y ) { y = ""; }
407 return ((x < y) ? -1 : ((x > y) ? 1 : 0));
410 jQuery.fn.dataTableExt.oSort['callnumbers-desc'] = function(x,y) {
411 var x_array = x.split("<div>");
412 var y_array = y.split("<div>");
414 /* Pop the first elements, they are empty strings */
418 x_array = jQuery.map( x_array, function( a ) {
419 return parse_callnumber( a );
421 y_array = jQuery.map( y_array, function( a ) {
422 return parse_callnumber( a );
431 if ( !x ) { x = ""; }
432 if ( !y ) { y = ""; }
434 return ((x < y) ? 1 : ((x > y) ? -1 : 0));
437 function parse_callnumber ( html ) {
438 var array = html.split('<span class="callnumber">');
440 array = array[1].split('</span>');
447 // see http://www.datatables.net/examples/advanced_init/footer_callback.html
448 function footer_column_sum( api, column_numbers ) {
449 // Remove the formatting to get integer data for summation
450 var intVal = function ( i ) {
451 if ( typeof i === 'number' ) {
452 if ( isNaN(i) ) return 0;
454 } else if ( typeof i === 'string' ) {
455 var value = i.replace(/[a-zA-Z ,.]/g, '')*1;
456 if ( isNaN(value) ) return 0;
463 for ( var indice = 0 ; indice < column_numbers.length ; indice++ ) {
464 var column_number = column_numbers[indice];
467 var cells = api.column( column_number, { page: 'current' } ).nodes().to$().find("span.total_amount");
468 var budgets_totaled = [];
469 $(cells).each(function(){ budgets_totaled.push( $(this).data('self_id') ); });
470 $(cells).each(function(){
471 if( $(this).data('parent_id') && $.inArray( $(this).data('parent_id'), budgets_totaled) > -1 ){
474 total += intVal( $(this).html() );
478 total /= 100; // Hard-coded decimal precision
481 $( api.column( column_number ).footer() ).html(total.format_price());
485 function filterDataTable( table, column, term ){
487 table.column( column ).search( term ).draw("page");
489 table.search( term ).draw("page");
493 jQuery.fn.dataTable.ext.errMode = function(settings, note, message) {
494 if ( settings && settings.jqXHR ) {
495 console.log("Got %s (%s)".format(settings.jqXHR.status, settings.jqXHR.statusText));
496 alert(__("Something went wrong when loading the table.\n%s: %s. \n%s").format(
497 settings.jqXHR.status,
498 settings.jqXHR.statusText,
499 ( settings.jqXHR.responseJSON && settings.jqXHR.responseJSON.errors ) ? settings.jqXHR.responseJSON.errors.map(m => m.message).join("\n") : ''
502 alert(__("Something went wrong when loading the table."));
504 console.log(message);
507 function _dt_default_ajax (params){
508 let default_filters = params.default_filters;
509 let options = params.options;
511 if(!options.criteria || ['contains', 'starts_with', 'ends_with', 'exact'].indexOf(options.criteria.toLowerCase()) === -1) options.criteria = 'contains';
512 options.criteria = options.criteria.toLowerCase();
518 'beforeSend': function(xhr, settings) {
521 xhr.setRequestHeader('x-koha-embed', Array.isArray(options.embed)?options.embed.join(','):options.embed);
524 'dataFilter': function(data, type) {
525 var json = {data: JSON.parse(data)};
526 if (total = this._xhr.getResponseHeader('x-total-count')) {
527 json.recordsTotal = total;
528 json.recordsFiltered = total;
530 if (total = this._xhr.getResponseHeader('x-base-total-count')) {
531 json.recordsTotal = total;
533 if (draw = this._xhr.getResponseHeader('x-koha-request-id')) {
537 return JSON.stringify(json);
539 'data': function( data, settings ) {
540 var length = data.length;
541 var start = data.start;
544 _page: Math.floor(start/length) + 1,
548 function build_query(col, value){
551 var attributes = col.data.split(':');
552 for (var i=0;i<attributes.length;i++){
554 var attr = attributes[i];
555 let criteria = options.criteria;
556 if ( value.match(/^\^(.*)\$$/) ) {
557 value = value.replace(/^\^/, '').replace(/\$$/, '');
560 // escape SQL LIKE special characters %
561 value = value.replace(/(\%|\\)/g, "\\$1");
565 if ( col.type == 'date' ) {
566 let rfc3339 = $date_to_rfc3339(value);
567 if ( rfc3339 != 'Invalid Date' ) {
568 built_value = rfc3339;
572 if ( col.datatype !== undefined ) {
573 if (col.datatype == 'related-object') {
574 let query_term = value;
576 if (criteria != 'exact') {
577 query_term = { like: (['contains', 'ends_with'].indexOf(criteria) !== -1 ? '%' : '') + value + (['contains', 'starts_with'].indexOf(criteria) !== -1 ? '%' : '') };
581 [col.related + '.' + col.relatedKey]: col.relatedValue,
582 [col.related + '.' + col.relatedSearchOn]: query_term
585 console.log("datatype %s not supported yet".format(col.datatype));
589 if (col.datatype != 'related-object') {
591 if ( criteria === 'exact' ) {
592 value_part = built_value ? [value, built_value] : value
594 let like = {like: (['contains', 'ends_with'].indexOf(criteria) !== -1?'%':'') + value + (['contains', 'starts_with'].indexOf(criteria) !== -1?'%':'')};
595 value_part = built_value ? [like, built_value] : like;
598 part[!attr.includes('.')?'me.'+attr:attr] = value_part;
606 var filter = data.search.value;
607 // Build query for each column filter
608 var and_query_parameters = settings.aoColumns
609 .filter(function(col) {
610 return col.bSearchable && typeof col.data == 'string' && data.columns[col.idx].search.value != ''
613 var value = data.columns[col.idx].search.value;
614 return build_query(col, value)
617 return ($.isArray(e) ? $.map(e, r) : e);
620 // Build query for the global search filter
621 var or_query_parameters = settings.aoColumns
622 .filter(function(col) {
623 return col.bSearchable && filter != ''
627 return build_query(col, value)
630 return ($.isArray(e) ? $.map(e, r) : e);
633 if ( default_filters ) {
634 let additional_filters = {};
635 for ( f in default_filters ) {
637 if ( typeof(default_filters[f]) === 'function' ) {
638 let val = default_filters[f]();
639 if ( val != undefined && val != "" ) {
643 k = f; v = default_filters[f];
646 // Pass to -or if you want a separate OR clause
647 // It's not the usual DBIC notation!
649 if (v) or_query_parameters.push(v)
650 } else if ( f == '-and' ) {
651 if (v) and_query_parameters.push(v)
653 additional_filters[k] = v;
656 if ( Object.keys(additional_filters).length ) {
657 and_query_parameters.push(additional_filters);
660 query_parameters = and_query_parameters;
661 if ( or_query_parameters.length) {
662 query_parameters.push(or_query_parameters);
665 if(query_parameters.length) {
666 query_parameters = JSON.stringify(query_parameters.length === 1?query_parameters[0]:{"-and": query_parameters});
667 if(options.header_filter) {
668 options.query_parameters = query_parameters;
670 dataSet.q = query_parameters;
671 delete options.query_parameters;
674 delete options.query_parameters;
677 dataSet._match = options.criteria;
679 if ( data["draw"] !== undefined ) {
680 settings.ajax.headers = { 'x-koha-request-id': data.draw }
683 if(options.columns) {
684 var order = data.order;
685 var orderArray = new Array();
686 order.forEach(function (e,i) {
687 var order_col = e.column;
688 var order_by = options.columns[order_col].data;
689 order_by = order_by.split(':');
690 var order_dir = e.dir == 'asc' ? '+' : '-';
691 Array.prototype.push.apply(orderArray,order_by.map(x => order_dir + (!x.includes('.')?'me.'+x:x)));
693 dataSet._order_by = orderArray.filter((v, i, a) => a.indexOf(v) === i).join(',');
701 function _dt_buttons(params){
702 let included_ids = params.included_ids || [];
703 let settings = params.settings || {};
704 let table_settings = params.table_settings;
706 var exportColumns = ":visible:not(.noExport)";
707 if( settings.hasOwnProperty("exportColumns") ){
708 // A custom buttons configuration has been passed from the page
709 exportColumns = settings["exportColumns"];
712 var export_format = {
713 body: function ( data, row, column, node ) {
714 var newnode = $(node);
716 if ( newnode.find(".noExport").length > 0 ) {
717 newnode = newnode.clone();
718 newnode.find(".noExport").remove();
721 return newnode.text().replace( /\n/g, ' ' ).trim();
725 var export_buttons = [
727 extend: 'excelHtml5',
730 columns: exportColumns,
731 format: export_format
738 columns: exportColumns,
739 format: export_format
746 columns: exportColumns,
747 format: export_format
754 columns: exportColumns,
755 format: export_format
764 className: "dt_button_clear_filter",
765 titleAttr: __("Clear filter"),
767 text: '<i class="fa fa-lg fa-remove"></i> <span class="dt-button-text">' + __("Clear filter") + '</span>',
768 action: function ( e, dt, node, config ) {
769 dt.search( "" ).draw("page");
770 node.addClass("disabled");
775 if( included_ids.length > 0 ){
780 columns: included_ids,
781 className: "columns_controls",
782 titleAttr: __("Columns settings"),
783 text: '<i class="fa fa-lg fa-gear"></i> <span class="dt-button-text">' + __("Columns") + '</span>',
785 columns: exportColumns
793 extend: 'collection',
796 className: "export_controls",
797 titleAttr: __("Export or print"),
798 text: '<i class="fa fa-lg fa-download"></i> <span class="dt-button-text">' + __("Export") + '</span>',
799 buttons: export_buttons
803 if ( table_settings && CAN_user_parameters_manage_column_config ) {
806 className: "dt_button_configure_table",
808 titleAttr: __("Configure table"),
809 text: '<i class="fa fa-lg fa-wrench"></i> <span class="dt-button-text">' + __("Configure") + '</span>',
811 window.location = '/cgi-bin/koha/admin/columns_settings.pl?module=' + table_settings['module'] + '&page=' + table_settings['page'] + '&table=' + table_settings['table'];
820 function _dt_visibility(table_settings, settings){
823 let included_ids = [];
824 if ( table_settings ) {
825 var columns_settings = table_settings['columns'];
826 $(columns_settings).each( function() {
827 var named_id = $( 'thead th[data-colname="' + this.columnname + '"]', this ).index( 'th' );
828 var used_id = settings.bKohaColumnsUseNames ? named_id : counter;
829 if ( used_id == -1 ) return;
831 if ( this['is_hidden'] == "1" ) {
832 hidden_ids.push( used_id );
834 if ( this['cannot_be_toggled'] == "0" ) {
835 included_ids.push( used_id );
840 return [hidden_ids, included_ids];
843 function _dt_on_visibility(add_filters, table_node, table_dt){
845 let visible_columns = table_dt.columns().visible();
846 $(table_node).find('thead tr:eq(1) th').each( function (i) {
847 let th_id = $(this).data('th-id');
848 if ( visible_columns[th_id] == false ) {
856 if( typeof columnsInit == 'function' ){
857 // This function can be created separately and used to trigger
858 // an event after the DataTable has loaded AND column visibility
859 // has been updated according to the table's configuration
864 function _dt_add_filters(table_node, table_dt, filters_options = {}) {
865 $(table_node).find('thead tr').clone().appendTo( $(table_node).find('thead') );
867 $(table_node).find('thead tr:eq(1) th').each( function (i) {
868 var is_searchable = table_dt.settings()[0].aoColumns[i].bSearchable;
869 $(this).removeClass('sorting').removeClass("sorting_asc").removeClass("sorting_desc");
870 $(this).data('th-id', i);
871 if ( is_searchable ) {
872 let input_type = 'input';
873 if ( $(this).data('filter') || filters_options.hasOwnProperty(i)) {
874 input_type = 'select'
875 let filter_type = $(this).data('filter');
876 let existing_search = table_dt.column(i).search();
877 let select = $('<select><option value=""></option></select');
879 // FIXME eval here is bad and dangerous, how do we workaround that?
880 if ( !filters_options.hasOwnProperty(i) ) {
881 filters_options[i] = eval(filter_type)
882 } else if ( typeof filters_options[i] === "function" ) {
883 filters_options[i] = filters_options[i]()
885 $(filters_options[i]).each(function(){
886 let o = $('<option value="%s">%s</option>'.format(this._id, this._str));
887 if ( existing_search === this._id ) {
888 o.prop("selected", "selected");
892 $(this).html( select );
894 var title = $(this).text();
895 var existing_search = table_dt.column(i).search();
896 if ( existing_search ) {
897 $(this).html( '<input type="text" value="%s" style="width: 100%" />'.format(existing_search) );
899 var search_title = __("%s search").format(title);
900 $(this).html( '<input type="text" placeholder="%s" style="width: 100%" />'.format(search_title) );
904 $( input_type, this ).on( 'keyup change', function () {
905 if ( table_dt.column(i).search() !== this.value ) {
906 if ( input_type == "input" ) {
909 .search( this.value )
914 .search( this.value.length ? '^'+this.value+'$' : '', true, false )
929 * Create a new dataTables instance that uses the Koha RESTful API's as a data source
930 * @param {Object} options Please see the dataTables settings documentation for further
932 * @param {string} [options.criteria=contains] A koha specific extension to the dataTables settings block that
933 * allows setting the 'comparison operator' used in searches
934 * Supports `contains`, `starts_with`, `ends_with` and `exact` match
935 * @param {string} [options.columns.*.type Data type the field is stored in so we may impose some additional
936 * manipulation to search strings. Supported types are currenlty 'date'
937 * @param {Object} table_settings The arrayref as returned by TableSettings.GetTableSettings function
938 * available from the columns_settings template toolkit include
939 * @param {Boolean} add_filters Add a filters row as the top row of the table
940 * @param {Object} default_filters Add a set of default search filters to apply at table initialisation
941 * @return {Object} The dataTables instance
943 $.fn.kohaTable = function(options, table_settings, add_filters, default_filters) {
947 // Don't redefine the default initComplete
948 if ( options.initComplete ) {
949 let our_initComplete = options.initComplete;
950 options.initComplete = function(settings, json){
951 our_initComplete(settings, json);
952 dataTablesDefaults.initComplete(settings, json)
956 settings = $.extend(true, {}, dataTablesDefaults, {
961 'pagingType': 'full_numbers',
964 'emptyTable': (options.emptyTable) ? options.emptyTable : __("No data available in table")
966 'ajax': _dt_default_ajax({default_filters, options}),
970 let hidden_ids, included_ids;
971 [hidden_ids, included_ids] = _dt_visibility(table_settings, settings)
973 settings["buttons"] = _dt_buttons({included_ids, settings, table_settings});
975 $(".dt_button_clear_filter, .columns_controls, .export_controls, .dt_button_configure_table").tooltip();
978 settings['orderCellsTop'] = true;
981 if ( table_settings ) {
982 if ( table_settings.hasOwnProperty('default_display_length') && table_settings['default_display_length'] != null ) {
983 settings["pageLength"] = table_settings['default_display_length'];
985 if ( table_settings.hasOwnProperty('default_sort_order') && table_settings['default_sort_order'] != null ) {
986 settings["order"] = [[ table_settings['default_sort_order'], 'asc' ]];
990 var table = $(this).dataTable(settings);
992 var table_dt = table.DataTable();
994 _dt_add_filters(this, table_dt);
997 table.DataTable().on("column-visibility.dt", function(){_dt_on_visibility(add_filters, table, table_dt);})
998 .columns( hidden_ids ).visible( false );