@refinitiv-ui/efx-grid 6.0.90 → 6.0.92

package/lib/core/es6/index.d.ts

@@ -2,7 +2,6 @@ import Util from "./grid/util/util.js";
 
 // Core
 import EventDispatcher from "./grid/event/EventDispatcher.js";
-import ElementFrameWork from "./grid/util/ElementFrameWork.js";
 import ElementWrapper from "./grid/components/ElementWrapper.js";
 import ILayoutGrid from "./grid/ILayoutGrid.js";
 import LayoutGrid from "./grid/LayoutGrid.js";
@@ -44,7 +43,6 @@ export {
 	// Core
 	EventDispatcher,
 	ElementWrapper,
-	ElementFrameWork,
 	ILayoutGrid,
 	LayoutGrid,
 	Core,

package/lib/core/es6/index.js

@@ -2,7 +2,6 @@ import Util from "./grid/util/util.js";
 
 // Core
 import EventDispatcher from "./grid/event/EventDispatcher.js";
-import ElementFrameWork from "./grid/util/ElementFrameWork.js";
 import ElementWrapper from "./grid/components/ElementWrapper.js";
 import ILayoutGrid from "./grid/ILayoutGrid.js";
 import LayoutGrid from "./grid/LayoutGrid.js";
@@ -51,7 +50,6 @@ if(!grid) {
 Object.assign(tr, Util);
 tr.EventDispatcher = EventDispatcher;
 tr.ElementWrapper = ElementWrapper;
-tr.ElementFrameWork = ElementFrameWork;
 tr.ILayoutGrid = ILayoutGrid;
 tr.LayoutGrid = LayoutGrid;
 tr.Grid = Core;
@@ -91,7 +89,6 @@ export {
 	// Core
 	EventDispatcher,
 	ElementWrapper,
-	ElementFrameWork,
 	ILayoutGrid,
 	LayoutGrid,
 	Core,

package/lib/grid/index.js

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

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

@@ -9969,10 +9969,12 @@ Segment.prototype.getSubSegmentIds = function(out_ary) {
 Segment.prototype.addChild = function(rid, dataId) {
 	if(rid) {
 		this._shared.childToSegment[rid] = this._rid;
-		if(this._collapsed) {
-			this._shared.dirtyCollapsingState = true; // TODO: Check if we need to update this only when new child is added
-		}
-		if(!this._children[rid]) {
+		if(this._children[rid]) {
+			this._children[rid] = dataId || rid; // Update data id
+		} else {
+			if(this._collapsed) {
+				this._shared.dirtyCollapsingState = true; // TODO: Check if we need to update this only when new child is added
+			}
 			this._children[rid] = dataId || rid;
 			++this._childCount;
 			return true;
@@ -10750,6 +10752,17 @@ SegmentCollection.prototype.getSegment = function(rid) {
 	return this._segments[rid] || null;
 };
 /** @public
+* @param {string} rid
+* @return {Segment}
+*/
+SegmentCollection.prototype.getSegmentParent = function(rid) {
+	var parentRowId = this.getParentRowId(rid);
+	if(parentRowId) {
+		return this.getSegment(parentRowId);
+	}
+	return null;
+};
+/** @public
 * @return {Object.<string, Segment>}
 */
 SegmentCollection.prototype.getSegments = function() {
@@ -11397,8 +11410,34 @@ DataTable.prototype.setData = function(rid, cid, value) { // Data changed event
 	values[cid] = value;
 	return this.setRowData(rid, values);
 };
+/** @private
+* @param {string} rid Row Id
+* @returns {boolean}
+*/
+DataTable.prototype._removeRidFromSegments = function(rid) { // Data changed event may be dispatched
+	if(this._segments) {
+		var segment = this._segments.getSegment(rid);
+		if(segment) {
+			if(this._segments.removeSegment(rid)) {
+				// TODO: Handle sub segment removal
+				if(!this._segments.getSegmentCount()) {
+					this._segments.dispose();
+					this._segments = null;
+				}
+				return true;
+			}
+		} else {
+			var segmentParentId = this._segments.getParentRowId(rid);
+			if(segmentParentId) {
+				this._segments.removeSegmentChild(segmentParentId, rid);
+			}
+		}
+	}
+	return false;
+};
 /** Set data in row manner
 * @override
+* @public
 * @param {string} rid Row Id
 * @param {Object.<string, *>=} values Object where the key is column Id and value is the data to be set
 * @param {Object=} eventArg Additional arguments to be attached to the event fired
@@ -11455,18 +11494,7 @@ DataTable.prototype.setRowData = function(rid, values, eventArg) { // Data chang
 			// delete this._prevData[rid];
 			this._prevData[rid] = this._rows[rid]; // Move reference from the removed row to history
 			delete this._rows[rid];
-			if(this._segments) {
-				var segment = this._segments.getSegment(rid);
-				if(segment) {
-					if(this._segments.removeSegment(rid)) {
-						// TODO: Handle sub segment removal
-						segmentChanged = true;
-						if(!this._segments.getSegmentCount()) {
-							this._segments = null;
-						}
-					}
-				}
-			}
+			segmentChanged = this._removeRidFromSegments(rid);
 			DataTable._removeArrayItem(this._rids, rid);
 			dirty = true;
 		}
@@ -11770,7 +11798,7 @@ DataTable.prototype.removeRows = function(refs) {
 			this._prevData[rid] = this._rows[rid];
 			this._removedRows[rid] = 1;
 			delete this._rows[rid];
-			// TODO: remove segments
+			this._removeRidFromSegments(rid);
 			dirty = true;
 		}
 	}
@@ -11813,9 +11841,10 @@ DataTable._removeArrayItem = function(ary, item) {
 DataTable.prototype.clearAllData = function(suppressEvent) {
 	DataTable.base(this, "clearAllData", true);
 	this._prevData = {};
-	// TODO: Clear all segments
+
 	if(this._segments) {
-		this._segments.removeAllSegmentChildren(); // This immediately remove all sub segments
+		this._segments.dispose();
+		this._segments = null;
 	}
 
 	if(this._rids.length) {
@@ -12189,6 +12218,7 @@ DataTable.prototype.setSegmentSeparator = function(rid, enabled) {
 */
 DataTable.prototype.unsetAllSegmentSeparators = function() {
 	if(this._segments) {
+		this._segments.dispose();
 		this._segments = null;
 		this.dispatchGlobalChange();
 		return true;
@@ -12216,7 +12246,7 @@ DataTable.prototype.isSegmentSeparator = function(rid) {
 /** Get Segment object
 * @public
 * @param {string} rid Row id
-* @return {Segment} Return 0 if the given rid is not a segment
+* @return {Segment} Returns null if a segment cannot be found
 */
 DataTable.prototype.getSegment = function(rid) {
 	if(this._segments) {
@@ -12224,6 +12254,17 @@ DataTable.prototype.getSegment = function(rid) {
 	}
 	return null;
 };
+/**
+* @public
+* @param {string} rid Row id of a segment child
+* @return {string} Returns null if a segment cannot be found
+*/
+DataTable.prototype.getSegmentParent = function(rid) {
+	if(this._segments) {
+		return this._segments.getSegmentParent(rid);
+	}
+	return null;
+};
 /** Segment level starts from 1
 * @public
 * @param {string} rid
@@ -13217,6 +13258,7 @@ DataTable._proto = DataTable.prototype;
 * @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
@@ -13313,6 +13355,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
 */
@@ -13407,6 +13453,7 @@ RowDefinition.prototype.dispose = function() {
 		this._view = null;
 	}
 	this._rowId = this._dataId = "";
+	this._userId = false;
 	this._userModel = null;
 };
 /** @public
@@ -13423,6 +13470,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"];
@@ -13546,28 +13601,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) {
@@ -13593,6 +13656,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;
@@ -14070,6 +14138,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
@@ -14092,14 +14176,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
@@ -14485,7 +14584,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;
@@ -31480,12 +31579,20 @@ DataView.prototype.isSegmentSeparator = function(rid) {
 
 /** Get Segment object
 * @public
-* @param {string} rid Row id
-* @return {Segment} Return 0 if the given rid is not a segment
+* @param {string} rid Row id of a segment
+* @return {Segment} Returns null if a segment cannot be found
 */
 DataView.prototype.getSegment = function(rid) {
 	return this._dt.getSegment(rid);
 };
+/**
+* @public
+* @param {string} rid Row id of a segment child
+* @return {string} Returns null if a segment cannot be found
+*/
+DataView.prototype.getSegmentParent = function(rid) {
+	return this._dt.getSegmentParent(rid);
+};
 /** Segment level starts from 1
 * @public
 * @param {string} rid Row id
@@ -36332,7 +36439,7 @@ Core.prototype._hasPendingRowChange = false;
 * @return {string}
 */
 Core.getVersion = function () {
-	return "5.1.92";
+	return "5.1.95";
 };
 /** {@link ElementWrapper#dispose}
 * @override
@@ -39622,7 +39729,7 @@ Core.prototype.requestRowRefresh = function() {
 	}
 };
 /** Set a timer to call updateScrollbarHeight only once to avoid performance issue due to multiple call of _updateScrollbarHeight()
-* @public
+* @private
 */
 Core.prototype._requestScrollbarUpdate = function() {
 	this._updateScrollbarHeight(true, true);
@@ -44632,7 +44739,7 @@ SortableTitlePlugin._proto = SortableTitlePlugin.prototype;
 */
 
 /** @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.
 */
 
@@ -44719,33 +44826,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;
@@ -45968,7 +46075,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++) {
@@ -46078,7 +46185,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);
@@ -46849,7 +46956,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
@@ -47185,9 +47292,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);
@@ -47195,9 +47309,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"]);
 		}
 	}
 };
@@ -48169,7 +48283,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
@@ -48463,26 +48577,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
@@ -48526,7 +48649,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}