2 * ©2010-2014 SpryMedia Ltd - datatables.net/license
7 * @description Provide the ability to reorder columns in a DataTable
9 * @file dataTables.colReorder.js
10 * @author SpryMedia Ltd (www.sprymedia.co.uk)
11 * @contact www.sprymedia.co.uk/contact
12 * @copyright Copyright 2010-2014 SpryMedia Ltd.
14 * This source file is free software, available under the following license:
15 * MIT license - http://datatables.net/license/mit
17 * This source file is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
19 * or FITNESS FOR A PARTICULAR PURPOSE. See the license files for details.
21 * For details please refer to: http://www.datatables.net
24 (function(window, document, undefined) {
28 * Switch the key value pairing of an index array to be value key (i.e. the old value is now the
29 * key). For example consider [ 2, 0, 1 ] this would be returned as [ 1, 2, 0 ].
30 * @method fnInvertKeyValues
31 * @param array aIn Array to switch around
34 function fnInvertKeyValues( aIn )
37 for ( var i=0, iLen=aIn.length ; i<iLen ; i++ )
46 * Modify an array by switching the position of two elements
47 * @method fnArraySwitch
48 * @param array aArray Array to consider, will be modified by reference (i.e. no return)
49 * @param int iFrom From point
50 * @param int iTo Insert point
53 function fnArraySwitch( aArray, iFrom, iTo )
55 var mStore = aArray.splice( iFrom, 1 )[0];
56 aArray.splice( iTo, 0, mStore );
61 * Switch the positions of nodes in a parent node (note this is specifically designed for
62 * table rows). Note this function considers all element nodes under the parent!
64 * @param string sTag Tag to consider
65 * @param int iFrom Element to move
66 * @param int Point to element the element to (before this point), can be null for append
69 function fnDomSwitch( nParent, iFrom, iTo )
72 for ( var i=0, iLen=nParent.childNodes.length ; i<iLen ; i++ )
74 if ( nParent.childNodes[i].nodeType == 1 )
76 anTags.push( nParent.childNodes[i] );
79 var nStore = anTags[ iFrom ];
83 nParent.insertBefore( nStore, anTags[iTo] );
87 nParent.appendChild( nStore );
93 var factory = function( $, DataTable ) {
97 * Plug-in for DataTables which will reorder the internal column structure by taking the column
98 * from one position (iFrom) and insert it into a given point (iTo).
99 * @method $.fn.dataTableExt.oApi.fnColReorder
100 * @param object oSettings DataTables settings object - automatically added by DataTables!
101 * @param int iFrom Take the column to be repositioned from this point
102 * @param int iTo and insert it into this point
105 $.fn.dataTableExt.oApi.fnColReorder = function ( oSettings, iFrom, iTo )
107 var v110 = $.fn.dataTable.Api ? true : false;
108 var i, iLen, j, jLen, iCols=oSettings.aoColumns.length, nTrs, oCol;
109 var attrMap = function ( obj, prop, mapping ) {
110 if ( ! obj[ prop ] ) {
114 var a = obj[ prop ].split('.');
117 if ( isNaN( num*1 ) ) {
121 obj[ prop ] = mapping[ num*1 ]+'.'+a.join('.');
124 /* Sanity check in the input */
127 /* Pointless reorder */
131 if ( iFrom < 0 || iFrom >= iCols )
133 this.oApi._fnLog( oSettings, 1, "ColReorder 'from' index is out of bounds: "+iFrom );
137 if ( iTo < 0 || iTo >= iCols )
139 this.oApi._fnLog( oSettings, 1, "ColReorder 'to' index is out of bounds: "+iTo );
144 * Calculate the new column array index, so we have a mapping between the old and new
147 for ( i=0, iLen=iCols ; i<iLen ; i++ )
151 fnArraySwitch( aiMapping, iFrom, iTo );
152 var aiInvertMapping = fnInvertKeyValues( aiMapping );
156 * Convert all internal indexing to the new column order indexes
159 for ( i=0, iLen=oSettings.aaSorting.length ; i<iLen ; i++ )
161 oSettings.aaSorting[i][0] = aiInvertMapping[ oSettings.aaSorting[i][0] ];
165 if ( oSettings.aaSortingFixed !== null )
167 for ( i=0, iLen=oSettings.aaSortingFixed.length ; i<iLen ; i++ )
169 oSettings.aaSortingFixed[i][0] = aiInvertMapping[ oSettings.aaSortingFixed[i][0] ];
173 /* Data column sorting (the column which the sort for a given column should take place on) */
174 for ( i=0, iLen=iCols ; i<iLen ; i++ )
176 oCol = oSettings.aoColumns[i];
177 for ( j=0, jLen=oCol.aDataSort.length ; j<jLen ; j++ )
179 oCol.aDataSort[j] = aiInvertMapping[ oCol.aDataSort[j] ];
182 // Update the column indexes
184 oCol.idx = aiInvertMapping[ oCol.idx ];
189 // Update 1.10 optimised sort class removal variable
190 $.each( oSettings.aLastSort, function (i, val) {
191 oSettings.aLastSort[i].src = aiInvertMapping[ val.src ];
195 /* Update the Get and Set functions for each column */
196 for ( i=0, iLen=iCols ; i<iLen ; i++ )
198 oCol = oSettings.aoColumns[i];
200 if ( typeof oCol.mData == 'number' ) {
201 oCol.mData = aiInvertMapping[ oCol.mData ];
203 // regenerate the get / set functions
204 oSettings.oApi._fnColumnOptions( oSettings, i, {} );
206 else if ( $.isPlainObject( oCol.mData ) ) {
207 // HTML5 data sourced
208 attrMap( oCol.mData, '_', aiInvertMapping );
209 attrMap( oCol.mData, 'filter', aiInvertMapping );
210 attrMap( oCol.mData, 'sort', aiInvertMapping );
211 attrMap( oCol.mData, 'type', aiInvertMapping );
213 // regenerate the get / set functions
214 oSettings.oApi._fnColumnOptions( oSettings, i, {} );
220 * Move the DOM elements
222 if ( oSettings.aoColumns[iFrom].bVisible )
224 /* Calculate the current visible index and the point to insert the node before. The insert
225 * before needs to take into account that there might not be an element to insert before,
226 * in which case it will be null, and an appendChild should be used
228 var iVisibleIndex = this.oApi._fnColumnIndexToVisible( oSettings, iFrom );
229 var iInsertBeforeIndex = null;
231 i = iTo < iFrom ? iTo : iTo + 1;
232 while ( iInsertBeforeIndex === null && i < iCols )
234 iInsertBeforeIndex = this.oApi._fnColumnIndexToVisible( oSettings, i );
239 nTrs = oSettings.nTHead.getElementsByTagName('tr');
240 for ( i=0, iLen=nTrs.length ; i<iLen ; i++ )
242 fnDomSwitch( nTrs[i], iVisibleIndex, iInsertBeforeIndex );
246 if ( oSettings.nTFoot !== null )
248 nTrs = oSettings.nTFoot.getElementsByTagName('tr');
249 for ( i=0, iLen=nTrs.length ; i<iLen ; i++ )
251 fnDomSwitch( nTrs[i], iVisibleIndex, iInsertBeforeIndex );
256 for ( i=0, iLen=oSettings.aoData.length ; i<iLen ; i++ )
258 if ( oSettings.aoData[i].nTr !== null )
260 fnDomSwitch( oSettings.aoData[i].nTr, iVisibleIndex, iInsertBeforeIndex );
266 * Move the internal array elements
269 fnArraySwitch( oSettings.aoColumns, iFrom, iTo );
272 fnArraySwitch( oSettings.aoPreSearchCols, iFrom, iTo );
274 /* Array array - internal data anodes cache */
275 for ( i=0, iLen=oSettings.aoData.length ; i<iLen ; i++ )
277 var data = oSettings.aoData[i];
281 if ( data.anCells ) {
282 fnArraySwitch( data.anCells, iFrom, iTo );
285 // For DOM sourced data, the invalidate will reread the cell into
286 // the data array, but for data sources as an array, they need to
288 if ( data.src !== 'dom' && $.isArray( data._aData ) ) {
289 fnArraySwitch( data._aData, iFrom, iTo );
294 if ( $.isArray( data._aData ) ) {
295 fnArraySwitch( data._aData, iFrom, iTo );
297 fnArraySwitch( data._anHidden, iFrom, iTo );
301 /* Reposition the header elements in the header layout array */
302 for ( i=0, iLen=oSettings.aoHeader.length ; i<iLen ; i++ )
304 fnArraySwitch( oSettings.aoHeader[i], iFrom, iTo );
307 if ( oSettings.aoFooter !== null )
309 for ( i=0, iLen=oSettings.aoFooter.length ; i<iLen ; i++ )
311 fnArraySwitch( oSettings.aoFooter[i], iFrom, iTo );
315 // In 1.10 we need to invalidate row cached data for sorting, filtering etc
317 var api = new $.fn.dataTable.Api( oSettings );
318 api.rows().invalidate();
322 * Update DataTables' event handlers
326 for ( i=0, iLen=iCols ; i<iLen ; i++ )
328 $(oSettings.aoColumns[i].nTh).off('click.DT');
329 this.oApi._fnSortAttachListener( oSettings, oSettings.aoColumns[i].nTh, i );
333 /* Fire an event so other plug-ins can update */
334 $(oSettings.oInstance).trigger( 'column-reorder', [ oSettings, {
337 "aiInvertMapping": aiInvertMapping
343 * ColReorder provides column visibility control for DataTables
346 * @param {object} dt DataTables settings object
347 * @param {object} opts ColReorder options
349 var ColReorder = function( dt, opts )
353 if ( $.fn.dataTable.Api ) {
354 oDTSettings = new $.fn.dataTable.Api( dt ).settings()[0];
357 else if ( dt.fnSettings ) {
358 // DataTables object, convert to the settings object
359 oDTSettings = dt.fnSettings();
361 else if ( typeof dt === 'string' ) {
363 if ( $.fn.dataTable.fnIsDataTable( $(dt)[0] ) ) {
364 oDTSettings = $(dt).eq(0).dataTable().fnSettings();
367 else if ( dt.nodeName && dt.nodeName.toLowerCase() === 'table' ) {
369 if ( $.fn.dataTable.fnIsDataTable( dt.nodeName ) ) {
370 oDTSettings = $(dt.nodeName).dataTable().fnSettings();
373 else if ( dt instanceof jQuery ) {
375 if ( $.fn.dataTable.fnIsDataTable( dt[0] ) ) {
376 oDTSettings = dt.eq(0).dataTable().fnSettings();
380 // DataTables settings object
384 // Ensure that we can't initialise on the same table twice
385 if ( oDTSettings._colReorder ) {
386 throw "ColReorder already initialised on table #"+oDTSettings.nTable.id;
389 // Convert from camelCase to Hungarian, just as DataTables does
390 var camelToHungarian = $.fn.dataTable.camelToHungarian;
391 if ( camelToHungarian ) {
392 camelToHungarian( ColReorder.defaults, ColReorder.defaults, true );
393 camelToHungarian( ColReorder.defaults, opts || {} );
397 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
398 * Public class variables
399 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
402 * @namespace Settings object which contains customisable information for ColReorder instance
406 * DataTables settings object
414 * Initialisation object used for this instance
419 "init": $.extend( true, {}, ColReorder.defaults, opts ),
422 * Number of columns to fix (not allow to be reordered)
430 * Number of columns to fix counting from right (not allow to be reordered)
431 * @property fixedRight
438 * Callback function for once the reorder has been done
439 * @property reorderCallback
443 "reorderCallback": null,
446 * @namespace Information used for the mouse drag
459 * Information which is used for positioning the insert cusor and knowing where to do the
460 * insert. Array of objects with the properties:
463 * @property aoTargets
472 * @namespace Common and useful DOM elements for the class instance
476 * Dragging element (the one the mouse is moving)
493 /* Constructor logic */
494 this.s.dt = oDTSettings;
495 this.s.dt._colReorder = this;
498 /* Add destroy callback */
499 oDTSettings.oApi._fnCallbackReg(oDTSettings, 'aoDestroyCallback', $.proxy(this._fnDestroy, this), 'ColReorder');
506 ColReorder.prototype = {
507 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
509 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
512 * Reset the column ordering to the original ordering that was detected on
514 * @return {this} Returns `this` for chaining.
517 * // DataTables initialisation with ColReorder
518 * var table = $('#example').dataTable( {
522 * // Add click event to a button to reset the ordering
523 * $('#resetOrdering').click( function (e) {
524 * e.preventDefault();
525 * $.fn.dataTable.ColReorder( table ).fnReset();
528 "fnReset": function ()
531 for ( var i=0, iLen=this.s.dt.aoColumns.length ; i<iLen ; i++ )
533 a.push( this.s.dt.aoColumns[i]._ColReorder_iOrigCol );
536 this._fnOrderColumns( a );
542 * `Deprecated` - Get the current order of the columns, as an array.
543 * @return {array} Array of column identifiers
544 * @deprecated `fnOrder` should be used in preference to this method.
545 * `fnOrder` acts as a getter/setter.
547 "fnGetCurrentOrder": function ()
549 return this.fnOrder();
553 * Get the current order of the columns, as an array. Note that the values
554 * given in the array are unique identifiers for each column. Currently
555 * these are the original ordering of the columns that was detected on
556 * start up, but this could potentially change in future.
557 * @return {array} Array of column identifiers
560 * // Get column ordering for the table
561 * var order = $.fn.dataTable.ColReorder( dataTable ).fnOrder();
563 * Set the order of the columns, from the positions identified in the
564 * ordering array given. Note that ColReorder takes a brute force approach
565 * to reordering, so it is possible multiple reordering events will occur
566 * before the final order is settled upon.
567 * @param {array} [set] Array of column identifiers in the new order. Note
568 * that every column must be included, uniquely, in this array.
569 * @return {this} Returns `this` for chaining.
572 * // Swap the first and second columns
573 * $.fn.dataTable.ColReorder( dataTable ).fnOrder( [1, 0, 2, 3, 4] );
576 * // Move the first column to the end for the table `#example`
577 * var curr = $.fn.dataTable.ColReorder( '#example' ).fnOrder();
578 * var first = curr.shift();
579 * curr.push( first );
580 * $.fn.dataTable.ColReorder( '#example' ).fnOrder( curr );
583 * // Reverse the table's order
584 * $.fn.dataTable.ColReorder( '#example' ).fnOrder(
585 * $.fn.dataTable.ColReorder( '#example' ).fnOrder().reverse()
588 "fnOrder": function ( set )
590 if ( set === undefined )
593 for ( var i=0, iLen=this.s.dt.aoColumns.length ; i<iLen ; i++ )
595 a.push( this.s.dt.aoColumns[i]._ColReorder_iOrigCol );
600 this._fnOrderColumns( fnInvertKeyValues( set ) );
606 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
607 * Private methods (they are of course public in JS, but recommended as private)
608 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
612 * @method _fnConstruct
616 "_fnConstruct": function ()
619 var iLen = this.s.dt.aoColumns.length;
622 /* Columns discounted from reordering - counting left to right */
623 if ( this.s.init.iFixedColumns )
625 this.s.fixed = this.s.init.iFixedColumns;
628 /* Columns discounted from reordering - counting right to left */
629 this.s.fixedRight = this.s.init.iFixedColumnsRight ?
630 this.s.init.iFixedColumnsRight :
633 /* Drop callback initialisation option */
634 if ( this.s.init.fnReorderCallback )
636 this.s.reorderCallback = this.s.init.fnReorderCallback;
639 /* Add event handlers for the drag and drop, and also mark the original column order */
640 for ( i = 0; i < iLen; i++ )
642 if ( i > this.s.fixed-1 && i < iLen - this.s.fixedRight )
644 this._fnMouseListener( i, this.s.dt.aoColumns[i].nTh );
647 /* Mark the original column order for later reference */
648 this.s.dt.aoColumns[i]._ColReorder_iOrigCol = i;
652 this.s.dt.oApi._fnCallbackReg( this.s.dt, 'aoStateSaveParams', function (oS, oData) {
653 that._fnStateSave.call( that, oData );
654 }, "ColReorder_State" );
656 /* An initial column order has been specified */
658 if ( this.s.init.aiOrder )
660 aiOrder = this.s.init.aiOrder.slice();
663 /* State loading, overrides the column order given */
664 if ( this.s.dt.oLoadedState && typeof this.s.dt.oLoadedState.ColReorder != 'undefined' &&
665 this.s.dt.oLoadedState.ColReorder.length == this.s.dt.aoColumns.length )
667 aiOrder = this.s.dt.oLoadedState.ColReorder;
670 /* If we have an order to apply - do so */
673 /* We might be called during or after the DataTables initialisation. If before, then we need
674 * to wait until the draw is done, if after, then do what we need to do right away
676 if ( !that.s.dt._bInitComplete )
679 this.s.dt.aoDrawCallback.push( {
681 if ( !that.s.dt._bInitComplete && !bDone )
684 var resort = fnInvertKeyValues( aiOrder );
685 that._fnOrderColumns.call( that, resort );
688 "sName": "ColReorder_Pre"
693 var resort = fnInvertKeyValues( aiOrder );
694 that._fnOrderColumns.call( that, resort );
698 this._fnSetColumnIndexes();
704 * Set the column order from an array
705 * @method _fnOrderColumns
706 * @param array a An array of integers which dictate the column order that should be applied
710 "_fnOrderColumns": function ( a )
712 if ( a.length != this.s.dt.aoColumns.length )
714 this.s.dt.oInstance.oApi._fnLog( this.s.dt, 1, "ColReorder - array reorder does not "+
715 "match known number of columns. Skipping." );
719 for ( var i=0, iLen=a.length ; i<iLen ; i++ )
721 var currIndex = $.inArray( i, a );
722 if ( i != currIndex )
724 /* Reorder our switching array */
725 fnArraySwitch( a, currIndex, i );
727 /* Do the column reorder in the table */
728 this.s.dt.oInstance.fnColReorder( currIndex, i );
732 /* When scrolling we need to recalculate the column sizes to allow for the shift */
733 if ( this.s.dt.oScroll.sX !== "" || this.s.dt.oScroll.sY !== "" )
735 this.s.dt.oInstance.fnAdjustColumnSizing( false );
739 this.s.dt.oInstance.oApi._fnSaveState( this.s.dt );
741 this._fnSetColumnIndexes();
743 if ( this.s.reorderCallback !== null )
745 this.s.reorderCallback.call( this );
751 * Because we change the indexes of columns in the table, relative to their starting point
752 * we need to reorder the state columns to what they are at the starting point so we can
753 * then rearrange them again on state load!
754 * @method _fnStateSave
755 * @param object oState DataTables state
756 * @returns string JSON encoded cookie string for DataTables
759 "_fnStateSave": function ( oState )
761 var i, iLen, aCopy, iOrigColumn;
762 var oSettings = this.s.dt;
763 var columns = oSettings.aoColumns;
765 oState.ColReorder = [];
768 if ( oState.aaSorting ) {
770 for ( i=0 ; i<oState.aaSorting.length ; i++ ) {
771 oState.aaSorting[i][0] = columns[ oState.aaSorting[i][0] ]._ColReorder_iOrigCol;
774 var aSearchCopy = $.extend( true, [], oState.aoSearchCols );
776 for ( i=0, iLen=columns.length ; i<iLen ; i++ )
778 iOrigColumn = columns[i]._ColReorder_iOrigCol;
781 oState.aoSearchCols[ iOrigColumn ] = aSearchCopy[i];
784 oState.abVisCols[ iOrigColumn ] = columns[i].bVisible;
786 /* Column reordering */
787 oState.ColReorder.push( iOrigColumn );
790 else if ( oState.order ) {
792 for ( i=0 ; i<oState.order.length ; i++ ) {
793 oState.order[i][0] = columns[ oState.order[i][0] ]._ColReorder_iOrigCol;
796 var stateColumnsCopy = $.extend( true, [], oState.columns );
798 for ( i=0, iLen=columns.length ; i<iLen ; i++ )
800 iOrigColumn = columns[i]._ColReorder_iOrigCol;
803 oState.columns[ iOrigColumn ] = stateColumnsCopy[i];
805 /* Column reordering */
806 oState.ColReorder.push( iOrigColumn );
812 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
813 * Mouse drop and drag
817 * Add a mouse down listener to a particluar TH element
818 * @method _fnMouseListener
819 * @param int i Column index
820 * @param element nTh TH element clicked on
824 "_fnMouseListener": function ( i, nTh )
827 $(nTh).on( 'mousedown.ColReorder', function (e) {
829 that._fnMouseDown.call( that, e, nTh );
835 * Mouse down on a TH element in the table header
836 * @method _fnMouseDown
837 * @param event e Mouse event
838 * @param element nTh TH element to be dragged
842 "_fnMouseDown": function ( e, nTh )
846 /* Store information about the mouse position */
847 var target = $(e.target).closest('th, td');
848 var offset = target.offset();
849 var idx = parseInt( $(nTh).attr('data-column-index'), 10 );
851 if ( idx === undefined ) {
855 this.s.mouse.startX = e.pageX;
856 this.s.mouse.startY = e.pageY;
857 this.s.mouse.offsetX = e.pageX - offset.left;
858 this.s.mouse.offsetY = e.pageY - offset.top;
859 this.s.mouse.target = this.s.dt.aoColumns[ idx ].nTh;//target[0];
860 this.s.mouse.targetIndex = idx;
861 this.s.mouse.fromIndex = idx;
865 /* Add event handlers to the document */
867 .on( 'mousemove.ColReorder', function (e) {
868 that._fnMouseMove.call( that, e );
870 .on( 'mouseup.ColReorder', function (e) {
871 that._fnMouseUp.call( that, e );
877 * Deal with a mouse move event while dragging a node
878 * @method _fnMouseMove
879 * @param event e Mouse event
883 "_fnMouseMove": function ( e )
887 if ( this.dom.drag === null )
889 /* Only create the drag element if the mouse has moved a specific distance from the start
890 * point - this allows the user to make small mouse movements when sorting and not have a
891 * possibly confusing drag element showing up
894 Math.pow(e.pageX - this.s.mouse.startX, 2) +
895 Math.pow(e.pageY - this.s.mouse.startY, 2), 0.5 ) < 5 )
899 this._fnCreateDragNode();
902 /* Position the element - we respect where in the element the click occured */
904 left: e.pageX - this.s.mouse.offsetX,
905 top: e.pageY - this.s.mouse.offsetY
908 /* Based on the current mouse position, calculate where the insert should go */
910 var lastToIndex = this.s.mouse.toIndex;
912 for ( var i=1, iLen=this.s.aoTargets.length ; i<iLen ; i++ )
914 if ( e.pageX < this.s.aoTargets[i-1].x + ((this.s.aoTargets[i].x-this.s.aoTargets[i-1].x)/2) )
916 this.dom.pointer.css( 'left', this.s.aoTargets[i-1].x );
917 this.s.mouse.toIndex = this.s.aoTargets[i-1].to;
923 // The insert element wasn't positioned in the array (less than
924 // operator), so we put it at the end
927 this.dom.pointer.css( 'left', this.s.aoTargets[this.s.aoTargets.length-1].x );
928 this.s.mouse.toIndex = this.s.aoTargets[this.s.aoTargets.length-1].to;
931 // Perform reordering if realtime updating is on and the column has moved
932 if ( this.s.init.bRealtime && lastToIndex !== this.s.mouse.toIndex ) {
933 this.s.dt.oInstance.fnColReorder( this.s.mouse.fromIndex, this.s.mouse.toIndex );
934 this.s.mouse.fromIndex = this.s.mouse.toIndex;
941 * Finish off the mouse drag and insert the column where needed
943 * @param event e Mouse event
947 "_fnMouseUp": function ( e )
951 $(document).off( 'mousemove.ColReorder mouseup.ColReorder' );
953 if ( this.dom.drag !== null )
955 /* Remove the guide elements */
956 this.dom.drag.remove();
957 this.dom.pointer.remove();
958 this.dom.drag = null;
959 this.dom.pointer = null;
961 /* Actually do the reorder */
962 this.s.dt.oInstance.fnColReorder( this.s.mouse.fromIndex, this.s.mouse.toIndex );
963 this._fnSetColumnIndexes();
965 /* When scrolling we need to recalculate the column sizes to allow for the shift */
966 if ( this.s.dt.oScroll.sX !== "" || this.s.dt.oScroll.sY !== "" )
968 this.s.dt.oInstance.fnAdjustColumnSizing( false );
972 this.s.dt.oInstance.oApi._fnSaveState( this.s.dt );
974 if ( this.s.reorderCallback !== null )
976 this.s.reorderCallback.call( this );
983 * Calculate a cached array with the points of the column inserts, and the
989 "_fnRegions": function ()
991 var aoColumns = this.s.dt.aoColumns;
993 this.s.aoTargets.splice( 0, this.s.aoTargets.length );
995 this.s.aoTargets.push( {
996 "x": $(this.s.dt.nTable).offset().left,
1001 for ( var i=0, iLen=aoColumns.length ; i<iLen ; i++ )
1003 /* For the column / header in question, we want it's position to remain the same if the
1004 * position is just to it's immediate left or right, so we only incremement the counter for
1007 if ( i != this.s.mouse.fromIndex )
1012 if ( aoColumns[i].bVisible )
1014 this.s.aoTargets.push( {
1015 "x": $(aoColumns[i].nTh).offset().left + $(aoColumns[i].nTh).outerWidth(),
1021 /* Disallow columns for being reordered by drag and drop, counting right to left */
1022 if ( this.s.fixedRight !== 0 )
1024 this.s.aoTargets.splice( this.s.aoTargets.length - this.s.fixedRight );
1027 /* Disallow columns for being reordered by drag and drop, counting left to right */
1028 if ( this.s.fixed !== 0 )
1030 this.s.aoTargets.splice( 0, this.s.fixed );
1036 * Copy the TH element that is being drags so the user has the idea that they are actually
1037 * moving it around the page.
1038 * @method _fnCreateDragNode
1042 "_fnCreateDragNode": function ()
1044 var scrolling = this.s.dt.oScroll.sX !== "" || this.s.dt.oScroll.sY !== "";
1046 var origCell = this.s.dt.aoColumns[ this.s.mouse.targetIndex ].nTh;
1047 var origTr = origCell.parentNode;
1048 var origThead = origTr.parentNode;
1049 var origTable = origThead.parentNode;
1050 var cloneCell = $(origCell).clone();
1052 // This is a slightly odd combination of jQuery and DOM, but it is the
1053 // fastest and least resource intensive way I could think of cloning
1054 // the table with just a single header cell in it.
1055 this.dom.drag = $(origTable.cloneNode(false))
1056 .addClass( 'DTCR_clonedTable' )
1058 $(origThead.cloneNode(false)).append(
1059 $(origTr.cloneNode(false)).append(
1065 position: 'absolute',
1068 width: $(origCell).outerWidth(),
1069 height: $(origCell).outerHeight()
1071 .appendTo( 'body' );
1073 this.dom.pointer = $('<div></div>')
1074 .addClass( 'DTCR_pointer' )
1076 position: 'absolute',
1078 $('div.dataTables_scroll', this.s.dt.nTableWrapper).offset().top :
1079 $(this.s.dt.nTable).offset().top,
1080 height : scrolling ?
1081 $('div.dataTables_scroll', this.s.dt.nTableWrapper).height() :
1082 $(this.s.dt.nTable).height()
1084 .appendTo( 'body' );
1088 * Clean up ColReorder memory references and event handlers
1089 * @method _fnDestroy
1093 "_fnDestroy": function ()
1097 for ( i=0, iLen=this.s.dt.aoDrawCallback.length ; i<iLen ; i++ )
1099 if ( this.s.dt.aoDrawCallback[i].sName === 'ColReorder_Pre' )
1101 this.s.dt.aoDrawCallback.splice( i, 1 );
1106 $(this.s.dt.nTHead).find( '*' ).off( '.ColReorder' );
1108 $.each( this.s.dt.aoColumns, function (i, column) {
1109 $(column.nTh).removeAttr('data-column-index');
1112 this.s.dt._colReorder = null;
1118 * Add a data attribute to the column headers, so we know the index of
1119 * the row to be reordered. This allows fast detection of the index, and
1120 * for this plug-in to work with FixedHeader which clones the nodes.
1123 "_fnSetColumnIndexes": function ()
1125 $.each( this.s.dt.aoColumns, function (i, column) {
1126 $(column.nTh).attr('data-column-index', i);
1135 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
1137 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
1141 * ColReorder default settings for initialisation
1145 ColReorder.defaults = {
1147 * Predefined ordering for the columns that will be applied automatically
1148 * on initialisation. If not specified then the order that the columns are
1149 * found to be in the HTML is the order used.
1154 * // Using the `oColReorder` option in the DataTables options object
1155 * $('#example').dataTable( {
1156 * "sDom": 'Rlfrtip',
1158 * "aiOrder": [ 4, 3, 2, 1, 0 ]
1163 * // Using `new` constructor
1164 * $('#example').dataTable()
1166 * new $.fn.dataTable.ColReorder( '#example', {
1167 * "aiOrder": [ 4, 3, 2, 1, 0 ]
1173 * Redraw the table's column ordering as the end user draws the column
1174 * (`true`) or wait until the mouse is released (`false` - default). Note
1175 * that this will perform a redraw on each reordering, which involves an
1176 * Ajax request each time if you are using server-side processing in
1182 * // Using the `oColReorder` option in the DataTables options object
1183 * $('#example').dataTable( {
1184 * "sDom": 'Rlfrtip',
1191 * // Using `new` constructor
1192 * $('#example').dataTable()
1194 * new $.fn.dataTable.ColReorder( '#example', {
1201 * Indicate how many columns should be fixed in position (counting from the
1202 * left). This will typically be 1 if used, but can be as high as you like.
1207 * // Using the `oColReorder` option in the DataTables options object
1208 * $('#example').dataTable( {
1209 * "sDom": 'Rlfrtip',
1211 * "iFixedColumns": 1
1216 * // Using `new` constructor
1217 * $('#example').dataTable()
1219 * new $.fn.dataTable.ColReorder( '#example', {
1220 * "iFixedColumns": 1
1226 * As `iFixedColumnsRight` but counting from the right.
1231 * // Using the `oColReorder` option in the DataTables options object
1232 * $('#example').dataTable( {
1233 * "sDom": 'Rlfrtip',
1235 * "iFixedColumnsRight": 1
1240 * // Using `new` constructor
1241 * $('#example').dataTable()
1243 * new $.fn.dataTable.ColReorder( '#example', {
1244 * "iFixedColumnsRight": 1
1247 iFixedColumnsRight: 0,
1250 * Callback function that is fired when columns are reordered
1251 * @type function():void
1255 * // Using the `oColReorder` option in the DataTables options object
1256 * $('#example').dataTable( {
1257 * "sDom": 'Rlfrtip',
1259 * "fnReorderCallback": function () {
1260 * alert( 'Columns reordered' );
1266 * // Using `new` constructor
1267 * $('#example').dataTable()
1269 * new $.fn.dataTable.ColReorder( '#example', {
1270 * "fnReorderCallback": function () {
1271 * alert( 'Columns reordered' );
1275 fnReorderCallback: null
1280 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
1282 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
1285 * ColReorder version
1290 ColReorder.version = "1.1.3";
1294 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
1295 * DataTables interfaces
1296 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
1299 $.fn.dataTable.ColReorder = ColReorder;
1300 $.fn.DataTable.ColReorder = ColReorder;
1303 // Register a new feature with DataTables
1304 if ( typeof $.fn.dataTable == "function" &&
1305 typeof $.fn.dataTableExt.fnVersionCheck == "function" &&
1306 $.fn.dataTableExt.fnVersionCheck('1.9.3') )
1308 $.fn.dataTableExt.aoFeatures.push( {
1309 "fnInit": function( settings ) {
1310 var table = settings.oInstance;
1312 if ( ! settings._colReorder ) {
1313 var dtInit = settings.oInit;
1314 var opts = dtInit.colReorder || dtInit.oColReorder || {};
1316 new ColReorder( settings, opts );
1319 table.oApi._fnLog( settings, 1, "ColReorder attempted to initialise twice. Ignoring second" );
1322 return null; /* No node for DataTables to insert */
1325 "sFeature": "ColReorder"
1329 alert( "Warning: ColReorder requires DataTables 1.9.3 or greater - www.datatables.net/download");
1334 if ( $.fn.dataTable.Api ) {
1335 $.fn.dataTable.Api.register( 'colReorder.reset()', function () {
1336 return this.iterator( 'table', function ( ctx ) {
1337 ctx._colReorder.fnReset();
1341 $.fn.dataTable.Api.register( 'colReorder.order()', function ( set ) {
1343 return this.iterator( 'table', function ( ctx ) {
1344 ctx._colReorder.fnOrder( set );
1348 return this.context.length ?
1349 this.context[0]._colReorder.fnOrder() :
1358 // Define as an AMD module if possible
1359 if ( typeof define === 'function' && define.amd ) {
1360 define( ['jquery', 'datatables'], factory );
1362 else if ( typeof exports === 'object' ) {
1364 factory( require('jquery'), require('datatables') );
1366 else if ( jQuery && !jQuery.fn.dataTable.ColReorder ) {
1367 // Otherwise simply initialise as normal, stopping multiple evaluation
1368 factory( jQuery, jQuery.fn.dataTable );
1372 })(window, document);