GPQAPP
1/*! ColReorder 1.5.42* ©2010-2021 SpryMedia Ltd - datatables.net/license3*/4/**6* @summary ColReorder7* @description Provide the ability to reorder columns in a DataTable8* @version 1.5.49* @file dataTables.colReorder.js10* @author SpryMedia Ltd (www.sprymedia.co.uk)11* @contact www.sprymedia.co.uk/contact12* @copyright Copyright 2010-2021 SpryMedia Ltd.13*14* This source file is free software, available under the following license:15* MIT license - http://datatables.net/license/mit16*17* This source file is distributed in the hope that it will be useful, but18* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY19* or FITNESS FOR A PARTICULAR PURPOSE. See the license files for details.20*21* For details please refer to: http://www.datatables.net22*/23(function( factory ){24if ( typeof define === 'function' && define.amd ) {25// AMD26define( ['jquery', 'datatables.net'], function ( $ ) {27return factory( $, window, document );28} );29}30else if ( typeof exports === 'object' ) {31// CommonJS32module.exports = function (root, $) {33if ( ! root ) {34root = window;35}36/**54* Switch the key value pairing of an index array to be value key (i.e. the old value is now the55* key). For example consider [ 2, 0, 1 ] this would be returned as [ 1, 2, 0 ].56* @method fnInvertKeyValues57* @param array aIn Array to switch around58* @returns array59*/60function fnInvertKeyValues( aIn )61{62var aRet=[];63for ( var i=0, iLen=aIn.length ; i<iLen ; i++ )64{65aRet[ aIn[i] ] = i;66}67return aRet;68}69/**72* Modify an array by switching the position of two elements73* @method fnArraySwitch74* @param array aArray Array to consider, will be modified by reference (i.e. no return)75* @param int iFrom From point76* @param int iTo Insert point77* @returns void78*/79function fnArraySwitch( aArray, iFrom, iTo )80{81var mStore = aArray.splice( iFrom, 1 )[0];82aArray.splice( iTo, 0, mStore );83}84/**87* Switch the positions of nodes in a parent node (note this is specifically designed for88* table rows). Note this function considers all element nodes under the parent!89* @method fnDomSwitch90* @param string sTag Tag to consider91* @param int iFrom Element to move92* @param int Point to element the element to (before this point), can be null for append93* @returns void94*/95function fnDomSwitch( nParent, iFrom, iTo )96{97var anTags = [];98for ( var i=0, iLen=nParent.childNodes.length ; i<iLen ; i++ )99{100if ( nParent.childNodes[i].nodeType == 1 )101{102anTags.push( nParent.childNodes[i] );103}104}105var nStore = anTags[ iFrom ];106}116/**119* Plug-in for DataTables which will reorder the internal column structure by taking the column120* from one position (iFrom) and insert it into a given point (iTo).121* @method $.fn.dataTableExt.oApi.fnColReorder122* @param object oSettings DataTables settings object - automatically added by DataTables!123* @param int iFrom Take the column to be repositioned from this point124* @param int iTo and insert it into this point125* @param bool drop Indicate if the reorder is the final one (i.e. a drop)126* not a live reorder127* @param bool invalidateRows speeds up processing if false passed128* @returns void129*/130$.fn.dataTableExt.oApi.fnColReorder = function ( oSettings, iFrom, iTo, drop, invalidateRows )131{132var i, iLen, j, jLen, jen, iCols=oSettings.aoColumns.length, nTrs, oCol;133var attrMap = function ( obj, prop, mapping ) {134if ( ! obj[ prop ] || typeof obj[ prop ] === 'function' ) {135return;136}137* Calculate the new column array index, so we have a mapping between the old and new169*/170var aiMapping = [];171for ( i=0, iLen=iCols ; i<iLen ; i++ )172{173aiMapping[i] = i;174}175fnArraySwitch( aiMapping, iFrom, iTo );176var aiInvertMapping = fnInvertKeyValues( aiMapping );177* Convert all internal indexing to the new column order indexes181*/182/* Sorting */183for ( i=0, iLen=oSettings.aaSorting.length ; i<iLen ; i++ )184{185oSettings.aaSorting[i][0] = aiInvertMapping[ oSettings.aaSorting[i][0] ];186}187* Move the DOM elements234*/235if ( oSettings.aoColumns[iFrom].bVisible )236{237/* Calculate the current visible index and the point to insert the node before. The insert238* before needs to take into account that there might not be an element to insert before,239* in which case it will be null, and an appendChild should be used240*/241var iVisibleIndex = this.oApi._fnColumnIndexToVisible( oSettings, iFrom );242var iInsertBeforeIndex = null;243* Move the internal array elements280*/281/* Columns */282fnArraySwitch( oSettings.aoColumns, iFrom, iTo );283* Update DataTables' event handlers339*/340/**364* ColReorder provides column visibility control for DataTables365* @class ColReorder366* @constructor367* @param {object} dt DataTables settings object368* @param {object} opts ColReorder options369*/370var ColReorder = function( dt, opts )371{372var settings = new $.fn.dataTable.Api( dt ).settings()[0];373* Public class variables394* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */395* @namespace Settings object which contains customisable information for ColReorder instance398*/399this.s = {400/**401* DataTables settings object402* @property dt403* @type Object404* @default null405*/406"dt": null,407* Enable flag410* @property dt411* @type Object412* @default null413*/414"enable": null,415* Initialisation object used for this instance418* @property init419* @type object420* @default {}421*/422"init": $.extend( true, {}, ColReorder.defaults, opts ),423* Number of columns to fix (not allow to be reordered)426* @property fixed427* @type int428* @default 0429*/430"fixed": 0,431* Number of columns to fix counting from right (not allow to be reordered)434* @property fixedRight435* @type int436* @default 0437*/438"fixedRight": 0,439* Callback function for once the reorder has been done442* @property reorderCallback443* @type function444* @default null445*/446"reorderCallback": null,447* @namespace Information used for the mouse drag450*/451"mouse": {452"startX": -1,453"startY": -1,454"offsetX": -1,455"offsetY": -1,456"target": -1,457"targetIndex": -1,458"fromIndex": -1459},460* Information which is used for positioning the insert cusor and knowing where to do the463* insert. Array of objects with the properties:464* x: x-axis position465* to: insert point466* @property aoTargets467* @type array468* @default []469*/470"aoTargets": []471};472* @namespace Common and useful DOM elements for the class instance476*/477this.dom = {478/**479* Dragging element (the one the mouse is moving)480* @property drag481* @type element482* @default null483*/484"drag": null,485* The insert cursor488* @property pointer489* @type element490* @default null491*/492"pointer": null493};494* Public methods509* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */510* Enable / disable end user interaction513*/514fnEnable: function ( flag )515{516if ( flag === false ) {517return fnDisable();518}519* Disable end user interaction525*/526fnDisable: function ()527{528this.s.enable = false;529},530* Reset the column ordering to the original ordering that was detected on533* start up.534* @return {this} Returns `this` for chaining.535*536* @example537* // DataTables initialisation with ColReorder538* var table = $('#example').dataTable( {539* "sDom": 'Rlfrtip'540* } );541*542* // Add click event to a button to reset the ordering543* $('#resetOrdering').click( function (e) {544* e.preventDefault();545* $.fn.dataTable.ColReorder( table ).fnReset();546* } );547*/548"fnReset": function ()549{550this._fnOrderColumns( this.fnOrder() );551* `Deprecated` - Get the current order of the columns, as an array.557* @return {array} Array of column identifiers558* @deprecated `fnOrder` should be used in preference to this method.559* `fnOrder` acts as a getter/setter.560*/561"fnGetCurrentOrder": function ()562{563return this.fnOrder();564},565* Get the current order of the columns, as an array. Note that the values568* given in the array are unique identifiers for each column. Currently569* these are the original ordering of the columns that was detected on570* start up, but this could potentially change in future.571* @return {array} Array of column identifiers572*573* @example574* // Get column ordering for the table575* var order = $.fn.dataTable.ColReorder( dataTable ).fnOrder();576*//**577* Set the order of the columns, from the positions identified in the578* ordering array given. Note that ColReorder takes a brute force approach579* to reordering, so it is possible multiple reordering events will occur580* before the final order is settled upon.581* @param {array} [set] Array of column identifiers in the new order. Note582* that every column must be included, uniquely, in this array.583* @return {this} Returns `this` for chaining.584*585* @example586* // Swap the first and second columns587* $.fn.dataTable.ColReorder( dataTable ).fnOrder( [1, 0, 2, 3, 4] );588*589* @example590* // Move the first column to the end for the table `#example`591* var curr = $.fn.dataTable.ColReorder( '#example' ).fnOrder();592* var first = curr.shift();593* curr.push( first );594* $.fn.dataTable.ColReorder( '#example' ).fnOrder( curr );595*596* @example597* // Reverse the table's order598* $.fn.dataTable.ColReorder( '#example' ).fnOrder(599* $.fn.dataTable.ColReorder( '#example' ).fnOrder().reverse()600* );601*/602"fnOrder": function ( set, original )603{604var a = [], i, ien, j, jen;605var columns = this.s.dt.aoColumns;606* Convert from the original column index, to the original636*637* @param {int|array} idx Index(es) to convert638* @param {string} dir Transpose direction - `fromOriginal` / `toCurrent`639* or `'toOriginal` / `fromCurrent`640* @return {int|array} Converted values641*/642fnTranspose: function ( idx, dir )643{644if ( ! dir ) {645dir = 'toCurrent';646}647* Private methods (they are of course public in JS, but recommended as private)672* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */673* Constructor logic676* @method _fnConstruct677* @returns void678* @private679*/680"_fnConstruct": function ()681{682var that = this;683var iLen = this.s.dt.aoColumns.length;684var table = this.s.dt.nTable;685var i;686* to wait until the draw is done, if after, then do what we need to do right away745*/746if ( !that.s.dt._bInitComplete )747{748var bDone = false;749$(table).on( 'draw.dt.colReorder', function () {750if ( !that.s.dt._bInitComplete && !bDone )751{752bDone = true;753var resort = fnInvertKeyValues( aiOrder );754that._fnOrderColumns.call( that, resort );755}756} );757}758else759{760var resort = fnInvertKeyValues( aiOrder );761that._fnOrderColumns.call( that, resort );762}763}764else {765this._fnSetColumnIndexes();766}767* Set the column order from an array785* @method _fnOrderColumns786* @param array a An array of integers which dictate the column order that should be applied787* @returns void788* @private789*/790"_fnOrderColumns": function ( a )791{792var changed = false;793* Because we change the indexes of columns in the table, relative to their starting point843* we need to reorder the state columns to what they are at the starting point so we can844* then rearrange them again on state load!845* @method _fnStateSave846* @param object oState DataTables state847* @returns string JSON encoded cookie string for DataTables848* @private849*/850"_fnStateSave": function ( oState )851{852var i, iLen, aCopy, iOrigColumn;853var oSettings = this.s.dt;854var columns = oSettings.aoColumns;855* Mouse drop and drag905*/906* Add a mouse down listener to a particluar TH element909* @method _fnMouseListener910* @param int i Column index911* @param element nTh TH element clicked on912* @returns void913* @private914*/915"_fnMouseListener": function ( i, nTh )916{917var that = this;918$(nTh)919.on( 'mousedown.ColReorder', function (e) {920if ( that.s.enable && e.which === 1 ) {921that._fnMouseDown.call( that, e, nTh );922}923} )924.on( 'touchstart.ColReorder', function (e) {925if ( that.s.enable ) {926that._fnMouseDown.call( that, e, nTh );927}928} );929},930* Mouse down on a TH element in the table header934* @method _fnMouseDown935* @param event e Mouse event936* @param element nTh TH element to be dragged937* @returns void938* @private939*/940"_fnMouseDown": function ( e, nTh )941{942var that = this;943* Deal with a mouse move event while dragging a node976* @method _fnMouseMove977* @param event e Mouse event978* @returns void979* @private980*/981"_fnMouseMove": function ( e )982{983var that = this;984* point - this allows the user to make small mouse movements when sorting and not have a989* possibly confusing drag element showing up990*/991if ( Math.pow(992Math.pow(this._fnCursorPosition( e, 'pageX') - this.s.mouse.startX, 2) +993Math.pow(this._fnCursorPosition( e, 'pageY') - this.s.mouse.startY, 2), 0.5 ) < 5 )994{995return;996}997this._fnCreateDragNode();998}999* Finish off the mouse drag and insert the column where needed1089* @method _fnMouseUp1090* @param event e Mouse event1091* @returns void1092* @private1093*/1094"_fnMouseUp": function ( e )1095{1096var that = this;1097* Calculate a cached array with the points of the column inserts, and the1131* 'to' points1132* @method _fnRegions1133* @returns void1134* @private1135*/1136"_fnRegions": function ()1137{1138var aoColumns = this.s.dt.aoColumns;1139var isLTR = this._fnIsLtr();1140this.s.aoTargets.splice(0, this.s.aoTargets.length);1141var lastBound = $(this.s.dt.nTable).offset().left;1142* position is just to it's immediate left or right, so we only increment the counter for1182* other columns1183*/1184if (columnBound.index < this.s.mouse.fromIndex) {1185iToPoint++;1186}1187* Copy the TH element that is being drags so the user has the idea that they are actually1210* moving it around the page.1211* @method _fnCreateDragNode1212* @returns void1213* @private1214*/1215"_fnCreateDragNode": function ()1216{1217var scrolling = this.s.dt.oScroll.sX !== "" || this.s.dt.oScroll.sY !== "";1218* Add a data attribute to the column headers, so we know the index of1263* the row to be reordered. This allows fast detection of the index, and1264* for this plug-in to work with FixedHeader which clones the nodes.1265* @private1266*/1267"_fnSetColumnIndexes": function ()1268{1269$.each( this.s.dt.aoColumns, function (i, column) {1270$(column.nTh).attr('data-column-index', i);1271} );1272},1273* Get cursor position regardless of mouse or touch input1277* @param {Event} e jQuery Event1278* @param {string} prop Property to get1279* @return {number} Value1280*/1281_fnCursorPosition: function ( e, prop ) {1282if ( e.type.indexOf('touch') !== -1 ) {1283return e.originalEvent.touches[0][ prop ];1284}1285return e[ prop ];1286},1287/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *1298* Static parameters1299* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */1300/**1303* ColReorder default settings for initialisation1304* @namespace1305* @static1306*/1307ColReorder.defaults = {1308/**1309* Predefined ordering for the columns that will be applied automatically1310* on initialisation. If not specified then the order that the columns are1311* found to be in the HTML is the order used.1312* @type array1313* @default null1314* @static1315*/1316aiOrder: null,1317* ColReorder enable on initialisation1320* @type boolean1321* @default true1322* @static1323*/1324bEnable: true,1325* Redraw the table's column ordering as the end user draws the column1328* (`true`) or wait until the mouse is released (`false` - default). Note1329* that this will perform a redraw on each reordering, which involves an1330* Ajax request each time if you are using server-side processing in1331* DataTables.1332* @type boolean1333* @default false1334* @static1335*/1336bRealtime: true,1337* Indicate how many columns should be fixed in position (counting from the1340* left). This will typically be 1 if used, but can be as high as you like.1341* @type int1342* @default 01343* @static1344*/1345iFixedColumnsLeft: 0,1346* As `iFixedColumnsRight` but counting from the right.1349* @type int1350* @default 01351* @static1352*/1353iFixedColumnsRight: 0,1354* Callback function that is fired when columns are reordered. The `column-1357* reorder` event is preferred over this callback1358* @type function():void1359* @default null1360* @static1361*/1362fnReorderCallback: null1363};1364/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *1368* Constants1369* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */1370/**1372* ColReorder version1373* @constant version1374* @type String1375* @default As code1376*/1377ColReorder.version = "1.5.4";1378/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *1382* DataTables interfaces1383* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */1384// Expose1386$.fn.dataTable.ColReorder = ColReorder;1387$.fn.DataTable.ColReorder = ColReorder;1388// Register a new feature with DataTables1391if ( typeof $.fn.dataTable == "function" &&1392typeof $.fn.dataTableExt.fnVersionCheck == "function" &&1393$.fn.dataTableExt.fnVersionCheck('1.10.8') )1394{1395$.fn.dataTableExt.aoFeatures.push( {1396"fnInit": function( settings ) {1397var table = settings.oInstance;1398}1415else {1416alert( "Warning: ColReorder requires DataTables 1.10.8 or greater - www.datatables.net/download");1417}1418// Attach a listener to the document which listens for DataTables initialisation1421// events so we can automatically initialise1422$(document).on( 'preInit.dt.colReorder', function (e, settings) {1423if ( e.namespace !== 'dt' ) {1424return;1425}1426// API augmentation1441$.fn.dataTable.Api.register( 'colReorder.reset()', function () {1442return this.iterator( 'table', function ( ctx ) {1443ctx._colReorder.fnReset();1444} );1445} );1446