@refinitiv-ui/efx-grid 6.0.127 → 6.0.129

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
@@ -13249,7 +13415,10 @@ RowDefinition.prototype.setDataSource = function(dataSource, subs) {
 	this._dc = dataSource || null;
 
 	if(this._dc) {
-		this.setRowData(_cloneObject(this._staticValues)); // Trigger data change
+		this.setRowData({}); // Trigger data change
+		if(this._staticValues) {
+			this.setRowData(this._staticValues); // Trigger dataComposed and add updates
+		}
 	}
 
 	this._subs = subs || null;
@@ -13375,9 +13544,14 @@ RowDefinition.prototype.setRowData = function(data) {
 /** @public
 */
 RowDefinition.prototype.resetRowData = function() {
-	if(this._dc) {
-		this._dc.setRowData(this._rowId, null);
-		this._dc.setRowData(this._rowId, _cloneObject(this._staticValues)); // Row data is guaranteed to be existed
+	let dc = this._dc;
+	if(dc) {
+		let rowId = this._rowId;
+		dc.setRowData(rowId, null);
+		dc.setRowData(rowId, {}); // Row data is guaranteed to be existed
+		if(this._staticValues) {
+			dc.setRowData(rowId, this._staticValues);  // Trigger dataComposed and add updates
+		}
 	}
 };
 /** @public
@@ -31413,6 +31587,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
@@ -31513,6 +31704,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
@@ -31591,6 +31798,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
@@ -36294,7 +36511,7 @@ Core.prototype._hasPendingRowChange = false;
 * @return {string}
 */
 Core.getVersion = function () {
-	return "5.1.125";
+	return "5.1.129";
 };
 /** {@link ElementWrapper#dispose}
 * @override
@@ -42169,7 +42386,7 @@ DataConnector.prototype._fieldChangedConflator = null;
 * @private
 */
 DataConnector.prototype._ricChangedConflator = null;
-/** @type {Object.<string, RowDefinition>}
+/** @type {Object.<string, Array.<RowDefinition>>}
 * @private
 */
 DataConnector.prototype._rowDefMap = null;
@@ -43459,7 +43676,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
@@ -43858,14 +44083,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);
-		}
 	}
 };
 
@@ -45128,6 +45345,10 @@ Grid.prototype._formulaConflator = null;
 */
 Grid.prototype._chainConflator = null;
 /** @private
+* @type {Object}
+*/
+Grid.prototype._constituentMap = null;
+/** @private
 * @type {number}
 */
 Grid.prototype._clientWidth = NaN;
@@ -46974,10 +47195,10 @@ Grid.prototype.insertRow = function(rowOption, rowRef) {
 		}
 	}
 	let rowDef = new RowDefinition(rowOption);
+	rowDef.registerToView(this._dv, this._getRowId(rowRef));
 	rowDef.setDataSource(this._dc, this._subs); // This could also subscribe chain index/ric to JET/RTK
 	this._initDuplicateRicData(rowDef);
 
-	rowDef.registerToView(this._dv, this._getRowId(rowRef));
 	if(rowOption && rowOption["hidden"]) {
 		this._dv.hideRow(rowDef.getRowId()); // Try to obtain rowId in rowDef since rowId is not assigned when new rows are created.
 	}
@@ -47298,6 +47519,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
@@ -48197,15 +48419,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);
@@ -48216,15 +48438,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);
+		}
 	}
 };
 
@@ -48235,6 +48470,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) {
@@ -48544,17 +48782,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 = rowData[ROW_DEF];
+	let rowId = e["rid"];
+	let rowDef = this._getRowDefinitionById(rowId);
 	if(!rowDef) {
-		return;
-	}
-	if(!rowDef.getDataSource()) {
-		return; // Somehow, rowDef is invalid and doesn't have data source
+		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
@@ -48615,8 +48857,8 @@ Grid.prototype._onSubSegmentChanged = function(e) {
 		rowDef = new RowDefinition({
 			"segmentId": segmentId // WARNING: This could cause row id duplication
 		});
-		rowDef.setDataSource(this._dc); // auto generated row does not require a subscription
 		rowDef.registerToView(this._dv);
+		rowDef.setDataSource(this._dc); // auto generated row does not require a subscription
 	}
 };
 
@@ -49128,7 +49370,8 @@ Grid.prototype._onTabNavigation = function(e) {
 */
 Grid.prototype._getEventHandlers = function() {
 	return {
-		"tabNavigation": this._onTabNavigation
+		"tabNavigation": this._onTabNavigation,
+		"q2DataChanged": this._onQ2DataChanged
 	};
 };