@refinitiv-ui/efx-grid 6.0.91 → 6.0.92

package/lib/rt-grid/es6/Grid.js

@@ -157,7 +157,7 @@ import { ElementWrapper } from "../../core/es6/grid/components/ElementWrapper.js
 */
 
 /** @event Grid#beforeContentBinding
-* @property {Object} e Event of beforeContentBinding,  We can use e.actualUpdate to check the actual data update, otherwise It will be empty when it is rendered by row virtualization or only the UI changes.
+* @property {Object} e Event of beforeContentBinding, we can use e.actualUpdate to check the actual data update, otherwise It will be empty when it is rendered by row virtualization or only the UI changes.
 * @description Trigger before content binding.
 */
 
@@ -244,33 +244,33 @@ let compareNumber = function(rowDefA, rowDefB, sortOrder, fieldName) { // edit n
 * @param {string} sortOrder
 * @return {number} The outcome of the value comparison
 */
-let _sortChildrenOfChain =  function (rowDefA, rowDefB, sortOrder) {
+let _sortChildrenOfChain = function (rowDefA, rowDefB, sortOrder) {
 	let parentA = rowDefA.getParent();
 
 	if (!parentA) {
-	  return 0;
+		return 0;
 	}
 
 	let parentB = rowDefB.getParent();
 
 	if (!parentB) {
-	  return 0;
+		return 0;
 	}
 
 	if (parentA !== parentB) {
-	  return 0;
+		return 0;
 	}
 
 	let a = rowDefA.getData('CHILD_ORDER');
 
 	if (a == null) {
-	  return 0;
+		return 0;
 	}
 
 	let b = rowDefB.getData('CHILD_ORDER');
 
 	if (b == null) {
-	  return 0;
+		return 0;
 	}
 
 	return ( a - b ) * sortOrder;
@@ -1493,7 +1493,7 @@ Grid.prototype._populateTimeSeriesChildren = function (colDef) {
 		return;
 	}
 
-	let colDefs  = this._timeSeriesChildConflator.popAllData();
+	let colDefs = this._timeSeriesChildConflator.popAllData();
 	let i, j, len, childField, idx;
 
 	for (i = 0; i < colDefs.length; i++) {
@@ -1603,7 +1603,7 @@ Grid.prototype.replaceColumn = function (columnOption, colRef) {
 
 	let colDef = this.getColumnDefinition(colIndex);
 	if(colDef && colConfig.id == null) {
-		colConfig.id =  colDef.getId(); // retain ID
+		colConfig.id = colDef.getId(); // retain ID
 	}
 	this._grid.startBatch("reset");
 	this.removeColumn(colIndex);
@@ -2374,7 +2374,7 @@ Grid.prototype.insertRows = function(rowOptions, rowRef, opt_fields) {
 * ], ["field1", "field2", "field3"]); // 3 rows are appended
 *
 * grid.addStaticDataRows([ // Object format can also be used
-*  {"field1": 40, "field2": "a",  "field3": true},
+*  {"field1": 40, "field2": "a", "field3": true},
 *  {"field1": 50, "field2": "b"}, // each row doesn't have to be the same
 *  {"field1": 60, "field4": "some thing"}
 * ]); // 3 more rows are appended
@@ -2710,9 +2710,16 @@ Grid.prototype.setRic = function(rowRef, str, options) {
 	}
 	let rowDef = this._getRowDefinitionByRef(rowRef);
 	if(rowDef) {
-		options = options || {};
-		options["ric"] = str;
-		let extractedOptions = RowDefinition.extractRowOptions(options);
+		var tempOpt = options || {};
+		if(typeof str === "string") {
+			tempOpt["ric"] = str;
+		} else {
+			if(str && !options) {
+				tempOpt = str;
+			}
+			str = tempOpt["ric"] ? tempOpt["ric"] : "";
+		}
+		let extractedOptions = RowDefinition.extractRowOptions(tempOpt);
 		let oldRic = rowDef.getSymbol();
 		if(rowDef.setContent(str, extractedOptions)) { // The given string may not be a RIC
 			this._connector.removeRic(rowDef, oldRic);
@@ -2720,9 +2727,9 @@ Grid.prototype.setRic = function(rowRef, str, options) {
 			this._connector.addRic(rowDef);
 		}
 
-		let values = options["values"];
+		let values = tempOpt["values"];
 		if(values != null) {
-			rowDef.setStaticRowData(values, options["fields"]);
+			rowDef.setStaticRowData(values, tempOpt["fields"]);
 		}
 	}
 };
@@ -3694,7 +3701,7 @@ Grid.prototype.isFocused = function() {
 		return this.contains(activeElement);
 	}
  	// For wrapper scenarios, such as atlas-blotter or efx-grid
-	return  activeElement.shadowRoot === this._topNode.parentNode;
+	return activeElement.shadowRoot === this._topNode.parentNode;
 };
 /** @description Focus grid element without moving window scrollbar
  * @public
@@ -3988,26 +3995,35 @@ Grid.prototype._logData = function(rowDefs, options) {
 };
 
 /** @public
-* @description Replace existing row with a new row. Row ID would be changed, after row is replaced.
+* @description Replace existing row by a new row. Row Id is always changed, after the row is replaced.
 * @param {Grid~RowReference} rowRef Reference (i.e. row index, row id, or row definition) of the insert position
 * @param {(RowDefinition~Options|string)=} rowOption
-* @returns {RowDefinition}
+* @returns {RowDefinition} Returns null, if the row is not replaced. Otherwise, a newly created row is returned
 */
 Grid.prototype.replaceRow = function(rowRef, rowOption) {
-	let rowId = this._getRowId(rowRef);
-	let rowDef = this._getRowDefinitionByRef(rowRef);
-	if(rowDef.isAutoGenerated()) { // Users cannot replace auto-generated
-		return  null;
+	let insertPos = this._getRowId(rowRef);
+	let rowDef = this._getRowDefinitionById(insertPos);
+
+	if(rowDef) {
+		if(rowDef.isAutoGenerated()) {
+			return null; // Users cannot replace an auto-generated row
+		}
+
+		let configObj = rowDef.getConfigObject();
+		if(rowDef.getRowId() === rowOption["rowId"]) {
+			return null; // Cannot replace a row with the same row id
+		}
+
+		if(deepEqual(configObj, rowOption)){
+			return null;
+		}
 	}
-	let configObj = rowDef.getConfigObject();
 
-	if(deepEqual(configObj, rowOption)){
-		return null;
-	} else {
-		let insertedRow = this.insertRow(rowOption, rowId);
-		this.removeRow(rowId);
-		return insertedRow;
+	let newRow = this.insertRow(rowOption, insertPos);
+	if(rowDef) {
+		this.removeRow(insertPos);
 	}
+	return newRow;
 };
 
 /** Scroll the view to the specified column. If the column is already in the view, nothing happens. If the column is outside of the view, the view will be moved to the column with some additional offsets
@@ -4051,7 +4067,7 @@ Grid.prototype.getScrollTop = function () {
 Grid.prototype.setScrollLeft = function (pixels) {
 	this._grid.setScrollLeft(pixels);
 };
-/**  Set scroll value to the vertical scrollbar. This will move the scrollbar to specific position
+/** Set scroll value to the vertical scrollbar. This will move the scrollbar to specific position
 * @public
 * @param {number} pixels
 * @see {@link Grid.scrollDown}

package/lib/rt-grid/es6/RowDefinition.d.ts

@@ -15,7 +15,8 @@ declare namespace RowDefinition {
         label?: (string|null)|null,
         hidden?: boolean|null,
         realTime?: boolean|null,
-        info?: any
+        info?: any,
+        rowId?: string|null
     };
 
     type RowTypes = {

package/lib/rt-grid/es6/RowDefinition.js

@@ -17,6 +17,7 @@ import { DataTable } from "../../core/es6/data/DataTable.js";
 * @property {boolean=} hidden=true When this row is hidden
 * @property {boolean=} realTime=true Realtime row, able to request for JET/RTK
 * @property {Object=} info=null For storing any additional information to the row
+* @property {string=} rowId Row identifier used for referencing the row
 */
 
 /** @typedef {Object} RowDefinition~RowTypes
@@ -113,6 +114,10 @@ RowDefinition.prototype._rowId = ""; // Row Id must be unique
 * @private
 */
 RowDefinition.prototype._dataId = ""; // Data id can be different from rowId for constituents of a chain
+/** @type {boolean}
+* @private
+*/
+RowDefinition.prototype._userId = false;
 /** @type {DataCache}
 * @private
 */
@@ -207,6 +212,7 @@ RowDefinition.prototype.dispose = function() {
 		this._view = null;
 	}
 	this._rowId = this._dataId = "";
+	this._userId = false;
 	this._userModel = null;
 };
 /** @public
@@ -223,6 +229,14 @@ RowDefinition.prototype.initialize = function(rowOptions) {
 		return;
 	}
 
+	if(!this._autoGenerated) {
+		let userRowId = rowOptions["rowId"];
+		if(userRowId && typeof userRowId === "string") {
+			this._rowId = this._dataId = userRowId;
+			this._userId = true;
+		}
+	}
+
 	let extractedOptions = RowDefinition.extractRowOptions(rowOptions);
 
 	let val = rowOptions["permId"];
@@ -346,28 +360,36 @@ RowDefinition.prototype.setContent = function(userInput, extractedOptions) {
 		} else {
 			this._ric = this._userInput;
 		}
-		this._isChain = asChain;
+		this._isChain = asChain != null ? asChain : null; // this could be null or undefined
 		this._chainRic = chainRic || "";
 	}
 
+	let segmentId = "";
 	if(this._view) {
-		if(this._isChain){
-			let rid = this.getRowId();
-			let segmentId = this._view.getSegmentParentRowId(rid);
-			if(segmentId){
-				this._view.removeSegmentChild(segmentId, rid);
-			}
+		segmentId = this._view.getSegmentParentRowId(this._rowId);
+		if(this._isChain && segmentId){ // If the row was a normal row and has been changed to a chain, remove it from existing segment
+			let targetRowId = _getEndOfSegmentRowId(this._view, this._rowId);
+			this._view.removeSegmentChild(segmentId, this._rowId);
+			this._view.moveRow(this._rowId, targetRowId);
+
+			segmentId = "";
 		}
 		this._view.setSegmentSeparator(this._rowId, !!this._isChain);
-		if(this._expanded && this.isChainCollapsed()){
-			this.expandChain();
-		} else if (!this._expanded && this.isChainExpanded()){
-			this.collapseChain();
+		if(this.isChainCollapsed()) {
+			if(this._expanded){
+				this.expandChain();
+			}
+		} else {
+			if (!this._expanded) {
+				this.collapseChain();
+			}
 		}
 	}
 
-	this._dataId = this._rowId + this.getSymbol(); // JET/RTK will generate data id to be rowId (given from this rowDef) + ric;
-
+	this._dataId = this._rowId + this.getSymbol(); // JET/RTK will generate data id to be rowId (given from this rowDef) + ric
+	if(segmentId) { // If data id is changed and the row is a child of a segment, then segment child data id must be updated
+		this._view.addSegmentChild(segmentId, this._rowId, this._dataId);
+	}
 
 	if(!this.subscribeForUpdates()) {
 		if(this._dc) {
@@ -393,6 +415,11 @@ RowDefinition.prototype.getRowId = function() {
 */
 RowDefinition.prototype.getConfigObject = function(rowOptions) {
 	let obj = rowOptions || {};
+
+	if(this._userId) {
+		obj["rowId"] = this._rowId;
+	}
+
 	let val = this._ric;
 	if(val) {
 		obj["ric"] = val;
@@ -870,6 +897,22 @@ RowDefinition.prototype.resetUpdates = function() {
 	}
 };
 
+/** @private
+* @param {DataView} view
+* @param {string} rowId
+* @returns {string}
+*/
+let _getEndOfSegmentRowId = function(view, rowId) {
+	let rowIndex = view.getRowIndex(rowId);
+	do {
+		rowId = view.getRowId(++rowIndex);
+		if(rowId && !view.getSegmentParentRowId(rowId)) {
+			break;
+		}
+	} while(rowId);
+	return rowId;
+};
+
 /** @public
 * @param {DataView} view
 * @param {string=} rowId
@@ -892,14 +935,29 @@ RowDefinition.prototype.registerToView = function(view, rowId) {
 	rowData = {};
 	rowData[ROW_DEF] = this;
 
-	let newRowId = this._view.insertRow(rowId, rowData, this.getRowId());
-	this._rowId = newRowId; // In case there is some duplicate row id.
+	let parentRowId = "";
+	if(rowId) {
+		parentRowId = view.getSegmentParentRowId(rowId);
+		if(parentRowId) {
+			if(this._isChain) { // A chain cannot be put inside another segment
+				rowId = _getEndOfSegmentRowId(view, rowId);
+			} // else { // Normal row is inserted into a segment
+		}
+	}
+
+	let newRowId = view.insertRow(rowId, rowData, this.getRowId());
+	if(newRowId !== this._rowId) {
+		this._rowId = newRowId; // In case there is some duplicate row id
+		this._userId = false;
+	}
 
 	if(this._isChain) {
 		view.setSegmentSeparator(this._rowId);
 		if(!this._expanded) {
 			this.collapseChain();
 		}
+	} else if(parentRowId) {
+		view.addSegmentChild(parentRowId, this._rowId, this._dataId);
 	}
 };
 /** @private
@@ -1285,7 +1343,7 @@ RowDefinition.extractRowOptions = function(rowOptions) {
 		extractedOptions["collapsed"] = collapsed;
 	}
 	extractedOptions["ric"] = ric;
-	extractedOptions["permId"] = permId;
+	extractedOptions["permId"] = permId || "";
 	extractedOptions["chainRic"] = chainRic;
 	extractedOptions["asChain"] = asChain;
 	return extractedOptions;

package/lib/tr-grid-cell-selection/es6/CellSelection.js

@@ -385,7 +385,62 @@ CellSelectionPlugin.prototype.getConfigObject = function (gridOptions) {
   }
   return obj;
 };
-
+/** @public
+* @description Emitate the mousedown event. This is for testing purpose.
+* @ignore
+* @param {number} colIndex
+* @param {number} rowIndex
+*/
+CellSelectionPlugin.prototype.mockMouseClick = function (colIndex, rowIndex) {
+  var host = this._hosts[0];
+  host.focus(); // Used for blur event triggering
+  var evt = this._mockMouseEvent(colIndex, rowIndex);
+  this._onMouseDown(evt);
+  this._onMouseUp(evt);
+};
+/** @public
+* @description Emitate the mousedown event. This is for testing purpose.
+* @ignore
+* @param {number} colIndex
+* @param {number} rowIndex
+*/
+CellSelectionPlugin.prototype.mockMouseDown = function (colIndex, rowIndex) {
+  var evt = this._mockMouseEvent(colIndex, rowIndex);
+  this._onMouseDown(evt);
+};
+/** @public
+* @description Emitate the mousedown event. This is for testing purpose.
+* @ignore
+* @param {number} colIndex
+* @param {number} rowIndex
+*/
+CellSelectionPlugin.prototype.mockMouseUp = function (colIndex, rowIndex) {
+  var evt = this._mockMouseEvent(colIndex, rowIndex);
+  this._onMouseUp(evt);
+};
+/** @public
+* @description Emitate the mousemove event. This is for testing purpose.
+* @ignore
+* @param {number} colIndex
+* @param {number} rowIndex
+* @param {number} x
+* @param {number} y
+* @param {Element} target Specify element out side of Grid to test scrolling
+*/
+CellSelectionPlugin.prototype.mockMouseMove = function (colIndex, rowIndex, x, y, target) {
+  var evt = {
+    clientX: x,
+    clientY: y
+  };
+  evt = this._mockMouseEvent(colIndex, rowIndex, evt);
+  if (target) {
+    evt.target = target;
+    evt.path = [target];
+  } else {
+    evt.path = [evt.target];
+  }
+  this._onMouseMove(evt);
+};
 /** Fire when mouse down.
 * @private
 * @param {MouseEvent} e

package/lib/tr-grid-column-grouping/es6/ColumnGrouping.d.ts

@@ -2,7 +2,7 @@ import { Ext } from "../../tr-grid-util/es6/Ext.js";
 import { cloneObject } from "../../tr-grid-util/es6/Util.js";
 import { GridPlugin } from "../../tr-grid-util/es6/GridPlugin.js";
 import { GroupDefinitions } from "../../tr-grid-util/es6/GroupDefinitions.js";
-import { injectCss, prettifyCss } from "../../tr-grid-util/es6/Util.js";
+import { injectCss, prettifyCss, deepEqual } from "../../tr-grid-util/es6/Util.js";
 
 declare namespace ColumnGroupingPlugin {
 
@@ -39,6 +39,8 @@ declare class ColumnGroupingPlugin extends GridPlugin {
 
     public renderGroups(): void;
 
+    public getMutualGroupId(colRefs: (string|number)[]|null): string;
+
     public addColumnToGroup(column: any, groupId: string, colIndex: number): void;
 
     public addGroup(groupDef: ColumnGroupingPlugin.GroupDefinition|null): string;

package/lib/tr-grid-column-grouping/es6/ColumnGrouping.js

@@ -2,7 +2,7 @@ import { Ext } from "../../tr-grid-util/es6/Ext.js";
 import { cloneObject } from "../../tr-grid-util/es6/Util.js";
 import { GridPlugin } from "../../tr-grid-util/es6/GridPlugin.js";
 import { GroupDefinitions } from "../../tr-grid-util/es6/GroupDefinitions.js";
-import { injectCss, prettifyCss } from "../../tr-grid-util/es6/Util.js";
+import { injectCss, prettifyCss, deepEqual } from "../../tr-grid-util/es6/Util.js";
 
 /** @typedef {Array<ColumnGroupingPlugin~GroupDefinition>} ColumnGroupingPlugin~Options
 * @description This options can be specified by `columnGrouping` property of the main grid's options or extension options.
@@ -818,6 +818,34 @@ ColumnGroupingPlugin.prototype.renderGroups = function () {
     }
   }
 };
+
+/** @public
+* @param {Array<string|number>} colRefs
+* @return {string} groupId if all the given columns are children of that groupId, otherwise empty string
+*/
+ColumnGroupingPlugin.prototype.getMutualGroupId = function (colRefs) {
+  var colCount = colRefs.length;
+  for (var i = 0; i < colCount; i++) {
+    if (typeof colRefs[i] === "string") {
+      colRefs[i] = this.getColumnIndex(colRefs[i]);
+    }
+    var colIndex = colRefs[i];
+    var groupIds = this.getGroupIds(colIndex);
+    if (!groupIds) {
+      // If at least 1 column is not part of a group, there is no need to find the groupId.
+      return "";
+    }
+    var groupCount = groupIds.length;
+    for (var j = 0; j < groupCount; j++) {
+      var groupId = groupIds[j];
+      var childrenIndices = this.getChildColumnIndices(groupId);
+      if (deepEqual(childrenIndices, colRefs)) {
+        return groupId;
+      }
+    }
+  }
+  return "";
+};
 /** Render single column group header without affecting cell span.
 * @private
 * @param {Object} groupDef