@refinitiv-ui/efx-grid 6.0.37 → 6.0.39

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

@@ -13277,7 +13277,7 @@ RowDefinition.prototype._permId = "";
 /** @type {string|null}
 * @private
 */
-RowDefinition.prototype._label = null; // Label overrides _ric and _displayText
+RowDefinition.prototype._label = null; // Label overrides _ric and _permId
 /** @type {boolean|null}
 * @private
 */
@@ -13444,15 +13444,15 @@ RowDefinition.prototype.initialize = function(rowOptions) {
 
 	var expanded = this._expanded;
 	var symbol = this._ric || this._chainRic;
-	var asChain = rowOptions["asChain"] || !!this._chainRic;
+	var asChain = this._isChain || !!this._chainRic;
 	if(this._ric && this._ric.indexOf("0#") >= 0){
 		asChain = true;
 		expanded = true;
 	}
-	if(rowOptions["asChain"] === false){
+	if(this._isChain === false){
 		asChain = false;
 	}
-	if(rowOptions["collapsed"] === true){
+	if(this._expanded === false){
 		expanded = false;
 	}
 	if(symbol || this._permId){
@@ -13467,7 +13467,7 @@ RowDefinition.prototype._initializeAsConstituent = function(rowOptions) {
 	var parentDef = /** @type{RowDefinition} */(rowOptions["parent"]);
 	if(this.setParent(parentDef)) {
 		this._dataId = /** @type{string} */(rowOptions["dataId"]); // Constituent will have the same subId as its parent but with different ric
-
+		this._ric = /** @type{string} */(rowOptions["ric"]);
 		this._dc = parentDef._dc; // Parent chain must have data cache
 		if(this._dc) {
 			var rowData = this.getRowData(); // Do not trigger any data update
@@ -13522,7 +13522,7 @@ RowDefinition.prototype.setContent = function(userInput, permId, asChain, expand
 			if(asChain === false){
 				this._ric = this._userInput;
 			} else {
-				this._ric = expanded ? this._userInput.replace("0#", "") : this._userInput;
+				this._ric = expanded === false ? this._userInput : this._userInput.replace("0#", "");
 				this._expanded = expanded;
 				this._isChain = true; // Only chain can be expanded by 0#
 				this._chainRic = this._userInput;
@@ -15803,10 +15803,11 @@ ColumnDefinition.prototype.getConfigObject = function(colOptions) {
 		obj["minWidth"] = value;
 	}
 
-	value = core.isColumnVisible(colIndex);
 	// If "hidden" property already available from core/extensions, don't override this property
-	if(!value && obj["hidden"] == null) {
-		obj["hidden"] = true;
+	if(obj["hidden"] == null) {
+		if(!core.getColumnVisibility(colIndex, 0)) {
+			obj["hidden"] = true;
+		}
 	}
 
 	value = core.getColumnAlignment(colIndex);
@@ -19313,18 +19314,18 @@ TrackLayout.prototype.showLane = function (index, opt_val) {
 };
 /** @public
 * @param {number} index
-* @param {boolean=} opt_hidden
-* @param {number=} opt_bitIndex
+* @param {boolean=} hidden
+* @param {number=} bitIndex
 * @return {boolean}
 */
-TrackLayout.prototype.hideLane = function (index, opt_hidden, opt_bitIndex) {
+TrackLayout.prototype.hideLane = function (index, hidden, bitIndex) {
 	if (index < 0 || index >= this._laneCount) { return false; }
 
 	var col = this._newColumn(index);
 	var prevVis = !col.invisibility;
 
-	var bit = (opt_bitIndex != null) ? this._bits[opt_bitIndex] : 1;
-	if(opt_hidden !== false) {
+	var bit = (bitIndex != null) ? this._bits[bitIndex] : 1;
+	if(hidden !== false) {
 		col.invisibility |= bit; // Add invisibility bit
 	} else {
 		col.invisibility &= ~bit; // Remove invisibility bit
@@ -19335,6 +19336,24 @@ TrackLayout.prototype.hideLane = function (index, opt_hidden, opt_bitIndex) {
 	}
 	return false;
 };
+/** Return true if the lane does not exist nor is not hidden. Return false only if the lane is hidden by the specified bit
+* @public
+* @param {number} index
+* @param {number=} bitIndex
+* @return {boolean}
+*/
+TrackLayout.prototype.getLaneVisibilityBit = function (index, bitIndex) {
+	if (index >= 0 && index < this._laneCount) {
+		var col = this._cols[index];
+		if(col) {
+			var bit = (bitIndex != null) ? this._bits[bitIndex] : 1;
+			if(col.invisibility & bit) {
+				return false;
+			}
+		}
+	}
+	return true;
+};
 /** @public
 * @param {boolean=} opt_shown
 */
@@ -35465,6 +35484,7 @@ var Core = function (opt_initializer) {
 	_t._onVScroll = _t._onVScroll.bind(_t);
 	_t._onHScroll = _t._onHScroll.bind(_t);
 	_t._onSyncVScroll = _t._onSyncVScroll.bind(_t);
+	_t._onSyncHScroll = _t._onSyncHScroll.bind(_t);
 	_t.updateLayout = _t.updateLayout.bind(_t);
 	_t._onRowRefresh = _t._onRowRefresh.bind(_t);
 	_t._onVScrollEnabled = _t._onVScrollEnabled.bind(_t);
@@ -35577,7 +35597,8 @@ var Core = function (opt_initializer) {
 		"rowPositionChanged",
 		"beforeColumnBoundUpdate",
 		"beforeBatchOperation",
-		"afterBatchOperation"
+		"afterBatchOperation",
+		"pinningChanged"
 	);
 
 	// For debugging in advanced optimization mode
@@ -35926,7 +35947,7 @@ Core.prototype._batches = null;
 * @return {string}
 */
 Core.getVersion = function () {
-	return "5.1.50";
+	return "5.1.53";
 };
 /** {@link ElementWrapper#dispose}
 * @override
@@ -35968,6 +35989,12 @@ Core.prototype.dispose = function () {
 		mainScrolbar.unlisten("scroll", this._onSyncVScroll);
 		this._vscrollbar._mainScrollbar = null;
 	}
+	mainScrolbar = this._hscrollbar._mainScrollbar;
+	if(mainScrolbar) {
+		mainScrolbar.unlisten("scroll", this._onSyncHScroll);
+		this._hscrollbar._mainScrollbar = null;
+	}
+
 	this._vscrollbar.dispose();
 	this._hscrollbar.dispose();
 	this._rowHeightConflator.dispose();
@@ -38281,10 +38308,14 @@ Core.prototype.freezeColumn = function (frozenColIndex, numRightColumn) {
 	var colCount = this.getColumnCount();
 	var leftPinnedCount = 0;
 	var rightPinnedCount = 0;
+	var dirty = false;
 	if (frozenColIndex || frozenColIndex === 0) {
 		this._hScrollbarEnabled = true;
 		leftPinnedCount = (frozenColIndex >= 0) ? frozenColIndex + 1 : 0;
-		this._pinnedLeftColumnCount = leftPinnedCount; // This variable is used for caching
+		if (this._pinnedLeftColumnCount !== leftPinnedCount) {
+			dirty = true;
+			this._pinnedLeftColumnCount = leftPinnedCount; // This variable is used for caching
+		}
 
 		for (i = 0; i < colCount; ++i) {
 			colDef = this._getColumnDef(i);
@@ -38295,7 +38326,10 @@ Core.prototype.freezeColumn = function (frozenColIndex, numRightColumn) {
 	}
 	if(numRightColumn != null) {
 		rightPinnedCount = numRightColumn > 0 ? numRightColumn : 0;
-		this._pinnedRightColumnCount = rightPinnedCount; // This variable is used for caching
+		if (this._pinnedLeftColumnCount !== rightPinnedCount) {
+			dirty = true;
+			this._pinnedRightColumnCount = rightPinnedCount; // This variable is used for caching
+		}
 
 		for (i = colCount; --i >= 0;) {
 			colDef = this._getColumnDef(i);
@@ -38306,6 +38340,12 @@ Core.prototype.freezeColumn = function (frozenColIndex, numRightColumn) {
 	this._onColumnCountChanged(); // Activate horizontal scrollbar and column virtualization
 	this._updateScrollbarWidth(true, true);
 	this._updateColumnSeparators();
+
+	if (dirty) {
+		if (!this._isEventDispatching("pinningChanged")) {
+			this._dispatch("pinningChanged", {});
+		}
+	}
 };
 
 /** @private
@@ -39130,6 +39170,26 @@ Core.prototype.synchronizeVScrollbar = function (subGrid) {
 	this._vscrollbar.listen("scroll", subGrid._onSyncVScroll);
 };
 
+/** Synchronize two horizontal scrollbars of two grid, by hiding its scrollbar and using the one from the given grid
+* @public
+* @param {Core} subGrid
+*/
+Core.prototype.synchronizeHScrollbar = function (subGrid) {
+	subGrid.unlisten("mousemove", subGrid._onMouseMove);
+	subGrid.listen("mousemove", this._onMouseMove);
+
+	var hscrollbar = subGrid.getHScrollbar();
+	hscrollbar._mainScrollbar = this._hscrollbar; // HACK
+
+	hscrollbar.setStyle("visibility", "hidden");
+	hscrollbar.setStyle("pointerEvents", "none");
+	hscrollbar.disableMouseWheel(); // Disable sub-grid wheel behavior
+	hscrollbar.attachToExternalElement(this._hscrollbar.getParent()); // MouseWheel event is still available on the main
+
+	// TODO: Check if we need to re-append this._hscrollbar to move it to the front over other grid elements.
+	this._hscrollbar.listen("scroll", subGrid._onSyncHScroll);
+};
+
 /** Fires data binding event without actual change in the data source. <br>
 * This will force visual elements to be re-rendered with the latest data in the data source.
 * @public
@@ -39272,7 +39332,7 @@ Core.prototype.getHorizontalLayout = function () {
 * @ignore
 * @param {number} colIndex
 * @param {boolean} bool
-* @param {number} flag Default is 0
+* @param {number} flag
 * @return {boolean}
 */
 Core.prototype.setColumnVisibility = function (colIndex, bool, flag) {
@@ -39292,6 +39352,16 @@ Core.prototype.setColumnVisibility = function (colIndex, bool, flag) {
 	}
 	return false;
 };
+/** Get visibility state for the specified flag. This is for internal use only
+* @public
+* @ignore
+* @param {number} colIndex
+* @param {number=} flag
+* @return {boolean}
+*/
+Core.prototype.getColumnVisibility = function (colIndex, flag) {
+	return this._layoutX.getLaneVisibilityBit(colIndex, flag);
+};
 
 /** @public
 * @param {number} size
@@ -40785,6 +40855,12 @@ Core.prototype._onSyncVScroll = function (e) {
 	this._vscrollbar.setScrollTop(e.scrollTop);
 };
 /** @private
+* @param {Object} e
+*/
+Core.prototype._onSyncHScroll = function (e) {
+	this._hscrollbar.setScrollLeft(e.scrollLeft);
+};
+/** @private
 * @return {number} index of footer section
 */
 Core.prototype._getFooterStartIndex = function () {
@@ -46871,50 +46947,72 @@ Grid.prototype.freezeColumn = function(colIndex, pinnedRightColumns) {
 	}
 	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
+* @param {string=} side Available values are: left|right. If no value is supplied, the column will be pinned to the left.
 * @return {boolean}
 */
-Grid.prototype.pinColumn = function(colRef) {
+Grid.prototype.pinColumn = function(colRef, side) {
 	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]);
+			dirty |= this._pinColumn(ary[i], side);
 		}
 		return dirty ? true : false;
 	}
-	return this._pinColumn(colRef);
+	return this._pinColumn(colRef, side);
 };
 /** @private
 * @param {Grid~ColumnReference} colRef
+* @param {string=} side Available values are: left|right. If no value is supplied, the column will be pinned to the left.
 * @return {boolean}
 */
-Grid.prototype._pinColumn = function(colRef) {
+Grid.prototype._pinColumn = function(colRef, side) {
 	var colIndex = this.getColumnIndex(colRef);
-	if(colIndex < 0) {
+	var colCount = this.getColumnCount();
+	if(colIndex < 0 || colIndex > colCount) {
 		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++;
+
+	var leftPinnedCount = this._grid.getPinnedLeftColumnCount();
+	var rightPinnedCount = this._grid.getPinnedRightColumnCount();
+	var stationaryIdx = this._grid.getStationaryColumnIndex();
+
+	if(side && side.toLowerCase() === "right") {
+		var rightPinnedIndex = this._grid.getFirstPinnedRightIndex();
+		if(colIndex >= rightPinnedIndex) {
+			return false; // The column is already pinned area
+		}
+
+		if(stationaryIdx >= 0 && colIndex <= stationaryIdx) {
+			return false;
+		}
+
+		this.moveColumnById(colIndex, rightPinnedIndex);
+		rightPinnedCount += 1;
+		leftPinnedCount -= 1;
+	} else {
+		if(colIndex < leftPinnedCount) {
+			return false; // The column is already pinned area
+		}
+		if(!leftPinnedCount) {
+			if(stationaryIdx >= 0) {
+				leftPinnedCount = stationaryIdx;
+				if(colIndex > stationaryIdx) {
+					leftPinnedCount++;
+				}
 			}
 		}
+		this.moveColumnById(colIndex, leftPinnedCount);
 	}
 
-	this.moveColumnById(colIndex, pinnedCount);
-	this._grid.freezeColumn(pinnedCount);
+	this._grid.freezeColumn(leftPinnedCount, rightPinnedCount);
 	return true;
 };
 /** Unpin column from the left side by moving the specified column to the end of the frozen columns. <br>
@@ -46947,13 +47045,16 @@ Grid.prototype._unpinColumn = function(colRef, dest) {
 	if(colIndex < 0) {
 		return false;
 	}
-	var pinnedCount = this._grid.getFrozenColumnCount();
-	if(!pinnedCount) {
+
+	var leftPinnedCount = this._grid.getPinnedLeftColumnCount();
+	var rightPinnedCount = this._grid.getPinnedRightColumnCount();
+	var colCount = this.getColumnCount();
+	var firstRightPinnedIndex = colCount - rightPinnedCount;
+
+	if(colIndex >= leftPinnedCount && colIndex < firstRightPinnedIndex) {
 		return false;
 	}
-	if(colIndex >= pinnedCount) {
-		return false; // The column is outside of frozen area
-	}
+
 	var srcId = null;
 	var destId = null;
 	if(dest != null) {
@@ -46964,11 +47065,19 @@ Grid.prototype._unpinColumn = function(colRef, dest) {
 
 	var stationaryIdx = this._grid.getStationaryColumnIndex();
 
-	if(colIndex > stationaryIdx) {
-		this.moveColumnById(colIndex, pinnedCount);
-	}
+	if(colIndex < leftPinnedCount) {
+		if(colIndex > stationaryIdx) {
+			this.moveColumnById(colIndex, leftPinnedCount);
+		}
+
+		this._grid.freezeColumn(leftPinnedCount - 2, rightPinnedCount); // Column index is used for freezing
+	} else if(colIndex >= firstRightPinnedIndex) {
+		if(colIndex > stationaryIdx) {
+			this.moveColumnById(colIndex, firstRightPinnedIndex);
+		}
 
-	this._grid.freezeColumn(pinnedCount - 2); // Column index is used for freezing
+		this._grid.freezeColumn(leftPinnedCount - 1, rightPinnedCount - 1); // Column index is used for freezing
+	}
 
 	if(colIndex > stationaryIdx) {
 		if(destId != null) {
@@ -46983,11 +47092,12 @@ Grid.prototype._unpinColumn = function(colRef, dest) {
 * @return {boolean}
 */
 Grid.prototype.unpinAllColumns = function() {
-	var pinnedCount = this._grid.getFrozenColumnCount();
-	if(!pinnedCount) {
+	var leftPinnedCount = this._grid.getPinnedLeftColumnCount();
+	var rightPinnedCount = this._grid.getPinnedRightColumnCount();
+	if(!leftPinnedCount && !rightPinnedCount) {
 		return false;
 	}
-	this._grid.freezeColumn(-1); // Column index is used for freezing
+	this._grid.freezeColumn(-1, 0); // Column index is used for left freezing and column count is used for right freezing
 	return true;
 };