@refinitiv-ui/efx-grid 6.0.13 → 6.0.14

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

@@ -1,9 +1,13 @@
+import Ext from "../../../tr-grid-util/es6/Ext.js";
+import EventDispatcher from "../../../tr-grid-util/es6/EventDispatcher.js";
 import Segment from "./Segment.js";
 
 declare class SegmentCollection {
 
     constructor();
 
+    public dispose(): void;
+
     public addSegment(rid: string): boolean;
 
     public addSegments(rids: (string)[]|null): boolean;
@@ -34,7 +38,7 @@ declare class SegmentCollection {
 
     public getCollapsedRows(): any;
 
-    public addSegmentChild(segmentId: string, rid: string): boolean;
+    public addSegmentChild(segmentId: string, rid: string, dataId?: string|null): boolean;
 
     public addSegmentChildren(segmentId: string, rids: (string)[]|null): boolean;
 
@@ -54,6 +58,16 @@ declare class SegmentCollection {
 
     public getSegmentValues(rids: (string)[]): (number)[]|null;
 
+    public logStructure(): string;
+
+    public logRowIdMap(): string;
+
+    public setSegmentClassification(segmentId: string, fields: string|(string)[]|null): boolean;
+
+    public hasClassification(): boolean;
+
+    public classify(rows: { [key: string]:  any }|null): boolean;
+
 }
 
 export default SegmentCollection;

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

@@ -1,17 +1,29 @@
+import Ext from "../../../tr-grid-util/es6/Ext.js";
+import EventDispatcher from "../../../tr-grid-util/es6/EventDispatcher.js";
 import Segment from "./Segment.js";
 
 /** @constructor
 */
 var SegmentCollection = function() {
+	this._onSubSegmentAdded = this._onSubSegmentAdded.bind(this);
+	this._onSubSegmentRemoved = this._onSubSegmentRemoved.bind(this);
+
 	this._segments = {};
-	this._childToSegmentId = {};
+	this._insertionList = [];
+	this._removalList = [];
+
+	this._shared = {
+		childToSegment: {}, // child Id to segment Id
+		dirtyCollapsingState: false
+	};
 };
+Ext.inherits(SegmentCollection, EventDispatcher);
 
 
 /** @type {!Object.<string, Segment>}
 * @private
 */
-SegmentCollection.prototype._segments;
+SegmentCollection.prototype._segments; // Contains both segment and their sub segments
 /** @type {number}
 * @private
 */
@@ -20,28 +32,53 @@ SegmentCollection.prototype._segmentCount = 0;
 * @private
 */
 SegmentCollection.prototype._collapsedRids = null;
+/** @type {!Object}
+* @private
+*/
+SegmentCollection.prototype._shared;
+/** @type {Array.<Segment>}
+* @private
+*/
+SegmentCollection.prototype._segmentList = null; // Array of main segments
+/** @type {Array.<Segment>}
+* @private
+*/
+SegmentCollection.prototype._insertionList = null; // Array of sub segments
+/** @type {Array.<string>}
+* @private
+*/
+SegmentCollection.prototype._removalList = null; // Array of sub segment ids
 /** @type {boolean}
 * @private
 */
-SegmentCollection.prototype._dirtyCollapsingState = false;
-/** @type {!Object.<string, string>}
+SegmentCollection.prototype._classification = false;
+/** @type {boolean}
 * @private
 */
-SegmentCollection.prototype._childToSegmentId;
-
+SegmentCollection.prototype._classifierChanged = false;
 
+/** @public
+*/
+SegmentCollection.prototype.dispose = function() {
+	this.removeAllSegments();
+	this._collapsedRids = null;
+	this._segmentList = this._insertionList = this._removalList = null;
+};
 /** @public
 * @param {string} rid
 * @return {boolean} Returns true if there is any change. Otherwise, returns false
 */
 SegmentCollection.prototype.addSegment = function(rid) {
 	if(rid && !this._segments[rid]) {
-		if(this._childToSegmentId[rid]) {
+		if(this.getParentRowId(rid)) {
 			console.log("child of a segment cannot be set as a segment separator");
 			return false;
 		}
-		this._segments[rid] = new Segment(rid);
+		var segment = this._segments[rid] = new Segment(rid, this._shared);
+		segment.addEventListener("subSegmentAdded", this._onSubSegmentAdded);
+		segment.addEventListener("subSegmentRemoved", this._onSubSegmentRemoved);
 		++this._segmentCount;
+		this._segmentList = null; // order could be changed
 		return true;
 	}
 	return false;
@@ -71,7 +108,7 @@ SegmentCollection.prototype.containsSegment = function(rid) {
 * @return {string} parent row id of this segmentation. If the parent row id for this segmentation cannot be found, return ""
 */
 SegmentCollection.prototype.getParentRowId = function(rid) {
-	return this._childToSegmentId[rid] || "";
+	return this._shared.childToSegment[rid] || "";
 };
 /** @public
 * @param {string} rid
@@ -80,10 +117,27 @@ SegmentCollection.prototype.getParentRowId = function(rid) {
 SegmentCollection.prototype.removeSegment = function(rid) {
 	var segment = this._segments[rid];
 	if(segment) {
-		if(segment.isCollapsed()) {
-			this._dirtyCollapsingState = true;
+		if(this._segmentCount <= 1) {
+			return this.removeAllSegments();
+		}
+		if(segment.isSubSegment()) {
+			this._removalList.push(segment.getId());
 		}
-		segment.removeAllChildren(this._childToSegmentId);
+		var subSegIds = segment.getSubSegmentIds();
+		if(subSegIds) {
+			var len = subSegIds.length;
+			for(var i = 0; i < len; ++i) {
+				var subSegId = subSegIds[i];
+				if(this._segments[subSegId]) {
+					this._removalList.push(subSegId);
+					delete this._segments[subSegId]; // Slow
+					--this._segmentCount;
+				}
+			}
+		}
+		segment.removeAllChildren(); // This is important for updating childToSegment
+		segment.dispose();
+
 		delete this._segments[rid]; // Slow
 		--this._segmentCount;
 		return true;
@@ -95,10 +149,15 @@ SegmentCollection.prototype.removeSegment = function(rid) {
 */
 SegmentCollection.prototype.removeAllSegments = function() {
 	if(this._segmentCount) {
+		for(var key in this._segments) {
+			this._segments[key].dispose();
+		}
 		this._segments = {};
-		this._childToSegmentId = {};
 		this._segmentCount = 0;
-		this._dirtyCollapsingState = true;
+		this._segmentList = null;
+		this._shared.childToSegment = {};
+
+		this._classification = this._classifierChanged = false;
 		return true;
 	}
 	return false;
@@ -139,11 +198,7 @@ SegmentCollection.prototype.getSegmentIds = function() {
 SegmentCollection.prototype.collapseSegment = function(segmentId, bool) {
 	var segment = this._segments[segmentId];
 	if(segment) {
-		var dirty = segment.collapse(bool);
-		if(dirty) {
-			this._dirtyCollapsingState = true;
-			return true;
-		}
+		return segment.collapse(bool);
 	}
 	return false;
 };
@@ -166,7 +221,6 @@ SegmentCollection.prototype.expandAllSegments = function() {
 			dirty |= segmentSeparators[rid].expand();
 		}
 		if(dirty) {
-			this._dirtyCollapsingState = true;
 			return true;
 		}
 	}
@@ -187,17 +241,19 @@ SegmentCollection.prototype.isCollapsedSegment = function(segmentId) {
 * @return {Object}
 */
 SegmentCollection.prototype.getCollapsedRows = function() {
-	if(this._dirtyCollapsingState) {
-		this._dirtyCollapsingState = false;
+	if(this._shared.dirtyCollapsingState) {
+		this._shared.dirtyCollapsingState = false;
 		var collapsedRids = null;
 		var count = 0;
 		if(this._segmentCount) {
 			var segmentSeparators = this._segments;
 			collapsedRids = {};
 			for(var rid in segmentSeparators) {
-				if(segmentSeparators[rid].isCollapsed()) {
-					segmentSeparators[rid].getCollapsingStates(collapsedRids);
-					++count;
+				var segment = segmentSeparators[rid];
+				if(!segment.isSubSegment()) {
+					if(segment.getCollapsingStates(collapsedRids)) {
+						++count;
+					}
 				}
 			}
 		}
@@ -209,18 +265,13 @@ SegmentCollection.prototype.getCollapsedRows = function() {
 /** @public
 * @param {string} segmentId
 * @param {string} rid
+* @param {string=} dataId Row id for retrieving data
 * @return {boolean} Returns true if there is any change. Otherwise, returns false
 */
-SegmentCollection.prototype.addSegmentChild = function(segmentId, rid) {
+SegmentCollection.prototype.addSegmentChild = function(segmentId, rid, dataId) {
 	var segment = this._segments[segmentId];
-	if(segment) {
-		var dirty = segment.addChild(rid, this._childToSegmentId);
-		if(dirty) {
-			if(segment.isCollapsed()) {
-				this._dirtyCollapsingState = true;
-			}
-			return true;
-		}
+	if(segment && !segment.isSubSegment()) {
+		return segment.addChild(rid, dataId);
 	}
 	return false;
 };
@@ -231,14 +282,8 @@ SegmentCollection.prototype.addSegmentChild = function(segmentId, rid) {
 */
 SegmentCollection.prototype.addSegmentChildren = function(segmentId, rids) {
 	var segment = this._segments[segmentId];
-	if(segment) {
-		var dirty = segment.addChildren(rids, this._childToSegmentId);
-		if(dirty) {
-			if(segment.isCollapsed()) {
-				this._dirtyCollapsingState = true;
-			}
-			return true;
-		}
+	if(segment && !segment.isSubSegment()) {
+		return segment.addChildren(rids);
 	}
 	return false;
 };
@@ -262,13 +307,7 @@ SegmentCollection.prototype.containsSegmentChild = function(segmentId, rid) {
 SegmentCollection.prototype.removeSegmentChild = function(segmentId, rid) {
 	var segment = this._segments[segmentId];
 	if(segment) {
-		var dirty = segment.removeChild(rid, this._childToSegmentId);
-		if(dirty) {
-			if(segment.isCollapsed()) {
-				this._dirtyCollapsingState = true;
-			}
-			return true;
-		}
+		return segment.removeChild(rid);
 	}
 	return false;
 };
@@ -280,13 +319,7 @@ SegmentCollection.prototype.removeSegmentChild = function(segmentId, rid) {
 SegmentCollection.prototype.removeSegmentChildren = function(segmentId, rids) {
 	var segment = this._segments[segmentId];
 	if(segment) {
-		var dirty = segment.removeChildren(rids, this._childToSegmentId);
-		if(dirty) {
-			if(segment.isCollapsed()) {
-				this._dirtyCollapsingState = true;
-			}
-			return true;
-		}
+		return segment.removeChildren(rids);
 	}
 	return false;
 };
@@ -294,20 +327,20 @@ SegmentCollection.prototype.removeSegmentChildren = function(segmentId, rids) {
 * @return {boolean} Returns true if there is any change. Otherwise, returns false
 */
 SegmentCollection.prototype.removeAllSegmentChildren = function() {
-	this._childToSegmentId = {};
+	this._shared.childToSegment = {};
 	var segmentSeparators = this._segments;
-	var dirtyCollapsingState = this._dirtyCollapsingState;
 	var dirty = false;
 	for(var rid in segmentSeparators) {
-		var segment = this._segments[rid];
+		var segment = segmentSeparators[rid];
 		if(segment.removeAllChildren()) {
 			dirty = true;
-			if(!dirtyCollapsingState && segment.isCollapsed()) {
-				dirtyCollapsingState = this._dirtyCollapsingState = true;
-			}
 		}
 	}
 
+	if(dirty) {
+		this.classify();
+	}
+
 	return dirty;
 };
 
@@ -321,22 +354,18 @@ SegmentCollection.prototype.fillSegment = function(segmentId, rids) {
 		return;
 	}
 	var segmentSeparators = this._segments;
-	var childToSegmentId = this._childToSegmentId;
 	var curSegment = segmentSeparators[segmentId];
-	if(curSegment) {
+	if(curSegment && !curSegment.isSubSegment()) {
 		var segmentAt = rids.indexOf(segmentId);
 		if(segmentAt >= 0) {
-			if(curSegment.isCollapsed()) {
-				this._dirtyCollapsingState = true;
-			}
-			curSegment.removeAllChildren(childToSegmentId);
+			curSegment.removeAllChildren();
 			for(var r = segmentAt + 1; r < rowCount; ++r) {
 				var rid = rids[r];
 				var segmentSeparator = segmentSeparators[rid];
 				if(segmentSeparator) {
 					break;
 				}
-				curSegment.addChild(rid, childToSegmentId);
+				curSegment.addChild(rid);
 			}
 		}
 	}
@@ -346,23 +375,20 @@ SegmentCollection.prototype.fillSegment = function(segmentId, rids) {
 * @return {boolean} Return true if the fill segments have changed, otherwise return false
 */
 SegmentCollection.prototype.fillSegments = function(rids) {
+	this._shared.childToSegment = {};
+
 	var rowCount = Array.isArray(rids) ? rids.length : 0;
-	this._childToSegmentId = {};
 	var segmentSeparators = this._segments;
-	var childToSegmentId = this._childToSegmentId;
 	var curSegment = null;
 	var change = false;
 	for(var r = 0; r < rowCount; ++r) {
 		var rid = rids[r];
 		var segmentSeparator = segmentSeparators[rid];
-		if(segmentSeparator) {
+		if(segmentSeparator && !segmentSeparator.isSubSegment()) {
 			curSegment = segmentSeparator;
-			if(curSegment.isCollapsed()) {
-				this._dirtyCollapsingState = true;
-			}
 			curSegment.removeAllChildren();
-		} else if(curSegment) {
-			curSegment.addChild(rid, childToSegmentId);
+		} else if(curSegment && !curSegment.isSubSegment()) {
+			curSegment.addChild(rid);
 			change = true;
 		}
 	}
@@ -372,6 +398,13 @@ SegmentCollection.prototype.fillSegments = function(rids) {
 * @param {Array.<string>} rids
 */
 SegmentCollection.prototype.calcSegmentOrder = function(rids) {
+	var segmentList = this._segmentList;
+	if(segmentList) {
+		segmentList.length = 0;
+	} else {
+		segmentList = this._segmentList = [];
+	}
+
 	var ridCount = rids ? rids.length : 0;
 	var segmentSeparators = this._segments;
 	var segmentCount = this._segmentCount;
@@ -380,8 +413,11 @@ SegmentCollection.prototype.calcSegmentOrder = function(rids) {
 		var rid = rids[i];
 		var segment = segmentSeparators[rid];
 		if(segment) {
-			segment.setOrder(++order);
-			if(order >= segmentCount) {
+			if(!segment.isSubSegment()) {
+				this._segmentList.push(segment);
+				segment.setOrder(++order); // WARNING: Segments and sub segments start with 1
+			}
+			if(--segmentCount <= 0) {
 				break;
 			}
 		}
@@ -397,7 +433,7 @@ SegmentCollection.prototype.getSegmentValues = function(rids) {
 		return null;
 	}
 	var segmentSeparators = this._segments;
-	var childToSegmentId = this._childToSegmentId;
+	var childToSegmentId = this._shared.childToSegment;
 	var curSegment = null;
 	var prevSegment = null;
 	var segmentValues = new Array(rowCount);
@@ -427,6 +463,126 @@ SegmentCollection.prototype.getSegmentValues = function(rids) {
 
 	return prevSegment ? segmentValues : null;
 };
+/** @public
+* @return {string}
+*/
+SegmentCollection.prototype.logStructure = function() {
+	var segmentList = this._segmentList;
+	if(!segmentList) {
+		return "";
+	}
+	var segmentCount = segmentList.length;
+	var lines = [];
+	for(var i = 0; i < segmentCount; ++i) {
+		segmentList[i].log(lines);
+	}
+
+	return lines.join("\n");
+};
+/** @public
+* @return {string}
+*/
+SegmentCollection.prototype.logRowIdMap = function() {
+	var lines = [];
+	var childToSegmentId = this._shared.childToSegment;
+	for(var rid in childToSegmentId) {
+		var segmentId = childToSegmentId[rid];
+		lines.push(rid + " > " + segmentId);
+	}
+
+	return lines.join("\n");
+};
+
+
+/** @public
+* @param {string} segmentId
+* @param {string|Array.<string>} fields
+* @return {boolean}
+*/
+SegmentCollection.prototype.setSegmentClassification = function(segmentId, fields) {
+	var segment = this._segments[segmentId];
+	if(segment) {
+		if(segment.setClassification(fields)) {
+			if(segment.getClassification()) {
+				this._classification = true;
+			}
+			this._classifierChanged = true;
+
+			return true;
+		}
+	}
+	return false;
+};
+/** @public
+* @return {boolean}
+*/
+SegmentCollection.prototype.hasClassification = function() {
+	// WARNING: This include the time when classification is removed
+	return this._classification || this._classifierChanged;
+};
+/** @public
+* @param {Object.<string, Object>} rows Object maps between row id and its record
+* @return {boolean}
+*/
+SegmentCollection.prototype.classify = function(rows) {
+	if(!this._segmentCount) {
+		return false;
+	}
+	if(!this.hasClassification()) {
+		return false;
+	}
+	this._classification = this._classifierChanged = false;
+
+	var segmentSeparators = this._segments;
+	for(var rid in segmentSeparators) {
+		var segment = this._segments[rid];
+		if(!segment.isSubSegment()) {
+			if(segment.getClassification()) {
+				this._classification = true;
+			}
+			segment.classify(rows);
+		}
+	}
+	if(this._insertionList.length || this._removalList.length) {
+		this._dispatch("subSegmentChanged", {
+			"insertionList": this._insertionList,
+			"removalList": this._removalList
+		});
+		this._insertionList.length = 0;
+		this._removalList.length = 0;
+
+		this._dispatch("classified", {});
+		return true;
+	}
+
+	this._dispatch("classified", {});
+	return false;
+};
+
+/** @private
+* @param {!Object} e
+*/
+SegmentCollection.prototype._onSubSegmentAdded = function(e) {
+	var rid = e["rid"];
+	if(!this._segments[rid]) {
+		var segment = /** @type{Segment} */(e["segment"]);
+		this._insertionList.push(segment);
+		this._segments[rid] = segment;
+		this._segmentCount++;
+
+		segment.addEventListener("subSegmentAdded", this._onSubSegmentAdded);
+		segment.addEventListener("subSegmentRemoved", this._onSubSegmentRemoved);
+	} else {
+		console.log("Incorrect logic detected.");
+	}
+};
+/** @private
+* @param {!Object} e
+*/
+SegmentCollection.prototype._onSubSegmentRemoved = function(e) {
+	var rid = e["rid"];
+	this.removeSegment(rid);
+};
 
 
 export default SegmentCollection;

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

@@ -528,7 +528,7 @@ Core.prototype._rowHeightTimerId = 0;
 * @return {string}
 */
 Core.getVersion = function () {
-	return "5.1.20";
+	return "5.1.26";
 };
 /** {@link ElementWrapper#dispose}
 * @override

package/lib/grid/index.js

@@ -1,2 +1,2 @@
 import "./lib/efx-grid.js";
-window.EFX_GRID = { version: "6.0.13" };
+window.EFX_GRID = { version: "6.0.14" };

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

@@ -47,6 +47,8 @@ declare class RowSegmentingPlugin extends GridPlugin {
 
     public setSegmentSeparator(rowRef: string|number|null, enabled?: boolean|null): boolean;
 
+    public setSegmentClassification(rowRef: string|number|null, fields: string|(string)[]|null): boolean;
+
     public unsetAllSegmentSeparators(): boolean;
 
     public hasSegmentation(): boolean;

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

@@ -424,7 +424,6 @@ RowSegmentingPlugin.prototype._updateHeader = function (settings, firstRowIndex,
 	var arg = {};
 	arg.section = section;
 	arg.colIndex = headerColumn;
-	arg.groupLevel = 1;
 
 	var colCount = section.getColumnCount();
 	for (var c = 0; c < colCount; c++) {
@@ -446,12 +445,22 @@ RowSegmentingPlugin.prototype._updateHeader = function (settings, firstRowIndex,
 		arg.rowIndex = r;
 		arg.rowData = this._getRow(dv, r); // Support composite and rt-grid
 		arg.spanning = null;
+		arg.content = null;
 		var rowId = arg.rowId = dv.getRowId(r); // Slow
+		// TODO: Getting segment once for better performance
 		var segmentSeparator = arg.segmentSeparator = dv.isSegmentSeparator(rowId);
 		arg.collapsedSegment = arg.collapsed = segmentSeparator ? dv.isSegmentCollapsed(rowId) : false;
-		var indentLevel = 0;
 
 		if (segmentSeparator) {
+			arg.groupLevel = dv.getSegmentLevel ? dv.getSegmentLevel(rowId) : 1;
+			arg.indentSize = this._getIndentSize(arg.groupLevel - 1, true); // Group level starts from 1
+			if(dv.getSegment) {
+				var segment = dv.getSegment(rowId);
+				if(segment && arg.groupLevel > 1) { // Sub segment always has name
+					arg.content = segment.getSubSegmentName();
+				}
+			}
+
 			var spanning = arg.rowData[this._rowSpanningField];
 			if(spanning != null) {
 				arg.spanning = !!spanning;
@@ -460,10 +469,11 @@ RowSegmentingPlugin.prototype._updateHeader = function (settings, firstRowIndex,
 			if (this._predefinedColors) {
 				arg.colorTagClass = arg.rowData[cssField];
 			}
-			arg.indentSize = this._getIndentSize(indentLevel, true);
 			rowPainter.applyHeaderStyle(arg);
 			this._dispatch("segmentSeparatorBinding", arg);
 		} else {
+			arg.groupLevel = 0;
+			var indentLevel = 0;
 			var parentId = this.getSegmentParentRowId(rowId);
 			if(parentId) {
 				indentLevel = 1; // TODO: Provide a way for segmenting multiple levels. Currently, just one level is supported.
@@ -553,6 +563,19 @@ RowSegmentingPlugin.prototype.setSegmentSeparator = function(rowRef, enabled) {
 	}
 	return false;
 };
+/** Set classification for the specified segment
+* @public
+* @param {string|number} rowRef Row id or row index
+* @param {string|Array.<string>} fields
+* @return {boolean}
+*/
+RowSegmentingPlugin.prototype.setSegmentClassification = function(rowRef, fields) {
+	var dv = this._getDataView();
+	if(dv) {
+		return dv.setSegmentClassification(rowRef, fields);
+	}
+	return false;
+};
 /** Clear all segment separator rows
 * @public
 * @return {boolean} Return true if there is any change