@refinitiv-ui/efx-grid 6.0.129 → 6.0.130

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

@@ -258,6 +258,8 @@ declare class Grid extends EventDispatcher {
 
     public hasRic(): boolean;
 
+    public getRic(rowRef?: (string|number)|null): string;
+
     public setRowData(rowRef: Grid.RowReference|null, values: any): void;
 
     public setStaticRowData(rowRef: Grid.RowReference|null, values: any): void;

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

@@ -175,6 +175,14 @@ import { ElementWrapper } from "../../core/es6/grid/components/ElementWrapper.js
 * @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}
@@ -609,11 +617,6 @@ Grid.prototype._topSection = true;
 * @private
 */
 Grid.prototype._focusingArgs = null;
-/** @type {boolean}
-* @private
-*/
-Grid.prototype._unlinking = false;
-
 
 /** @public
 */
@@ -2842,13 +2845,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);
@@ -2856,8 +2887,6 @@ Grid.prototype.unlinkChain = function(rowRef) {
 	}
 
 	rowDef.unlinkChain();
-
-	this._unlinking = false;
 };
 
 /** Alias to setRic
@@ -3171,6 +3200,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

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

@@ -102,7 +102,7 @@ declare class RowDefinition {
 
     public subscribeForUpdates(subs?: any): boolean;
 
-    public unsubscribeForUpdates(): null;
+    public unsubscribeForUpdates(keepData?: boolean|null): null;
 
     public isSubscribing(): boolean;
 

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

@@ -48,12 +48,6 @@ const ROW_TYPES = {
 	GROUP_MEMBER: "GROUP_MEMBER"
 };
 
-/** @type {RegExp}
-* @private
-* @const
-*/
-const ROW_ID_PATTERN = /^_[^_]+_$/;
-
 /** @private
 * @function
 * @param {Object} obj
@@ -98,6 +92,11 @@ RowDefinition._runningId = 0;
 * @private
 */
 RowDefinition._childDataField = "CHILD_VALUES";
+/** @type {RegExp}
+* @private
+* @const
+*/
+RowDefinition.ROW_ID_PATTERN = /^_[^_]+_$/;
 //#region Private Members
 /** @type {string}
 * @private
@@ -253,7 +252,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;
@@ -904,12 +903,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()) {
@@ -917,7 +911,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){
@@ -941,14 +939,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;
 };
@@ -1167,8 +1168,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
 	}
@@ -1179,7 +1181,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
 };
 
@@ -1190,7 +1196,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) {

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

@@ -15,7 +15,8 @@ declare namespace ColumnGroupingPlugin {
         tooltip?: (boolean|string)|null,
         children: (string)[]|null,
         alignment?: string|null,
-        render?: ((...params: any[]) => any)|null
+        render?: ((...params: any[]) => any)|null,
+        backgroundColor?: string|null
     };
 
 }

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

@@ -19,6 +19,7 @@ import { cloneObject, injectCss, prettifyCss, deepEqual } from "../../tr-grid-ut
 * @property {Array.<string>} children Child member in this group
 * @property {string=} alignment eg. left, center, right
 * @property {Function=} render render function handler
+* @property {string=} backgroundColor Background color of group header
 */
 
 /** @constructor
@@ -501,7 +502,8 @@ ColumnGroupingPlugin.prototype._applyGrouping = function () {
 	let rowCount = this._maxDepth + 1;
 	let hostCount = this._hosts.length;
 	for(i = hostCount; --i >= 0;) {
-		section = this._hosts[i].getSection("title");
+		let host = this._hosts[i];
+		section = host.getSection("title");
 		if(section) {
 			section.setRowCount(rowCount); // This will cause postSectionRender event to be fired
 			section.clearCellSpans();
@@ -522,6 +524,9 @@ ColumnGroupingPlugin.prototype._applyGrouping = function () {
 					}
 				}
 			}
+			if(host.applyColumnsBackgroundColor) {
+				host.applyColumnsBackgroundColor(section);
+			}
 
 			this._spanGroupVertically(section);
 			// TODO: Some calculation in here should not be done in this loop
@@ -833,8 +838,9 @@ ColumnGroupingPlugin.prototype._spanGroupHorizontally = function (titleSection)
 			section.setCellColSpan(start, groupDef["onRow"], end - start + 1);
 			groupDef["colIndex"] = start;
 
+			let cell = section.getCell(start, groupDef["onRow"]);
+			cell.setStyle("backgroundColor", groupDef["backgroundColor"] || "");
 			if(isAllSelected){
-				let cell = section.getCell(start, groupDef["onRow"]);
 				cell.addClass("selected-group");
 			}
 		}

package/lib/types/es6/ColumnGrouping.d.ts

@@ -15,7 +15,8 @@ declare namespace ColumnGroupingPlugin {
         tooltip?: (boolean|string)|null,
         children: (string)[]|null,
         alignment?: string|null,
-        render?: ((...params: any[]) => any)|null
+        render?: ((...params: any[]) => any)|null,
+        backgroundColor?: string|null
     };
 
 }

package/lib/types/es6/RealtimeGrid/Grid.d.ts

@@ -295,6 +295,8 @@ declare class Grid extends EventDispatcher {
 
     public hasRic(): boolean;
 
+    public getRic(rowRef?: (string|number)|null): string;
+
     public setRowData(rowRef: Grid.RowReference|null, values: any): void;
 
     public setStaticRowData(rowRef: Grid.RowReference|null, values: any): void;

package/lib/types/es6/RealtimeGrid/RowDefinition.d.ts

@@ -102,7 +102,7 @@ declare class RowDefinition {
 
     public subscribeForUpdates(subs?: any): boolean;
 
-    public unsubscribeForUpdates(): null;
+    public unsubscribeForUpdates(keepData?: boolean|null): null;
 
     public isSubscribing(): boolean;
 

package/lib/versions.json

@@ -1,5 +1,5 @@
 {
-	"tr-grid-util": "1.3.161",
+	"tr-grid-util": "1.3.164",
 	"tr-grid-printer": "1.0.18",
 	"@grid/column-dragging": "1.0.21",
 	"@grid/row-segmenting": "1.0.35",
@@ -10,7 +10,7 @@
 	"tr-grid-checkbox": "1.0.70",
 	"tr-grid-column-fitter": "1.0.41",
 	"tr-grid-column-formatting": "0.9.36",
-	"tr-grid-column-grouping": "1.0.63",
+	"tr-grid-column-grouping": "1.0.64",
 	"tr-grid-column-resizing": "1.0.29",
 	"tr-grid-column-selection": "1.0.33",
 	"tr-grid-column-stack": "1.0.76",
@@ -27,7 +27,7 @@
 	"tr-grid-row-filtering": "1.0.83",
 	"tr-grid-row-grouping": "1.0.88",
 	"tr-grid-row-selection": "1.0.32",
-	"tr-grid-rowcoloring": "1.0.25",
+	"tr-grid-rowcoloring": "1.0.26",
 	"tr-grid-textformatting": "1.0.48",
 	"tr-grid-titlewrap": "1.0.22",
 	"@grid/formatters": "1.0.55",

package/package.json

@@ -69,5 +69,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"version": "6.0.129"
+	"version": "6.0.130"
 }