@refinitiv-ui/efx-grid 6.0.128 → 6.0.130

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

@@ -8966,6 +8966,35 @@ DataCache.prototype.cloneRowData = function (rid) {
 	return values;
 };
 
+/**
+ * @protected
+ * @ignore
+ * @param {string} fromRid
+ * @param {string} toRid
+ * @return {boolean}
+ */
+DataCache.prototype._replaceRowId = function(fromRid, toRid) {
+	let rows = this._rows;
+	if(rows[fromRid]) {
+		rows[toRid] = rows[fromRid];
+		delete rows[fromRid];
+		return true;
+	}
+	return false;
+};
+/**
+ * @public
+ * @ignore
+ * @param {Object} ridPair
+ */
+DataCache.prototype.replaceRowIds = function(ridPair) {
+	if(typeof ridPair === "object") {
+		for(let oldRid in ridPair) {
+			this._replaceRowId(oldRid, ridPair[oldRid]);
+		}
+	}
+};
+
 /** Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
  * @public
  * @ignore
@@ -10173,6 +10202,27 @@ SegmentCollection.prototype.getSegmentIds = function() {
 };
 
 
+/** @public
+* @param {Array.<string>} segmentIds
+* @param {boolean=} bool
+* @return {boolean} Returns true if there is any change. Otherwise, returns false
+*/
+SegmentCollection.prototype.collapseSegments = function(segmentIds, bool) {
+	if(this._segmentCount) {
+		let dirty = 0;
+		let len = segmentIds.length;
+		for (let i = 0; i < len; i++) {
+			let rowId = segmentIds[i];
+			dirty |= this._segments[rowId].collapse(bool);
+
+		}
+		if(dirty) {
+			return true;
+		}
+	}
+	return false;
+};
+
 /** @public
 * @param {string} segmentId
 * @param {boolean=} bool
@@ -11412,6 +11462,45 @@ DataTable.prototype.swapRow = function(fromIndex, toIndex) { // No event is fire
 	this._rids[toIndex] = rid;
 };
 
+/**
+* @protected
+* @override
+* @ignore
+* @param {string} fromRid
+* @param {string} toRid
+* @return {boolean}
+*/
+DataTable.prototype._replaceRowId = function(fromRid, toRid) {
+	let rids = this._rids;
+	let idx = rids.indexOf(fromRid);
+	if(idx >= 0) {
+		rids[idx] = toRid;
+		this._rows[toRid] = this._rows[fromRid];
+		delete this._rows[fromRid];
+		this._prevData[toRid] = this._prevData[fromRid];
+		delete this._prevData[fromRid];
+		return true;
+	}
+	return false;
+};
+/**
+* @public
+* @override
+* @ignore
+* @param {Object} ridPair
+*/
+DataTable.prototype.replaceRowIds = function(ridPair) {
+	if(typeof ridPair === "object") {
+		let dirty = false;
+		for(let oldRid in ridPair) {
+			dirty |= this._replaceRowId(oldRid, ridPair[oldRid]);
+		}
+		if(dirty) {
+			this.dispatchGlobalChange();
+		}
+	}
+};
+
 /** @public
 * @function
 * @param {string} rid
@@ -11553,6 +11642,55 @@ DataTable.prototype.isFrozen = function() {
 	return this._frozen;
 };
 
+/**
+* @public
+* @param {Array.<string>} rids
+* @param {boolean=} enabled
+* @return {boolean} Return true if there is any change
+*/
+DataTable.prototype.setSegmentSeparators = function(rids, enabled) {
+	let change = false;
+	if (rids) {
+		let len = rids.length;
+		let segmentChanged = false;
+		for (let i = 0; i < len; i++) {
+			if(enabled !== false) {
+				let rid = rids[i];
+				if (!this._segments) {
+					this._segments = new data_SegmentCollection();
+					this._segments.addEventListener("subSegmentChanged", this._onSubSegmentChanged);
+				}
+				if(this._autoSegmentFilling) {
+					let parentId = this._segments.getParentRowId(rid);
+					if(parentId) {
+						this._segments.removeSegmentChild(parentId, rid);
+					}
+				}
+				segmentChanged = this._segments.addSegment(rid);
+			} else if (this._segments) { // remove case
+				let segment = this._segments.getSegment(rid);
+				if(segment) {
+					if(this._segments.removeSegment(rid)) {
+						change = true;
+						if(!this._segments.getSegmentCount()) {
+							this._segments = null;
+						}
+					}
+				}
+			}
+
+		}
+		if (enabled !== false && segmentChanged) {
+			this._segments.calcSegmentOrder(this._rids);
+			change = true;
+		}
+		if(change) {
+			this.dispatchGlobalChange();
+		}
+	}
+	return change;
+
+};
 
 /**
 * @public
@@ -11579,7 +11717,7 @@ DataTable.prototype.setSegmentSeparator = function(rid, enabled) {
 				this._segments.calcSegmentOrder(this._rids);
 				change = true;
 			}
-		} else if(this._segments) {
+		} else if(this._segments) { // mean remove separator
 			let segment = this._segments.getSegment(rid);
 			if(segment) {
 				memberCount = segment.getChildCount();
@@ -11805,6 +11943,34 @@ DataTable.prototype.addSegmentChildren = function(segmentId, rids, dataIds) {
 	}
 	return false;
 };
+
+/** @public
+* @param {Array.<Object>} segmentArr Segment array that contain "segmentId", "rowIds" to set segment children
+* @return {boolean} Return true if there is any change
+*/
+DataTable.prototype.setSegmentChildren = function(segmentArr) {
+	if(!this._segments) {
+		return false;
+	}
+	this.removeAllSegmentChildren();
+	let len = segmentArr.length;
+	let dirty;
+	for (let i = 0; i < len; i++) {
+		let obj = segmentArr[i];
+		if(this._segments.addSegmentChildren(obj.segmentId, obj.rowIds)) {
+			dirty = true;
+		}
+	}
+	if(dirty) {
+		this._sort(null);
+		this._dispatchPositionChange(); // Force rerendering, even if there is no position change
+
+		this.requestClassifying();
+		return true;
+	}
+
+	return false;
+};
 /** @public
 * @param {string} segmentId Row id
 * @param {string} rid Row id
@@ -12687,12 +12853,6 @@ const ROW_TYPES = {
 	GROUP_MEMBER: "GROUP_MEMBER"
 };
 
-/** @type {RegExp}
-* @private
-* @const
-*/
-const ROW_ID_PATTERN = /^_[^_]+_$/;
-
 /** @private
 * @function
 * @param {Object} obj
@@ -12737,6 +12897,11 @@ RowDefinition._runningId = 0;
 * @private
 */
 RowDefinition._childDataField = "CHILD_VALUES";
