@refinitiv-ui/efx-grid 6.0.128 → 6.0.130

package/lib/core/es6/data/DataCache.js

@@ -346,6 +346,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

package/lib/core/es6/data/DataTable.d.ts

@@ -80,6 +80,8 @@ declare class DataTable extends DataCache {
 
     public isFrozen(): boolean;
 
+    public setSegmentSeparators(rids: (string)[]|null, enabled?: boolean|null): boolean;
+
     public setSegmentSeparator(rid: string, enabled?: boolean|null): boolean;
 
     public unsetAllSegmentSeparators(): boolean;
@@ -106,6 +108,8 @@ declare class DataTable extends DataCache {
 
     public addSegmentChildren(segmentId: string, rids: (string)[]|null, dataIds?: (string)[]|null): boolean;
 
+    public setSegmentChildren(segmentArr: (any)[]|null): boolean;
+
     public removeSegmentChild(segmentId: string, rid: string): boolean;
 
     public removeSegmentChildren(segmentId: string, rids: (string)[]|null): boolean;

package/lib/core/es6/data/DataTable.js

@@ -823,6 +823,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
@@ -964,6 +1003,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 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
@@ -990,7 +1078,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();
@@ -1216,6 +1304,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

package/lib/core/es6/data/DataView.d.ts

@@ -246,6 +246,8 @@ declare class DataView extends EventDispatcher {
 
     public synchronizeRowOrder(): void;
 
+    public setSegmentSeparators(rowIds: (string)[]|null, enabled?: boolean|null): boolean;
+
     public setSegmentSeparator(rowRef: string|number|null, enabled?: boolean|null): boolean;
 
     public unsetAllSegmentSeparators(): boolean;
@@ -264,6 +266,8 @@ declare class DataView extends EventDispatcher {
 
     public collapseSegment(rowRef: string|number|null, collapsed?: boolean|null): boolean;
 
+    public collapseSegments(rowIds: (string|number)[]|null, collapsed?: boolean|null): boolean;
+
     public expandSegment(rowRef: string|number|null, expanded?: boolean|null): boolean;
 
     public expandAllSegments(): boolean;
@@ -278,6 +282,8 @@ declare class DataView extends EventDispatcher {
 
     public addSegmentChildren(segmentRef: string|number|null, rowRefs: (string|number)[]|null, dataIds?: (string)[]|null): boolean;
 
+    public setSegmentChildren(segmentArr: (any)[]|null): boolean;
+
     public removeSegmentChild(segmentRef: string|number|null, rowRef: string|number|null): boolean;
 
     public removeSegmentChildren(segmentRef: string|number|null, rowRefs: (string|number)[]|null): boolean;

package/lib/core/es6/data/DataView.js

@@ -2428,6 +2428,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
@@ -2528,6 +2545,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
@@ -2606,6 +2639,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

package/lib/core/es6/data/SegmentCollection.d.ts

@@ -30,6 +30,8 @@ declare class SegmentCollection extends EventDispatcher {
 
     public getSegmentIds(): (string)[];
 
+    public collapseSegments(segmentIds: (string)[]|null, bool?: boolean|null): boolean;
+
     public collapseSegment(segmentId: string, bool?: boolean|null): boolean;
 
     public expandSegment(segmentId: string, bool?: boolean|null): boolean;

package/lib/core/es6/data/SegmentCollection.js

@@ -208,6 +208,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

package/lib/core/es6/grid/Core.js

@@ -621,7 +621,7 @@ Core.prototype._hasPendingRowChange = false;
 * @return {string}
 */
 Core.getVersion = function () {
-	return "5.1.125";
+	return "5.1.130";
 };
 /** {@link ElementWrapper#dispose}
 * @override
@@ -2352,21 +2352,45 @@ Core.prototype.setColumnBackgroundColor = function(colIndex, color) {
 		}
 
 		if(settings.getType() !== "content") {
-			let rowCount = section.getRowCount();
-			for(let r = 0; r < rowCount; r++) {
-				let cellSpan = section.getCellColSpan(colIndex, r);
-				if(cellSpan > 1) { continue; }
-				let cell = section.getCell(colIndex, r);
-				if(cell) {
-					cell.setStyle("backgroundColor", color);
-				}
-			}
+			this._applyCellsBackgroundColor(section, colIndex, color);
 		} else {
 			let column = section.getColumn(colIndex);
 			column.setStyle("backgroundColor", color);
 		}
 	}
 };
+/** @private
+* @param {ILayoutGrid} section
+* @param {number} colIndex
+* @param {string} color
+*/
+Core.prototype._applyCellsBackgroundColor = function(section, colIndex, color) {
+	let rowCount = section.getRowCount();
+	for(let r = 0; r < rowCount; r++) {
+		let cellSpan = section.getCellColSpan(colIndex, r);
+		if(cellSpan > 1) { continue; }
+		let cell = section.getCell(colIndex, r);
+		if(cell) {
+			cell.setStyle("backgroundColor", color);
+		}
+	}
+};
+/** @public
+* @ignore
+* @param {ILayoutGrid} section
+*/
+Core.prototype.applyColumnsBackgroundColor = function(section) {
+	if(!section) {
+		return;
+	}
+
+	let colCount = section.getColumnCount();
+	for(let c = 0; c < colCount; c++) {
+		let colDef = this._getColumnDef(c);
+		let color = colDef["backgroundColor"] || "";
+		this._applyCellsBackgroundColor(section, c, color);
+	}
+};
 
 /** @public
 * @param {number} colIndex
@@ -5624,6 +5648,11 @@ Core.prototype._onRowCountChanged = function (e) {
 
 	this._updateColumnSeparators();
 	if(prevRowCount < newRowCount) {
+		// Apply column background color
+		let settings = this.getSectionSettings(section);
+		if(settings.getType() !== "content") {
+			this.applyColumnsBackgroundColor(section);
+		}
 		this._dispatch("rowAdded", e);
 	} else if(prevRowCount > newRowCount) {
 		this._dispatch("rowRemoved", e);

package/lib/core/es6/grid/plugins/SortableTitlePlugin.js

@@ -803,7 +803,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
@@ -1202,14 +1210,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);
-		}
 	}
 };
 

package/lib/grid/index.js

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

package/lib/row-segmenting/es6/RowSegmenting.d.ts

@@ -51,6 +51,8 @@ declare class RowSegmentingPlugin extends GridPlugin {
 
     public _resolveDisplayColumn(): number;
 
+    public setSegmentSeparators(rowIds: (string)[]|null, enabled?: boolean|null): boolean;
+
     public setSegmentSeparator(rowRef: string|number|null, enabled?: boolean|null): boolean;
 
     public setSegmentClassification(rowRef: string|number|null, fields: string|(string)[]|null): boolean;
@@ -61,6 +63,8 @@ declare class RowSegmentingPlugin extends GridPlugin {
 
     public isSegmentSeparator(rowRef: string|number|null): boolean;
 
+    public collapseSegments(rowIds: (string )[]|null, collapsed: (string )[]|null): boolean;
+
     public collapseSegment(rowRef: string|number|null, collapsed?: boolean|null): boolean;
 
     public expandSegment(rowRef: string|number|null, expanded?: boolean|null): boolean;
@@ -77,6 +81,8 @@ declare class RowSegmentingPlugin extends GridPlugin {
 
     public addSegmentChild(segmentRef: string|number|null, rowRef: string|number|null): void;
 
+    public setSegmentChildren(segmentArr: (any)[]|null): void;
+
     public addSegmentChildren(segmentRef: string|number|null, rowRefs: (string|number)[]|null): void;
 
     public removeSegmentChild(segmentRef: string|number|null, rowRef: string|number|null): void;

package/lib/row-segmenting/es6/RowSegmenting.js

@@ -220,24 +220,35 @@ RowSegmentingPlugin.prototype._refreshSegmentSeparator = function () {
 	var rowIds = dt.getAllRowIds();
 	var rowCount = rowIds.length;
 	var separatorMap = {};
+	var segmentArr = [];
+	var separatorArr = [];
+	var collapseArr = [];
 	for(var i = 0; i < rowCount; i++) {
 		rowId = rowIds[i];
 		rowData = this._rowGetter(dt.getRowData(rowId));
 		segmentId = rowData[this._segmentIdField];
-
-		if (segmentId != null) {
-			if (separatorMap[segmentId] != null ) {
-				this.addSegmentChild(separatorMap[segmentId], rowId);
-			} else {
-				separatorMap[segmentId] = rowId;
-				this.setSegmentSeparator(rowId);
-				if (collapsingMap[segmentId] != null) {
-					this.collapseSegment(rowId, collapsingMap[segmentId]);
-				}
+		if(segmentId == null) {
+			continue;
+		}
+		if(separatorMap[segmentId] == null) {
+			separatorMap[segmentId] = {
+				rowIds: [],
+				segmentId: rowId // Row id of parent
+			};
+			segmentArr.push(separatorMap[segmentId]);
+			separatorArr.push(rowId);
+			if (collapsingMap[segmentId] === true) { // TODO: Currenly is expand by default, then it need to only collapse some row from prev segment id
+				collapseArr.push(rowId);
 			}
-			this._prevSegmentBySegmentId = true;
+		} else {
+			// Add rowId to set segment separator
+			separatorMap[segmentId].rowIds.push(rowId);
 		}
+		this._prevSegmentBySegmentId = true;
 	}
+	this.setSegmentSeparators(separatorArr);
+	this.setSegmentChildren(segmentArr);
+	this.collapseSegments(collapseArr);
 };
 /** @public
 * @param {Object=} host core grid instance
@@ -728,6 +739,20 @@ RowSegmentingPlugin.prototype._getDataView = function () {
 	return host ? host.getDataSource() : null;
 };
 
+/** Set specified row ids as a segment separator
+* @public
+* @param {Array<string>} rowIds
+* @param {boolean=} enabled
+* @return {boolean} Return true if there is any change
+*/
+RowSegmentingPlugin.prototype.setSegmentSeparators = function(rowIds, enabled) {
+	var dv = this._getDataView();
+	if(dv) {
+		return dv.setSegmentSeparators(rowIds, enabled);
+	}
+	return false;
+};
+
 /** Set specified row as a segment separator
 * @public
 * @param {string|number} rowRef Row id or row index
@@ -796,6 +821,21 @@ RowSegmentingPlugin.prototype.isSegmentSeparator = function(rowRef) {
 	return false;
 };
 
+/**
+* @public
+* @param {Array.<string >} rowIds
+* @param {Array.<string >} collapsed
+
+* @return {boolean} Return true if there is any change
+*/
+RowSegmentingPlugin.prototype.collapseSegments = function(rowIds, collapsed) {
+	var dv = this._getDataView();
+	if(dv) {
+		return dv.collapseSegments(rowIds, collapsed);
+	}
+	return false;
+};
+
 /** Hide all members in the segment
 * @public
 * @param {string|number} rowRef Row id or row index of the segment separator
@@ -888,6 +928,17 @@ RowSegmentingPlugin.prototype.addSegmentChild = function(segmentRef, rowRef) {
 		dv.addSegmentChild(segmentRef, rowRef, dataId);
 	}
 };
+
+/** @public
+* @param {Array<Object>} segmentArr Segment array that contain "segmentId", "rowIds" to set segment children
+*/
+RowSegmentingPlugin.prototype.setSegmentChildren = function(segmentArr) {
+	let dv = this._getDataView();
+	if(dv) {
+		dv.setSegmentChildren(segmentArr);
+	}
+};
+
 /** @public
 * @param {string|number} segmentRef Row id or row index
 * @param {Array.<string|number>} rowRefs Array of row ids or row indices.  If null is given, no child will be removed.