@refinitiv-ui/efx-grid 6.0.20 → 6.0.21

package/lib/grid/index.js

@@ -1,3 +1,3 @@
 import {Grid} from "./lib/efx-grid.js";
 export {Grid}
-window.EFX_GRID = { version: "6.0.20" };
+window.EFX_GRID = { version: "6.0.21" };

package/lib/rt-grid/dist/rt-grid.js

@@ -44797,17 +44797,136 @@ Grid.prototype.getAllFields = function() {
 	return this._connector.getAllFields();
 };
 /** Freeze the column at the left side of the table starting from index 0 to the specified colIndex
- * If no index is specified (null or undefined index), unfreeze all columns.
- * @public
- * @param {number=} colIndex Negative index is equivalent to null value
- * @param {number=} pinnedRightColumns Number of columns to be pinned/snapped on the right side
- */
+* If no index is specified (null or undefined index), unfreeze all columns.
+* @public
+* @param {number=} colIndex Negative index is equivalent to null value
+* @param {number=} pinnedRightColumns Number of columns to be pinned/snapped on the right side
+*/
 Grid.prototype.freezeColumn = function(colIndex, pinnedRightColumns) {
 	if(colIndex == null) {
 		colIndex = -1;
 	}
 	this._grid.freezeColumn(colIndex, pinnedRightColumns);
 };
+/** Pin column to the left side by moving the specified column to the rightmost of the frozen columns. <br>
+* The method will do nothing if the specified column is already pinned to the left side
+* @public
+* @param {Grid~ColumnReference|Array.<Grid~ColumnReference>} colRef
+* @return {boolean}
+*/
+Grid.prototype.pinColumn = function(colRef) {
+	if(Array.isArray(colRef)) {
+		var ary = colRef;
+		var len = ary.length;
+
+		var dirty = 0;
+		for(var i = 0; i < len; ++i) {
+			dirty |= this._pinColumn(ary[i]);
+		}
+		return dirty ? true : false;
+	}
+	return this._pinColumn(colRef);
+};
+/** @private
+* @param {Grid~ColumnReference} colRef
+* @return {boolean}
+*/
+Grid.prototype._pinColumn = function(colRef) {
+	var colIndex = this.getColumnIndex(colRef);
+	if(colIndex < 0) {
+		return false;
+	}
+	var pinnedCount = this._grid.getFrozenColumnCount();
+	if(colIndex < pinnedCount) {
+		return false; // The column is already pinned area
+	}
+	if(!pinnedCount) {
+		var stationaryIdx = this._grid.getStationaryColumnIndex();
+		if(stationaryIdx >= 0) {
+			pinnedCount = stationaryIdx;
+			if(colIndex > stationaryIdx) {
+				pinnedCount++;
+			}
+		}
+	}
+
+	this.moveColumnById(colIndex, pinnedCount);
+	this._grid.freezeColumn(pinnedCount);
+	return true;
+};
+/** Unpin column from the left side by moving the specified column to the end of the frozen columns. <br>
+* The method will do nothing if the specified column is not pinned on the left side.
+* @public
+* @param {Grid~ColumnReference|Array.<Grid~ColumnReference>} colRef
+* @param {Grid~ColumnReference=} dest The unpinned column will be placed before the destination position after the operation
+* @return {boolean}
+*/
+Grid.prototype.unpinColumn = function(colRef, dest) {
+	if(Array.isArray(colRef)) {
+		var ary = colRef;
+		var len = ary.length;
+
+		var dirty = 0;
+		for(var i = 0; i < len; ++i) {
+			dirty |= this._unpinColumn(ary[i], dest);
+		}
+		return dirty ? true : false;
+	}
+	return this._unpinColumn(colRef, dest);
+};
+/** @private
+* @param {Grid~ColumnReference} colRef
+* @param {Grid~ColumnReference=} dest The unpinned column will be placed before the destination position after the operation
+* @return {boolean}
+*/
+Grid.prototype._unpinColumn = function(colRef, dest) {
+	var colIndex = this.getColumnIndex(colRef);
+	if(colIndex < 0) {
+		return false;
+	}
+	var pinnedCount = this._grid.getFrozenColumnCount();
+	if(!pinnedCount) {
+		return false;
+	}
+	if(colIndex >= pinnedCount) {
+		return false; // The column is outside of frozen area
+	}
+	var srcId = null;
+	var destId = null;
+	if(dest != null) {
+		var destIdx = this.getColumnIndex(dest);
+		destId = this.getColumnId(destIdx);
+		srcId = this.getColumnId(colIndex);
+	}
+
+	var stationaryIdx = this._grid.getStationaryColumnIndex();
+
+	if(colIndex > stationaryIdx) {
+		this.moveColumnById(colIndex, pinnedCount);
+	}
+
+	this._grid.freezeColumn(pinnedCount - 2); // Column index is used for freezing
+
+	if(colIndex > stationaryIdx) {
+		if(destId != null) {
+			this.moveColumnById(srcId, destId);
+		}
+	}
+
+	return true;
+};
+/** A shorthand to unpin all columns from the left hand side
+* @public
+* @return {boolean}
+*/
+Grid.prototype.unpinAllColumns = function() {
+	var pinnedCount = this._grid.getFrozenColumnCount();
+	if(!pinnedCount) {
+		return false;
+	}
+	this._grid.freezeColumn(-1); // Column index is used for freezing
+	return true;
+};
 
 /** @private
 * @param {Object} e