@refinitiv-ui/efx-grid 6.0.97 → 6.0.99

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

@@ -184,6 +184,8 @@ declare class Grid extends EventDispatcher {
 
     public insertRow(rowOption?: (RowDefinition.Options|string)|null, rowRef?: Grid.RowReference|null): RowDefinition|null;
 
+    public insertSegmentSeparator(rowOption?: RowDefinition.Options|null, rowRef?: Grid.RowReference|null): RowDefinition|null;
+
     public insertRows(rowOptions: (RowDefinition.Options|string)[]|null, rowRef?: Grid.RowReference|null, opt_fields?: (string)[]|null): void;
 
     public addStaticDataRows(dataRows: any[]|null, fields?: (string)[]|null): void;

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

@@ -2321,6 +2321,22 @@ Grid.prototype.insertRow = function(rowOption, rowRef) {
 	this._connector.addRic(rowDef);
 	return rowDef;
 };
+/** Insert a row as a segment separator
+* @public
+* @param {RowDefinition~Options=} rowOption
+* @param {Grid~RowReference=} rowRef Reference (i.e. row index, row id, or row definition) of the insert position
+* @returns {RowDefinition}
+*/
+Grid.prototype.insertSegmentSeparator = function(rowOption, rowRef) {
+	if(!rowOption) {
+		rowOption = {};
+	}
+	if(typeof rowOption === "object") {
+		rowOption.asSegment = true;
+		return this.insertRow(rowOption, rowRef);
+	}
+	return null;
+};
 /** @public
 * @param {Array.<RowDefinition~Options|string>} rowOptions Array of row option object
 * @param {Grid~RowReference=} rowRef Reference (i.e. row index, row id, or row definition) of the insert position

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

@@ -142,7 +142,5 @@ declare const ROW_DEF: string;
 
 declare const ROW_TYPES: RowDefinition.RowTypes;
 
-declare function rowData(userInput: string, extractedOptions: any): boolean;
-
 export {RowDefinition, ROW_DEF, ROW_TYPES};
 export default RowDefinition;

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

@@ -12,7 +12,7 @@ import { DataTable } from "../../core/es6/data/DataTable.js";
 * @property {Array.<string>=} fields=null Field that corresponds to the given static values
 * @property {boolean=} asChain=false The given ric will be treated as a chain
 * @property {string=} chainRic="" RIC to be used for chain request (overiding ric property)
-* @property {boolean=} collapsed=true Chain is collapsed by default
+* @property {boolean=} collapsed=true Chain or segment is collapsed by default
 * @property {(string|null)=} label=null
 * @property {boolean=} hidden=true When this row is hidden
 * @property {boolean=} realTime=true Realtime row, able to request for JET/RTK
@@ -104,6 +104,10 @@ RowDefinition.prototype._isChain = null;
 /** @type {boolean}
 * @private
 */
+RowDefinition.prototype._asSegment = false;
+/** @type {boolean}
+* @private
+*/
 RowDefinition.prototype._realTime = true;
 
 /** @type {string}
@@ -258,8 +262,8 @@ RowDefinition.prototype.initialize = function(rowOptions) {
 	}
 
 	val = extractedOptions["asChain"];
-	if(val !== null) {
-		this._isChain = val;
+	if(val != null) {
+		this._isChain = val ? true : false;
 	}
 
 	val = rowOptions["realTime"];
@@ -272,6 +276,12 @@ RowDefinition.prototype.initialize = function(rowOptions) {
 	if(val != null || !collapsed){
 		this._expanded = !collapsed;
 	}
+
+	val = rowOptions["asSegment"];
+	if(val != null) {
+		this._asSegment = val ? true : false;
+	}
+
 	val = rowOptions["keepModel"];
 	if(val) {
 		this._userModel = rowOptions;
@@ -315,6 +325,41 @@ RowDefinition.prototype._initializeAsConstituent = function(rowOptions) {
 		this.setStaticRowData(val, rowOptions["fields"]);
 	}
 };
+/** @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;
+};
+
+/** @private
+* @param {DataView} view
+* @param {boolean} newState
+* @param {boolean} prevState
+* @returns {boolean} Current state
+*/
+let _stallSorting = function(view, newState, prevState) {
+	if(view && view.isSorting()) {
+		newState = newState ? true : false;
+		if(newState !== prevState) {
+			if(newState) {
+				view.synchronizeRowOrder();
+			}
+			view.stallSorting(newState);
+		}
+		return newState;
+	}
+	return false;
+};
 /** @public
 * @ignore
 * @param {string} userInput RIC
@@ -342,44 +387,53 @@ RowDefinition.prototype.setContent = function(userInput, extractedOptions) {
 		return false;
 	}
 
+	let asChain = extractedOptions["asChain"];
+	let realtimeRow = true;
+	if(userInput.charAt(0) === "'") { // Single quote is used as a marker for non realtime row
+		realtimeRow = false;
+		this._ric = this._chainRic = ""; // No ric for realtime request
+	}
+
+	let dv = this._view;
+	let stalledSorting = _stallSorting(dv, realtimeRow && asChain, false); // To preserve current position of the segment/chain
+
 	if(!this.unsubscribeForUpdates()){
 		this._clearStaticData();
 	}
 	this.resetUpdates(); // Remove all previous data updates because a new content is just entered
 
 	this._userInput = userInput;
-	if(this._userInput.charAt(0) === "'") { // This is a row header
-		this._ric = this._chainRic = ""; // No ric for realtime request
-	} else {
-		let asChain = extractedOptions["asChain"];
+	if(realtimeRow) {
 		let expanded = !extractedOptions["collapsed"];
 		let chainRic = extractedOptions["chainRic"];
 		if(asChain === true){
-			this._ric = expanded === false ? this._userInput : this._userInput.replace("0#", "");
+			this._ric = expanded === false ? userInput : userInput.replace("0#", "");
 			this._expanded = expanded; // Only chain can be expanded by 0#
 		} else {
-			this._ric = this._userInput;
+			this._ric = userInput;
 		}
 		this._isChain = asChain != null ? asChain : null; // this could be null or undefined
 		this._chainRic = chainRic || "";
 	}
+	// A symbol can be either RIC or permId
+	// JET/RTK will generate data id to be rowId (given from this rowDef) + ric
+	this._dataId = this._rowId + this.getSymbol();
 
-	let segmentId = "";
-	if(this._view) {
-		segmentId = this._view.getSegmentParentRowId(this._rowId);
+	if(dv) {
+		let segmentId = dv.getSegmentParentRowId(this._rowId);
 		if(segmentId) {
 			if(this._isChain){ // 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);
+				let targetRowId = _getEndOfSegmentRowId(dv, this._rowId);
+				dv.removeSegmentChild(segmentId, this._rowId);
+				dv.moveRow(this._rowId, targetRowId);
 
 				segmentId = "";
 			}
-		} else if(this._view.getSegment(this._rowId)) {
-			this._view.setSegmentSeparator(this._rowId, false); // Remove existing segment
+		} else if(dv.getSegment(this._rowId)) {
+			dv.setSegmentSeparator(this._rowId, false); // Remove existing segment
 		}
 		if(this._isChain) {
-			this._view.setSegmentSeparator(this._rowId, true);
+			dv.setSegmentSeparator(this._rowId, true);
 		}
 		if(this.isChainCollapsed()) {
 			if(this._expanded){
@@ -390,11 +444,10 @@ RowDefinition.prototype.setContent = function(userInput, extractedOptions) {
 				this.collapseChain();
 			}
 		}
-	}
-
-	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);
+		_stallSorting(dv, false, stalledSorting);
+		if(segmentId) { // If data id is changed and the row is a child of a segment, then segment child data id must be updated
+			dv.addSegmentChild(segmentId, this._rowId, this._dataId);
+		}
 	}
 
 	if(!this.subscribeForUpdates()) {
@@ -903,22 +956,6 @@ 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
@@ -942,28 +979,32 @@ RowDefinition.prototype.registerToView = function(view, rowId) {
 	rowData[ROW_DEF] = this;
 
 	let parentRowId = "";
+	let isSegment = this._isChain || this._asSegment;
 	if(rowId) {
 		parentRowId = view.getSegmentParentRowId(rowId);
 		if(parentRowId) {
-			if(this._isChain) { // A chain cannot be put inside another segment
+			if(isSegment) { // A chain or a segment cannot be put inside another segment
 				rowId = _getEndOfSegmentRowId(view, rowId);
 			} // else { // Normal row is inserted into a segment
 		}
 	}
 
+	let stalledSorting = _stallSorting(view, isSegment, false);
+
 	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(isSegment) {
+		view.setSegmentSeparator(newRowId);
+		_stallSorting(view, false, stalledSorting);
 		if(!this._expanded) {
-			this.collapseChain();
+			view.collapseSegment(newRowId);
 		}
 	} else if(!this._parent && parentRowId) { // Constituent cannot be added to another segment
-		view.addSegmentChild(parentRowId, this._rowId, this._dataId);
+		view.addSegmentChild(parentRowId, newRowId, this._dataId);
 	}
 };
 /** @private

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

@@ -1093,7 +1093,18 @@ ColumnGroupingPlugin.prototype._onBeforeColumnBoundUpdate = function (e) {
       }
     }
   }
-  e.topBoundRowIndex = topBoundRowIndex;
+
+  // Find maximum spanned row count
+  var section = this._hosts[0].getSection("title");
+  var minRowSpanCount = 0;
+  var bottomRowIndex = this._maxDepth;
+  for (i = 0; i < selectedColumns.length; i++) {
+    var rowSpanCount = section.getCellRowSpan(selectedColumns[i], bottomRowIndex);
+    if (rowSpanCount < minRowSpanCount) {
+      minRowSpanCount = rowSpanCount;
+    }
+  }
+  e.topBoundRowIndex = bottomRowIndex + minRowSpanCount;
 };
 /** Deprecated. Column should be directly added through grid APIs.
 * @deprecated

package/lib/types/es6/Core/data/DataView.d.ts

@@ -236,7 +236,9 @@ declare class DataView extends EventDispatcher {
 
     public searchNext(rowRef: number|string|null, searchLogic: ((...params: any[]) => any)|null): number;
 
-    public stall(opt_bool?: boolean|null): boolean;
+    public stall(bool?: boolean|null): boolean;
+
+    public stallSorting(bool?: boolean|null): boolean;
 
     public enableAutoGroupRemoval(opt_bool?: boolean|null): boolean;
 

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

@@ -221,6 +221,8 @@ declare class Grid extends EventDispatcher {
 
     public insertRow(rowOption?: (RowDefinition.Options|string)|null, rowRef?: Grid.RowReference|null): RowDefinition|null;
 
+    public insertSegmentSeparator(rowOption?: RowDefinition.Options|null, rowRef?: Grid.RowReference|null): RowDefinition|null;
+
     public insertRows(rowOptions: (RowDefinition.Options|string)[]|null, rowRef?: Grid.RowReference|null, opt_fields?: (string)[]|null): void;
 
     public addStaticDataRows(dataRows: any[]|null, fields?: (string)[]|null): void;

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

@@ -142,7 +142,5 @@ declare const ROW_DEF: string;
 
 declare const ROW_TYPES: RowDefinition.RowTypes;
 
-declare function rowData(userInput: string, extractedOptions: any): boolean;
-
 export {RowDefinition, ROW_DEF, ROW_TYPES};
 export default RowDefinition;

package/lib/versions.json

@@ -1,5 +1,5 @@
 {
-	"tr-grid-util": "1.3.149",
+	"tr-grid-util": "1.3.151",
 	"tr-grid-printer": "1.0.17",
 	"@grid/column-dragging": "1.0.20",
 	"@grid/row-segmenting": "1.0.31",
@@ -10,7 +10,7 @@
 	"tr-grid-checkbox": "1.0.67",
 	"tr-grid-column-fitter": "1.0.40",
 	"tr-grid-column-formatting": "0.9.36",
-	"tr-grid-column-grouping": "1.0.60",
+	"tr-grid-column-grouping": "1.0.61",
 	"tr-grid-column-resizing": "1.0.28",
 	"tr-grid-column-selection": "1.0.33",
 	"tr-grid-column-stack": "1.0.75",

package/package.json

@@ -66,5 +66,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"version": "6.0.97"
+	"version": "6.0.99"
 }