+/** @type {RegExp}
+* @private
+* @const
+*/
+RowDefinition.ROW_ID_PATTERN = /^_[^_]+_$/;
 //#region Private Members
 /** @type {string}
 * @private
@@ -12892,7 +13057,7 @@ RowDefinition.prototype.initialize = function(rowOptions) {
 	if(!this._autoGenerated) {
 		let userRowId = rowOptions["rowId"];
 		if(userRowId && typeof userRowId === "string") {
-			if(userRowId.match(ROW_ID_PATTERN)) {
+			if(userRowId.match(RowDefinition.ROW_ID_PATTERN)) {
 				console.warn("Please change the rowId format to avoid duplicated rows' id causing unexpected behavior.");
 			} else {
 				this._rowId = userRowId;
@@ -13543,12 +13708,7 @@ RowDefinition.prototype.isRealTimeRow = function() {
 * @return {boolean} If a subscription is made, return true.
 */
 RowDefinition.prototype.subscribeForUpdates = function(subs) {
-	if(subs) {
-		this._subs = subs;
-	} else {
-		subs = this._subs;
-	}
-	if(!subs) {
+	if(!(subs  || this._subs)) {
 		return false;
 	}
 	if(!this.isRealTimeRow() && !this.getPermId()) {
@@ -13556,7 +13716,11 @@ RowDefinition.prototype.subscribeForUpdates = function(subs) {
 	}
 	// TODO: Check if the same subscription is being made.
 	this.unsubscribeForUpdates();
-
+	if(subs) {
+		this._subs = subs;
+	} else {
+		subs = this._subs;
+	}
 	if(this.isChain()) {
 		let symbol = this._chainRic;
 		if(!symbol){
@@ -13580,14 +13744,17 @@ RowDefinition.prototype.subscribeForUpdates = function(subs) {
 };
 /** Unsubscribe existing real-time data service. Static data is maintained
 * @public
+* @param {boolean=} keepData
 * @returns {null} Always return null
 */
-RowDefinition.prototype.unsubscribeForUpdates = function() {
+RowDefinition.prototype.unsubscribeForUpdates = function(keepData) {
 	if(this.isSubscribing()) { // Only normal real-time rows and chains have both subId and subscription object
 		this._subs["removeSubscription"](this._subId);
 		this._subId = "";
-		this.resetUpdates();
-		this.resetRowData(); // Real-time data is removed while static data is maintained
+		if(!keepData) {
+			this.resetUpdates();
+			this.resetRowData(); // Real-time data is removed while static data is maintained
+		}
 	}
 	return null;
 };
@@ -13806,8 +13973,9 @@ RowDefinition.prototype.addConstituent = function(ric) {
 /** Used to convert autogenerated row to regular real-time row
 * @public
 * @ignore
+* @param {string=} userRowId
 */
-RowDefinition.prototype.toRealTimeRow = function() {
+RowDefinition.prototype.toRealTimeRow = function(userRowId) {
 	if(!this.isConstituent()) {
 		return; // Only a constituent can be converted to a real-time row
 	}
@@ -13818,7 +13986,11 @@ RowDefinition.prototype.toRealTimeRow = function() {
 	this._parent = null;
 	this._depthLevel = 0;
 
-	this.resetRowData(); // WARNING: existing real-time data is lost after this line
+	if(userRowId) {
+		this._rowId = userRowId;
+		this._userId = true;
+	}
+
 	this.subscribeForUpdates(subs); // Static data remains intact
 };
 
@@ -13829,7 +14001,7 @@ RowDefinition.prototype.unlinkChain = function() {
 		return;
 	}
 
-	this.unsubscribeForUpdates(); // Static data remains intact
+	this.unsubscribeForUpdates(true); // Static data remains intact
 
 	let view = this._view;
 	if(view) {
@@ -31421,6 +31593,23 @@ DataView.prototype.synchronizeRowOrder = function() {
 		this._dt._sort(this._sortingDefs);
 	}
 };
+/**
+* @public
+* @param {Array<string>} rowIds
+* @param {boolean=} enabled
+* @return {boolean} Return true if there is any change
+*/
+DataView.prototype.setSegmentSeparators = function(rowIds, enabled) {
+	if(rowIds) {
+		enabled = enabled !== false;
+		if(enabled) {
+			this.synchronizeRowOrder();
+		}
+		// TODO: Force expanding of segment before unsetting segment separator
+		return this._dt.setSegmentSeparators(rowIds, enabled);
+	}
+	return false;
+};
 /** Set visible row as segment separator (hidden or filtered rows cannot be a segment separator)
 * @public
 * @param {string|number} rowRef Row id or row index
@@ -31521,6 +31710,22 @@ DataView.prototype.collapseSegment = function(rowRef, collapsed) {
 	return false;
 };
 /** @public
+* @param {Array<string|number>} rowIds
+* @param {boolean=} collapsed
+* @return {boolean} Return true if there is any change
+*/
+DataView.prototype.collapseSegments = function(rowIds, collapsed) {
+	collapsed = collapsed !== false;
+	let segments = this._dt._getSegmentSeparators();
+	if(segments) {
+		if(segments.collapseSegments(rowIds, collapsed)) {
+			this._refreshAndNotify(); // dispatch global change event
+			return true;
+		}
+	}
+	return false;
+};
+/** @public
 * @param {string|number} rowRef Row id or row index
 * @param {boolean=} expanded
 * @return {boolean} Return true if there is any change
@@ -31599,6 +31804,16 @@ DataView.prototype.addSegmentChildren = function(segmentRef, rowRefs, dataIds) {
 	return false;
 };
 /** @public
+* @param {Array<Object>} segmentArr Segment array that contain "segmentId", "rowIds" to set segment children
+* @return {boolean} Return true if there is any change
+*/
+DataView.prototype.setSegmentChildren = function(segmentArr) {
+	if(this._dt._getSegmentSeparators()) {
+		return this._dt.setSegmentChildren(segmentArr);
+	}
+	return false;
+};
+/** @public
 * @param {string|number} segmentRef Row id or row index
 * @param {string|number} rowRef Row id, row index
 * @return {boolean} Return true if there is any change
@@ -36302,7 +36517,7 @@ Core.prototype._hasPendingRowChange = false;
 * @return {string}
 */
 Core.getVersion = function () {
-	return "5.1.125";
+	return "5.1.129";
 };
 /** {@link ElementWrapper#dispose}
 * @override
@@ -42177,7 +42392,7 @@ DataConnector.prototype._fieldChangedConflator = null;
 * @private
 */
 DataConnector.prototype._ricChangedConflator = null;
-/** @type {Object.<string, RowDefinition>}
+/** @type {Object.<string, Array.<RowDefinition>>}
 * @private
 */
 DataConnector.prototype._rowDefMap = null;
@@ -43467,7 +43682,15 @@ SortableTitlePlugin.prototype.isSorting = function () {
 * @fires SortableTitlePlugin#columnSorted
 */
 SortableTitlePlugin.prototype.sortColumn = function (colRef, sortOrder, opt_arg) {
-	this._sortColumn(this._prepareSorting(colRef, sortOrder), opt_arg);
+	let sortOptions = this._prepareSorting(colRef, sortOrder);
+	this._sortColumn(sortOptions, opt_arg);
+	if (opt_arg && opt_arg["isUserAction"]) { // Currently, the 'isUserAction' flag is triggered by a user clicking on the title and clicking the filter dialog. TODO: preClicked should be firing too.
+		let ce = {};
+		ce["colIndex"] = sortOptions.colIndex;
+		ce["sortOrder"] = this.getSortOrder(sortOptions.colIndex);
+		ce["dataColumnName"] = this.getColumnSortingField(sortOptions.colIndex); // This should be deprecated
+		this._dispatch("clicked", ce);
+	}
 };
 
 /** Sort multiple columns at once
@@ -43866,14 +44089,6 @@ SortableTitlePlugin.prototype._proceedSorting = function (hitObj) {
 		if(grid && grid["focus"]) {
 			grid["focus"]();
 		}
-
-		if (this._hasListener("clicked")) {
-			let ce = {};
-			ce["colIndex"] = colIndex;
-			ce["sortOrder"] = this.getSortOrder(colIndex);
-			ce["dataColumnName"] = this.getColumnSortingField(colIndex); // This should be deprecated
-			this._dispatch("clicked", ce);
-		}
 	}
 };
 
@@ -44787,6 +45002,14 @@ SortableTitlePlugin._proto = SortableTitlePlugin.prototype;
 * @description Fired only when a row will be removed through Grid's API and before occurring of the actual removal
 */
 
+/** @event Grid#beforeUnlinked
+* @description Trigger before unlinking a chain row.
+* @type {Object}
+* @property {RowDefinition} chain An row definition object of a chain row.
+* @property {boolean} collapsed Collapsing state of a chain row.
+* @property {Object} ridMap A map of constituent rics and row ids used to customize row ids.
+*/
+
 /** @private
 * @param {RowDefinition} rowDef
 * @return {Object}
@@ -45136,6 +45359,10 @@ Grid.prototype._formulaConflator = null;
 */
 Grid.prototype._chainConflator = null;
 /** @private
+* @type {Object}
+*/
+Grid.prototype._constituentMap = null;
+/** @private
 * @type {number}
 */
 Grid.prototype._clientWidth = NaN;
@@ -45217,11 +45444,6 @@ Grid.prototype._topSection = true;
 * @private
 */
 Grid.prototype._focusingArgs = null;
-/** @type {boolean}
-* @private
-*/
-Grid.prototype._unlinking = false;
-
 
 /** @public
 */
@@ -47306,6 +47528,7 @@ Grid.prototype.removeAllRows = function() {
 	this._dcConflator.reset();
 	this._formulaConflator.reset();
 	this._chainConflator.reset();
+	this._constituentMap = null;
 	this._connector.removeAllRics();
 
 	// TODO: This logic should also be in the core grid
@@ -47449,13 +47672,41 @@ Grid.prototype.unlinkChain = function(rowRef) {
 		return;
 	}
 
-	this._unlinking = true;
-
 	let childRowDefs = rowDef.getDescendants(); // TODO: Support nested child
 	if(childRowDefs) {
-		if(rowDef.isChainExpanded()) {
-			for(let i = 0; i < childRowDefs.length; i++) {
-				childRowDefs[i].toRealTimeRow();
+		let len = childRowDefs.length;
+		let ridMap = {};
+		for(let i = 0; i < len; i++) {
+			ridMap[childRowDefs[i].getRic()] = "";
+		}
+		let collapsed = rowDef.isChainCollapsed();
+		let args = {
+			chain: rowDef,
+			collapsed: collapsed,
+			ridMap: ridMap
+		};
+		this._dispatch("beforeUnlinked", args);
+
+		if(!collapsed) {
+			let rowIdChanged = false;
+			let ridPair = {};
+			for(let i = 0; i < len; i++) {
+				let childRowDef = childRowDefs[i];
+				let mappedRowId = ridMap[childRowDef.getRic()];
+				if(mappedRowId) {
+					if(mappedRowId.match(RowDefinition.ROW_ID_PATTERN)) {
+						console.warn("Please change the rowId format to avoid duplicated rows' id causing unexpected behavior.");
+						mappedRowId = "";
+					} else {
+						rowIdChanged = true;
+						ridPair[childRowDef.getRowId()] = mappedRowId;
+					}
+				}
+				childRowDef.toRealTimeRow(mappedRowId);
+			}
+			if(rowIdChanged) {
+				this._dc.replaceRowIds(ridPair);
+				this._dt.replaceRowIds(ridPair);
 			}
 		} else {
 			this._removeConstituentRows(childRowDefs);
@@ -47463,8 +47714,6 @@ Grid.prototype.unlinkChain = function(rowRef) {
 	}
 
 	rowDef.unlinkChain();
-
-	this._unlinking = false;
 };
 
 /** Alias to setRic
@@ -47778,6 +48027,15 @@ Grid.prototype.getAllRics = function() {
 Grid.prototype.hasRic = function() {
 	return this._connector.hasRic();
 };
+/** Returns RIC of given row reference.
+* @public
+* @param {(string|number)=} rowRef
+* @return {string}
+*/
+Grid.prototype.getRic = function(rowRef) {
+	let rowDef = this.getRowDefinition(rowRef);
+	return rowDef.getRic();
+};
 /** A shorthand to set row data based on index of the specified row. It is better to keep rowDefinition object for updating data directly as row index can be changed by sorting and filtering.
 * @public
 * @param {Grid~RowReference} rowRef
@@ -48205,15 +48463,15 @@ Grid.prototype._onQuote2PostUpdate = function (e) {
 * @param {Object} e
  */
 Grid.prototype._onQ2DataChanged = function (e) {
-	let subId = e["subId"];
-	let rowDef = this._getRowDefinitionById(subId);
+	let rowDef = this._getRowDefinitionById(e["subId"]);
 	if(!rowDef) {
 		return; // WARNING: This should not be happened because row has been removed but the data is still received
 	}
 
+	let ric = e["ric"];
 	let values = e["values"];
 	if (values) {
-		let ric = e["ric"];
+		let duplicateRics = null;
 		if(rowDef.verifyConstituent(ric)) {
 			let parentDef = rowDef;
 			let childDef = parentDef.getConstituent(ric);
@@ -48224,15 +48482,28 @@ Grid.prototype._onQ2DataChanged = function (e) {
 				if(!childDef) {
 					return; // Parent chain is not alive
 				}
+				duplicateRics = this._connector.getRowDefByRic(ric);
 				this._connector.addRic(childDef); // TODO: JET/RTK should not re-subscribe this
+				if(!this._constituentMap) {
+					this._constituentMap = {};
+				}
+				this._constituentMap[childDef.getRowId()] = childDef;
 				this._registerConstituents(childDef);
 			}
 		}
 
+		if(duplicateRics && duplicateRics.length) {
+			let duplicateRic = duplicateRics[0];
+			duplicateRic.cloneRowData(values, values);
+		}
+
 		rowDef.setRowData(values); // Trigger data changes
-	} else if(rowDef.isConstituent()) { // Subscription and its parent has been removed by Real-time provider
-		rowDef.setParent(null); // Manually remove child reference from its parent
-		this._removeRow(rowDef);
+	} else { // The constituent is requested to be removed by the real-time data provider
+		let childDef = rowDef.getConstituent(ric); // WARNING: normal ric and its delayed version must match with the one first given
+		if(childDef) {
+			childDef.setParent(null); // Manually remove child reference from its parent
+			this._removeRow(childDef);
+		}
 	}
 };
 
@@ -48243,6 +48514,9 @@ Grid.prototype._registerConstituents = function(rowDef) {
 	if(this._chainConflator.conflate(rowDef)) {
 		return;
 	}
+
+	this._constituentMap = null;
+
 	let view = this._dv;
 	let dt = view ? view.getDataSource() : null;
 	if(!dt) {
@@ -48552,14 +48826,21 @@ Grid.prototype._onDataComposed = function(e) {
 		return; // Cannot do data composition if there is no change in data
 	}
 
-	let rowData = e["rowData"];
-	if(!rowData) {
+	if(!e["rowData"]) {
 		return; // Row could already be removed or global change event is sent
 	}
 
-	let rowDef = this._getRowDefinitionById(e["rid"]);
+	let rowId = e["rid"];
+	let rowDef = this._getRowDefinitionById(rowId);
 	if(!rowDef) {
-		return; // Somehow the given row id is invalid
+		rowDef = this._constituentMap ? this._constituentMap[rowId] : null; // Row def could be in pending for adding to view
+		if(!rowDef) {
+			return; // Somehow the given row id is invalid
+		}
+		if(rowDef.isDisposed()) {
+			this._constituentMap[rowId] = null;
+			return;
+		}
 	}
 
 	if(this._autoDateConversion) { // auto data conversion
@@ -49133,7 +49414,8 @@ Grid.prototype._onTabNavigation = function(e) {
 */
 Grid.prototype._getEventHandlers = function() {
 	return {
-		"tabNavigation": this._onTabNavigation
+		"tabNavigation": this._onTabNavigation,
+		"q2DataChanged": this._onQ2DataChanged
 	};
 };